stream-chat 6.4.0 → 6.6.0

package/src/types.ts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { EVENT_MAP } from './events';
 import { Role } from './permissions';
 
@@ -119,6 +119,7 @@ export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics
     permission_version?: string;
     policies?: Record<string, Policy[]>;
     push_notifications?: {
+      offline_only: boolean;
       version: string;
       apn?: APNConfig;
       firebase?: FirebaseConfig;
@@ -1454,6 +1455,7 @@ export type AppSettings = {
   // all possible file mime types are https://www.iana.org/assignments/media-types/media-types.xhtml
   file_upload_config?: FileUploadConfig;
   firebase_config?: {
+    apn_template?: string;
     credentials_json?: string;
     data_template?: string;
     notification_template?: string;
@@ -1466,8 +1468,11 @@ export type AppSettings = {
   };
   image_moderation_enabled?: boolean;
   image_upload_config?: FileUploadConfig;
+  migrate_permissions_to_v2?: boolean;
   multi_tenant_enabled?: boolean;
+  permission_version?: 'v1' | 'v2';
   push_config?: {
+    offline_only?: boolean;
     version?: string;
   };
   reminders_interval?: number;
@@ -1654,6 +1659,7 @@ export type PushProviderAPN = {
 };
 
 export type PushProviderFirebase = {
+  firebase_apn_template?: string;
   firebase_credentials?: string;
   firebase_data_template?: string;
   firebase_notification_template?: string;
@@ -1718,16 +1724,19 @@ export type DeviceFields = BaseDeviceFields & {
 
 export type EndpointName =
   | 'Connect'
+  | 'LongPoll'
   | 'DeleteFile'
   | 'DeleteImage'
   | 'DeleteMessage'
   | 'DeleteUser'
+  | 'DeleteUsers'
   | 'DeactivateUser'
   | 'ExportUser'
   | 'DeleteReaction'
   | 'UpdateChannel'
   | 'UpdateChannelPartial'
   | 'UpdateMessage'
+  | 'UpdateMessagePartial'
   | 'GetMessage'
   | 'GetManyMessages'
   | 'UpdateUsers'
@@ -1740,18 +1749,22 @@ export type EndpointName =
   | 'QueryUsers'
   | 'QueryMembers'
   | 'QueryBannedUsers'
+  | 'QueryFlags'
+  | 'QueryMessageFlags'
   | 'GetReactions'
   | 'GetReplies'
+  | 'GetPinnedMessages'
   | 'Ban'
   | 'Unban'
-  | 'Mute'
+  | 'MuteUser'
   | 'MuteChannel'
   | 'UnmuteChannel'
   | 'UnmuteUser'
   | 'RunMessageAction'
   | 'SendEvent'
+  | 'SendUserCustomEvent'
   | 'MarkRead'
-  | 'MarkAllRead'
+  | 'MarkChannelsRead'
   | 'SendMessage'
   | 'ImportChannelMessages'
   | 'UploadFile'
@@ -1763,8 +1776,12 @@ export type EndpointName =
   | 'SendReaction'
   | 'Flag'
   | 'Unflag'
+  | 'Unblock'
+  | 'QueryFlagReports'
+  | 'FlagReportReview'
   | 'CreateChannelType'
   | 'DeleteChannel'
+  | 'DeleteChannels'
   | 'DeleteChannelType'
   | 'GetChannelType'
   | 'ListChannelTypes'
@@ -1784,6 +1801,7 @@ export type EndpointName =
   | 'CreateRole'
   | 'DeleteRole'
   | 'ListRoles'
+  | 'ListCustomRoles'
   | 'Sync'
   | 'TranslateMessage'
   | 'CreateCommand'
@@ -1800,7 +1818,30 @@ export type EndpointName =
   | 'GetExportChannelsStatus'
   | 'CheckSQS'
   | 'GetRateLimits'
-  | 'MessageUpdatePartial';
+  | 'CreateSegment'
+  | 'GetSegment'
+  | 'ListSegments'
+  | 'UpdateSegment'
+  | 'DeleteSegment'
+  | 'CreateCampaign'
+  | 'GetCampaign'
+  | 'ListCampaigns'
+  | 'UpdateCampaign'
+  | 'DeleteCampaign'
+  | 'ScheduleCampaign'
+  | 'StopCampaign'
+  | 'ResumeCampaign'
+  | 'TestCampaign'
+  | 'GetOG'
+  | 'GetTask'
+  | 'ExportUsers'
+  | 'CreateImport'
+  | 'CreateImportURL'
+  | 'GetImport'
+  | 'ListImports'
+  | 'UpsertPushProvider'
+  | 'DeletePushProvider'
+  | 'ListPushProviders';
 
 export type ExportChannelRequest = {
   id: string;
@@ -1835,6 +1876,7 @@ export type FileUploadConfig = {
 };
 
 export type FirebaseConfig = {
+  apn_template?: string;
   credentials_json?: string;
   data_template?: string;
   enabled?: boolean;
@@ -2201,6 +2243,11 @@ export type Campaign = {
 } & CampaignData &
   CampaignStatus;
 
+export type TestCampaignResponse = {
+  campaign?: Campaign;
+  invalid_users?: Record<string, string>;
+};
+
 export type TaskStatus = {
   created_at: string;
   status: string;
@@ -2274,3 +2321,23 @@ export type PushProviderUpsertResponse = {
 export type PushProviderListResponse = {
   push_providers: PushProvider[];
 };
+
+type ErrorResponseDetails = {
+  code: number;
+  messages: string[];
+};
+
+export type APIErrorResponse = {
+  code: number;
+  duration: string;
+  message: string;
+  more_info: string;
+  StatusCode: number;
+  details?: ErrorResponseDetails;
+};
+
+export class ErrorFromResponse<T> extends Error {
+  code?: number;
+  response?: AxiosResponse<T>;
+  status?: number;
+}