featurebase-node 0.13.0 → 0.14.1

package/resources/reports.js

@@ -0,0 +1,238 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reports = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+/**
+ * Query your workspace analytics: conversation volume, response times, CSAT, SLA compliance, teammate performance, AI agent resolutions and more. Start with the datasets catalog to discover metrics and attributes, then run queries with filters, grouping and period comparison.
+ */
+class Reports extends resource_1.APIResource {
+    /**
+     * Returns the reporting catalog: every dataset available to your workspace with
+     * its metrics and attributes.
+     *
+     * This is the discovery endpoint for the reporting API — read it before building
+     * query payloads:
+     *
+     * - **Metrics** carry the `metric` IDs accepted by `POST /v2/reports/query`, plus
+     *   each metric's `allowedAggregations`, unit, and whether it supports
+     *   office-hours restriction and period comparison.
+     * - **Attributes** carry the `fieldId`s accepted in filter rules and the attribute
+     *   IDs accepted as `groupBy` / `segmentBy`, plus each attribute's
+     *   `allowedOperators` and value type. Attributes with `staticOptions` list their
+     *   full value set inline; other filterable attributes resolve values via
+     *   `POST /v2/reports/filter-values`.
+     *
+     * The catalog includes your workspace's custom conversation/ticket attributes
+     * where applicable, so it can differ between workspaces.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.listDatasets();
+     * ```
+     */
+    listDatasets(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/reports/datasets', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Executes an ad-hoc reporting query: one metric + aggregation over a date range,
+     * with optional filters, grouping, segmentation and period-over-period comparison.
+     *
+     * ### Building a query
+     *
+     * 1. Pick a `metric` and `aggregation` from the datasets catalog
+     *    (`GET /v2/reports/datasets`). Counts use `count`; duration metrics support
+     *    `avg`, `median`, `min`, `max` and `percentile` (pass `percentile: 95` for
+     *    p95); rate metrics use `value`.
+     * 2. Set the reporting window with `startDate` / `endDate` (ISO 8601) and a
+     *    `granularity` (`hour`, `day`, `week`, `month`) for the returned time series.
+     * 3. Optionally narrow with `filters` — a rule
+     *    (`{ "kind": "rule", "fieldId": "...", "operator": "in", "value": [...] }`) or
+     *    an `and`/`or` group of rules. Attribute IDs and allowed operators come from
+     *    the catalog.
+     * 4. Optionally break results down with `groupBy` (primary dimension) and
+     *    `segmentBy` (secondary dimension).
+     * 5. Optionally pass `compareStartDate` / `compareEndDate` to get `previousValue`
+     *    / `deltaPercent` alongside every data point.
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "metric": "new_conversations",
+     *   "aggregation": "count",
+     *   "startDate": "2026-06-01",
+     *   "endDate": "2026-06-30",
+     *   "granularity": "day",
+     *   "groupBy": "conversation.channel",
+     *   "filters": {
+     *     "kind": "rule",
+     *     "fieldId": "conversation.state",
+     *     "operator": "is",
+     *     "value": "closed"
+     *   }
+     * }
+     * ```
+     *
+     * ### Response shape
+     *
+     * - `value` — the aggregate across the whole window
+     * - `timeSeries` — one datum per granularity bucket
+     * - `groupedData` / `segmentData` — present when `groupBy` / `segmentBy` were
+     *   requested
+     * - `flowData` — present for `view: "sankey"` (Overview conversation-flow metrics)
+     * - `meta` — echo of the resolved metric, dataset, unit and aggregation
+     *
+     * ### Special views
+     *
+     * - `view: "hourly_heatmap"` buckets by day-of-week × hour-of-day (use with volume
+     *   metrics)
+     * - `view: "sankey"` returns conversation flow edges (Overview metrics only)
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.query({
+     *   aggregation: 'count',
+     *   endDate: '2026-06-30',
+     *   granularity: 'day',
+     *   metric: 'new_conversations',
+     *   startDate: '2026-06-01',
+     * });
+     * ```
+     */
+    query(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/reports/query', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns the available values for a filterable attribute — use it to build valid
+     * `filters` rules for `POST /v2/reports/query`.
+     *
+     * Works for attributes whose values live in your workspace data (tags, teammates,
+     * teams, companies, plans, countries, ...). Attributes with `staticOptions` in the
+     * catalog don't need this endpoint — their value set is already inline.
+     *
+     * - `query` narrows results by search string
+     * - `selectedValues` resolves labels for values you already hold (returned
+     *   alongside search results)
+     *
+     * ### Example
+     *
+     * ```json
+     * { "fieldId": "conversation.tags", "query": "bill", "limit": 20 }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.lookupFilterValues({
+     *   fieldId: 'conversation.tags',
+     * });
+     * ```
+     */
+    lookupFilterValues(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/reports/filter-values', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns the paginated row-level records behind a metric — either the whole
+     * reporting window, or one specific data point from a previous
+     * `POST /v2/reports/query` response.
+     *
+     * Send the **same** `metric`, date range, `granularity`, `filters`, `groupBy` /
+     * `segmentBy` and `view` as the query you're drilling into, plus
+     * `dataPointFilters` selecting the data point:
+     *
+     * - `timeBucket` — a `date` from the time series
+     * - `groupValue` / `segmentValue` — a `group` / `segment` value from grouped data
+     * - `dayOfWeek` + `hourOfDay` — a heatmap cell (`hourly_heatmap` view)
+     * - `flowPathId` or `sourceNodeId` + `targetNodeId` — a flow edge (`sankey` view)
+     *
+     * Pass `dataPointFilters: {}` to list all rows behind the metric for the window.
+     *
+     * Results are paginated with `page` / `pageSize` (max 200 per page);
+     * `availableColumns` describes every column the dataset can return and
+     * `defaultColumnIds` the recommended subset. Rows are keyed by column ID; identity
+     * cells (teammates, contacts) are objects with `id` + `label`.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.drillIn({
+     *   endDate: 'xxxxxxxxxx',
+     *   granularity: 'day',
+     *   metric: 'new_conversations',
+     *   startDate: 'xxxxxxxxxx',
+     * });
+     * ```
+     */
+    drillIn(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/reports/drill-in', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Reports = Reports;
+//# sourceMappingURL=reports.js.map

package/resources/reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAmD;AAGnD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YAAY,CACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,KAAK,CAAC,MAAyB,EAAE,OAAwB;QACvD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC5C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,kBAAkB,CAChB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,CAAC,MAA2B,EAAE,OAAwB;QAC3D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA3OD,0BA2OC"}

package/resources/reports.mjs

@@ -0,0 +1,234 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+/**
+ * Query your workspace analytics: conversation volume, response times, CSAT, SLA compliance, teammate performance, AI agent resolutions and more. Start with the datasets catalog to discover metrics and attributes, then run queries with filters, grouping and period comparison.
+ */
+export class Reports extends APIResource {
+    /**
+     * Returns the reporting catalog: every dataset available to your workspace with
+     * its metrics and attributes.
+     *
+     * This is the discovery endpoint for the reporting API — read it before building
+     * query payloads:
+     *
+     * - **Metrics** carry the `metric` IDs accepted by `POST /v2/reports/query`, plus
+     *   each metric's `allowedAggregations`, unit, and whether it supports
+     *   office-hours restriction and period comparison.
+     * - **Attributes** carry the `fieldId`s accepted in filter rules and the attribute
+     *   IDs accepted as `groupBy` / `segmentBy`, plus each attribute's
+     *   `allowedOperators` and value type. Attributes with `staticOptions` list their
+     *   full value set inline; other filterable attributes resolve values via
+     *   `POST /v2/reports/filter-values`.
+     *
+     * The catalog includes your workspace's custom conversation/ticket attributes
+     * where applicable, so it can differ between workspaces.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.listDatasets();
+     * ```
+     */
+    listDatasets(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/reports/datasets', {
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Executes an ad-hoc reporting query: one metric + aggregation over a date range,
+     * with optional filters, grouping, segmentation and period-over-period comparison.
+     *
+     * ### Building a query
+     *
+     * 1. Pick a `metric` and `aggregation` from the datasets catalog
+     *    (`GET /v2/reports/datasets`). Counts use `count`; duration metrics support
+     *    `avg`, `median`, `min`, `max` and `percentile` (pass `percentile: 95` for
+     *    p95); rate metrics use `value`.
+     * 2. Set the reporting window with `startDate` / `endDate` (ISO 8601) and a
+     *    `granularity` (`hour`, `day`, `week`, `month`) for the returned time series.
+     * 3. Optionally narrow with `filters` — a rule
+     *    (`{ "kind": "rule", "fieldId": "...", "operator": "in", "value": [...] }`) or
+     *    an `and`/`or` group of rules. Attribute IDs and allowed operators come from
+     *    the catalog.
+     * 4. Optionally break results down with `groupBy` (primary dimension) and
+     *    `segmentBy` (secondary dimension).
+     * 5. Optionally pass `compareStartDate` / `compareEndDate` to get `previousValue`
+     *    / `deltaPercent` alongside every data point.
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "metric": "new_conversations",
+     *   "aggregation": "count",
+     *   "startDate": "2026-06-01",
+     *   "endDate": "2026-06-30",
+     *   "granularity": "day",
+     *   "groupBy": "conversation.channel",
+     *   "filters": {
+     *     "kind": "rule",
+     *     "fieldId": "conversation.state",
+     *     "operator": "is",
+     *     "value": "closed"
+     *   }
+     * }
+     * ```
+     *
+     * ### Response shape
+     *
+     * - `value` — the aggregate across the whole window
+     * - `timeSeries` — one datum per granularity bucket
+     * - `groupedData` / `segmentData` — present when `groupBy` / `segmentBy` were
+     *   requested
+     * - `flowData` — present for `view: "sankey"` (Overview conversation-flow metrics)
+     * - `meta` — echo of the resolved metric, dataset, unit and aggregation
+     *
+     * ### Special views
+     *
+     * - `view: "hourly_heatmap"` buckets by day-of-week × hour-of-day (use with volume
+     *   metrics)
+     * - `view: "sankey"` returns conversation flow edges (Overview metrics only)
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.query({
+     *   aggregation: 'count',
+     *   endDate: '2026-06-30',
+     *   granularity: 'day',
+     *   metric: 'new_conversations',
+     *   startDate: '2026-06-01',
+     * });
+     * ```
+     */
+    query(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/reports/query', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns the available values for a filterable attribute — use it to build valid
+     * `filters` rules for `POST /v2/reports/query`.
+     *
+     * Works for attributes whose values live in your workspace data (tags, teammates,
+     * teams, companies, plans, countries, ...). Attributes with `staticOptions` in the
+     * catalog don't need this endpoint — their value set is already inline.
+     *
+     * - `query` narrows results by search string
+     * - `selectedValues` resolves labels for values you already hold (returned
+     *   alongside search results)
+     *
+     * ### Example
+     *
+     * ```json
+     * { "fieldId": "conversation.tags", "query": "bill", "limit": 20 }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.lookupFilterValues({
+     *   fieldId: 'conversation.tags',
+     * });
+     * ```
+     */
+    lookupFilterValues(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/reports/filter-values', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns the paginated row-level records behind a metric — either the whole
+     * reporting window, or one specific data point from a previous
+     * `POST /v2/reports/query` response.
+     *
+     * Send the **same** `metric`, date range, `granularity`, `filters`, `groupBy` /
+     * `segmentBy` and `view` as the query you're drilling into, plus
+     * `dataPointFilters` selecting the data point:
+     *
+     * - `timeBucket` — a `date` from the time series
+     * - `groupValue` / `segmentValue` — a `group` / `segment` value from grouped data
+     * - `dayOfWeek` + `hourOfDay` — a heatmap cell (`hourly_heatmap` view)
+     * - `flowPathId` or `sourceNodeId` + `targetNodeId` — a flow edge (`sankey` view)
+     *
+     * Pass `dataPointFilters: {}` to list all rows behind the metric for the window.
+     *
+     * Results are paginated with `page` / `pageSize` (max 200 per page);
+     * `availableColumns` describes every column the dataset can return and
+     * `defaultColumnIds` the recommended subset. Rows are keyed by column ID; identity
+     * cells (teammates, contacts) are objects with `id` + `label`.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer, and
+     * only for workspaces with the Reports product enabled (404 otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.drillIn({
+     *   endDate: 'xxxxxxxxxx',
+     *   granularity: 'day',
+     *   metric: 'new_conversations',
+     *   startDate: 'xxxxxxxxxx',
+     * });
+     * ```
+     */
+    drillIn(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/reports/drill-in', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=reports.mjs.map

package/resources/reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAGnD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YAAY,CACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,KAAK,CAAC,MAAyB,EAAE,OAAwB;QACvD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC5C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,kBAAkB,CAChB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,CAAC,MAA2B,EAAE,OAAwB;QAC3D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/support/conversation-tags.d.mts

@@ -5,19 +5,6 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  * Conversation tags let you organize, filter, and automate around inbox conversations. Use these endpoints to list, look up, create, rename, and delete workspace conversation tags.
  */
 export declare class ConversationTags extends APIResource {
-    /**
-     * Returns a single conversation tag by its Featurebase tag ID. Archived tags can
-     * still be retrieved directly by ID, while permanently deleted tags return `404`.
-     *
-     * @example
-     * ```ts
-     * const conversationTag =
-     *   await client.support.conversationTags.retrieve(
-     *     '67ec1234abcd5678ef901234',
-     *   );
-     * ```
-     */
-    retrieve(id: string, params?: ConversationTagRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTag>;
     /**
      * Returns the live conversation tags available in the workspace tag catalog. These
      * are the canonical tags that power conversation payloads, filters, and tag
@@ -31,32 +18,45 @@ export declare class ConversationTags extends APIResource {
      */
     list(params?: ConversationTagListParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagListResponse>;
     /**
-     * Deletes a conversation tag from the workspace catalog and removes it from
-     * aggregate conversation tag state. Archived and historical part applications
-     * remain part of the audit trail where applicable.
+     * Creates a new workspace conversation tag when only `name` is provided. If `id`
+     * is also provided, the existing tag is renamed instead.
      *
      * @example
      * ```ts
      * const conversationTag =
-     *   await client.support.conversationTags.delete(
+     *   await client.support.conversationTags.createOrRename({
+     *     name: 'Churn',
+     *   });
+     * ```
+     */
+    createOrRename(params: ConversationTagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag>;
+    /**
+     * Returns a single conversation tag by its Featurebase tag ID. Archived tags can
+     * still be retrieved directly by ID, while permanently deleted tags return `404`.
+     *
+     * @example
+     * ```ts
+     * const conversationTag =
+     *   await client.support.conversationTags.retrieve(
      *     '67ec1234abcd5678ef901234',
      *   );
      * ```
      */
-    delete(id: string, params?: ConversationTagDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagDeleteResponse>;
+    retrieve(id: string, params?: ConversationTagRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTag>;
     /**
-     * Creates a new workspace conversation tag when only `name` is provided. If `id`
-     * is also provided, the existing tag is renamed instead.
+     * Deletes a conversation tag from the workspace catalog and removes it from
+     * aggregate conversation tag state. Archived and historical part applications
+     * remain part of the audit trail where applicable.
      *
      * @example
      * ```ts
      * const conversationTag =
-     *   await client.support.conversationTags.createOrRename({
-     *     name: 'Churn',
-     *   });
+     *   await client.support.conversationTags.delete(
+     *     '67ec1234abcd5678ef901234',
+     *   );
      * ```
      */
-    createOrRename(params: ConversationTagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag>;
+    delete(id: string, params?: ConversationTagDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagDeleteResponse>;
 }
 export interface ConversationTag {
     /**
@@ -100,21 +100,23 @@ export interface ConversationTagDeleteResponse {
      */
     object: 'tag';
 }
-export interface ConversationTagRetrieveParams {
+export interface ConversationTagListParams {
     /**
      * API version for this request. Defaults to your organization's configured API
      * version if not specified.
      */
     'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
-export interface ConversationTagListParams {
+export interface ConversationTagCreateOrRenameParams {
     /**
-     * API version for this request. Defaults to your organization's configured API
-     * version if not specified.
+     * Body param: Tag name
      */
-    'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
-}
-export interface ConversationTagDeleteParams {
+    name: string;
+    /**
+     * Body param: Optional existing tag ID. Provide this to rename an existing tag
+     * instead of creating a new one.
+     */
+    id?: string;
     /**
      * Body param: Optional admin ID for actor attribution and permission checks.
      */
@@ -125,16 +127,14 @@ export interface ConversationTagDeleteParams {
      */
     'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
-export interface ConversationTagCreateOrRenameParams {
-    /**
-     * Body param: Tag name
-     */
-    name: string;
+export interface ConversationTagRetrieveParams {
     /**
-     * Body param: Optional existing tag ID. Provide this to rename an existing tag
-     * instead of creating a new one.
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
      */
-    id?: string;
+    'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+}
+export interface ConversationTagDeleteParams {
     /**
      * Body param: Optional admin ID for actor attribution and permission checks.
      */
@@ -146,6 +146,6 @@ export interface ConversationTagCreateOrRenameParams {
     'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 export declare namespace ConversationTags {
-    export { type ConversationTag as ConversationTag, type ConversationTagListResponse as ConversationTagListResponse, type ConversationTagDeleteResponse as ConversationTagDeleteResponse, type ConversationTagRetrieveParams as ConversationTagRetrieveParams, type ConversationTagListParams as ConversationTagListParams, type ConversationTagDeleteParams as ConversationTagDeleteParams, type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams, };
+    export { type ConversationTag as ConversationTag, type ConversationTagListResponse as ConversationTagListResponse, type ConversationTagDeleteResponse as ConversationTagDeleteResponse, type ConversationTagListParams as ConversationTagListParams, type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams, type ConversationTagRetrieveParams as ConversationTagRetrieveParams, type ConversationTagDeleteParams as ConversationTagDeleteParams, };
 }
 //# sourceMappingURL=conversation-tags.d.mts.map

package/resources/support/conversation-tags.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"conversation-tags.d.mts","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAe9B;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAe1C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAgB5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAe/B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
+{"version":3,"file":"conversation-tags.d.mts","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAe1C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAgB9B;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAe9B;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAe7C;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}