@wokuapp/sdk 0.5.0 → 0.7.0

package/dist/index.d.cts

@@ -1830,6 +1830,11 @@ interface components {
             name: string;
             /** @description Kinds of comment that alert this number. Defaults to all four. */
             sources?: ("woku" | "nps" | "csat" | "ces")[];
+            /**
+             * @description true alerts every review of those kinds (recognitions too); false or absent alerts improvements only.
+             * @default false
+             */
+            allReviews: boolean;
         };
         UpdateFolderBodyDTO: {
             name?: string;
@@ -4312,34 +4317,6 @@ interface operations {
             };
         };
     };
-    V1QuarantinesController_check: {
-        parameters: {
-            query?: {
-                email?: string;
-                phone?: string;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Quarantine status for the respondent */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description email or phone is required */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
     V1InvitationsController_sendNpsInvitations: {
         parameters: {
             query?: never;
@@ -5593,7 +5570,7 @@ interface operations {
                 /** @description Upper bound for createdAt (ISO 8601). */
                 createdTo?: string;
                 /** @description Lifecycle status of the whole invitation. */
-                status?: "invited" | "partially_responded" | "responded" | "failed";
+                status?: "invited" | "partially_responded" | "responded" | "failed" | "skipped";
                 page?: number;
                 limit?: number;
             };
@@ -6640,6 +6617,10 @@ interface operations {
             query?: {
                 /** @description Period in days: 7, 30 or 90, or 0 for the whole history. Defaults to 30. */
                 days?: 0 | 7 | 30 | 90;
+                /** @description Custom period start (YYYY-MM-DD, UTC day, inclusive). With `to`, replaces `days`. */
+                from?: string;
+                /** @description Custom period end (YYYY-MM-DD, UTC day, inclusive). */
+                to?: string;
             };
             header?: never;
             path: {
@@ -7363,6 +7344,8 @@ interface WhatsappAlertRecipient {
     name: string;
     /** Kinds of comment that alert this number (numbers created before this feature only get `woku`). */
     sources: ToolType[];
+    /** `true`: every review of those kinds (recognitions too). `false`: improvements only (default). */
+    allReviews: boolean;
 }
 /** A folder with its breadcrumb path and subtree stats. */
 interface Folder {
@@ -7376,7 +7359,7 @@ interface Folder {
     origin: FolderOrigin | null;
     /** Provider of an integration folder (`shopify`, `pancake`), otherwise `null`. */
     integrationProvider?: string | null;
-    /** WhatsApp numbers alerted when a comment of any tool in the folder is an improvement. */
+    /** WhatsApp numbers alerted when a comment of any tool in the folder is an improvement (or any review, with `allReviews`). */
     whatsappAlertRecipients: WhatsappAlertRecipient[];
     createdAt: string | null;
     stats: FolderStats;
@@ -7446,6 +7429,9 @@ interface DailyPoint {
 interface FolderToolMetrics {
     /** Period in days; `0` is the whole history (then every `previous` window is empty). */
     days: number;
+    /** Custom period (`YYYY-MM-DD`, both inclusive) when one was asked for. */
+    from?: string;
+    to?: string;
     tools: ToolMetrics[];
     /** Daily sums of both windows (2 x `days`). */
     daily: DailyPoint[];
@@ -7949,17 +7935,6 @@ declare class Journeys {
     emitEvent(body: JourneyEventInput, opts?: RequestOptions): Promise<Schemas['V1JourneyEventResponseDto']>;
 }
 
-/** Check respondent quarantine status (`/v1/quarantines`). */
-declare class Quarantines {
-    private readonly client;
-    constructor(client: WokuClient);
-    /** Check whether a contact is quarantined. */
-    check(params: {
-        email?: string;
-        phone?: string | number;
-    }, opts?: RequestOptions): Promise<WokuRecord>;
-}
-
 /**
  * Folders that organize wokus and NPS, CSAT and CES tools (`/v1/folders`).
  * To list what a folder contains use `woku.tools.list({ folderId })`.
@@ -8004,11 +7979,14 @@ declare class Folders {
      * subfolders for a period against the one before it, with the daily sums and
      * the histogram of scores. `days` is 7, 30 (default) or 90, or 0 for the whole
      * history (every `previous` window is then empty). The period is the last
-     * `days` calendar days in UTC, today included. Scales are never mixed across
-     * types.
+     * `days` calendar days in UTC, today included. Or a custom range with `from`
+     * and `to` (`YYYY-MM-DD` UTC days, both inclusive, up to 731 days), which
+     * replaces `days`. Scales are never mixed across types.
      */
     metrics(id: string, params?: {
         days?: 0 | 7 | 30 | 90;
+        from?: string;
+        to?: string;
     }, opts?: RequestOptions): Promise<FolderToolMetrics>;
     /** CSV text with one row per response of every tool of the folder subtree. */
     csv(id: string, opts?: RequestOptions): Promise<FolderCsv>;
@@ -8154,7 +8132,6 @@ declare class Woku {
     readonly company: Company;
     /** Customer journeys: moments, their tools and how each one starts. */
     readonly journeys: Journeys;
-    readonly quarantines: Quarantines;
     /** Folders that organize wokus and NPS, CSAT and CES tools. */
     readonly folders: Folders;
     /** Unified search, headline figures and batch moves across every tool type. */

package/dist/index.d.ts

@@ -1830,6 +1830,11 @@ interface components {
             name: string;
             /** @description Kinds of comment that alert this number. Defaults to all four. */
             sources?: ("woku" | "nps" | "csat" | "ces")[];
+            /**
+             * @description true alerts every review of those kinds (recognitions too); false or absent alerts improvements only.
+             * @default false
+             */
+            allReviews: boolean;
         };
         UpdateFolderBodyDTO: {
             name?: string;
@@ -4312,34 +4317,6 @@ interface operations {
             };
         };
     };
-    V1QuarantinesController_check: {
-        parameters: {
-            query?: {
-                email?: string;
-                phone?: string;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Quarantine status for the respondent */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description email or phone is required */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
     V1InvitationsController_sendNpsInvitations: {
         parameters: {
             query?: never;
@@ -5593,7 +5570,7 @@ interface operations {
                 /** @description Upper bound for createdAt (ISO 8601). */
                 createdTo?: string;
                 /** @description Lifecycle status of the whole invitation. */
-                status?: "invited" | "partially_responded" | "responded" | "failed";
+                status?: "invited" | "partially_responded" | "responded" | "failed" | "skipped";
                 page?: number;
                 limit?: number;
             };
@@ -6640,6 +6617,10 @@ interface operations {
             query?: {
                 /** @description Period in days: 7, 30 or 90, or 0 for the whole history. Defaults to 30. */
                 days?: 0 | 7 | 30 | 90;
+                /** @description Custom period start (YYYY-MM-DD, UTC day, inclusive). With `to`, replaces `days`. */
+                from?: string;
+                /** @description Custom period end (YYYY-MM-DD, UTC day, inclusive). */
+                to?: string;
             };
             header?: never;
             path: {
@@ -7363,6 +7344,8 @@ interface WhatsappAlertRecipient {
     name: string;
     /** Kinds of comment that alert this number (numbers created before this feature only get `woku`). */
     sources: ToolType[];
+    /** `true`: every review of those kinds (recognitions too). `false`: improvements only (default). */
+    allReviews: boolean;
 }
 /** A folder with its breadcrumb path and subtree stats. */
 interface Folder {
@@ -7376,7 +7359,7 @@ interface Folder {
     origin: FolderOrigin | null;
     /** Provider of an integration folder (`shopify`, `pancake`), otherwise `null`. */
     integrationProvider?: string | null;
-    /** WhatsApp numbers alerted when a comment of any tool in the folder is an improvement. */
+    /** WhatsApp numbers alerted when a comment of any tool in the folder is an improvement (or any review, with `allReviews`). */
     whatsappAlertRecipients: WhatsappAlertRecipient[];
     createdAt: string | null;
     stats: FolderStats;
@@ -7446,6 +7429,9 @@ interface DailyPoint {
 interface FolderToolMetrics {
     /** Period in days; `0` is the whole history (then every `previous` window is empty). */
     days: number;
+    /** Custom period (`YYYY-MM-DD`, both inclusive) when one was asked for. */
+    from?: string;
+    to?: string;
     tools: ToolMetrics[];
     /** Daily sums of both windows (2 x `days`). */
     daily: DailyPoint[];
@@ -7949,17 +7935,6 @@ declare class Journeys {
     emitEvent(body: JourneyEventInput, opts?: RequestOptions): Promise<Schemas['V1JourneyEventResponseDto']>;
 }
 
-/** Check respondent quarantine status (`/v1/quarantines`). */
-declare class Quarantines {
-    private readonly client;
-    constructor(client: WokuClient);
-    /** Check whether a contact is quarantined. */
-    check(params: {
-        email?: string;
-        phone?: string | number;
-    }, opts?: RequestOptions): Promise<WokuRecord>;
-}
-
 /**
  * Folders that organize wokus and NPS, CSAT and CES tools (`/v1/folders`).
  * To list what a folder contains use `woku.tools.list({ folderId })`.
@@ -8004,11 +7979,14 @@ declare class Folders {
      * subfolders for a period against the one before it, with the daily sums and
      * the histogram of scores. `days` is 7, 30 (default) or 90, or 0 for the whole
      * history (every `previous` window is then empty). The period is the last
-     * `days` calendar days in UTC, today included. Scales are never mixed across
-     * types.
+     * `days` calendar days in UTC, today included. Or a custom range with `from`
+     * and `to` (`YYYY-MM-DD` UTC days, both inclusive, up to 731 days), which
+     * replaces `days`. Scales are never mixed across types.
      */
     metrics(id: string, params?: {
         days?: 0 | 7 | 30 | 90;
+        from?: string;
+        to?: string;
     }, opts?: RequestOptions): Promise<FolderToolMetrics>;
     /** CSV text with one row per response of every tool of the folder subtree. */
     csv(id: string, opts?: RequestOptions): Promise<FolderCsv>;
@@ -8154,7 +8132,6 @@ declare class Woku {
     readonly company: Company;
     /** Customer journeys: moments, their tools and how each one starts. */
     readonly journeys: Journeys;
-    readonly quarantines: Quarantines;
     /** Folders that organize wokus and NPS, CSAT and CES tools. */
     readonly folders: Folders;
     /** Unified search, headline figures and batch moves across every tool type. */

package/dist/index.js

@@ -36,7 +36,7 @@ var FollowUps = class {
 };
 
 // package.json
-var version = "0.5.0";
+var version = "0.7.0";
 
 // src/core/errors.ts
 var WokuError = class extends Error {
@@ -1575,20 +1575,6 @@ var Journeys = class {
   }
 };
 
-// src/resources/quarantines.ts
-var Quarantines = class {
-  constructor(client) {
-    this.client = client;
-  }
-  /** Check whether a contact is quarantined. */
-  check(params, opts) {
-    return this.client.request("get", "/v1/quarantines/check", {
-      ...opts,
-      query: { ...params, ...opts?.query }
-    });
-  }
-};
-
 // src/resources/folders.ts
 var Folders = class {
   constructor(client) {
@@ -1664,8 +1650,9 @@ var Folders = class {
    * subfolders for a period against the one before it, with the daily sums and
    * the histogram of scores. `days` is 7, 30 (default) or 90, or 0 for the whole
    * history (every `previous` window is then empty). The period is the last
-   * `days` calendar days in UTC, today included. Scales are never mixed across
-   * types.
+   * `days` calendar days in UTC, today included. Or a custom range with `from`
+   * and `to` (`YYYY-MM-DD` UTC days, both inclusive, up to 731 days), which
+   * replaces `days`. Scales are never mixed across types.
    */
   metrics(id, params, opts) {
     return this.client.request(
@@ -1851,7 +1838,6 @@ var Woku = class {
     this.folders = new Folders(this.client);
     this.tools = new Tools(this.client);
     this.journeyFolders = new JourneyFolders(this.client);
-    this.quarantines = new Quarantines(this.client);
   }
 };