featurebase-node 0.0.2

package/resources/brands.d.mts

@@ -0,0 +1,180 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
+ */
+export declare class Brands extends APIResource {
+    /**
+     * Retrieves a single brand by its Featurebase ID.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a brand object with:
+     *
+     * - `id` - Featurebase internal ID
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "brand",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Default Brand",
+     *   "isDefault": true,
+     *   "createdAt": "2025-01-01T12:00:00.000Z",
+     *   "updatedAt": "2025-01-10T15:30:00.000Z",
+     *   "helpCenterId": "11",
+     *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Brand with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    retrieve(id: string, params?: BrandRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Brand>;
+    /**
+     * Returns all brands in your organization with cursor-based pagination.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of brands to return (1-100, default: 10)
+     * - `cursor` - Opaque cursor from a previous response for pagination
+     *
+     * ### Response Structure
+     *
+     * The response includes:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of brand objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Brand Object
+     *
+     * Each brand includes:
+     *
+     * - `id` - Featurebase internal ID (MongoDB ObjectId)
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "brand",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "name": "Default Brand",
+     *       "isDefault": true,
+     *       "createdAt": "2025-01-01T12:00:00.000Z",
+     *       "updatedAt": "2025-01-10T15:30:00.000Z",
+     *       "helpCenterId": "11",
+     *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     *     }
+     *   ],
+     *   "nextCursor": null
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params?: BrandListParams | null | undefined, options?: RequestOptions): APIPromise<BrandListResponse>;
+}
+export interface Brand {
+    /**
+     * Featurebase internal ID
+     */
+    id: string;
+    /**
+     * ISO date when brand was created
+     */
+    createdAt: string | null;
+    /**
+     * The ID of the help center associated with this brand
+     */
+    helpCenterId: string | null;
+    /**
+     * Whether this is the default brand
+     */
+    isDefault: boolean;
+    /**
+     * Brand display name
+     */
+    name: string;
+    /**
+     * Object type identifier
+     */
+    object: 'brand';
+    /**
+     * The ID of the default sending email address for this brand
+     */
+    senderEmailAddressId: string | null;
+    /**
+     * ISO date when brand was last updated
+     */
+    updatedAt: string | null;
+}
+export interface BrandListResponse {
+    /**
+     * Array of brands
+     */
+    data: Array<Brand>;
+    /**
+     * Cursor for fetching the next page (cursor-based pagination)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+}
+export interface BrandRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface BrandListParams {
+    /**
+     * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+     * previous response to fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * Query param: A limit on the number of brands to be returned, between 1 and 100.
+     */
+    limit?: number;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Brands {
+    export { type Brand as Brand, type BrandListResponse as BrandListResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandListParams as BrandListParams, };
+}
+//# sourceMappingURL=brands.d.mts.map

package/resources/brands.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brands.d.mts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAWpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAWjC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/brands.d.ts

@@ -0,0 +1,180 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
+ */
+export declare class Brands extends APIResource {
+    /**
+     * Retrieves a single brand by its Featurebase ID.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a brand object with:
+     *
+     * - `id` - Featurebase internal ID
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "brand",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Default Brand",
+     *   "isDefault": true,
+     *   "createdAt": "2025-01-01T12:00:00.000Z",
+     *   "updatedAt": "2025-01-10T15:30:00.000Z",
+     *   "helpCenterId": "11",
+     *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Brand with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    retrieve(id: string, params?: BrandRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Brand>;
+    /**
+     * Returns all brands in your organization with cursor-based pagination.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of brands to return (1-100, default: 10)
+     * - `cursor` - Opaque cursor from a previous response for pagination
+     *
+     * ### Response Structure
+     *
+     * The response includes:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of brand objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Brand Object
+     *
+     * Each brand includes:
+     *
+     * - `id` - Featurebase internal ID (MongoDB ObjectId)
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "brand",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "name": "Default Brand",
+     *       "isDefault": true,
+     *       "createdAt": "2025-01-01T12:00:00.000Z",
+     *       "updatedAt": "2025-01-10T15:30:00.000Z",
+     *       "helpCenterId": "11",
+     *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     *     }
+     *   ],
+     *   "nextCursor": null
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params?: BrandListParams | null | undefined, options?: RequestOptions): APIPromise<BrandListResponse>;
+}
+export interface Brand {
+    /**
+     * Featurebase internal ID
+     */
+    id: string;
+    /**
+     * ISO date when brand was created
+     */
+    createdAt: string | null;
+    /**
+     * The ID of the help center associated with this brand
+     */
+    helpCenterId: string | null;
+    /**
+     * Whether this is the default brand
+     */
+    isDefault: boolean;
+    /**
+     * Brand display name
+     */
+    name: string;
+    /**
+     * Object type identifier
+     */
+    object: 'brand';
+    /**
+     * The ID of the default sending email address for this brand
+     */
+    senderEmailAddressId: string | null;
+    /**
+     * ISO date when brand was last updated
+     */
+    updatedAt: string | null;
+}
+export interface BrandListResponse {
+    /**
+     * Array of brands
+     */
+    data: Array<Brand>;
+    /**
+     * Cursor for fetching the next page (cursor-based pagination)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+}
+export interface BrandRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface BrandListParams {
+    /**
+     * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+     * previous response to fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * Query param: A limit on the number of brands to be returned, between 1 and 100.
+     */
+    limit?: number;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Brands {
+    export { type Brand as Brand, type BrandListResponse as BrandListResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandListParams as BrandListParams, };
+}
+//# sourceMappingURL=brands.d.ts.map

package/resources/brands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAWpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAWjC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/brands.js

@@ -0,0 +1,130 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Brands = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
+ */
+class Brands extends resource_1.APIResource {
+    /**
+     * Retrieves a single brand by its Featurebase ID.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a brand object with:
+     *
+     * - `id` - Featurebase internal ID
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "brand",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Default Brand",
+     *   "isDefault": true,
+     *   "createdAt": "2025-01-01T12:00:00.000Z",
+     *   "updatedAt": "2025-01-10T15:30:00.000Z",
+     *   "helpCenterId": "11",
+     *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Brand with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/brands/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all brands in your organization with cursor-based pagination.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of brands to return (1-100, default: 10)
+     * - `cursor` - Opaque cursor from a previous response for pagination
+     *
+     * ### Response Structure
+     *
+     * The response includes:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of brand objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Brand Object
+     *
+     * Each brand includes:
+     *
+     * - `id` - Featurebase internal ID (MongoDB ObjectId)
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "brand",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "name": "Default Brand",
+     *       "isDefault": true,
+     *       "createdAt": "2025-01-01T12:00:00.000Z",
+     *       "updatedAt": "2025-01-10T15:30:00.000Z",
+     *       "helpCenterId": "11",
+     *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     *     }
+     *   ],
+     *   "nextCursor": null
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/brands', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Brands = Brands;
+//# sourceMappingURL=brands.js.map

package/resources/brands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brands.js","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CACN,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE;YAC9C,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,IAAI,CACF,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YACpC,KAAK;YACL,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;AA7HD,wBA6HC"}

package/resources/brands.mjs

@@ -0,0 +1,126 @@
+// 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";
+/**
+ * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
+ */
+export class Brands extends APIResource {
+    /**
+     * Retrieves a single brand by its Featurebase ID.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a brand object with:
+     *
+     * - `id` - Featurebase internal ID
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "brand",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "name": "Default Brand",
+     *   "isDefault": true,
+     *   "createdAt": "2025-01-01T12:00:00.000Z",
+     *   "updatedAt": "2025-01-10T15:30:00.000Z",
+     *   "helpCenterId": "11",
+     *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Brand with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/brands/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all brands in your organization with cursor-based pagination.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of brands to return (1-100, default: 10)
+     * - `cursor` - Opaque cursor from a previous response for pagination
+     *
+     * ### Response Structure
+     *
+     * The response includes:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of brand objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Brand Object
+     *
+     * Each brand includes:
+     *
+     * - `id` - Featurebase internal ID (MongoDB ObjectId)
+     * - `name` - Brand display name
+     * - `isDefault` - Whether this is the default brand
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     * - `helpCenterId` - Associated help center ID
+     * - `senderEmailAddressId` - Default sender email address ID
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "brand",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "name": "Default Brand",
+     *       "isDefault": true,
+     *       "createdAt": "2025-01-01T12:00:00.000Z",
+     *       "updatedAt": "2025-01-10T15:30:00.000Z",
+     *       "helpCenterId": "11",
+     *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
+     *     }
+     *   ],
+     *   "nextCursor": null
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/brands', {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=brands.mjs.map

package/resources/brands.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"brands.mjs","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CACN,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE;YAC9C,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,IAAI,CACF,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YACpC,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"}