feat: segments API (wip #3)

GetStream · Dec 28, 2023 · 9a96e20 · 9a96e20
1 parent 5d212df
commit 9a96e20
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -2891,15 +2891,17 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   /**
    * querySegments - Query Segments
    *
+   * @param {filter} filter MongoDB style filter conditions
+   * @param {QuerySegmentsOptions} options Options for sorting/paginating the results
    *
    * @return {Segment[]} Segments
    */
-  async querySegments(filters: SegmentFilters, options: QuerySegmentsOptions = {}) {
+  async querySegments(filter: {}, options: QuerySegmentsOptions = {}) {
     return await this.get<{
       segments: Segment[];
     }>(this.baseURL + `/segments`, {
       payload: {
-        filter_conditions: filters,
+        filter: filter,
         ...options,
       },
     });
@@ -2916,6 +2918,18 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     return this.delete<APIResponse>(this.baseURL + `/segments/${id}`);
   }
 
+  /**
+   * segmentTargetExists - Check if a target exists in a segment
+   *
+   * @param {string} segmentId Segment ID
+   * @param {string} targetId Target ID
+   *
+   * @return {Promise<APIResponse>} The Server Response
+   */
+  async segmentTargetExists(segmentId: string, targetId: string) {
+    return this.get<APIResponse>(this.baseURL + `/segments/${segmentId}/target/${targetId}`);
+  }
+
   /**
    * createCampaign - Creates a Campaign
    *

diff --git a/src/types.ts b/src/types.ts
@@ -2409,7 +2409,7 @@ export type UpdateSegmentParams = {
 
 export type SortParam = {
   field: string;
-  direction?: 'asc' | 'desc';
+  direction?: AscDesc;
 }
 
 export type Pager = {
@@ -2420,8 +2420,7 @@ export type Pager = {
 
 export type QuerySegmentsOptions = {
   sort?: SortParam[];
-  pager?: Pager;
-}
+} & Pager;
 
 export type CampaignSortField = {
   field: string;