stream-chat - npm Package Compare versions

Comparing version 7.0.0 to 7.1.0

dist/types/client.d.ts

@@ -9,3 +9,3 @@ /// <reference types="node" />
 import { WSConnectionFallback } from './connection_fallback';
-import { APIErrorResponse, APIResponse, AppSettings, AppSettingsAPIResponse, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BaseDeviceFields, BlockList, BlockListResponse, Campaign, CampaignData, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CreateImportOptions, CreateImportResponse, CreateImportURLResponse, CustomPermissionOptions, DefaultGenerics, DeleteCommandResponse, DeleteUserOptions, Device, EndpointName, ErrorFromResponse, Event, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, ExportUsersRequest, ExportUsersResponse, ExtendableGenerics, FlagMessageResponse, FlagReportsFilters, FlagReportsPaginationOptions, FlagReportsResponse, FlagsFilters, FlagsPaginationOptions, FlagsResponse, FlagUserResponse, GetCallTokenResponse, GetChannelTypeResponse, GetCommandResponse, GetImportResponse, GetMessageAPIResponse, GetRateLimitsResponse, ListChannelResponse, ListCommandsResponse, ListImportsPaginationOptions, ListImportsResponse, Logger, MarkChannelsReadOptions, MessageFilters, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OGAttachment, OwnUserResponse, PartialMessageUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PushProvider, PushProviderConfig, PushProviderID, PushProviderListResponse, PushProviderUpsertResponse, ReactionResponse, ReviewFlagReportOptions, ReviewFlagReportResponse, SearchAPIResponse, SearchOptions, Segment, SegmentData, SendFileAPIResponse, StreamChatOptions, SyncOptions, SyncResponse, TaskResponse, TaskStatus, TestCampaignResponse, TestPushDataInput, TestSQSDataInput, TokenOrProvider, UnBanUserOptions, UpdateChannelOptions, UpdateChannelResponse, UpdateCommandOptions, UpdateCommandResponse, UpdatedMessage, UpdateMessageAPIResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort } from './types';
+import { APIErrorResponse, APIResponse, AppSettings, AppSettingsAPIResponse, BannedUsersFilters, BannedUsersPaginationOptions, BannedUsersResponse, BannedUsersSort, BanUserOptions, BaseDeviceFields, BlockList, BlockListResponse, Campaign, CampaignData, CampaignFilters, CampaignQueryOptions, ChannelAPIResponse, ChannelData, ChannelFilters, ChannelMute, ChannelOptions, ChannelResponse, ChannelSort, ChannelStateOptions, CheckPushResponse, CheckSQSResponse, Configs, ConnectAPIResponse, CreateChannelOptions, CreateChannelResponse, CreateCommandOptions, CreateCommandResponse, CreateImportOptions, CreateImportResponse, CreateImportURLResponse, CustomPermissionOptions, DefaultGenerics, DeleteCampaignOptions, DeleteCommandResponse, DeleteUserOptions, Device, EndpointName, ErrorFromResponse, Event, EventHandler, ExportChannelOptions, ExportChannelRequest, ExportChannelResponse, ExportChannelStatusResponse, ExportUsersRequest, ExportUsersResponse, ExtendableGenerics, FlagMessageResponse, FlagReportsFilters, FlagReportsPaginationOptions, FlagReportsResponse, FlagsFilters, FlagsPaginationOptions, FlagsResponse, FlagUserResponse, GetCallTokenResponse, GetChannelTypeResponse, GetCommandResponse, GetImportResponse, GetMessageAPIResponse, GetRateLimitsResponse, ListChannelResponse, ListCommandsResponse, ListImportsPaginationOptions, ListImportsResponse, Logger, MarkChannelsReadOptions, MessageFilters, MessageFlagsFilters, MessageFlagsPaginationOptions, MessageFlagsResponse, MessageResponse, Mute, MuteUserOptions, MuteUserResponse, OGAttachment, OwnUserResponse, PartialMessageUpdate, PartialUserUpdate, PermissionAPIResponse, PermissionsAPIResponse, PushProvider, PushProviderConfig, PushProviderID, PushProviderListResponse, PushProviderUpsertResponse, ReactionResponse, Recipient, RecipientFilters, RecipientQueryOptions, ReviewFlagReportOptions, ReviewFlagReportResponse, SearchAPIResponse, SearchOptions, Segment, SegmentData, SegmentFilters, SegmentQueryOptions, SendFileAPIResponse, StreamChatOptions, SyncOptions, SyncResponse, TaskResponse, TaskStatus, TestCampaignResponse, TestPushDataInput, TestSQSDataInput, TokenOrProvider, UnBanUserOptions, UpdateChannelOptions, UpdateChannelResponse, UpdateCommandOptions, UpdateCommandResponse, UpdatedMessage, UpdateMessageAPIResponse, UserCustomEvent, UserFilters, UserOptions, UserResponse, UserSort } from './types';
 import { InsightMetrics } from './insights';
@@ -853,13 +853,4 @@ export declare class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> {
         args?: string | undefined;
-        channel?: import("./types").ChannelResponse<StreamChatGenerics> | undefined;
-        cid?: string | undefined; /**
-         * @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<StreamChatGenerics> | UserResponse<StreamChatGenerics>} user Data about this user. IE {name: "john"}
-         * @param {TokenOrProvider} userTokenOrProvider Token or provider
-         *
-         * @return {ConnectAPIResponse<StreamChatGenerics>} Returns a promise that resolves when the connection is setup
-         */
+        channel?: ChannelResponse<StreamChatGenerics> | undefined;
+        cid?: string | undefined;
         command?: string | undefined;
@@ -1072,19 +1063,10 @@ command_info?: {
     /**
-     * getSegment - Get a Campaign Segment
+     * querySegments - Query Campaign Segments
      *
-     * @param {string} id Segment ID
      *
-     * @return {Segment} A Segment
-     */
-    getSegment(id: string): Promise<Segment>;
-    /**
-     * listSegments - List Campaign Segments
-     *
-     *
      * @return {Segment[]} Segments
      */
-    listSegments(options: {
-        limit?: number;
-        offset?: number;
-    }): Promise<Segment[]>;
+    querySegments(filters: SegmentFilters, options?: SegmentQueryOptions): Promise<{
+        segments: Segment[];
+    }>;
     /**
@@ -1116,19 +1098,13 @@ * updateSegment - Update a Campaign Segment
     /**
-     * getCampaign - Get a Campaign
+     * queryCampaigns - Query Campaigns
      *
-     * @param {string} id Campaign ID
      *
-     * @return {Campaign} A Campaign
-     */
-    getCampaign(id: string): Promise<Campaign>;
-    /**
-     * listCampaigns - List Campaigns
-     *
-     *
      * @return {Campaign[]} Campaigns
      */
-    listCampaigns(options: {
-        limit?: number;
-        offset?: number;
-    }): Promise<Campaign[]>;
+    queryCampaigns(filters: CampaignFilters, options?: CampaignQueryOptions): Promise<{
+        campaigns: Campaign[];
+        segments: Record<string, Segment>;
+        channels?: Record<string, ChannelResponse<StreamChatGenerics>> | undefined;
+        users?: Record<string, UserResponse<StreamChatGenerics>> | undefined;
+    }>;
     /**
@@ -1150,3 +1126,3 @@ * updateCampaign - Update a Campaign
      */
-    deleteCampaign(id: string): Promise<APIResponse>;
+    deleteCampaign(id: string, params?: DeleteCampaignOptions): Promise<APIResponse>;
     /**
@@ -1191,2 +1167,15 @@ * scheduleCampaign - Schedule a Campaign
     /**
+     * queryRecipients - Query Campaign Recipient Results
+     *
+     *
+     * @return {Recipient[]} Recipients
+     */
+    queryRecipients(filters: RecipientFilters, options?: RecipientQueryOptions): Promise<{
+        campaigns: Record<string, Campaign>;
+        recipients: Recipient[];
+        segments: Record<string, Segment>;
+        channels?: Record<string, ChannelResponse<StreamChatGenerics>> | undefined;
+        users?: Record<string, UserResponse<StreamChatGenerics>> | undefined;
+    }>;
+    /**
      * enrichURL - Get OpenGraph data of the given link
@@ -1193,0 +1182,0 @@ *

package.json

 {
   "name": "stream-chat",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "JS SDK for the Stream Chat API",
@@ -5,0 +5,0 @@ "author": "GetStream",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4873136

increased by0.23%

Lines of code

51321

increased by0.04%

No dependency changes