import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'; import { Channel } from './channel'; import { ClientState } from './client_state'; import { StableWSConnection } from './connection'; import { UploadManager } from './uploadManager'; import { TokenManager } from './token_manager'; import { WSConnectionFallback } from './connection_fallback'; import { Campaign } from './campaign'; import { ChannelBatchUpdater } from './channel_batch_updater'; import { Segment } from './segment'; import type { ActiveLiveLocationsAPIResponse, APIErrorResponse, APIResponse, AppSettings, AppSettingsAPIResponse, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BaseDeviceFields, BlockList, BlockListResponse, BlockUserAPIResponse, CampaignData, CampaignFilters, CampaignQueryOptions, CampaignResponse, CampaignSort, CastVoteAPIResponse, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelResponse, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSNSResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CreateImportOptions, CreateImportResponse, CreateImportURLResponse, CreatePollAPIResponse, CreatePollData, CreatePollOptionAPIResponse, CreatePredefinedFilterOptions, CreateReminderOptions, CustomPermissionOptions, DeactivateUsersOptions, DeleteCommandResponse, DeleteMessageOptions, DeleteUserOptions, Device, DeviceIdentifier, DraftFilters, DraftSort, EndpointName, Event, EventAPIResponse, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, ExportUsersRequest, ExportUsersResponse, FlagMessageResponse, FlagReportsFilters, FlagReportsPaginationOptions, FlagReportsResponse, FlagsFilters, FlagsPaginationOptions, FlagsResponse, FlagUserResponse, FutureChannelBansResponse, GetBlockedUsersAPIResponse, GetCampaignOptions, GetChannelTypeResponse, GetCommandResponse, GetHookEventsResponse, GetImportResponse, GetMessageOptions, GetPollAPIResponse, GetRateLimitsResponse, GetRetentionPolicyResponse, GetRetentionPolicyRunsOptions, GetRetentionPolicyRunsResponse, GetThreadAPIResponse, GetThreadOptions, GetUnreadCountAPIResponse, GetUnreadCountBatchAPIResponse, ListChannelResponse, ListCommandsResponse, ListImportsPaginationOptions, ListImportsResponse, ListPredefinedFiltersOptions, ListPredefinedFiltersResponse, LocalMessage, Logger, MarkChannelsReadOptions, MarkDeliveredOptions, MessageFilters, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OGAttachment, OwnUserResponse, Pager, PartialMessageUpdate, PartialPollUpdate, PartialThreadUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PollAnswersAPIResponse, PollData, PollOptionData, PollSort, PollVote, PollVoteData, PollVotesAPIResponse, PredefinedFilterResponse, Product, PushPreference, PushProvider, PushProviderConfig, PushProviderID, PushProviderListResponse, PushProviderUpsertResponse, QueryChannelsAPIResponse, QueryDraftsResponse, QueryFutureChannelBansOptions, QueryMessageHistoryFilters, QueryMessageHistoryOptions, QueryMessageHistoryResponse, QueryMessageHistorySort, QueryPollsFilters, QueryPollsOptions, QueryPollsResponse, QueryReactionsAPIResponse, QueryReactionsOptions, QueryRemindersOptions, QueryRemindersResponse, QuerySegmentsOptions, QuerySegmentTargetsFilter, QueryTeamUsageStatsOptions, QueryTeamUsageStatsResponse, QueryThreadsOptions, QueryVotesFilters, QueryVotesOptions, ReactionFilters, ReactionResponse, ReactionSort, ReactivateUserOptions, ReactivateUsersOptions, ReminderAPIResponse, ReviewFlagReportOptions, ReviewFlagReportResponse, SdkIdentifier, SearchAPIResponse, SearchOptions, SegmentData, SegmentResponse, SegmentTargetsResponse, SegmentType, SendFileAPIResponse, SetRetentionPolicyResponse, SharedLocationResponse, SortParam, StreamChatOptions, SyncOptions, SyncResponse, TaskResponse, TaskStatus, TestPushDataInput, TestSNSDataInput, TestSQSDataInput, TokenOrProvider, TranslateResponse, UnBanUserOptions, UpdateChannelsBatchOptions, UpdateChannelTypeRequest, UpdateChannelTypeResponse, UpdateCommandOptions, UpdateCommandResponse, UpdateLocationPayload, UpdateMessageAPIResponse, UpdateMessageOptions, UpdatePollAPIResponse, UpdatePredefinedFilterOptions, UpdateReminderOptions, UpdateSegmentData, UpdateUsersAPIResponse, UpsertPushPreferencesResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort, VoteSort } from './types'; import { ErrorFromResponse } from './types'; import { InsightMetrics } from './insights'; import { Thread } from './thread'; import { Moderation } from './moderation'; import { ThreadManager } from './thread_manager'; import { PollManager } from './poll_manager'; import type { ChannelManagerEventHandlerOverrides, ChannelManagerOptions, QueryChannelsRequestType } from './channel_manager'; import { ChannelManager } from './channel_manager'; import { MessageDeliveryReporter } from './messageDelivery'; import { NotificationManager } from './notifications'; import { ReminderManager } from './reminders'; import { StateStore } from './store'; import type { MessageComposer } from './messageComposer'; import type { AbstractOfflineDB } from './offline-support'; type MessageComposerTearDownFunction = () => void; export type QueryChannelsResponseWithChannels = Omit & { channels: Channel[]; }; type MessageComposerSetupFunction = ({ composer, }: { composer: MessageComposer; }) => void | MessageComposerTearDownFunction; export type BlockedUsersState = { userIds: string[]; }; export type MessageComposerSetupState = { /** * Each `MessageComposer` runs this function each time its signature changes or * whenever you run `MessageComposer.registerSubscriptions`. Function returned * from `applyModifications` will be used as a cleanup function - it will be stored * and ran before new modification is applied. Cleaning up only the * modified parts is the general way to go but if your setup gets a bit * complicated, feel free to restore the whole composer with `MessageComposer.restore`. */ setupFunction: MessageComposerSetupFunction | null; }; export declare class StreamChat { private static _instance?; messageDeliveryReporter: MessageDeliveryReporter; /** * @internal */ uploadManager: UploadManager; _user?: OwnUserResponse | UserResponse; appSettingsPromise?: Promise; activeChannels: { [key: string]: Channel; }; threads: ThreadManager; polls: PollManager; offlineDb?: AbstractOfflineDB; notifications: NotificationManager; reminders: ReminderManager; anonymous: boolean; persistUserOnConnectionFailure?: boolean; axiosInstance: AxiosInstance; baseURL?: string; browser: boolean; cleaningIntervalRef?: NodeJS.Timeout; clientID?: string; configs: Configs; key: string; listeners: Record void>>; logger: Logger; /** * When network is recovered, we re-query the active channels on client. But in single query, you can recover * only 30 channels. So its not guaranteed that all the channels in activeChannels object have updated state. * Thus in UI sdks, state recovery is managed by components themselves, they don't rely on js client for this. * * `recoverStateOnReconnect` parameter can be used in such cases, to disable state recovery within js client. * When false, user/consumer of this client will need to make sure all the channels present on UI by * manually calling queryChannels endpoint. */ recoverStateOnReconnect?: boolean; /** * If true, we will not clean up threads when channel state is in initializing state. * The main use case for SDKs who do independent state recovery for channels. */ preventThreadCleanup: boolean; moderation: Moderation; mutedChannels: ChannelMute[]; mutedUsers: Mute[]; blockedUsers: StateStore; node: boolean; options: StreamChatOptions; secret?: string; setUserPromise: ConnectAPIResponse | null; state: ClientState; tokenManager: TokenManager; user?: OwnUserResponse | UserResponse; userAgent?: string; userID?: string; wsBaseURL?: string; wsConnection: StableWSConnection | null; wsFallback?: WSConnectionFallback; wsPromise: ConnectAPIResponse | null; consecutiveFailures: number; insightMetrics: InsightMetrics; defaultWSTimeoutWithFallback: number; defaultWSTimeout: number; sdkIdentifier?: SdkIdentifier; deviceIdentifier?: DeviceIdentifier; private nextRequestAbortController; /** * @private */ _messageComposerSetupState: StateStore; /** * Initialize a client * * **Only use constructor for advanced usages. It is strongly advised to use `StreamChat.getInstance()` instead of `new StreamChat()` to reduce integration issues due to multiple WebSocket connections** * @param {string} key - the api key * @param {string} [secret] - the api secret * @param {StreamChatOptions} [options] - additional options, here you can pass custom options to axios instance * @param {boolean} [options.browser] - enforce the client to be in browser mode * @param {boolean} [options.warmUp] - default to false, if true, client will open a connection as soon as possible to speed up following requests * @param {Logger} [options.Logger] - custom logger * @param {number} [options.timeout] - default to 3000 * @param {httpsAgent} [options.httpsAgent] - custom httpsAgent, in node it's default to https.agent() * @example initialize the client in user mode * new StreamChat('api_key') * @example initialize the client in user mode with options * new StreamChat('api_key', { warmUp:true, timeout:5000 }) * @example secret is optional and only used in server side mode * new StreamChat('api_key', "secret", { httpsAgent: customAgent }) */ constructor(key: string, options?: StreamChatOptions); constructor(key: string, secret?: string, options?: StreamChatOptions); /** * Get a client instance * * This function always returns the same Client instance to avoid issues raised by multiple Client and WS connections * * **After the first call, the client configuration will not change if the key or options parameters change** * * @param {string} key - the api key * @param {string} [secret] - the api secret * @param {StreamChatOptions} [options] - additional options, here you can pass custom options to axios instance * @param {boolean} [options.browser] - enforce the client to be in browser mode * @param {boolean} [options.warmUp] - default to false, if true, client will open a connection as soon as possible to speed up following requests * @param {Logger} [options.Logger] - custom logger * @param {number} [options.timeout] - default to 3000 * @param {httpsAgent} [options.httpsAgent] - custom httpsAgent, in node it's default to https.agent() * @example initialize the client in user mode * StreamChat.getInstance('api_key') * @example initialize the client in user mode with options * StreamChat.getInstance('api_key', { timeout:5000 }) * @example secret is optional and only used in server side mode * StreamChat.getInstance('api_key', "secret", { httpsAgent: customAgent }) */ static getInstance(key: string, options?: StreamChatOptions): StreamChat; static getInstance(key: string, secret?: string, options?: StreamChatOptions): StreamChat; setOfflineDBApi(offlineDBInstance: AbstractOfflineDB): void; devToken(userID: string): string; getAuthType(): "anonymous" | "jwt"; setBaseURL(baseURL: string): void; _getConnectionID: () => string | undefined; _hasConnectionID: () => boolean; setMessageComposerSetupFunction: (setupFunction: MessageComposerSetupState["setupFunction"]) => void; /** * connectUser - Set the current user and open a WebSocket connection * * @param {OwnUserResponse | UserResponse} user Data about this user. IE {name: "john"} * @param {TokenOrProvider} userTokenOrProvider Token or provider * * @return {ConnectAPIResponse} Returns a promise that resolves when the connection is setup */ connectUser: (user: OwnUserResponse | UserResponse, userTokenOrProvider: TokenOrProvider) => Promise; /** * @deprecated Please use connectUser() function instead. Its naming is more consistent with its functionality. * * setUser - Set the current user and open a WebSocket connection * * @param {OwnUserResponse | UserResponse} user Data about this user. IE {name: "john"} * @param {TokenOrProvider} userTokenOrProvider Token or provider * * @return {ConnectAPIResponse} Returns a promise that resolves when the connection is setup */ setUser: (user: OwnUserResponse | UserResponse, userTokenOrProvider: TokenOrProvider) => Promise; _setToken: (user: UserResponse, userTokenOrProvider: TokenOrProvider) => Promise; _setUser(user: OwnUserResponse | UserResponse): void; /** * Disconnects the websocket connection, without removing the user set on client. * client.closeConnection will not trigger default auto-retry mechanism for reconnection. You need * to call client.openConnection to reconnect to websocket. * * This is mainly useful on mobile side. You can only receive push notifications * if you don't have active websocket connection. * So when your app goes to background, you can call `client.closeConnection`. * And when app comes back to foreground, call `client.openConnection`. * * @param timeout Max number of ms, to wait for close event of websocket, before forcefully assuming succesful disconnection. * https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent */ closeConnection: (timeout?: number) => Promise; /** * Creates an instance of ChannelManager. * * @internal * * @param eventHandlerOverrides - the overrides for event handlers to be used * @param options - the options used for the channel manager */ createChannelManager: ({ eventHandlerOverrides, options, queryChannelsOverride, }: { eventHandlerOverrides?: ChannelManagerEventHandlerOverrides; options?: ChannelManagerOptions; queryChannelsOverride?: QueryChannelsRequestType; }) => ChannelManager; /** * Creates a new WebSocket connection with the current user. Returns empty promise, if there is an active connection */ openConnection: () => ConnectAPIResponse | undefined; /** * @deprecated Please use client.openConnction instead. * @private * * Creates a new websocket connection with current user. */ _setupConnection: () => ConnectAPIResponse | undefined; /** * updateAppSettings - updates application settings * * @param {AppSettings} options App settings. * IE: { 'apn_config': { 'auth_type': 'token', 'auth_key": fs.readFileSync( './apn-push-auth-key.p8', 'utf-8', ), 'key_id': 'keyid', 'team_id': 'teamid', 'notification_template": 'notification handlebars template', 'bundle_id': 'com.apple.your.app', 'development': true }, 'firebase_config': { 'server_key': 'server key from fcm', 'notification_template': 'notification handlebars template', 'data_template': 'data handlebars template', 'apn_template': 'apn notification handlebars template under v2' }, 'webhook_url': 'https://acme.com/my/awesome/webhook/', 'event_hooks': [ { 'hook_type': 'webhook', 'enabled': true, 'event_types': ['message.new'], 'webhook_url': 'https://acme.com/my/awesome/webhook/' }, { 'hook_type': 'sqs', 'enabled': true, 'event_types': ['message.new'], 'sqs_url': 'https://sqs.us-east-1.amazonaws.com/1234567890/my-queue', 'sqs_auth_type': 'key', 'sqs_key': 'my-access-key', 'sqs_secret': 'my-secret-key' } ] } */ updateAppSettings(options: AppSettings): Promise; _normalizeDate: (before: Date | string | null) => string | null; /** * Revokes all tokens on application level issued before given time */ revokeTokens(before: Date | string | null): Promise; /** * Revokes token for a user issued before given time */ revokeUserToken(userID: string, before?: Date | string | null): Promise; /** * Revokes tokens for a list of users issued before given time */ revokeUsersToken(userIDs: string[], before?: Date | string | null): Promise; /** * getAppSettings - retrieves application settings */ getAppSettings(): Promise; /** * testPushSettings - Tests the push settings for a user with a random chat message and the configured push templates * * @param {string} userID User ID. If user has no devices, it will error * @param {TestPushDataInput} [data] Overrides for push templates/message used * IE: { messageID: 'id-of-message', // will error if message does not exist apnTemplate: '{}', // if app doesn't have apn configured it will error firebaseTemplate: '{}', // if app doesn't have firebase configured it will error firebaseDataTemplate: '{}', // if app doesn't have firebase configured it will error skipDevices: true, // skip config/device checks and sending to real devices pushProviderName: 'staging' // one of your configured push providers pushProviderType: 'apn' // one of supported provider types } */ testPushSettings(userID: string, data?: TestPushDataInput): Promise; /** * testSQSSettings - Tests that the given or configured SQS configuration is valid * * @param {TestSQSDataInput} [data] Overrides SQS settings for testing if needed * IE: { sqs_key: 'auth_key', sqs_secret: 'auth_secret', sqs_url: 'url_to_queue', } */ testSQSSettings(data?: TestSQSDataInput): Promise; /** * testSNSSettings - Tests that the given or configured SNS configuration is valid * * @param {TestSNSDataInput} [data] Overrides SNS settings for testing if needed * IE: { sns_key: 'auth_key', sns_secret: 'auth_secret', sns_topic_arn: 'topic_to_publish_to', } */ testSNSSettings(data?: TestSNSDataInput): Promise; /** * Disconnects the websocket and removes the user from client. * * @param timeout Max number of ms, to wait for close event of websocket, before forcefully assuming successful disconnection. * https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent */ disconnectUser: (timeout?: number) => Promise; /** * * @deprecated Please use client.disconnectUser instead. * * Disconnects the websocket and removes the user from client. */ disconnect: (timeout?: number) => Promise; /** * connectAnonymousUser - Set an anonymous user and open a WebSocket connection */ connectAnonymousUser: () => ConnectAPIResponse | undefined; /** * @deprecated Please use connectAnonymousUser. Its naming is more consistent with its functionality. */ setAnonymousUser: () => ConnectAPIResponse | undefined; /** * setGuestUser - Setup a temporary guest user * * @param {UserResponse} user Data about this user. IE {name: "john"} * * @return {ConnectAPIResponse} Returns a promise that resolves when the connection is setup */ setGuestUser(user: UserResponse): Promise; /** * createToken - Creates a token to authenticate this user. This function is used server side. * The resulting token should be passed to the client side when the users registers or logs in. * * @param {string} userID The User ID * @param {number} [exp] The expiration time for the token expressed in the number of seconds since the epoch * * @return {string} Returns a token */ createToken(userID: string, exp?: number, iat?: number): string; /** * on - Listen to events on all channels and users your watching * * client.on('message.new', event => {console.log("my new message", event, channel.state.messages)}) * or * client.on(event => {console.log(event.type)}) * * @param {EventHandler | string} callbackOrString The event type to listen for (optional) * @param {EventHandler} [callbackOrNothing] The callback to call * * @return {{ unsubscribe: () => void }} Description */ on(callback: EventHandler): { unsubscribe: () => void; }; on(eventType: string, callback: EventHandler): { unsubscribe: () => void; }; /** * off - Remove the event handler * */ off(callback: EventHandler): void; off(eventType: string, callback: EventHandler): void; _logApiRequest(type: string, url: string, data: unknown, config: AxiosRequestConfig & { config?: AxiosRequestConfig & { maxBodyLength?: number; }; }): void; _logApiResponse(type: string, url: string, response: AxiosResponse): void; _logApiError(type: string, url: string, error: unknown): void; doAxiosRequest: (type: string, url: string, data?: unknown, options?: AxiosRequestConfig & { config?: AxiosRequestConfig & { maxBodyLength?: number; }; }) => Promise; get(url: string, params?: AxiosRequestConfig['params']): Promise; put(url: string, data?: unknown): Promise; post(url: string, data?: unknown): Promise; patch(url: string, data?: unknown): Promise; delete(url: string, params?: AxiosRequestConfig['params']): Promise; sendFile(url: string, uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse, axiosRequestConfig?: AxiosRequestConfig): Promise; errorFromResponse(response: AxiosResponse): ErrorFromResponse; handleResponse(response: AxiosResponse): T; dispatchEvent: (event: Event) => void; /** * Updates the members, watchers and read references of the currently active channels that contain this user * * @param {UserResponse} user */ _updateMemberWatcherReferences: (user: UserResponse) => void; /** * @deprecated Please _updateMemberWatcherReferences instead. * @private */ _updateUserReferences: (user: UserResponse) => void; /** * @private * * Updates the messages from the currently active channels that contain this user, * with updated user object. * * @param {UserResponse} user */ _updateUserMessageReferences: (user: UserResponse) => void; /** * @private * * Deletes the messages from the currently active channels that contain this user * * If hardDelete is true, all the content of message will be stripped down. * Otherwise, only 'message.type' will be set as 'deleted'. * * @param {UserResponse} user * @param {boolean} hardDelete */ _deleteUserMessageReference: (user: UserResponse, hardDelete?: boolean, deletedAt?: LocalMessage["deleted_at"]) => void; /** * @private * * Handle following user related events: * - user.presence.changed * - user.updated * - user.deleted * * @param {Event} event */ _handleUserEvent: (event: Event) => void; _handleClientEvent(event: Event): (() => void)[]; _muteStatus(cid: string): { muted: boolean; createdAt: Date; expiresAt: Date | null; } | { muted: boolean; createdAt: null; expiresAt: null; }; _callClientListeners: (event: Event) => void; recoverState: () => Promise; /** * @private */ connect(): Promise; /** * Check the connectivity with server for warmup purpose. * * @private */ _sayHi(): void; /** * queryUsers - Query users and watch user presence * * @param {UserFilters} filterConditions MongoDB style filter conditions * @param {UserSort} sort Sort options, for instance [{last_active: -1}]. * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_active: -1}, {created_at: 1}] * @param {UserOptions} options Option object, {presence: true} * * @return {Promise<{ users: Array }>} User Query Response */ queryUsers(filterConditions: UserFilters, sort?: UserSort, options?: UserOptions): Promise; }>; /** * queryBannedUsers - Query user bans * * @param {BannedUsersFilters} filterConditions MongoDB style filter conditions * @param {BannedUsersSort} sort Sort options [{created_at: 1}]. * @param {BannedUsersPaginationOptions} options Option object, {limit: 10, offset:0, exclude_expired_bans: true} * * @return {Promise} Ban Query Response */ queryBannedUsers(filterConditions?: BannedUsersFilters, sort?: BannedUsersSort, options?: BannedUsersPaginationOptions): Promise; /** * queryFutureChannelBans - Query future channel bans created by a user * * @param {QueryFutureChannelBansOptions} options Option object with user_id, exclude_expired_bans, limit, offset * @returns {Promise} Future Channel Bans Response */ queryFutureChannelBans(options?: QueryFutureChannelBansOptions): Promise; /** * queryMessageFlags - Query message flags * * @param {MessageFlagsFilters} filterConditions MongoDB style filter conditions * @param {MessageFlagsPaginationOptions} options Option object, {limit: 10, offset:0} * * @return {Promise} Message Flags Response */ queryMessageFlags(filterConditions?: MessageFlagsFilters, options?: MessageFlagsPaginationOptions): Promise; /** * queryChannelsRequestWithResponse - Queries channels and returns the full API response * including top-level metadata such as `predefined_filter`. * * This exists as a compatibility bridge, as changing `queryChannelsRequest()` to return * `QueryChannelsAPIResponse` would be a breaking change because it currently returns * only the channel list. In the next major release, the request/response APIs should * be consolidated so callers can access the full response through the primary API. * * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options. * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}. * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}] * @param {ChannelOptions} [options] Options object. Can include predefined_filter, filter_values, and sort_values for using predefined filters. * * @return {Promise} full search channels response */ queryChannelsRequestWithResponse(filterConditions: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions): Promise; /** * queryChannelsRequest - Queries channels and returns the raw channel response list. * * This preserves the historical return shape for backwards compatibility. Use * `queryChannelsRequestWithResponse()` when response level metadata such as * `predefined_filter` is needed. In the next major release these APIs should be * consolidated into a single full-response API. * * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options. * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}. * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}] * @param {ChannelOptions} [options] Options object. Can include predefined_filter, filter_values, and sort_values for using predefined filters. * * @return {Promise>} search channels response */ queryChannelsRequest(filterConditions: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions): Promise[]>; /** * queryChannels - Query channels * * @param {ChannelFilters} filterConditions object MongoDB style filters * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}. * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}] * @param {ChannelOptions} [options] Options object * @param {ChannelStateOptions} [stateOptions] State options object. These options will only be used for state management and won't be sent in the request. * - stateOptions.skipInitialization - Skips the initialization of the state for the channels matching the ids in the list. * - stateOptions.skipHydration - Skips returning the channels as instances of the Channel class and rather returns the raw query response. * - stateOptions.withResponse - Returns the full query response with hydrated channels. This is a compatibility bridge for internal callers that need response-level metadata while the default return value remains `Channel[]`. * * @return {Promise>} search channels response */ queryChannels(filterConditions: ChannelFilters, sort: ChannelSort, options: ChannelOptions, stateOptions: ChannelStateOptions & { withResponse: true; }): Promise; queryChannels(filterConditions?: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions, stateOptions?: ChannelStateOptions): Promise; /** * queryReactions - Query reactions * * @param {ReactionFilters} filter object MongoDB style filters * @param {ReactionSort} [sort] Sort options, for instance {created_at: -1}. * @param {QueryReactionsOptions} [options] Pagination object * * @return {Promise<{ QueryReactionsAPIResponse } search channels response */ queryReactions(messageID: string, filter: ReactionFilters, sort?: ReactionSort, options?: QueryReactionsOptions): Promise; hydrateActiveChannels(channelsFromApi?: ChannelAPIResponse[], stateOptions?: ChannelStateOptions, queryChannelsOptions?: ChannelOptions): Channel[]; /** * search - Query messages * * @param {ChannelFilters} filterConditions MongoDB style filter conditions * @param {MessageFilters | string} query search query or object MongoDB style filters * @param {SearchOptions} [options] Option object, {user_id: 'tommaso'} * * @return {Promise} search messages response */ search(filterConditions: ChannelFilters, query: string | MessageFilters, options?: SearchOptions): Promise; /** * setLocalDevice - Set the device info for the current client(device) that will be sent via WS connection automatically * * @param {BaseDeviceFields} device the device object * @param {string} device.id device id * @param {string} device.push_provider the push provider * */ setLocalDevice(device: BaseDeviceFields): void; /** * addDevice - Adds a push device for a user. * * @param {string} id the device id * @param {PushProvider} push_provider the push provider * @param {string} [userID] the user id (defaults to current user) * @param {string} [push_provider_name] user provided push provider name for multi bundle support * */ addDevice(id: string, push_provider: PushProvider, userID?: string, push_provider_name?: string): Promise; /** * getDevices - Returns the devices associated with a current user * * @param {string} [userID] User ID. Only works on serverside * * @return {Device[]} Array of devices */ getDevices(userID?: string): Promise; /** * getUnreadCount - Returns unread counts for a single user * * @param {string} [userID] User ID. * * @return {} */ getUnreadCount(userID?: string): Promise; /** * getUnreadCountBatch - Returns unread counts for multiple users at once. Only works server side. * * @param {string[]} [userIDs] List of user IDs to fetch unread counts for. * * @return {} */ getUnreadCountBatch(userIDs: string[]): Promise; /** * setPushPreferences - Applies the list of push preferences. * * @param {PushPreference[]} A list of push preferences. * * @return {} */ setPushPreferences(preferences: PushPreference[]): Promise; /** * removeDevice - Removes the device with the given id. Clientside users can only delete their own devices * * @param {string} id The device id * @param {string} [userID] The user id. Only specify this for serverside requests * */ removeDevice(id: string, userID?: string): Promise; /** * getRateLimits - Returns the rate limits quota and usage for the current app, possibly filter for a specific platform and/or endpoints. * Only available server-side. * * @param {object} [params] The params for the call. If none of the params are set, all limits for all platforms are returned. * @returns {Promise} */ getRateLimits(params?: { android?: boolean; endpoints?: EndpointName[]; ios?: boolean; serverSide?: boolean; web?: boolean; }): Promise; /** * getHookEvents - Get available events for hooks (webhook, SQS, and SNS) * * @param {Product[]} [products] Optional array of products to filter events by (e.g., [Product.Chat, Product.Video]) * @returns {Promise} Response containing available hook events */ getHookEvents(products?: Product[]): Promise; _addChannelConfig({ cid, config }: ChannelResponse): void; /** * channel - Returns a new channel with the given type, id and custom data * * If you want to create a unique conversation between 2 or more users; you can leave out the ID parameter and provide the list of members. * Make sure to await channel.create() or channel.watch() before accessing channel functions: * ie. channel = client.channel("messaging", {members: ["tommaso", "thierry"]}) * await channel.create() to assign an ID to channel * * @param {string} channelType The channel type * @param {string | ChannelData | null} [channelIDOrCustom] The channel ID, you can leave this out if you want to create a conversation channel * @param {object} [custom] Custom data to attach to the channel * * @return {channel} The channel object, initialize it using channel.watch() */ channel(channelType: string, channelID?: string | null, custom?: ChannelData): Channel; channel(channelType: string, custom?: ChannelData): Channel; /** * It's a helper method for `client.channel()` method, used to create unique conversation or * channel based on member list instead of id. * * If the channel already exists in `activeChannels` list, then we simply return it, since that * means the same channel was already requested or created. * * Otherwise we create a new instance of Channel class and return it. * * @private * * @param {string} channelType The channel type * @param {object} [custom] Custom data to attach to the channel * * @return {channel} The channel object, initialize it using channel.watch() */ getChannelByMembers: (channelType: string, custom: ChannelData) => Channel; /** * Its a helper method for `client.channel()` method, used to channel given the id of channel. * * If the channel already exists in `activeChannels` list, then we simply return it, since that * means the same channel was already requested or created. * * Otherwise we create a new instance of Channel class and return it. * * @private * * @param {string} channelType The channel type * @param {string} [channelID] The channel ID * @param {object} [custom] Custom data to attach to the channel * * @return {channel} The channel object, initialize it using channel.watch() */ getChannelById: (channelType: string, channelID: string, custom: ChannelData) => Channel; /** * partialUpdateUser - Update the given user object * * @param {PartialUserUpdate} partialUserObject which should contain id and any of "set" or "unset" params; * example: {id: "user1", set:{field: value}, unset:["field2"]} * * @return {Promise<{ users: { [key: string]: UserResponse } }>} list of updated users */ partialUpdateUser(partialUserObject: PartialUserUpdate): Promise; /** * upsertUsers - Batch upsert the list of users * * @param {UserResponse[]} users list of users * * @return {Promise<{ users: { [key: string]: UserResponse } }>} */ upsertUsers(users: UserResponse[]): Promise; /** * @deprecated Please use upsertUsers() function instead. * * updateUsers - Batch update the list of users * * @param {UserResponse[]} users list of users * @return {Promise<{ users: { [key: string]: UserResponse } }>} */ updateUsers: (users: UserResponse[]) => Promise; /** * upsertUser - Update or Create the given user object * * @param {UserResponse} userObject user object, the only required field is the user id. IE {id: "myuser"} is valid * * @return {Promise<{ users: { [key: string]: UserResponse } }>} */ upsertUser(userObject: UserResponse): Promise; /** * @deprecated Please use upsertUser() function instead. * * updateUser - Update or Create the given user object * * @param {UserResponse} userObject user object, the only required field is the user id. IE {id: "myuser"} is valid * @return {Promise<{ users: { [key: string]: UserResponse } }>} */ updateUser: (userObject: UserResponse) => Promise; /** * partialUpdateUsers - Batch partial update of users * * @param {PartialUserUpdate[]} users list of partial update requests * * @return {Promise<{ users: { [key: string]: UserResponse } }>} */ partialUpdateUsers(users: PartialUserUpdate[]): Promise; deleteUser(userID: string, params?: { delete_conversation_channels?: boolean; hard_delete?: boolean; mark_messages_deleted?: boolean; }): Promise; /** * restoreUsers - Restore soft deleted users * * @param {string[]} user_ids which users to restore * * @return {APIResponse} An API response */ restoreUsers(user_ids: string[]): Promise; /** * reactivateUser - Reactivate one user * * @param {string} userID which user to reactivate * @param {ReactivateUserOptions} [options] * * @return {UserResponse} Reactivated user */ reactivateUser(userID: string, options?: ReactivateUserOptions): Promise; /** * reactivateUsers - Reactivate many users asynchronously * * @param {string[]} user_ids which users to reactivate * @param {ReactivateUsersOptions} [options] * * @return {TaskResponse} A task ID */ reactivateUsers(user_ids: string[], options?: ReactivateUsersOptions): Promise; /** * deactivateUser - Deactivate one user * * @param {string} userID which user to deactivate * @param {DeactivateUsersOptions} [options] * * @return {UserResponse} Deactivated user */ deactivateUser(userID: string, options?: DeactivateUsersOptions): Promise; /** * deactivateUsers - Deactivate many users asynchronously * * @param {string[]} user_ids which users to deactivate * @param {DeactivateUsersOptions} [options] * * @return {TaskResponse} A task ID */ deactivateUsers(user_ids: string[], options?: DeactivateUsersOptions): Promise; exportUser(userID: string, options?: Record): Promise; /** banUser - bans a user from all channels * * @param {string} targetUserID * @param {BanUserOptions} [options] * @returns {Promise} */ banUser(targetUserID: string, options?: BanUserOptions): Promise; /** unbanUser - revoke global ban for a user * * @param {string} targetUserID * @param {UnBanUserOptions} [options] * @returns {Promise} */ unbanUser(targetUserID: string, options?: UnBanUserOptions): Promise; /** shadowBan - shadow bans a user from all channels * * @param {string} targetUserID * @param {BanUserOptions} [options] * @returns {Promise} */ shadowBan(targetUserID: string, options?: BanUserOptions): Promise; /** removeShadowBan - revoke global shadow ban for a user * * @param {string} targetUserID * @param {UnBanUserOptions} [options] * @returns {Promise} */ removeShadowBan(targetUserID: string, options?: UnBanUserOptions): Promise; blockUser(blockedUserID: string, user_id?: string): Promise; getBlockedUsers(user_id?: string): Promise; unBlockUser(blockedUserID: string, userID?: string): Promise; /** getSharedLocations * * @returns {Promise} The server response * */ getSharedLocations(): Promise; /** muteUser - mutes a user * * @param {string} targetID * @param {string} [userID] Only used with serverside auth * @param {MuteUserOptions} [options] * @returns {Promise} */ muteUser(targetID: string, userID?: string, options?: MuteUserOptions): Promise; /** unmuteUser - unmutes a user * * @param {string} targetID * @param {string} [currentUserID] Only used with serverside auth * @returns {Promise} */ unmuteUser(targetID: string, currentUserID?: string): Promise; /** userMuteStatus - check if a user is muted or not, can be used after connectUser() is called * * @param {string} targetID * @returns {boolean} */ userMuteStatus(targetID: string): boolean; /** * flagMessage - flag a message * @param {string} targetMessageID * @param {string} [options.user_id] currentUserID, only used with serverside auth * @returns {Promise} */ flagMessage(targetMessageID: string, options?: { reason?: string; user_id?: string; }): Promise; /** * flagUser - flag a user * @param {string} targetID * @param {string} [options.user_id] currentUserID, only used with serverside auth * @returns {Promise} */ flagUser(targetID: string, options?: { reason?: string; user_id?: string; }): Promise; /** * unflagMessage - unflag a message * @param {string} targetMessageID * @param {string} [options.user_id] currentUserID, only used with serverside auth * @returns {Promise} */ unflagMessage(targetMessageID: string, options?: { user_id?: string; }): Promise; /** * unflagUser - unflag a user * @param {string} targetID * @param {string} [options.user_id] currentUserID, only used with serverside auth * @returns {Promise} */ unflagUser(targetID: string, options?: { user_id?: string; }): Promise; /** * _queryFlags - Query flags. * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {FlagsFilters} filterConditions MongoDB style filter conditions * @param {FlagsPaginationOptions} options Option object, {limit: 10, offset:0} * * @return {Promise} Flags Response */ _queryFlags(filterConditions?: FlagsFilters, options?: FlagsPaginationOptions): Promise; /** * _queryFlagReports - Query flag reports. * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {FlagReportsFilters} filterConditions MongoDB style filter conditions * @param {FlagReportsPaginationOptions} options Option object, {limit: 10, offset:0} * * @return {Promise} Flag Reports Response */ _queryFlagReports(filterConditions?: FlagReportsFilters, options?: FlagReportsPaginationOptions): Promise; /** * _reviewFlagReport - review flag report * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {string} [id] flag report to review * @param {string} [reviewResult] flag report review result * @param {string} [options.user_id] currentUserID, only used with serverside auth * @param {string} [options.review_details] custom information about review result * @returns {Promise>} */ _reviewFlagReport(id: string, reviewResult: string, options?: ReviewFlagReportOptions): Promise; /** * unblockMessage - unblocks message blocked by automod * * * @param {string} targetMessageID * @param {string} [options.user_id] currentUserID, only used with serverside auth * @returns {Promise} */ unblockMessage(targetMessageID: string, options?: { user_id?: string; }): Promise; _unblockMessage: (targetMessageID: string, options?: { user_id?: string; }) => Promise; /** * @deprecated use markChannelsRead instead * * markAllRead - marks all channels for this user as read * @param {MarkAllReadOptions} [data] * * @return {Promise} */ markAllRead: (data?: MarkChannelsReadOptions) => Promise; /** * markChannelsRead - marks channels read - * it accepts a map of cid:messageid pairs, if messageid is empty, the whole channel will be marked as read * * @param {MarkChannelsReadOptions } [data] * * @return {Promise} */ markChannelsRead(data?: MarkChannelsReadOptions): Promise; createCommand(data: CreateCommandOptions): Promise; getCommand(name: string): Promise; updateCommand(name: string, data: UpdateCommandOptions): Promise; deleteCommand(name: string): Promise; listCommands(): Promise; createChannelType(data: CreateChannelOptions): Promise; getChannelType(channelType: string): Promise; updateChannelType(channelType: string, data: UpdateChannelTypeRequest): Promise; deleteChannelType(channelType: string): Promise; listChannelTypes(): Promise; /** * translateMessage - adds the translation to the message * * @param {string} messageId * @param {string} language * * @return {MessageResponse} Response that includes the message */ translateMessage(messageId: string, language: string): Promise> & { language: import("./types").TranslationLanguages; }; latest_reactions?: ReactionResponse[]; member?: import("./types").ChannelMemberResponse; mentioned_users?: UserResponse[]; mentioned_channel?: boolean; mentioned_here?: boolean; mentioned_roles?: string[]; message_text_updated_at?: string; moderation?: import("./types").ModerationResponse; moderation_details?: import("./types").ModerationDetailsResponse; own_reactions?: ReactionResponse[] | null; pin_expires?: string | null; pinned_at?: string | null; pinned_by?: UserResponse | null; poll?: import("./types").PollResponse; reaction_counts?: { [key: string]: number; } | null; reaction_groups?: { [key: string]: import("./types").ReactionGroupResponse; } | null; reaction_scores?: { [key: string]: number; } | null; reminder?: import("./types").ReminderResponseBase; reply_count?: number; shadowed?: boolean; shared_location?: SharedLocationResponse; status?: string; thread_participants?: UserResponse[]; updated_at?: string; deleted_for_me?: boolean; } & { quoted_message?: import("./types").MessageResponseBase; }>; /** * translate - translates the given text to provided language * * @param {string} text * @param {string} destination_language * @param {string} source_language * * @return {TranslateResponse} Response that includes the message */ translate(text: string, destination_language: string, source_language: string): Promise; /** * _normalizeExpiration - transforms expiration value into ISO string * @param {undefined|null|number|string|Date} timeoutOrExpirationDate expiration date or timeout. Use number type to set timeout in seconds, string or Date to set exact expiration date */ _normalizeExpiration(timeoutOrExpirationDate?: null | number | string | Date): string | null; /** * _messageId - extracts string message id from either message object or message id * @param {string | { id: string }} messageOrMessageId message object or message id * @param {string} errorText error message to report in case of message id absence */ _validateAndGetMessageId(messageOrMessageId: string | { id: string; }, errorText: string): string; /** * pinMessage - pins the message * @param {string | { id: string }} messageOrMessageId message object or message id * @param {undefined|null|number|string|Date} timeoutOrExpirationDate expiration date or timeout. Use number type to set timeout in seconds, string or Date to set exact expiration date * @param {undefined|string | { id: string }} [pinnedBy] who will appear as a user who pinned a message. Only for server-side use. Provide `undefined` when pinning message client-side * @param {undefined|number|string|Date} pinnedAt date when message should be pinned. It affects the order of pinned messages. Use negative number to set relative time in the past, string or Date to set exact date of pin */ pinMessage(messageOrMessageId: string | { id: string; }, timeoutOrExpirationDate?: null | number | string | Date, pinnedBy?: string | { id: string; }, pinnedAt?: number | string | Date): Promise; /** * unpinMessage - unpins the message that was previously pinned * @param {string | { id: string }} messageOrMessageId message object or message id * @param {string | { id: string }} [userId] */ unpinMessage(messageOrMessageId: string | { id: string; }, userId?: string | { id: string; }): Promise; /** * updateMessage - Update the given message * * @param {Omit & { mentioned_users?: string[] }} message object, id needs to be specified * @param {string | { id: string }} [partialUserOrUserId] * @param {boolean} [options.skip_enrich_url] Do not try to enrich the URLs within message * * @return {{ message: LocalMessage | MessageResponse }} Response that includes the message */ updateMessage(message: LocalMessage | Partial, partialUserOrUserId?: string | { id: string; }, options?: UpdateMessageOptions): Promise; _updateMessage(message: LocalMessage | Partial, partialUserOrUserId?: string | { id: string; }, options?: UpdateMessageOptions): Promise; /** * partialUpdateMessage - Update the given message id while retaining additional properties * * @param {string} id the message id * * @param {PartialUpdateMessage} partialMessageObject which should contain id and any of "set" or "unset" params; * example: {id: "user1", set:{text: "hi"}, unset:["color"]} * @param {string | { id: string }} [userId] * * @param {boolean} [options.skip_enrich_url] Do not try to enrich the URLs within message * * @return {{ message: MessageResponse }} Response that includes the updated message */ partialUpdateMessage(id: string, partialMessageObject: PartialMessageUpdate, partialUserOrUserId?: string | { id: string; }, options?: UpdateMessageOptions): Promise; /** * Updates message fields without storing them in the database, only sends update event. * * Available only on the server-side. * * @param messageId the message id to update. * @param partialMessageObject the message payload. * @param partialUserOrUserId the user id linked to this action. * @param options additional options. */ ephemeralUpdateMessage(messageId: string, partialMessageObject: PartialMessageUpdate, partialUserOrUserId?: string | { id: string; }, options?: UpdateMessageOptions): Promise; /** * deleteMessage - Delete a message * * @param {string} messageID The id of the message to delete * @param {boolean | DeleteMessageOptions | undefined} [optionsOrHardDelete] * @return {Promise} The API response */ deleteMessage(messageID: string, optionsOrHardDelete?: DeleteMessageOptions | boolean): Promise; _deleteMessage(messageID: string, optionsOrHardDelete?: DeleteMessageOptions | boolean): Promise; /** * undeleteMessage - Undelete a message * * undeletes a message that was previous soft deleted. Hard deleted messages * cannot be undeleted. This is only allowed to be called from server-side * clients. * * @param {string} messageID The id of the message to undelete * @param {string} userID The id of the user who undeleted the message * * @return {{ message: MessageResponse }} Response that includes the message */ undeleteMessage(messageID: string, userID: string): Promise; getMessage(messageID: string, options?: GetMessageOptions): Promise; /** * queryThreads - returns the list of threads of current user. * * @param {QueryThreadsOptions} options Options object for pagination and limiting the participants and replies. * @param {number} options.limit Limits the number of threads to be returned. * @param {boolean} options.watch Subscribes the user to the channels of the threads. * @param {number} options.participant_limit Limits the number of participants returned per threads. * @param {number} options.reply_limit Limits the number of replies returned per threads. * @param {ThreadFilters} options.filter MongoDB style filters for threads * @param {ThreadSort} options.sort MongoDB style sort for threads * * @returns {{ threads: Thread[], next: string }} Returns the list of threads and the next cursor. */ queryThreads(options?: QueryThreadsOptions): Promise<{ threads: Thread[]; next: string | undefined; }>; /** * getThread - returns the thread of a message by its id. * * @param {string} messageId The message id * @param {GetThreadOptions} options Options object for pagination and limiting the participants and replies. * @param {boolean} options.watch Subscribes the user to the channel of the thread. * @param {number} options.participant_limit Limits the number of participants returned per threads. * @param {number} options.reply_limit Limits the number of replies returned per threads. * * @returns {Thread} Returns the thread. */ getThread(messageId: string, options?: GetThreadOptions): Promise; /** * partialUpdateThread - updates the given thread * * @param {string} messageId The id of the thread message which needs to be updated. * @param {PartialThreadUpdate} partialThreadObject should contain "set" or "unset" params for any of the thread's non-reserved fields. * * @returns {GetThreadAPIResponse} Returns the updated thread. */ partialUpdateThread(messageId: string, partialThreadObject: PartialThreadUpdate): Promise; getUserAgent(): string; /** * @deprecated use sdkIdentifier instead * @param userAgent */ setUserAgent(userAgent: string): void; /** * _isUsingServerAuth - Returns true if we're using server side auth */ _isUsingServerAuth: () => boolean; _cacheEnabled: () => boolean; _enrichAxiosOptions(options?: AxiosRequestConfig & { config?: AxiosRequestConfig; }): AxiosRequestConfig; _getToken(): string | null | undefined; _startCleaning(): void; /** * encode ws url payload * @private * @returns json string */ _buildWSPayload: (client_request_id?: string) => string; /** * checks signature of a request * @param {string | Buffer} rawBody * @param {string} signature from HTTP header * @returns {boolean} */ verifyWebhook(requestBody: string | Buffer, xSignature: string): boolean; /** * Verify and parse an HTTP webhook event. * * Decompresses `rawBody` when gzipped (detected from the body bytes), * verifies the `X-Signature` header against the app's API secret, and * returns the parsed `Event`. Works whether or not Stream is currently * compressing payloads for this app, and stays correct behind * middleware that auto-decompresses the request. * * @param rawBody Raw HTTP request body bytes Stream signed * @param signature Value of the `X-Signature` header * @throws {InvalidWebhookError} When the signature does not match or * the gzip envelope is malformed. */ verifyAndParseWebhook(rawBody: string | Buffer, signature: string): Event; /** * Parse an SQS firehose event: decodes the message `Body` (base64 + * optional gzip) and returns the parsed `Event`. No HMAC verification * (Stream does not sign SQS bodies). * * @param messageBody SQS message `Body` string * @throws {InvalidWebhookError} When the base64 / gzip envelope is malformed. */ parseSqs(messageBody: string): Event; /** * Parse an SNS-delivered event (unwraps envelope JSON when needed, then * same decode path as SQS). No HMAC verification. * * @param notificationBody Raw SNS POST body or pre-extracted `Message` string * @throws {InvalidWebhookError} When the envelope cannot be decoded. */ parseSns(notificationBody: string): Event; /** getPermission - gets the definition for a permission * * @param {string} name * @returns {Promise} */ getPermission(name: string): Promise; /** createPermission - creates a custom permission * * @param {CustomPermissionOptions} permissionData the permission data * @returns {Promise} */ createPermission(permissionData: CustomPermissionOptions): Promise; /** updatePermission - updates an existing custom permission * * @param {string} id * @param {Omit} permissionData the permission data * @returns {Promise} */ updatePermission(id: string, permissionData: Omit): Promise; /** deletePermission - deletes a custom permission * * @param {string} name * @returns {Promise} */ deletePermission(name: string): Promise; /** listPermissions - returns the list of all permissions for this application * * @returns {Promise} */ listPermissions(): Promise; /** createRole - creates a custom role * * @param {string} name the new role name * @returns {Promise} */ createRole(name: string): Promise; /** listRoles - returns the list of all roles for this application * * @returns {Promise} */ listRoles(): Promise; /** deleteRole - deletes a custom role * * @param {string} name the role name * @returns {Promise} */ deleteRole(name: string): Promise; /** sync - returns all events that happened for a list of channels since last sync * @param {string[]} channel_cids list of channel CIDs * @param {string} last_sync_at last time the user was online and in sync. RFC3339 ie. "2020-05-06T15:05:01.207Z" * @param {SyncOptions} options See JSDoc in the type fields for more info * * @returns {Promise} */ sync(channel_cids: string[], last_sync_at: string, options?: SyncOptions): Promise; /** * sendUserCustomEvent - Send a custom event to a user * * @param {string} targetUserID target user id * @param {UserCustomEvent} event for example {type: 'friendship-request'} * * @return {Promise} The Server Response */ sendUserCustomEvent(targetUserID: string, event: UserCustomEvent): Promise; /** * Creates a new block list * * @param {BlockList} blockList - The block list to create * @param {string} blockList.name - The name of the block list * @param {string[]} blockList.words - List of words to block * @param {string} [blockList.team] - Team ID the block list belongs to * * @returns {Promise} The server response */ createBlockList(blockList: BlockList): Promise; /** * Lists all block lists * * @param {Object} [data] - Query parameters * @param {string} [data.team] - Team ID to filter block lists by * * @returns {Promise} Response containing array of block lists */ listBlockLists(data?: { team?: string; }): Promise; /** * Gets a specific block list * * @param {string} name - The name of the block list to retrieve * @param {Object} [data] - Query parameters * @param {string} [data.team] - Team ID that blocklist belongs to * * @returns {Promise} Response containing the block list */ getBlockList(name: string, data?: { team?: string; }): Promise; /** * Updates an existing block list * * @param {string} name - The name of the block list to update * @param {Object} data - The update data * @param {string[]} data.words - New list of words to block * @param {string} [data.team] - Team ID that blocklist belongs to * * @returns {Promise} The server response */ updateBlockList(name: string, data: { words: string[]; team?: string; }): Promise; /** * Deletes a block list * * @param {string} name - The name of the block list to delete * @param {Object} [data] - Query parameters * @param {string} [data.team] - Team ID that blocklist belongs to * * @returns {Promise} The server response */ deleteBlockList(name: string, data?: { team?: string; }): Promise; exportChannels(request: Array, options?: ExportChannelOptions): Promise; exportUsers(request: ExportUsersRequest): Promise; exportChannel(request: ExportChannelRequest, options?: ExportChannelOptions): Promise; getExportChannelStatus(id: string): Promise; campaign(idOrData: string | CampaignData, data?: CampaignData): Campaign; /** * channelBatchUpdater - Returns a ChannelBatchUpdater instance for batch channel operations * * @return {ChannelBatchUpdater} A ChannelBatchUpdater instance */ channelBatchUpdater(): ChannelBatchUpdater; segment(type: SegmentType, idOrData: string | SegmentData, data?: SegmentData): Segment; validateServerSideAuth(): void; /** * createSegment - Creates a segment * * @private * @param {SegmentType} type Segment type * @param {string} id Segment ID * @param {string} name Segment name * @param {SegmentData} params Segment data * * @return {{segment: SegmentResponse} & APIResponse} The created Segment */ createSegment(type: SegmentType, id: string | null, data?: SegmentData): Promise<{ segment: SegmentResponse; }>; /** * createUserSegment - Creates a user segment * * @param {string} id Segment ID * @param {string} name Segment name * @param {SegmentData} data Segment data * * @return {Segment} The created Segment */ createUserSegment(id: string | null, data?: SegmentData): Promise<{ segment: SegmentResponse; }>; /** * createChannelSegment - Creates a channel segment * * @param {string} id Segment ID * @param {string} name Segment name * @param {SegmentData} data Segment data * * @return {Segment} The created Segment */ createChannelSegment(id: string | null, data?: SegmentData): Promise<{ segment: SegmentResponse; }>; getSegment(id: string): Promise<{ segment: SegmentResponse; } & APIResponse>; /** * updateSegment - Update a segment * * @param {string} id Segment ID * @param {Partial} data Data to update * * @return {Segment} Updated Segment */ updateSegment(id: string, data: Partial): Promise<{ segment: SegmentResponse; }>; /** * addSegmentTargets - Add targets to a segment * * @param {string} id Segment ID * @param {string[]} targets Targets to add to the segment * * @return {APIResponse} API response */ addSegmentTargets(id: string, targets: string[]): Promise; querySegmentTargets(id: string, filter?: QuerySegmentTargetsFilter | null, sort?: SortParam[] | null | [], options?: {}): Promise<{ targets: SegmentTargetsResponse[]; next?: string; } & APIResponse>; /** * removeSegmentTargets - Remove targets from a segment * * @param {string} id Segment ID * @param {string[]} targets Targets to add to the segment * * @return {APIResponse} API response */ removeSegmentTargets(id: string, targets: string[]): Promise; /** * querySegments - Query Segments * * @param {filter} filter MongoDB style filter conditions * @param {QuerySegmentsOptions} options Options for sorting/paginating the results * * @return {Segment[]} Segments */ querySegments(filter: {}, sort?: SortParam[], options?: QuerySegmentsOptions): Promise<{ segments: SegmentResponse[]; next?: string; prev?: string; } & APIResponse>; /** * deleteSegment - Delete a Campaign Segment * * @param {string} id Segment ID * * @return {Promise} The Server Response */ deleteSegment(id: string): Promise; /** * segmentTargetExists - Check if a target exists in a segment * * @param {string} segmentId Segment ID * @param {string} targetId Target ID * * @return {Promise} The Server Response */ segmentTargetExists(segmentId: string, targetId: string): Promise; /** * createCampaign - Creates a Campaign * * @param {CampaignData} params Campaign data * * @return {Campaign} The Created Campaign */ createCampaign(params: CampaignData): Promise<{ campaign: CampaignResponse; users: { next?: string; prev?: string; }; } & APIResponse>; getCampaign(id: string, options?: GetCampaignOptions): Promise<{ campaign: CampaignResponse; users: { next?: string; prev?: string; }; } & APIResponse>; startCampaign(id: string, options?: { scheduledFor?: string; stopAt?: string; }): Promise<{ campaign: CampaignResponse; users: { next?: string; prev?: string; }; } & APIResponse>; /** * queryCampaigns - Query Campaigns * * * @return {Campaign[]} Campaigns */ queryCampaigns(filter: CampaignFilters, sort?: CampaignSort, options?: CampaignQueryOptions): Promise<{ campaigns: CampaignResponse[]; next?: string; prev?: string; } & APIResponse>; /** * updateCampaign - Update a Campaign * * @param {string} id Campaign ID * @param {Partial} params Campaign data * * @return {Campaign} Updated Campaign */ updateCampaign(id: string, params: Partial): Promise<{ campaign: CampaignResponse; users: { next?: string; prev?: string; }; }>; /** * deleteCampaign - Delete a Campaign * * @param {string} id Campaign ID * * @return {Promise} The Server Response */ deleteCampaign(id: string): Promise; /** * stopCampaign - Stop a Campaign * * @param {string} id Campaign ID * * @return {Campaign} Stopped Campaign */ stopCampaign(id: string): Promise<{ campaign: CampaignResponse; }>; /** * enrichURL - Get OpenGraph data of the given link * * @param {string} url link * @return {OGAttachment} OG Attachment */ enrichURL(url: string): Promise; /** * getTask - Gets status of a long running task * * @param {string} id Task ID * * @return {TaskStatus} The task status */ getTask(id: string): Promise; /** * deleteChannels - Deletes a list of channel * * @param {string[]} cids Channel CIDs * @param {boolean} [options.hard_delete] Defines if the channel is hard deleted or not * * @return {DeleteChannelsResponse} Result of the soft deletion, if server-side, it holds the task ID as well */ deleteChannels(cids: string[], options?: { hard_delete?: boolean; }): Promise; } & Partial>; /** * deleteUsers - Batch Delete Users * * @param {string[]} user_ids which users to delete * @param {DeleteUserOptions} options Configuration how to delete users * * @return {TaskResponse} A task ID */ deleteUsers(user_ids: string[], options?: DeleteUserOptions): Promise; /** * _createImportURL - Create an Import upload url. * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {string} filename filename of uploaded data * @return {APIResponse & CreateImportResponse} An ImportTask */ _createImportURL(filename: string): Promise; /** * _createImport - Create an Import Task. * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {string} path path of uploaded data * @param {CreateImportOptions} options import options * @return {APIResponse & CreateImportResponse} An ImportTask */ _createImport(path: string, options?: CreateImportOptions): Promise; /** * _getImport - Get an Import Task. * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {string} id id of Import Task * * @return {APIResponse & GetImportResponse} An ImportTask */ _getImport(id: string): Promise; /** * _listImports - Lists Import Tasks. * * Note: Do not use this. * It is present for internal usage only. * This function can, and will, break and/or be removed at any point in time. * * @private * @param {ListImportsPaginationOptions} options pagination options * * @return {APIResponse & ListImportsResponse} An ImportTask */ _listImports(options: ListImportsPaginationOptions): Promise; /** * upsertPushProvider - Create or Update a push provider * * Note: Works only for v2 push version is enabled on app settings. * * @param {PushProviderConfig} configuration of the provider you want to create or update * * @return {APIResponse & PushProviderUpsertResponse} A push provider */ upsertPushProvider(pushProvider: PushProviderConfig): Promise; /** * deletePushProvider - Delete a push provider * * Note: Works only for v2 push version is enabled on app settings. * * @param {PushProviderID} type and foreign id of the push provider to be deleted * * @return {APIResponse} An API response */ deletePushProvider({ type, name }: PushProviderID): Promise; /** * listPushProviders - Get all push providers in the app * * Note: Works only for v2 push version is enabled on app settings. * * @return {APIResponse & PushProviderListResponse} A push provider */ listPushProviders(): Promise; /** * creates an abort controller that will be used by the next HTTP Request. */ createAbortControllerForNextRequest(): AbortController; /** * commits a pending message, making it visible in the channel and for other users * @param id the message id * * @return {APIResponse & MessageResponse} The message */ commitMessage(id: string): Promise> & { language: import("./types").TranslationLanguages; }; latest_reactions?: ReactionResponse[]; member?: import("./types").ChannelMemberResponse; mentioned_users?: UserResponse[]; mentioned_channel?: boolean; mentioned_here?: boolean; mentioned_roles?: string[]; message_text_updated_at?: string; moderation?: import("./types").ModerationResponse; moderation_details?: import("./types").ModerationDetailsResponse; own_reactions?: ReactionResponse[] | null; pin_expires?: string | null; pinned_at?: string | null; pinned_by?: UserResponse | null; poll?: import("./types").PollResponse; reaction_counts?: { [key: string]: number; } | null; reaction_groups?: { [key: string]: import("./types").ReactionGroupResponse; } | null; reaction_scores?: { [key: string]: number; } | null; reminder?: import("./types").ReminderResponseBase; reply_count?: number; shadowed?: boolean; shared_location?: SharedLocationResponse; status?: string; thread_participants?: UserResponse[]; updated_at?: string; deleted_for_me?: boolean; } & { quoted_message?: import("./types").MessageResponseBase; }>; /** * Creates a poll * @param poll PollData The poll that will be created * @param userId string The user id (only serverside) * @returns {APIResponse & CreatePollAPIResponse} The poll */ createPoll(poll: CreatePollData, userId?: string): Promise; /** * Retrieves a poll * @param id string The poll id * @param userId string The user id (only serverside) * @returns {APIResponse & GetPollAPIResponse} The poll */ getPoll(id: string, userId?: string): Promise; /** * Updates a poll * @param poll PollData The poll that will be updated * @param userId string The user id (only serverside) * @returns {APIResponse & PollResponse} The poll */ updatePoll(poll: PollData, userId?: string): Promise; /** * Partially updates a poll * @param id string The poll id * @param {PartialPollUpdate} partialPollObject which should contain id and any of "set" or "unset" params; * @param userId string The user id (only serverside) * example: {id: "44f26af5-f2be-4fa7-9dac-71cf893781de", set:{field: value}, unset:["field2"]} * @returns {APIResponse & UpdatePollAPIResponse} The poll */ partialUpdatePoll(id: string, partialPollObject: PartialPollUpdate, userId?: string): Promise; /** * Delete a poll * @param id string The poll id * @param userId string The user id (only serverside) * @returns */ deletePoll(id: string, userId?: string): Promise; /** * Close a poll * @param id string The poll id * @param userId string The user id (only serverside) * @returns {APIResponse & UpdatePollAPIResponse} The poll */ closePoll(id: string, userId?: string): Promise; /** * Creates a poll option * @param pollId string The poll id * @param option PollOptionData The poll option that will be created * @param userId string The user id (only serverside) * @returns {APIResponse & PollOptionResponse} The poll option */ createPollOption(pollId: string, option: PollOptionData, userId?: string): Promise; /** * Retrieves a poll option * @param pollId string The poll id * @param optionId string The poll option id * @param userId string The user id (only serverside) * @returns {APIResponse & PollOptionResponse} The poll option */ getPollOption(pollId: string, optionId: string, userId?: string): Promise; /** * Updates a poll option * @param pollId string The poll id * @param option PollOptionData The poll option that will be updated * @param userId string The user id (only serverside) * @returns */ updatePollOption(pollId: string, option: PollOptionData, userId?: string): Promise; /** * Delete a poll option * @param pollId string The poll id * @param optionId string The poll option id * @param userId string The user id (only serverside) * @returns {APIResponse} The poll option */ deletePollOption(pollId: string, optionId: string, userId?: string): Promise; /** * Cast vote on a poll * @param messageId string The message id * @param pollId string The poll id * @param vote PollVoteData The vote that will be casted * @param userId string The user id (only serverside) * @returns {APIResponse & CastVoteAPIResponse} The poll vote */ castPollVote(messageId: string, pollId: string, vote: PollVoteData, userId?: string): Promise; /** * Add a poll answer * @param messageId string The message id * @param pollId string The poll id * @param answerText string The answer text * @param userId string The user id (only serverside) */ addPollAnswer(messageId: string, pollId: string, answerText: string, userId?: string): Promise; removePollVote(messageId: string, pollId: string, voteId: string, userId?: string): Promise; /** * Queries polls * @param filter * @param sort * @param options Option object, {limit: 10, offset:0} * @param userId string The user id (only serverside) * @returns {APIResponse & QueryPollsResponse} The polls */ queryPolls(filter?: QueryPollsFilters, sort?: PollSort, options?: QueryPollsOptions, userId?: string): Promise; /** * Queries poll votes * @param pollId * @param filter * @param sort * @param options Option object, {limit: 10, offset:0} * @param userId string The user id (only serverside) * @returns {APIResponse & PollVotesAPIResponse} The poll votes */ queryPollVotes(pollId: string, filter?: QueryVotesFilters, sort?: VoteSort, options?: QueryVotesOptions, userId?: string): Promise; /** * Queries poll answers * @param pollId * @param filter * @param sort * @param options Option object, {limit: 10, offset:0} * @param userId string The user id (only serverside) * @returns {APIResponse & PollAnswersAPIResponse} The poll votes */ queryPollAnswers(pollId: string, filter?: QueryVotesFilters, sort?: VoteSort, options?: QueryVotesOptions, userId?: string): Promise; /** * Query message history * @param filter * @param sort * @param options Option object, {limit: 10} * @returns {APIResponse & QueryMessageHistoryResponse} The message histories */ queryMessageHistory(filter?: QueryMessageHistoryFilters, sort?: QueryMessageHistorySort, options?: QueryMessageHistoryOptions): Promise; /** * updateFlags - reviews/unflags flagged message * * @param {string[]} message_ids list of message IDs * @param {string} options Option object in case user ID is set to review all the flagged messages by the user * @param {string} reviewed_by user ID who reviewed the flagged message * @returns {APIResponse} */ updateFlags(message_ids: string[], reviewed_by: string, options?: { user_id?: string; }): Promise; /** * queryDrafts - Queries drafts for the current user * * @param {object} [options] Query options * @param {object} [options.filter] Filters for the query * @param {number} [options.sort] Sort parameters * @param {number} [options.limit] Limit the number of results * @param {string} [options.next] Pagination parameter * @param {string} [options.prev] Pagination parameter * @param {string} [options.user_id] Has to be provided when called server-side * * @return {Promise} Response containing the drafts */ queryDrafts(options?: Pager & { filter?: DraftFilters; sort?: DraftSort; user_id?: string; }): Promise; /** * createReminder - Creates a reminder for a message * * @param {CreateReminderOptions} options The options for creating the reminder * @returns {Promise} */ createReminder({ messageId, ...options }: CreateReminderOptions): Promise; /** * updateReminder - Updates an existing reminder for a message * * @param {UpdateReminderOptions} options The options for updating the reminder * @returns {Promise} */ updateReminder({ messageId, ...options }: UpdateReminderOptions): Promise; /** * deleteReminder - Deletes a reminder for a message * * @param {string} messageId The ID of the message whose reminder to delete * @param {string} [userId] Optional user ID, required for server-side operations * @returns {Promise} */ deleteReminder(messageId: string, userId?: string): Promise; /** * queryReminders - Queries reminders based on given filters * * @param {QueryRemindersOptions} options The options for querying reminders * @returns {Promise} */ queryReminders({ filter, sort, ...rest }?: QueryRemindersOptions): Promise; /** * queryTeamUsageStats - Queries team-level usage statistics from the warehouse database * * Returns all 16 metrics grouped by team with cursor-based pagination. * * Date Range Options (mutually exclusive): * - Use 'month' parameter (YYYY-MM format) for monthly aggregated values * - Use 'start_date'/'end_date' parameters (YYYY-MM-DD format) for daily breakdown * - If neither provided, defaults to current month (monthly mode) * * This endpoint is server-side only. * * @param {QueryTeamUsageStatsOptions} options The options for querying team usage stats * @returns {Promise} */ queryTeamUsageStats(options?: QueryTeamUsageStatsOptions): Promise; /** * updateLocation - Updates a location * * @param location SharedLocationRequest the location data to update * * @returns {Promise} The server response */ updateLocation(location: UpdateLocationPayload): Promise; /** * uploadFile - Uploads a file to the configured storage (defaults to Stream CDN) * * @param {string|NodeJS.ReadableStream|Buffer|File} uri The file to upload * @param {string} [name] The name of the file * @param {string} [contentType] The content type of the file * @param {UserResponse} [user] Optional user information * @param {AxiosRequestConfig} [axiosRequestConfig] Optional axios config (e.g. onUploadProgress for progress tracking) * * @return {Promise} Response containing the file URL */ uploadFile(uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse, axiosRequestConfig?: AxiosRequestConfig): Promise; /** * uploadImage - Uploads an image to the configured storage (defaults to Stream CDN) * * @param {string|NodeJS.ReadableStream|File} uri The image to upload * @param {string} [name] The name of the image * @param {string} [contentType] The content type of the image * @param {UserResponse} [user] Optional user information * @param {AxiosRequestConfig} [axiosRequestConfig] Optional axios config (e.g. onUploadProgress for progress tracking) * * @return {Promise} Response containing the image URL */ uploadImage(uri: string | NodeJS.ReadableStream | File, name?: string, contentType?: string, user?: UserResponse, axiosRequestConfig?: AxiosRequestConfig): Promise; /** * deleteFile - Deletes a file from the configured storage * * @param {string} url The URL of the file to delete * * @return {Promise} The server response */ deleteFile(url: string): Promise; /** * deleteImage - Deletes an image from the configured storage * * @param {string} url The URL of the image to delete * * @return {Promise} The server response */ deleteImage(url: string): Promise; /** * Mark the channels delivered for the given messages and the user * * @param {MarkDeliveredOptions} data * @return {Promise} Description */ markChannelsDelivered(data: MarkDeliveredOptions): Promise; syncDeliveredCandidates(collections: Channel[]): void; /** * Update Channels Batch * * @param {UpdateChannelsBatchOptions} payload for updating channels in batch * @return {Promise} The server response */ updateChannelsBatch(payload: UpdateChannelsBatchOptions): Promise; } & Partial>; /** * createPredefinedFilter - Creates a new predefined filter (server-side only) * * @param {CreatePredefinedFilterOptions} options Predefined filter options * * @return {Promise} The created predefined filter */ createPredefinedFilter = Record>(options: CreatePredefinedFilterOptions): Promise>; /** * getPredefinedFilter - Gets a predefined filter by name (server-side only) * * @param {string} name Predefined filter name * * @return {Promise} The predefined filter */ getPredefinedFilter = Record>(name: string): Promise>; /** * updatePredefinedFilter - Updates a predefined filter (server-side only) * * @param {string} name Predefined filter name * @param {UpdatePredefinedFilterOptions} options Predefined filter options * * @return {Promise} The updated predefined filter */ updatePredefinedFilter = Record>(name: string, options: UpdatePredefinedFilterOptions): Promise>; /** * deletePredefinedFilter - Deletes a predefined filter (server-side only) * * @param {string} name Predefined filter name * * @return {Promise} The server response */ deletePredefinedFilter(name: string): Promise; /** * listPredefinedFilters - Lists all predefined filters (server-side only) * * @param {ListPredefinedFiltersOptions} options Query options * * @return {Promise} The list of predefined filters */ listPredefinedFilters = Record>(options?: ListPredefinedFiltersOptions): Promise>; /** * setRetentionPolicy - Creates or updates a retention policy for the app. * Server-side only. * * @param {string} policy The policy type ('old-messages' or 'inactive-channels') * @param {number} maxAgeHours Max age in hours (24-43800) * @returns {Promise} */ setRetentionPolicy(policy: string, maxAgeHours: number): Promise; /** * deleteRetentionPolicy - Deletes a retention policy for the app. * Server-side only. * * @param {string} policy The policy type ('old-messages' or 'inactive-channels') * @returns {Promise} */ deleteRetentionPolicy(policy: string): Promise; /** * getRetentionPolicy - Returns all retention policies configured for the app. * Server-side only. * * @returns {Promise} */ getRetentionPolicy(): Promise; /** * getRetentionPolicyRuns - Returns filtered and sorted retention cleanup run history. * Supports filter_conditions on 'policy' and 'date' fields. * Server-side only. * * @param {GetRetentionPolicyRunsOptions} options Filter, sort, and pagination options * @returns {Promise} */ getRetentionPolicyRuns(options?: GetRetentionPolicyRunsOptions): Promise; } export {};