stream-chat 8.56.1 → 8.57.1

package/src/client.ts

@@ -100,6 +100,7 @@ import {
   FlagUserResponse,
   GetBlockedUsersAPIResponse,
   GetCallTokenResponse,
+  GetCampaignOptions,
   GetChannelTypeResponse,
   GetCommandResponse,
   GetImportResponse,
@@ -173,6 +174,7 @@ import {
   ReservedMessageFields,
   ReviewFlagReportOptions,
   ReviewFlagReportResponse,
+  SdkIdentifier,
   SearchAPIResponse,
   SearchMessageSortBase,
   SearchOptions,
@@ -274,6 +276,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   insightMetrics: InsightMetrics;
   defaultWSTimeoutWithFallback: number;
   defaultWSTimeout: number;
+  sdkIdentifier?: SdkIdentifier;
   private nextRequestAbortController: AbortController | null = null;
 
   /**
@@ -2916,11 +2919,21 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   }
 
   getUserAgent() {
-    return (
-      this.userAgent || `stream-chat-javascript-client-${this.node ? 'node' : 'browser'}-${process.env.PKG_VERSION}`
-    );
+    if (this.userAgent) {
+      return this.userAgent;
+    }
+    const version = process.env.PKG_VERSION;
+    if (this.sdkIdentifier) {
+      return `stream-chat-${this.sdkIdentifier.name}-v${this.sdkIdentifier.version}-llc-v${version}`;
+    } else {
+      return `stream-chat-js-v${version}-${this.node ? 'node' : 'browser'}`;
+    }
   }
 
+  /**
+   * @deprecated use sdkIdentifier instead
+   * @param userAgent
+   */
   setUserAgent(userAgent: string) {
     this.userAgent = userAgent;
   }
@@ -3407,25 +3420,44 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    */
   async createCampaign(params: CampaignData) {
     this.validateServerSideAuth();
-    return this.post<{ campaign: CampaignResponse } & APIResponse>(this.baseURL + `/campaigns`, { ...params });
+    return this.post<
+      {
+        campaign: CampaignResponse;
+        users: {
+          next?: string;
+          prev?: string;
+        };
+      } & APIResponse
+    >(this.baseURL + `/campaigns`, { ...params });
   }
 
-  async getCampaign(id: string) {
+  async getCampaign(id: string, options?: GetCampaignOptions) {
     this.validateServerSideAuth();
-    return this.get<{ campaign: CampaignResponse } & APIResponse>(
-      this.baseURL + `/campaigns/${encodeURIComponent(id)}`,
-    );
+    return this.get<
+      {
+        campaign: CampaignResponse;
+        users: {
+          next?: string;
+          prev?: string;
+        };
+      } & APIResponse
+    >(this.baseURL + `/campaigns/${encodeURIComponent(id)}`, { ...options?.users });
   }
 
   async startCampaign(id: string, options?: { scheduledFor?: string; stopAt?: string }) {
     this.validateServerSideAuth();
-    return this.post<{ campaign: CampaignResponse } & APIResponse>(
-      this.baseURL + `/campaigns/${encodeURIComponent(id)}/start`,
+    return this.post<
       {
-        scheduled_for: options?.scheduledFor,
-        stop_at: options?.stopAt,
-      },
-    );
+        campaign: CampaignResponse;
+        users: {
+          next?: string;
+          prev?: string;
+        };
+      } & APIResponse
+    >(this.baseURL + `/campaigns/${encodeURIComponent(id)}/start`, {
+      scheduled_for: options?.scheduledFor,
+      stop_at: options?.stopAt,
+    });
   }
   /**
    * queryCampaigns - Query Campaigns
@@ -3458,7 +3490,13 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    */
   async updateCampaign(id: string, params: Partial<CampaignData>) {
     this.validateServerSideAuth();
-    return this.put<{ campaign: CampaignResponse }>(this.baseURL + `/campaigns/${encodeURIComponent(id)}`, params);
+    return this.put<{
+      campaign: CampaignResponse;
+      users: {
+        next?: string;
+        prev?: string;
+      };
+    }>(this.baseURL + `/campaigns/${encodeURIComponent(id)}`, params);
   }
 
   /**

package/src/types.ts

@@ -3000,6 +3000,10 @@ export type QuerySegmentTargetsFilter = {
 };
 export type QuerySegmentTargetsOptions = Pick<Pager, 'next' | 'limit'>;
 
+export type GetCampaignOptions = {
+  users?: { limit?: number; next?: string; prev?: string };
+};
+
 export type CampaignSort = {
   field: string;
   direction?: number;
@@ -3010,6 +3014,7 @@ export type CampaignQueryOptions = {
   next?: string;
   prev?: string;
   sort?: CampaignSort;
+  user_limit?: number;
 };
 
 export type SegmentQueryOptions = CampaignQueryOptions;
@@ -3050,6 +3055,8 @@ export type CampaignStats = {
   stats_completed_at?: string;
   stats_messages_sent?: number;
   stats_started_at?: string;
+  stats_users_read?: number;
+  stats_users_sent?: number;
 };
 export type CampaignResponse = {
   created_at: string;
@@ -3808,3 +3815,5 @@ export type PromoteChannelParams<SCG extends ExtendableGenerics = DefaultGeneric
    */
   channelToMoveIndexWithinChannels?: number;
 };
+
+export type SdkIdentifier = { name: 'react' | 'react-native' | 'angular'; version: string };