@wokuapp/sdk 0.4.0 → 0.5.0

package/dist/index.js

@@ -36,7 +36,7 @@ var FollowUps = class {
 };
 
 // package.json
-var version = "0.4.0";
+var version = "0.5.0";
 
 // src/core/errors.ts
 var WokuError = class extends Error {
@@ -383,7 +383,8 @@ var WokuClient = class {
           headers,
           bodyText,
           timeout,
-          args.signal
+          args.signal,
+          args.binary
         );
         if (status >= 200 && status < 300) {
           return body;
@@ -500,7 +501,7 @@ var WokuClient = class {
     }
     return headers;
   }
-  async send(url, method, headers, body, timeout, signal) {
+  async send(url, method, headers, body, timeout, signal, binary) {
     if (signal?.aborted)
       throw new WokuConnectionError("Request aborted", { code: "aborted" });
     const controller = new AbortController();
@@ -521,6 +522,20 @@ var WokuClient = class {
         body,
         signal: controller.signal
       });
+      if (binary && response.status >= 200 && response.status < 300) {
+        if (!response.arrayBuffer) {
+          throw new WokuError(
+            "The fetch implementation cannot read binary responses.",
+            { code: "config_error" }
+          );
+        }
+        return {
+          status: response.status,
+          body: new Uint8Array(await response.arrayBuffer()),
+          requestId: requestIdFrom(response.headers),
+          retryAfterSeconds: retryAfterFromHeaders(response.headers)
+        };
+      }
       const text = await response.text();
       return {
         status: response.status,
@@ -719,6 +734,14 @@ var NpsTools = class {
       }
     );
   }
+  /** Move the tool into a folder, or to the root with `folderId: null`. */
+  move(id, body, opts) {
+    return this.client.request(
+      "patch",
+      `/v1/nps-tools/${encodeURIComponent(id)}/move`,
+      { ...opts, body }
+    );
+  }
   delete(id, opts) {
     return this.client.request(
       "delete",
@@ -758,6 +781,14 @@ var CsatTools = class {
       }
     );
   }
+  /** Move the tool into a folder, or to the root with `folderId: null`. */
+  move(id, body, opts) {
+    return this.client.request(
+      "patch",
+      `/v1/csat-tools/${encodeURIComponent(id)}/move`,
+      { ...opts, body }
+    );
+  }
   delete(id, opts) {
     return this.client.request(
       "delete",
@@ -797,6 +828,14 @@ var CesTools = class {
       }
     );
   }
+  /** Move the tool into a folder, or to the root with `folderId: null`. */
+  move(id, body, opts) {
+    return this.client.request(
+      "patch",
+      `/v1/ces-tools/${encodeURIComponent(id)}/move`,
+      { ...opts, body }
+    );
+  }
   delete(id, opts) {
     return this.client.request(
       "delete",
@@ -1014,9 +1053,11 @@ var Flows = class {
   constructor(client) {
     this.client = client;
   }
+  /** List the flows of the company, with their ordered `steps`. */
   list(params, opts) {
     return this.client.getPage("/v1/flows", params, opts);
   }
+  /** The data of a flow: ordered steps with their tools, wokus and branding. */
   get(id, opts) {
     return this.client.request(
       "get",
@@ -1024,6 +1065,33 @@ var Flows = class {
       opts
     );
   }
+  /**
+   * Create a flow from 1 to 20 ordered steps (each tool once, all of your
+   * company). Flows live outside folders.
+   */
+  create(body, opts) {
+    return this.client.request("post", "/v1/flows", {
+      ...opts,
+      body,
+      idempotent: true
+    });
+  }
+  /** Rename a flow or replace its full ordered list of steps. */
+  update(id, body, opts) {
+    return this.client.request(
+      "patch",
+      `/v1/flows/${encodeURIComponent(id)}`,
+      { ...opts, body }
+    );
+  }
+  /** Delete a flow. Its tools and their responses stay. */
+  delete(id, opts) {
+    return this.client.request(
+      "delete",
+      `/v1/flows/${encodeURIComponent(id)}`,
+      opts
+    );
+  }
 };
 
 // src/resources/action-plans.ts
@@ -1521,6 +1589,240 @@ var Quarantines = class {
   }
 };
 
+// src/resources/folders.ts
+var Folders = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Every folder of the company, or the direct subfolders of `parentFolderId`. */
+  list(params, opts) {
+    return this.client.request("get", "/v1/folders", {
+      ...opts,
+      query: { ...params, ...opts?.query }
+    });
+  }
+  get(id, opts) {
+    return this.client.request(
+      "get",
+      `/v1/folders/${encodeURIComponent(id)}`,
+      opts
+    );
+  }
+  create(body, opts) {
+    return this.client.request("post", "/v1/folders", {
+      ...opts,
+      body,
+      idempotent: true
+    });
+  }
+  /**
+   * Rename or recolor a folder (`color: null` clears the color) and/or replace
+   * its WhatsApp alert recipients (`whatsappAlertRecipients`, `[]` clears them).
+   */
+  update(id, body, opts) {
+    return this.client.request(
+      "patch",
+      `/v1/folders/${encodeURIComponent(id)}`,
+      { ...opts, body }
+    );
+  }
+  /**
+   * Move a folder under another folder, or to the root with
+   * `parentFolderId: null`. A folder cannot move into its own subtree.
+   */
+  move(id, body, opts) {
+    return this.client.request(
+      "patch",
+      `/v1/folders/${encodeURIComponent(id)}/move`,
+      { ...opts, body }
+    );
+  }
+  /**
+   * Delete a folder. Nothing inside is deleted: subfolders, wokus and tools
+   * move up to the parent folder (or the root).
+   */
+  delete(id, opts) {
+    return this.client.request(
+      "delete",
+      `/v1/folders/${encodeURIComponent(id)}`,
+      opts
+    );
+  }
+  /**
+   * AI report over every woku, NPS, CSAT and CES tool of the folder and its
+   * subfolders. Scales differ per type, so there is no rating distribution.
+   */
+  report(id, params, opts) {
+    return this.client.request(
+      "get",
+      `/v1/folders/${encodeURIComponent(id)}/report`,
+      { ...opts, query: { ...params, ...opts?.query } }
+    );
+  }
+  /**
+   * Per-tool figures of the woku, NPS, CSAT and CES tools of the folder and its
+   * 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.
+   */
+  metrics(id, params, opts) {
+    return this.client.request(
+      "get",
+      `/v1/folders/${encodeURIComponent(id)}/metrics`,
+      { ...opts, query: { ...params, ...opts?.query } }
+    );
+  }
+  /** CSV text with one row per response of every tool of the folder subtree. */
+  csv(id, opts) {
+    return this.client.request(
+      "get",
+      `/v1/folders/${encodeURIComponent(id)}/csv`,
+      opts
+    );
+  }
+  /**
+   * PDF of the folder report (every woku, NPS, CSAT and CES tool of the folder
+   * and its subfolders) with a breakdown per type on each native scale.
+   * Returns the file bytes: write them to disk or send them as is.
+   */
+  pdf(id, params, opts) {
+    return this.client.request(
+      "get",
+      `/v1/folders/${encodeURIComponent(id)}/pdf`,
+      {
+        ...opts,
+        headers: { Accept: "application/pdf", ...opts?.headers },
+        query: { ...params, ...opts?.query },
+        binary: true
+      }
+    );
+  }
+};
+
+// src/resources/tools.ts
+var ToolsPage = class {
+  constructor(response, fetchNext, fetchMoreFolders = () => Promise.reject(new RangeError("No more folders"))) {
+    this.fetchNext = fetchNext;
+    this.fetchMoreFolders = fetchMoreFolders;
+    this.folders = response.folders;
+    this.tools = response.tools;
+    this.nextCursor = response.nextCursor;
+    this.foldersNextCursor = response.foldersNextCursor ?? null;
+    this.facets = response.facets;
+  }
+  hasMoreFolders() {
+    return this.foldersNextCursor !== null;
+  }
+  /** The next page of folders ("see more"): a page with those folders and no tools. */
+  getMoreFolders() {
+    if (this.foldersNextCursor === null)
+      throw new RangeError("No more folders");
+    return this.fetchMoreFolders(this.foldersNextCursor);
+  }
+  hasNextPage() {
+    return this.nextCursor !== null;
+  }
+  getNextPage() {
+    if (this.nextCursor === null) throw new RangeError("No next page");
+    return this.fetchNext(this.nextCursor);
+  }
+  async *iterPages() {
+    yield this;
+    if (this.hasNextPage()) yield* (await this.getNextPage()).iterPages();
+  }
+  async *[Symbol.asyncIterator]() {
+    for await (const page of this.iterPages()) {
+      for (const tool of page.tools) yield tool;
+    }
+  }
+};
+var Tools = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List one folder level (or search the company). Folders and tools of every
+   * type come together; the first page also carries the folders and facets.
+   */
+  async list(params, opts) {
+    const fetchPage = async (cursor, foldersCursor) => {
+      const response = await this.client.request(
+        "get",
+        "/v1/tools",
+        {
+          ...opts,
+          query: {
+            ...params,
+            types: params?.types?.join(","),
+            ...cursor ? { cursor } : {},
+            ...foldersCursor ? { foldersCursor } : {},
+            ...opts?.query
+          }
+        }
+      );
+      return new ToolsPage(
+        response,
+        fetchPage,
+        (next) => fetchPage(void 0, next)
+      );
+    };
+    return fetchPage();
+  }
+  /**
+   * Headline figures per type (woku stars, NPS score, CSAT satisfied %, CES
+   * mean) for the company or one folder and its subfolders, in a period.
+   * A type that fails reports `{ error: true }`; the others stay valid.
+   */
+  stats(params, opts) {
+    return this.client.request("get", "/v1/tools/stats", {
+      ...opts,
+      query: { ...params, ...opts?.query }
+    });
+  }
+  /**
+   * Move up to 200 items of mixed types (`woku`, `nps`, `csat`, `ces`,
+   * `folder`) into a folder, or to the root with `folderId: null`. Idempotent;
+   * nothing moves if one item or the destination is not found.
+   */
+  move(body, opts) {
+    return this.client.request("post", "/v1/tools/move", {
+      ...opts,
+      body
+    });
+  }
+};
+
+// src/resources/journey-folders.ts
+var JourneyFolders = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Whether the organization is on, running, and how much is still without a folder. */
+  status(opts) {
+    return this.client.request(
+      "get",
+      "/v1/journey-folders",
+      opts
+    );
+  }
+  /**
+   * Switch the organization on and run the one-off pass in the background: tools
+   * of existing journeys without a folder move into their moment folder, and
+   * tools journeys create from now on are placed there. Tools that already have
+   * a folder are never touched. Rejects with a conflict (409) while a pass is
+   * already running; poll {@link status} for progress.
+   */
+  organize(opts) {
+    return this.client.request(
+      "post",
+      "/v1/journey-folders/organize",
+      opts
+    );
+  }
+};
+
 // src/woku.ts
 var Woku = class {
   constructor(options) {
@@ -1546,10 +1848,13 @@ var Woku = class {
     this.reports = new Reports(this.client);
     this.company = new Company(this.client);
     this.journeys = new Journeys(this.client);
+    this.folders = new Folders(this.client);
+    this.tools = new Tools(this.client);
+    this.journeyFolders = new JourneyFolders(this.client);
     this.quarantines = new Quarantines(this.client);
   }
 };
 
-export { AuthenticationError, BadRequestError, ConflictError, FollowUps, InternalServerError, Journeys, Media, NotFoundError, Page, PayloadTooLargeError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, Woku, WokuAPIError, WokuClient, WokuConnectionError, WokuError, WokuTimeoutError };
+export { AuthenticationError, BadRequestError, ConflictError, Folders, FollowUps, InternalServerError, JourneyFolders, Journeys, Media, NotFoundError, Page, PayloadTooLargeError, PermissionDeniedError, RateLimitError, Tools, ToolsPage, UnprocessableEntityError, Woku, WokuAPIError, WokuClient, WokuConnectionError, WokuError, WokuTimeoutError };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map