@stream-io/node-sdk 0.7.62 → 0.7.64

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.
@@ -1,15 +1,31 @@
1
1
  import { ApiClient, StreamResponse } from '../../gen-imports';
2
- import { AppealRequest, AppealResponse, BanRequest, BanResponse, BulkImageModerationRequest, BulkImageModerationResponse, BypassRequest, BypassResponse, CheckRequest, CheckResponse, CheckS3AccessRequest, CheckS3AccessResponse, CustomCheckRequest, CustomCheckResponse, DeleteModerationConfigResponse, DeleteModerationRuleResponse, DeleteModerationTemplateResponse, FlagRequest, FlagResponse, GetAppealResponse, GetConfigResponse, GetFlagCountRequest, GetFlagCountResponse, GetModerationRuleResponse, GetReviewQueueItemResponse, InsertActionLogRequest, InsertActionLogResponse, MuteRequest, MuteResponse, QueryAppealsRequest, QueryAppealsResponse, QueryFeedModerationTemplatesResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationFlagsRequest, QueryModerationFlagsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryModerationRulesRequest, QueryModerationRulesResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, SubmitActionRequest, SubmitActionResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationRuleRequest, UpsertModerationRuleResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse } from '../models';
2
+ import { AnalyzeRequest, AnalyzeResponse, AppealRequest, AppealResponse, BanRequest, BulkActionAppealsRequest, BulkActionAppealsResponse, BulkDeleteActionConfigRequest, BulkDeleteActionConfigResponse, BulkImageModerationRequest, BulkImageModerationResponse, BulkUpsertActionConfigRequest, BulkUpsertActionConfigResponse, BypassRequest, BypassResponse, CheckRequest, CheckResponse, CheckS3AccessRequest, CheckS3AccessResponse, CreatePolicyTestSetRequest, CreateQueueRequest, CustomCheckRequest, CustomCheckResponse, DeleteActionConfigResponse, DeleteModerationConfigResponse, DeleteModerationRuleResponse, DeleteModerationTemplateResponse, DeleteQueueRequest, FlagItemResponse, FlagRequest, GetActionConfigResponse, GetAppealResponse, GetConfigResponse, GetFlagCountRequest, GetFlagCountResponse, GetModerationRuleResponse, GetReviewQueueItemResponse, GetSetupSessionResponse, InsertActionLogRequest, InsertActionLogResponse, LabelsRequest, LabelsResponse, ListQueuesResponse, ModerationBanResponse, MuteRequest, MuteResponse, PolicyTestRunResponse, PolicyTestSetListResponse, PolicyTestSetResponse, QueryAppealsRequest, QueryAppealsResponse, QueryFeedModerationTemplatesResponse, QueryLabelResultsRequest, QueryLabelResultsResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationFlagsRequest, QueryModerationFlagsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryModerationRulesRequest, QueryModerationRulesResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, QueueResponse, Response, SubmitActionRequest, SubmitActionResponse, SubmitModerationFeedbackRequest, SubmitModerationFeedbackResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpdateQueueRequest, UpsertActionConfigRequest, UpsertActionConfigResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationRuleRequest, UpsertModerationRuleResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse, UpsertSetupSessionRequest, UpsertSetupSessionResponse } from '../models';
3
3
  export declare class ModerationApi {
4
4
  readonly apiClient: ApiClient;
5
5
  constructor(apiClient: ApiClient);
6
+ getActionConfig(request?: {
7
+ queue_type?: string;
8
+ entity_type?: string;
9
+ exclude_defaults?: boolean;
10
+ only_defaults?: boolean;
11
+ user_id?: string;
12
+ }): Promise<StreamResponse<GetActionConfigResponse>>;
13
+ upsertActionConfig(request: UpsertActionConfigRequest): Promise<StreamResponse<UpsertActionConfigResponse>>;
14
+ bulkUpsertActionConfig(request: BulkUpsertActionConfigRequest): Promise<StreamResponse<BulkUpsertActionConfigResponse>>;
15
+ bulkDeleteActionConfig(request: BulkDeleteActionConfigRequest): Promise<StreamResponse<BulkDeleteActionConfigResponse>>;
16
+ deleteActionConfig(request: {
17
+ id: string;
18
+ user_id?: string;
19
+ }): Promise<StreamResponse<DeleteActionConfigResponse>>;
6
20
  insertActionLog(request: InsertActionLogRequest): Promise<StreamResponse<InsertActionLogResponse>>;
21
+ analyze(request?: AnalyzeRequest): Promise<StreamResponse<AnalyzeResponse>>;
7
22
  appeal(request: AppealRequest): Promise<StreamResponse<AppealResponse>>;
8
23
  getAppeal(request: {
9
24
  id: string;
10
25
  }): Promise<StreamResponse<GetAppealResponse>>;
11
26
  queryAppeals(request?: QueryAppealsRequest): Promise<StreamResponse<QueryAppealsResponse>>;
12
- ban(request: BanRequest): Promise<StreamResponse<BanResponse>>;
27
+ bulkActionAppeals(request: BulkActionAppealsRequest): Promise<StreamResponse<BulkActionAppealsResponse>>;
28
+ ban(request: BanRequest): Promise<StreamResponse<ModerationBanResponse>>;
13
29
  bulkImageModeration(request: BulkImageModerationRequest): Promise<StreamResponse<BulkImageModerationResponse>>;
14
30
  bypass(request: BypassRequest): Promise<StreamResponse<BypassResponse>>;
15
31
  check(request: CheckRequest): Promise<StreamResponse<CheckResponse>>;
@@ -29,22 +45,58 @@ export declare class ModerationApi {
29
45
  v2DeleteTemplate(): Promise<StreamResponse<DeleteModerationTemplateResponse>>;
30
46
  v2QueryTemplates(): Promise<StreamResponse<QueryFeedModerationTemplatesResponse>>;
31
47
  v2UpsertTemplate(request: UpsertModerationTemplateRequest): Promise<StreamResponse<UpsertModerationTemplateResponse>>;
32
- flag(request: FlagRequest): Promise<StreamResponse<FlagResponse>>;
48
+ flag(request: FlagRequest): Promise<StreamResponse<FlagItemResponse>>;
33
49
  getFlagCount(request: GetFlagCountRequest): Promise<StreamResponse<GetFlagCountResponse>>;
34
50
  queryModerationFlags(request?: QueryModerationFlagsRequest): Promise<StreamResponse<QueryModerationFlagsResponse>>;
51
+ labels(request: LabelsRequest): Promise<StreamResponse<LabelsResponse>>;
52
+ queryLabelResults(request?: QueryLabelResultsRequest): Promise<StreamResponse<QueryLabelResultsResponse>>;
35
53
  queryModerationLogs(request?: QueryModerationLogsRequest): Promise<StreamResponse<QueryModerationLogsResponse>>;
36
54
  upsertModerationRule(request: UpsertModerationRuleRequest): Promise<StreamResponse<UpsertModerationRuleResponse>>;
37
- deleteModerationRule(request?: {
55
+ deleteModerationRule(request: {
56
+ id: string;
38
57
  user_id?: string;
39
58
  }): Promise<StreamResponse<DeleteModerationRuleResponse>>;
40
- getModerationRule(): Promise<StreamResponse<GetModerationRuleResponse>>;
59
+ getModerationRule(request: {
60
+ id: string;
61
+ }): Promise<StreamResponse<GetModerationRuleResponse>>;
41
62
  queryModerationRules(request?: QueryModerationRulesRequest): Promise<StreamResponse<QueryModerationRulesResponse>>;
42
63
  mute(request: MuteRequest): Promise<StreamResponse<MuteResponse>>;
64
+ getPolicyTestRun(request: {
65
+ id: string;
66
+ }): Promise<StreamResponse<PolicyTestRunResponse>>;
67
+ listPolicyTestSets(): Promise<StreamResponse<PolicyTestSetListResponse>>;
68
+ createPolicyTestSet(request: CreatePolicyTestSetRequest): Promise<StreamResponse<PolicyTestSetResponse>>;
69
+ deletePolicyTestSet(request: {
70
+ id: string;
71
+ }): Promise<StreamResponse<Response>>;
72
+ getPolicyTestSet(request: {
73
+ id: string;
74
+ }): Promise<StreamResponse<PolicyTestSetResponse>>;
75
+ startPolicyTestRun(request: {
76
+ id: string;
77
+ }): Promise<StreamResponse<PolicyTestRunResponse>>;
78
+ listQueues(request?: {
79
+ user_id?: string;
80
+ }): Promise<StreamResponse<ListQueuesResponse>>;
81
+ createQueue(request: CreateQueueRequest): Promise<StreamResponse<QueueResponse>>;
82
+ getQueue(request: {
83
+ id: string;
84
+ user_id?: string;
85
+ }): Promise<StreamResponse<QueueResponse>>;
86
+ updateQueue(request: UpdateQueueRequest & {
87
+ id: string;
88
+ }): Promise<StreamResponse<QueueResponse>>;
89
+ deleteQueue(request: DeleteQueueRequest & {
90
+ id: string;
91
+ }): Promise<StreamResponse<QueueResponse>>;
43
92
  queryReviewQueue(request?: QueryReviewQueueRequest): Promise<StreamResponse<QueryReviewQueueResponse>>;
44
93
  getReviewQueueItem(request: {
45
94
  id: string;
46
95
  }): Promise<StreamResponse<GetReviewQueueItemResponse>>;
96
+ getSetupSession(): Promise<StreamResponse<GetSetupSessionResponse>>;
97
+ upsertSetupSession(request: UpsertSetupSessionRequest): Promise<StreamResponse<UpsertSetupSessionResponse>>;
47
98
  submitAction(request: SubmitActionRequest): Promise<StreamResponse<SubmitActionResponse>>;
99
+ submitModerationFeedback(request: SubmitModerationFeedbackRequest): Promise<StreamResponse<SubmitModerationFeedbackResponse>>;
48
100
  unban(request: UnbanRequest & {
49
101
  target_user_id: string;
50
102
  channel_cid?: string;
@@ -1,5 +1,5 @@
1
1
  import { ApiClient, StreamResponse } from '../../gen-imports';
2
- import { BlockUserRequest, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, CreateCallTypeRequest, CreateCallTypeResponse, CreateSIPTrunkRequest, CreateSIPTrunkResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteSIPInboundRoutingRuleResponse, DeleteSIPTrunkResponse, DeleteTranscriptionResponse, EndCallResponse, GetActiveCallsStatusResponse, GetCallParticipantSessionMetricsResponse, GetCallReportResponse, GetCallResponse, GetCallSessionParticipantStatsDetailsResponse, GetCallTypeResponse, GetEdgesResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, KickUserRequest, KickUserResponse, ListCallTypeResponse, ListRecordingsResponse, ListSIPInboundRoutingRuleResponse, ListSIPTrunksResponse, ListTranscriptionsResponse, MuteUsersRequest, MuteUsersResponse, PinRequest, PinResponse, QueryAggregateCallStatsRequest, QueryAggregateCallStatsResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallParticipantSessionsResponse, QueryCallParticipantsRequest, QueryCallParticipantsResponse, QueryCallSessionParticipantStatsResponse, QueryCallSessionParticipantStatsTimelineResponse, QueryCallSessionStatsRequest, QueryCallSessionStatsResponse, QueryCallStatsMapResponse, QueryCallStatsRequest, QueryCallStatsResponse, QueryCallsRequest, QueryCallsResponse, QueryUserFeedbackRequest, QueryUserFeedbackResponse, ResolveSipAuthRequest, ResolveSipAuthResponse, ResolveSipInboundRequest, ResolveSipInboundResponse, Response, RingCallRequest, RingCallResponse, SIPInboundRoutingRuleRequest, SIPInboundRoutingRuleResponse, SendCallEventRequest, SendCallEventResponse, SendClosedCaptionRequest, SendClosedCaptionResponse, SortParamRequest, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRTMPBroadcastsRequest, StopRTMPBroadcastsResponse, StopRecordingRequest, StopRecordingResponse, StopTranscriptionRequest, StopTranscriptionResponse, UnblockUserRequest, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateCallTypeRequest, UpdateCallTypeResponse, UpdateSIPInboundRoutingRuleRequest, UpdateSIPInboundRoutingRuleResponse, UpdateSIPTrunkRequest, UpdateSIPTrunkResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from '../models';
2
+ import { BlockUserRequest, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, CreateCallTypeRequest, CreateCallTypeResponse, CreateSIPTrunkRequest, CreateSIPTrunkResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteSIPInboundRoutingRuleResponse, DeleteSIPTrunkResponse, DeleteTranscriptionResponse, EndCallResponse, GetActiveCallsStatusResponse, GetCallParticipantSessionMetricsResponse, GetCallReportResponse, GetCallResponse, GetCallSessionParticipantStatsDetailsResponse, GetCallTypeResponse, GetDailyDigestResponse, GetEdgesResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, KickUserRequest, KickUserResponse, ListCallTypeResponse, ListRecordingsResponse, ListSIPInboundRoutingRuleResponse, ListSIPTrunksResponse, ListTranscriptionsResponse, MuteUsersRequest, MuteUsersResponse, PinRequest, PinResponse, QueryAggregateCallStatsRequest, QueryAggregateCallStatsResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallParticipantSessionsResponse, QueryCallParticipantsRequest, QueryCallParticipantsResponse, QueryCallSessionParticipantStatsResponse, QueryCallSessionParticipantStatsTimelineResponse, QueryCallSessionStatsRequest, QueryCallSessionStatsResponse, QueryCallStatsMapResponse, QueryCallStatsRequest, QueryCallStatsResponse, QueryCallsRequest, QueryCallsResponse, QueryUserFeedbackRequest, QueryUserFeedbackResponse, ReportClientEventRequest, ReportClientEventResponse, ResolveSipAuthRequest, ResolveSipAuthResponse, ResolveSipInboundRequest, ResolveSipInboundResponse, Response, RingCallRequest, RingCallResponse, SIPInboundRoutingRuleRequest, SIPInboundRoutingRuleResponse, SendCallEventRequest, SendCallEventResponse, SendClosedCaptionRequest, SendClosedCaptionResponse, SortParamRequest, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartFrameRecordingRequest, StartFrameRecordingResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopFrameRecordingResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRTMPBroadcastsRequest, StopRTMPBroadcastsResponse, StopRecordingRequest, StopRecordingResponse, StopTranscriptionRequest, StopTranscriptionResponse, UnblockUserRequest, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateCallTypeRequest, UpdateCallTypeResponse, UpdateSIPInboundRoutingRuleRequest, UpdateSIPInboundRoutingRuleResponse, UpdateSIPTrunkRequest, UpdateSIPTrunkResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from '../models';
3
3
  export declare class VideoApi {
4
4
  readonly apiClient: ApiClient;
5
5
  constructor(apiClient: ApiClient);
@@ -192,6 +192,7 @@ export declare class VideoApi {
192
192
  session: string;
193
193
  filename: string;
194
194
  }): Promise<StreamResponse<DeleteTranscriptionResponse>>;
195
+ reportClientCallEvent(request: ReportClientEventRequest): Promise<StreamResponse<ReportClientEventResponse>>;
195
196
  queryCallSessionStats(request?: QueryCallSessionStatsRequest): Promise<StreamResponse<QueryCallSessionStatsResponse>>;
196
197
  getCallStatsMap(request: {
197
198
  call_type: string;
@@ -265,4 +266,8 @@ export declare class VideoApi {
265
266
  }): Promise<StreamResponse<UpdateSIPTrunkResponse>>;
266
267
  resolveSipInbound(request: ResolveSipInboundRequest): Promise<StreamResponse<ResolveSipInboundResponse>>;
267
268
  queryAggregateCallStats(request?: QueryAggregateCallStatsRequest): Promise<StreamResponse<QueryAggregateCallStatsResponse>>;
269
+ getDailyDigest(request?: {
270
+ date?: string;
271
+ app_id?: string;
272
+ }): Promise<StreamResponse<GetDailyDigestResponse>>;
268
273
  }
@@ -0,0 +1,7 @@
1
+ export declare const isScalar: (value: any) => boolean;
2
+ /**
3
+ * Scalar arrays go on the wire comma-separated (`ids=a,b`), anything else has
4
+ * to be JSON or it stringifies to `[object Object]`. `null` and `undefined`
5
+ * entries are dropped so that a single empty value can't flip the format.
6
+ */
7
+ export declare const stringifyArrayParam: (param: any[]) => string;
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@stream-io/node-sdk",
3
- "version": "0.7.62",
3
+ "version": "0.7.64",
4
4
  "description": "",
5
5
  "exports": {
6
6
  ".": {
7
+ "types": "./dist/index.d.ts",
7
8
  "import": "./dist/index.es.mjs",
8
- "require": "./dist/index.cjs.js",
9
- "types": "./dist/index.d.ts"
9
+ "require": "./dist/index.cjs.js"
10
10
  }
11
11
  },
12
12
  "main": "dist/index.cjs.js",
package/src/ApiClient.ts CHANGED
@@ -2,6 +2,7 @@ import { randomUUID } from 'crypto';
2
2
  import { ApiConfig, RequestMetadata, StreamError } from './types';
3
3
  import { APIError } from './gen/models';
4
4
  import { getRateLimitFromResponseHeader } from './utils/rate-limit';
5
+ import { isScalar, stringifyArrayParam } from './utils/query-params';
5
6
 
6
7
  export class ApiClient {
7
8
  private readonly dispatcher?: RequestInit['dispatcher'];
@@ -128,20 +129,17 @@ export class ApiClient {
128
129
  const newParams = [];
129
130
  for (const k in params) {
130
131
  const param = params[k];
132
+ if (param === null || param === undefined) continue;
131
133
  if (Array.isArray(param)) {
132
- newParams.push(`${k}=${encodeURIComponent(param.join(','))}`);
134
+ newParams.push(
135
+ `${k}=${encodeURIComponent(stringifyArrayParam(param))}`,
136
+ );
133
137
  } else if (param instanceof Date) {
134
- newParams.push(param.toISOString());
138
+ newParams.push(`${k}=${encodeURIComponent(param.toISOString())}`);
135
139
  } else if (typeof param === 'object') {
136
140
  newParams.push(`${k}=${encodeURIComponent(JSON.stringify(param))}`);
137
- } else {
138
- if (
139
- typeof param === 'string' ||
140
- typeof param === 'number' ||
141
- typeof param === 'boolean'
142
- ) {
143
- newParams.push(`${k}=${encodeURIComponent(param)}`);
144
- }
141
+ } else if (isScalar(param)) {
142
+ newParams.push(`${k}=${encodeURIComponent(param)}`);
145
143
  }
146
144
  }
147
145
 
@@ -54,6 +54,30 @@ export class ChannelApi {
54
54
  });
55
55
  }
56
56
 
57
+ get(request?: {
58
+ state?: boolean;
59
+ messages_limit?: number;
60
+ members_limit?: number;
61
+ watchers_limit?: number;
62
+ messages_id_lt?: string;
63
+ messages_id_lte?: string;
64
+ messages_id_gt?: string;
65
+ messages_id_gte?: string;
66
+ messages_id_around?: string;
67
+ }): Promise<StreamResponse<ChannelStateResponse>> {
68
+ if (!this.id) {
69
+ throw new Error(
70
+ `Channel isn't yet created, call getOrCreateDistinctChannel() before this operation`,
71
+ );
72
+ }
73
+
74
+ return this.chatApi.getChannel({
75
+ id: this.id,
76
+ type: this.type,
77
+ ...request,
78
+ });
79
+ }
80
+
57
81
  updateChannelPartial(
58
82
  request?: UpdateChannelPartialRequest,
59
83
  ): Promise<StreamResponse<UpdateChannelPartialResponse>> {
@@ -240,6 +264,7 @@ export class ChannelApi {
240
264
 
241
265
  getManyMessages(request: {
242
266
  ids: string[];
267
+ member_custom_include?: string[];
243
268
  }): Promise<StreamResponse<GetManyMessagesResponse>> {
244
269
  if (!this.id) {
245
270
  throw new Error(
@@ -1,5 +1,6 @@
1
1
  import { ApiClient, StreamResponse } from '../../gen-imports';
2
2
  import {
3
+ AddSegmentTargetsRequest,
3
4
  CampaignResponse,
4
5
  CastPollVoteRequest,
5
6
  ChannelBatchUpdateRequest,
@@ -7,11 +8,16 @@ import {
7
8
  ChannelGetOrCreateRequest,
8
9
  ChannelStateResponse,
9
10
  CommitMessageRequest,
11
+ CreateCampaignRequest,
12
+ CreateCampaignResponse,
10
13
  CreateChannelTypeRequest,
11
14
  CreateChannelTypeResponse,
12
15
  CreateCommandRequest,
13
16
  CreateCommandResponse,
14
17
  CreateReminderRequest,
18
+ CreateSegmentRequest,
19
+ CreateSegmentResponse,
20
+ DeleteCampaignResponse,
15
21
  DeleteChannelResponse,
16
22
  DeleteChannelsRequest,
17
23
  DeleteChannelsResponse,
@@ -38,6 +44,8 @@ import {
38
44
  GetRetentionPolicyRunsResponse,
39
45
  GetSegmentResponse,
40
46
  GetThreadResponse,
47
+ GroupedQueryChannelsRequest,
48
+ GroupedQueryChannelsResponse,
41
49
  HideChannelRequest,
42
50
  HideChannelResponse,
43
51
  ListChannelTypesResponse,
@@ -108,6 +116,7 @@ import {
108
116
  UnmuteResponse,
109
117
  UnreadCountsBatchRequest,
110
118
  UnreadCountsBatchResponse,
119
+ UpdateCampaignRequest,
111
120
  UpdateChannelPartialRequest,
112
121
  UpdateChannelPartialResponse,
113
122
  UpdateChannelRequest,
@@ -124,6 +133,8 @@ import {
124
133
  UpdateMessageResponse,
125
134
  UpdateReminderRequest,
126
135
  UpdateReminderResponse,
136
+ UpdateSegmentRequest,
137
+ UpdateSegmentResponse,
127
138
  UpdateThreadPartialRequest,
128
139
  UpdateThreadPartialResponse,
129
140
  UploadChannelFileRequest,
@@ -137,6 +148,42 @@ import { decoders } from '../model-decoders/decoders';
137
148
  export class ChatApi {
138
149
  constructor(public readonly apiClient: ApiClient) {}
139
150
 
151
+ async createCampaign(
152
+ request: CreateCampaignRequest,
153
+ ): Promise<StreamResponse<CreateCampaignResponse>> {
154
+ const body = {
155
+ sender_id: request?.sender_id,
156
+ message_template: request?.message_template,
157
+ create_channels: request?.create_channels,
158
+ description: request?.description,
159
+ id: request?.id,
160
+ name: request?.name,
161
+ sender_mode: request?.sender_mode,
162
+ sender_visibility: request?.sender_visibility,
163
+ show_channels: request?.show_channels,
164
+ skip_push: request?.skip_push,
165
+ skip_webhook: request?.skip_webhook,
166
+ segment_ids: request?.segment_ids,
167
+ user_ids: request?.user_ids,
168
+ channel_template: request?.channel_template,
169
+ };
170
+
171
+ const response = await this.apiClient.sendRequest<
172
+ StreamResponse<CreateCampaignResponse>
173
+ >(
174
+ 'POST',
175
+ '/api/v2/chat/campaigns',
176
+ undefined,
177
+ undefined,
178
+ body,
179
+ 'application/json',
180
+ );
181
+
182
+ decoders.CreateCampaignResponse?.(response.body);
183
+
184
+ return { ...response.body, metadata: response.metadata };
185
+ }
186
+
140
187
  async queryCampaigns(
141
188
  request?: QueryCampaignsRequest,
142
189
  ): Promise<StreamResponse<QueryCampaignsResponse>> {
@@ -165,6 +212,22 @@ export class ChatApi {
165
212
  return { ...response.body, metadata: response.metadata };
166
213
  }
167
214
 
215
+ async deleteCampaign(request: {
216
+ id: string;
217
+ }): Promise<StreamResponse<DeleteCampaignResponse>> {
218
+ const pathParams = {
219
+ id: request?.id,
220
+ };
221
+
222
+ const response = await this.apiClient.sendRequest<
223
+ StreamResponse<DeleteCampaignResponse>
224
+ >('DELETE', '/api/v2/chat/campaigns/{id}', pathParams, undefined);
225
+
226
+ decoders.DeleteCampaignResponse?.(response.body);
227
+
228
+ return { ...response.body, metadata: response.metadata };
229
+ }
230
+
168
231
  async getCampaign(request: {
169
232
  id: string;
170
233
  prev?: string;
@@ -189,6 +252,45 @@ export class ChatApi {
189
252
  return { ...response.body, metadata: response.metadata };
190
253
  }
191
254
 
255
+ async updateCampaign(
256
+ request: UpdateCampaignRequest & { id: string },
257
+ ): Promise<StreamResponse<CampaignResponse>> {
258
+ const pathParams = {
259
+ id: request?.id,
260
+ };
261
+ const body = {
262
+ sender_id: request?.sender_id,
263
+ message_template: request?.message_template,
264
+ create_channels: request?.create_channels,
265
+ description: request?.description,
266
+ id: request?.id,
267
+ name: request?.name,
268
+ sender_mode: request?.sender_mode,
269
+ sender_visibility: request?.sender_visibility,
270
+ show_channels: request?.show_channels,
271
+ skip_push: request?.skip_push,
272
+ skip_webhook: request?.skip_webhook,
273
+ segment_ids: request?.segment_ids,
274
+ user_ids: request?.user_ids,
275
+ channel_template: request?.channel_template,
276
+ };
277
+
278
+ const response = await this.apiClient.sendRequest<
279
+ StreamResponse<CampaignResponse>
280
+ >(
281
+ 'PUT',
282
+ '/api/v2/chat/campaigns/{id}',
283
+ pathParams,
284
+ undefined,
285
+ body,
286
+ 'application/json',
287
+ );
288
+
289
+ decoders.CampaignResponse?.(response.body);
290
+
291
+ return { ...response.body, metadata: response.metadata };
292
+ }
293
+
192
294
  async startCampaign(
193
295
  request: StartCampaignRequest & { id: string },
194
296
  ): Promise<StreamResponse<StartCampaignResponse>> {
@@ -251,6 +353,7 @@ export class ChatApi {
251
353
  predefined_filter: request?.predefined_filter,
252
354
  state: request?.state,
253
355
  user_id: request?.user_id,
356
+ member_custom_include: request?.member_custom_include,
254
357
  sort: request?.sort,
255
358
  filter_conditions: request?.filter_conditions,
256
359
  filter_values: request?.filter_values,
@@ -350,6 +453,32 @@ export class ChatApi {
350
453
  return { ...response.body, metadata: response.metadata };
351
454
  }
352
455
 
456
+ async groupedQueryChannels(
457
+ request?: GroupedQueryChannelsRequest,
458
+ ): Promise<StreamResponse<GroupedQueryChannelsResponse>> {
459
+ const body = {
460
+ limit: request?.limit,
461
+ user_id: request?.user_id,
462
+ groups: request?.groups,
463
+ user: request?.user,
464
+ };
465
+
466
+ const response = await this.apiClient.sendRequest<
467
+ StreamResponse<GroupedQueryChannelsResponse>
468
+ >(
469
+ 'POST',
470
+ '/api/v2/chat/channels/grouped',
471
+ undefined,
472
+ undefined,
473
+ body,
474
+ 'application/json',
475
+ );
476
+
477
+ decoders.GroupedQueryChannelsResponse?.(response.body);
478
+
479
+ return { ...response.body, metadata: response.metadata };
480
+ }
481
+
353
482
  async markChannelsRead(
354
483
  request?: MarkChannelsReadRequest,
355
484
  ): Promise<StreamResponse<MarkReadResponse>> {
@@ -385,6 +514,7 @@ export class ChatApi {
385
514
  hide_for_creator: request?.hide_for_creator,
386
515
  state: request?.state,
387
516
  thread_unread_counts: request?.thread_unread_counts,
517
+ member_custom_include: request?.member_custom_include,
388
518
  data: request?.data,
389
519
  members: request?.members,
390
520
  messages: request?.messages,
@@ -429,6 +559,44 @@ export class ChatApi {
429
559
  return { ...response.body, metadata: response.metadata };
430
560
  }
431
561
 
562
+ async getChannel(request: {
563
+ type: string;
564
+ id: string;
565
+ state?: boolean;
566
+ messages_limit?: number;
567
+ members_limit?: number;
568
+ watchers_limit?: number;
569
+ messages_id_lt?: string;
570
+ messages_id_lte?: string;
571
+ messages_id_gt?: string;
572
+ messages_id_gte?: string;
573
+ messages_id_around?: string;
574
+ }): Promise<StreamResponse<ChannelStateResponse>> {
575
+ const queryParams = {
576
+ state: request?.state,
577
+ messages_limit: request?.messages_limit,
578
+ members_limit: request?.members_limit,
579
+ watchers_limit: request?.watchers_limit,
580
+ messages_id_lt: request?.messages_id_lt,
581
+ messages_id_lte: request?.messages_id_lte,
582
+ messages_id_gt: request?.messages_id_gt,
583
+ messages_id_gte: request?.messages_id_gte,
584
+ messages_id_around: request?.messages_id_around,
585
+ };
586
+ const pathParams = {
587
+ type: request?.type,
588
+ id: request?.id,
589
+ };
590
+
591
+ const response = await this.apiClient.sendRequest<
592
+ StreamResponse<ChannelStateResponse>
593
+ >('GET', '/api/v2/chat/channels/{type}/{id}', pathParams, queryParams);
594
+
595
+ decoders.ChannelStateResponse?.(response.body);
596
+
597
+ return { ...response.body, metadata: response.metadata };
598
+ }
599
+
432
600
  async updateChannelPartial(
433
601
  request: UpdateChannelPartialRequest & { type: string; id: string },
434
602
  ): Promise<StreamResponse<UpdateChannelPartialResponse>> {
@@ -767,6 +935,8 @@ export class ChatApi {
767
935
  const body = {
768
936
  message: request?.message,
769
937
  force_moderation: request?.force_moderation,
938
+ include_channel_context: request?.include_channel_context,
939
+ include_mentioned_members: request?.include_mentioned_members,
770
940
  keep_channel_hidden: request?.keep_channel_hidden,
771
941
  pending: request?.pending,
772
942
  skip_enrich_url: request?.skip_enrich_url,
@@ -794,9 +964,11 @@ export class ChatApi {
794
964
  type: string;
795
965
  id: string;
796
966
  ids: string[];
967
+ member_custom_include?: string[];
797
968
  }): Promise<StreamResponse<GetManyMessagesResponse>> {
798
969
  const queryParams = {
799
970
  ids: request?.ids,
971
+ member_custom_include: request?.member_custom_include,
800
972
  };
801
973
  const pathParams = {
802
974
  type: request?.type,
@@ -828,6 +1000,7 @@ export class ChatApi {
828
1000
  hide_for_creator: request?.hide_for_creator,
829
1001
  state: request?.state,
830
1002
  thread_unread_counts: request?.thread_unread_counts,
1003
+ member_custom_include: request?.member_custom_include,
831
1004
  data: request?.data,
832
1005
  members: request?.members,
833
1006
  messages: request?.messages,
@@ -1264,9 +1437,11 @@ export class ChatApi {
1264
1437
  channels: request?.channels,
1265
1438
  clear_deleted_message_text: request?.clear_deleted_message_text,
1266
1439
  export_users: request?.export_users,
1440
+ format: request?.format,
1267
1441
  include_soft_deleted_channels: request?.include_soft_deleted_channels,
1268
1442
  include_truncated_messages: request?.include_truncated_messages,
1269
1443
  version: request?.version,
1444
+ include_fields: request?.include_fields,
1270
1445
  };
1271
1446
 
1272
1447
  const response = await this.apiClient.sendRequest<
@@ -1823,6 +1998,7 @@ export class ChatApi {
1823
1998
  id_lt?: string;
1824
1999
  id_around?: string;
1825
2000
  sort?: SortParamRequest[];
2001
+ member_custom_include?: string[];
1826
2002
  }): Promise<StreamResponse<GetRepliesResponse>> {
1827
2003
  const queryParams = {
1828
2004
  limit: request?.limit,
@@ -1832,6 +2008,7 @@ export class ChatApi {
1832
2008
  id_lt: request?.id_lt,
1833
2009
  id_around: request?.id_around,
1834
2010
  sort: request?.sort,
2011
+ member_custom_include: request?.member_custom_include,
1835
2012
  };
1836
2013
  const pathParams = {
1837
2014
  parent_id: request?.parent_id,
@@ -2082,6 +2259,35 @@ export class ChatApi {
2082
2259
  return { ...response.body, metadata: response.metadata };
2083
2260
  }
2084
2261
 
2262
+ async createSegment(
2263
+ request: CreateSegmentRequest,
2264
+ ): Promise<StreamResponse<CreateSegmentResponse>> {
2265
+ const body = {
2266
+ type: request?.type,
2267
+ all_sender_channels: request?.all_sender_channels,
2268
+ all_users: request?.all_users,
2269
+ description: request?.description,
2270
+ id: request?.id,
2271
+ name: request?.name,
2272
+ filter: request?.filter,
2273
+ };
2274
+
2275
+ const response = await this.apiClient.sendRequest<
2276
+ StreamResponse<CreateSegmentResponse>
2277
+ >(
2278
+ 'POST',
2279
+ '/api/v2/chat/segments',
2280
+ undefined,
2281
+ undefined,
2282
+ body,
2283
+ 'application/json',
2284
+ );
2285
+
2286
+ decoders.CreateSegmentResponse?.(response.body);
2287
+
2288
+ return { ...response.body, metadata: response.metadata };
2289
+ }
2290
+
2085
2291
  async querySegments(
2086
2292
  request: QuerySegmentsRequest,
2087
2293
  ): Promise<StreamResponse<QuerySegmentsResponse>> {
@@ -2144,6 +2350,58 @@ export class ChatApi {
2144
2350
  return { ...response.body, metadata: response.metadata };
2145
2351
  }
2146
2352
 
2353
+ async updateSegment(
2354
+ request: UpdateSegmentRequest & { id: string },
2355
+ ): Promise<StreamResponse<UpdateSegmentResponse>> {
2356
+ const pathParams = {
2357
+ id: request?.id,
2358
+ };
2359
+ const body = {
2360
+ description: request?.description,
2361
+ name: request?.name,
2362
+ filter: request?.filter,
2363
+ };
2364
+
2365
+ const response = await this.apiClient.sendRequest<
2366
+ StreamResponse<UpdateSegmentResponse>
2367
+ >(
2368
+ 'PUT',
2369
+ '/api/v2/chat/segments/{id}',
2370
+ pathParams,
2371
+ undefined,
2372
+ body,
2373
+ 'application/json',
2374
+ );
2375
+
2376
+ decoders.UpdateSegmentResponse?.(response.body);
2377
+
2378
+ return { ...response.body, metadata: response.metadata };
2379
+ }
2380
+
2381
+ async addSegmentTargets(
2382
+ request: AddSegmentTargetsRequest & { id: string },
2383
+ ): Promise<StreamResponse<Response>> {
2384
+ const pathParams = {
2385
+ id: request?.id,
2386
+ };
2387
+ const body = {
2388
+ target_ids: request?.target_ids,
2389
+ };
2390
+
2391
+ const response = await this.apiClient.sendRequest<StreamResponse<Response>>(
2392
+ 'POST',
2393
+ '/api/v2/chat/segments/{id}/addtargets',
2394
+ pathParams,
2395
+ undefined,
2396
+ body,
2397
+ 'application/json',
2398
+ );
2399
+
2400
+ decoders.Response?.(response.body);
2401
+
2402
+ return { ...response.body, metadata: response.metadata };
2403
+ }
2404
+
2147
2405
  async deleteSegmentTargets(
2148
2406
  request: DeleteSegmentTargetsRequest & { id: string },
2149
2407
  ): Promise<StreamResponse<Response>> {