featurebase-node 0.0.2

package/resources/surveys.mjs

@@ -0,0 +1,145 @@
+// 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";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
+ */
+export class Surveys extends APIResource {
+    /**
+     * Retrieves a single survey by its unique identifier.
+     *
+     * Returns the survey object if found in your organization.
+     *
+     * ### Response
+     *
+     * Returns a survey object with:
+     *
+     * - `id` - Unique identifier
+     * - `title` - Survey title
+     * - `description` - Survey description
+     * - `isActive` - Whether the survey is active
+     * - `responseCount` - Number of responses received
+     * - `targeting` - Targeting configuration
+     * - `pages` - Array of survey pages/questions
+     * - `createdAt` - ISO 8601 timestamp when created
+     * - `updatedAt` - ISO 8601 timestamp when last updated
+     *
+     * ### Survey Pages
+     *
+     * Each page represents a question or screen in the survey:
+     *
+     * - `type` - Page type (text, link, rating, multiple-choice)
+     * - `title` - Question title
+     * - `description` - Optional description
+     * - `logic` - Conditional logic rules
+     * - `defaultAction` - Default action when no logic matches
+     *
+     * ### Errors
+     *
+     * - `404` - Survey not found in your organization
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/surveys/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all surveys configured in your Featurebase organization.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of items to return (1-100, default 10)
+     * - `cursor` - Cursor for pagination
+     * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
+     * - `isActive` - Filter by active status
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of survey objects
+     * - `nextCursor` - Cursor for next page (null if no more results)
+     *
+     * ### Survey Object
+     *
+     * Each survey includes:
+     *
+     * - `id` - Unique identifier
+     * - `title` - Survey title
+     * - `description` - Survey description
+     * - `isActive` - Whether the survey is active
+     * - `responseCount` - Number of responses received
+     * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
+     * - `pages` - Array of survey pages/questions
+     * - `createdAt` - ISO 8601 timestamp when created
+     * - `updatedAt` - ISO 8601 timestamp when last updated
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/surveys', {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves all user responses for a specific survey.
+     *
+     * ### Query Parameters
+     *
+     * - `pageId` - Filter responses to a specific survey page
+     * - `limit` - Number of items to return (1-100, default 10)
+     * - `cursor` - Cursor for pagination
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of survey response objects
+     * - `nextCursor` - Cursor for next page (null if no more results)
+     *
+     * ### Survey Response Object
+     *
+     * Each response includes:
+     *
+     * - `id` - Unique response identifier
+     * - `user` - User who submitted the response (may be null for anonymous)
+     * - `responses` - Array of individual answers
+     * - `createdAt` - ISO 8601 timestamp when submitted
+     *
+     * ### Individual Response
+     *
+     * Each item in the responses array:
+     *
+     * - `pageId` - The survey page this response is for
+     * - `type` - Response type (text, rating, multiple-choice)
+     * - `value` - The response value
+     *
+     * ### Errors
+     *
+     * - `404` - Survey not found in your organization
+     */
+    retrieveResponses(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get(path `/v2/surveys/${id}/responses`, {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=surveys.mjs.map

package/resources/surveys.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"surveys.mjs","sourceRoot":"","sources":["../src/resources/surveys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CACN,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CACF,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;YACrC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,iBAAiB,CACf,EAAU,EACV,SAA2D,EAAE,EAC7D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,YAAY,EAAE;YACzD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/tags.d.mts

@@ -0,0 +1,147 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+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 Tags 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.tags.retrieve(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    retrieve(id: string, params?: TagRetrieveParams | 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
+     * mutation endpoints.
+     *
+     * @example
+     * ```ts
+     * const tags = await client.tags.list();
+     * ```
+     */
+    list(params?: TagListParams | null | undefined, options?: RequestOptions): APIPromise<TagListResponse>;
+    /**
+     * 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 tag = await client.tags.delete(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    delete(id: string, params?: TagDeleteParams | null | undefined, options?: RequestOptions): APIPromise<TagDeleteResponse>;
+    /**
+     * 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.tags.createOrRename({
+     *   name: 'Churn',
+     * });
+     * ```
+     */
+    createOrRename(params: TagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag>;
+}
+export interface ConversationTag {
+    /**
+     * Unique tag identifier
+     */
+    id: string;
+    /**
+     * Current tag name
+     */
+    name: string;
+    /**
+     * Object type identifier for a tag
+     */
+    type: 'tag';
+}
+export interface TagListResponse {
+    /**
+     * Array containing the actual response elements
+     */
+    data: Array<ConversationTag>;
+    /**
+     * Cursor to use for fetching the next page. Null if there are no more results.
+     */
+    nextCursor: string | null;
+    /**
+     * String representing the object type
+     */
+    object: 'list';
+}
+export interface TagDeleteResponse {
+    /**
+     * Unique tag identifier
+     */
+    id: string;
+    /**
+     * Whether the tag has been deleted
+     */
+    deleted: true;
+    /**
+     * Object type identifier
+     */
+    object: 'tag';
+}
+export interface TagRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface TagListParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface TagDeleteParams {
+    /**
+     * Body param: Optional admin ID for actor attribution and permission checks.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface TagCreateOrRenameParams {
+    /**
+     * Body param: Tag name
+     */
+    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.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Tags {
+    export { type ConversationTag as ConversationTag, type TagListResponse as TagListResponse, type TagDeleteResponse as TagDeleteResponse, type TagRetrieveParams as TagRetrieveParams, type TagListParams as TagListParams, type TagDeleteParams as TagDeleteParams, type TagCreateOrRenameParams as TagCreateOrRenameParams, };
+}
+//# sourceMappingURL=tags.d.mts.map

package/resources/tags.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.mts","sourceRoot":"","sources":["../src/resources/tags.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAW9B;;;;;;;;;OASG;IACH,IAAI,CAAC,MAAM,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAW1G;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAYhC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;CAWvG;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,eAAe;IAC9B;;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,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,uBAAuB;IACtC;;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,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/tags.d.ts

@@ -0,0 +1,147 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * 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 Tags 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.tags.retrieve(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    retrieve(id: string, params?: TagRetrieveParams | 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
+     * mutation endpoints.
+     *
+     * @example
+     * ```ts
+     * const tags = await client.tags.list();
+     * ```
+     */
+    list(params?: TagListParams | null | undefined, options?: RequestOptions): APIPromise<TagListResponse>;
+    /**
+     * 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 tag = await client.tags.delete(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    delete(id: string, params?: TagDeleteParams | null | undefined, options?: RequestOptions): APIPromise<TagDeleteResponse>;
+    /**
+     * 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.tags.createOrRename({
+     *   name: 'Churn',
+     * });
+     * ```
+     */
+    createOrRename(params: TagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag>;
+}
+export interface ConversationTag {
+    /**
+     * Unique tag identifier
+     */
+    id: string;
+    /**
+     * Current tag name
+     */
+    name: string;
+    /**
+     * Object type identifier for a tag
+     */
+    type: 'tag';
+}
+export interface TagListResponse {
+    /**
+     * Array containing the actual response elements
+     */
+    data: Array<ConversationTag>;
+    /**
+     * Cursor to use for fetching the next page. Null if there are no more results.
+     */
+    nextCursor: string | null;
+    /**
+     * String representing the object type
+     */
+    object: 'list';
+}
+export interface TagDeleteResponse {
+    /**
+     * Unique tag identifier
+     */
+    id: string;
+    /**
+     * Whether the tag has been deleted
+     */
+    deleted: true;
+    /**
+     * Object type identifier
+     */
+    object: 'tag';
+}
+export interface TagRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface TagListParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface TagDeleteParams {
+    /**
+     * Body param: Optional admin ID for actor attribution and permission checks.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface TagCreateOrRenameParams {
+    /**
+     * Body param: Tag name
+     */
+    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.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Tags {
+    export { type ConversationTag as ConversationTag, type TagListResponse as TagListResponse, type TagDeleteResponse as TagDeleteResponse, type TagRetrieveParams as TagRetrieveParams, type TagListParams as TagListParams, type TagDeleteParams as TagDeleteParams, type TagCreateOrRenameParams as TagCreateOrRenameParams, };
+}
+//# sourceMappingURL=tags.d.ts.map

package/resources/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../src/resources/tags.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAW9B;;;;;;;;;OASG;IACH,IAAI,CAAC,MAAM,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAW1G;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAYhC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;CAWvG;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,eAAe;IAC9B;;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,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,uBAAuB;IACtC;;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,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/tags.js

@@ -0,0 +1,100 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tags = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * 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.
+ */
+class Tags extends resource_1.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.tags.retrieve(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/tags/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns the live conversation tags available in the workspace tag catalog. These
+     * are the canonical tags that power conversation payloads, filters, and tag
+     * mutation endpoints.
+     *
+     * @example
+     * ```ts
+     * const tags = await client.tags.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/tags', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * 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 tag = await client.tags.delete(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
+        return this._client.delete((0, path_1.path) `/v2/tags/${id}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * 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.tags.createOrRename({
+     *   name: 'Churn',
+     * });
+     * ```
+     */
+    createOrRename(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/tags', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Tags = Tags;
+//# sourceMappingURL=tags.js.map

package/resources/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../src/resources/tags.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE;YAC5C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,SAA2C,EAAE,EAAE,OAAwB;QAC1E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAA+B,EAAE,OAAwB;QACtE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAlGD,oBAkGC"}

package/resources/tags.mjs

@@ -0,0 +1,96 @@
+// 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";
+import { path } from "../internal/utils/path.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 class Tags 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.tags.retrieve(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/tags/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns the live conversation tags available in the workspace tag catalog. These
+     * are the canonical tags that power conversation payloads, filters, and tag
+     * mutation endpoints.
+     *
+     * @example
+     * ```ts
+     * const tags = await client.tags.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/tags', {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * 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 tag = await client.tags.delete(
+     *   '67ec1234abcd5678ef901234',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
+        return this._client.delete(path `/v2/tags/${id}`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * 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.tags.createOrRename({
+     *   name: 'Churn',
+     * });
+     * ```
+     */
+    createOrRename(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/tags', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=tags.mjs.map

package/resources/tags.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.mjs","sourceRoot":"","sources":["../src/resources/tags.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE;YAC5C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,SAA2C,EAAE,EAAE,OAAwB;QAC1E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAA+B,EAAE,OAAwB;QACtE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}