featurebase-node 0.0.2

package/resources/custom-fields.d.mts

@@ -0,0 +1,189 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
+ */
+export declare class CustomFields extends APIResource {
+    /**
+     * Retrieves a single custom field by its unique identifier.
+     *
+     * Returns the custom field object if found in your organization.
+     *
+     * ### Response
+     *
+     * Returns a custom field object with:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Errors
+     *
+     * - `404` - Custom field not found in your organization
+     */
+    retrieve(id: string, params?: CustomFieldRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomField>;
+    /**
+     * Returns all custom fields configured in your organization.
+     *
+     * This endpoint returns all custom fields at once (typically a small list). No
+     * pagination is supported.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of custom field objects
+     * - `nextCursor` - Always null
+     *
+     * ### Custom Field Object
+     *
+     * Each custom field includes:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Field Types
+     *
+     * - `text` - Single line text input
+     * - `number` - Numeric input
+     * - `select` - Single-choice dropdown
+     * - `multi-select` - Multiple-choice dropdown
+     * - `checkbox` - Boolean checkbox
+     * - `date` - Date picker
+     */
+    list(params?: CustomFieldListParams | null | undefined, options?: RequestOptions): APIPromise<CustomFieldList>;
+}
+export interface CustomField {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * Field label displayed to users
+     */
+    label: string;
+    /**
+     * Object type identifier
+     */
+    object: 'custom_field';
+    /**
+     * Field type
+     */
+    type: 'text' | 'number' | 'select' | 'multi-select' | 'checkbox' | 'date' | 'file';
+    /**
+     * Whether multiple files can be uploaded (file fields only)
+     */
+    allowMultiple?: boolean;
+    /**
+     * ISO timestamp when created
+     */
+    createdAt?: string;
+    /**
+     * Whether the field is for internal use only
+     */
+    internal?: boolean;
+    /**
+     * Options for select/multi-select fields
+     */
+    options?: Array<CustomField.Option>;
+    /**
+     * Placeholder text
+     */
+    placeholder?: string;
+    /**
+     * Whether the field value is publicly visible
+     */
+    public?: boolean;
+    /**
+     * Whether the field is required
+     */
+    required?: boolean;
+    /**
+     * ISO timestamp when last updated
+     */
+    updatedAt?: string;
+}
+export declare namespace CustomField {
+    interface Option {
+        /**
+         * Option unique identifier
+         */
+        id: string;
+        /**
+         * Option display label
+         */
+        label: string;
+    }
+}
+export interface CustomFieldList {
+    /**
+     * Array of custom fields
+     */
+    data: Array<CustomField>;
+    /**
+     * Cursor for fetching the next page (cursor-based pagination)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+    /**
+     * Pagination metadata for page-based requests
+     */
+    pagination?: CustomFieldList.Pagination;
+}
+export declare namespace CustomFieldList {
+    /**
+     * Pagination metadata for page-based requests
+     */
+    interface Pagination {
+        /**
+         * Items per page
+         */
+        limit: number;
+        /**
+         * Current page number
+         */
+        page: number;
+        /**
+         * Total number of items
+         */
+        total: number;
+        /**
+         * Total number of pages
+         */
+        totalPages: number;
+    }
+}
+export interface CustomFieldRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface CustomFieldListParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace CustomFields {
+    export { type CustomField as CustomField, type CustomFieldList as CustomFieldList, type CustomFieldRetrieveParams as CustomFieldRetrieveParams, type CustomFieldListParams as CustomFieldListParams, };
+}
+//# sourceMappingURL=custom-fields.d.mts.map

package/resources/custom-fields.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.mts","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAW1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAU/B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAEnF;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/custom-fields.d.ts

@@ -0,0 +1,189 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
+ */
+export declare class CustomFields extends APIResource {
+    /**
+     * Retrieves a single custom field by its unique identifier.
+     *
+     * Returns the custom field object if found in your organization.
+     *
+     * ### Response
+     *
+     * Returns a custom field object with:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Errors
+     *
+     * - `404` - Custom field not found in your organization
+     */
+    retrieve(id: string, params?: CustomFieldRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomField>;
+    /**
+     * Returns all custom fields configured in your organization.
+     *
+     * This endpoint returns all custom fields at once (typically a small list). No
+     * pagination is supported.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of custom field objects
+     * - `nextCursor` - Always null
+     *
+     * ### Custom Field Object
+     *
+     * Each custom field includes:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Field Types
+     *
+     * - `text` - Single line text input
+     * - `number` - Numeric input
+     * - `select` - Single-choice dropdown
+     * - `multi-select` - Multiple-choice dropdown
+     * - `checkbox` - Boolean checkbox
+     * - `date` - Date picker
+     */
+    list(params?: CustomFieldListParams | null | undefined, options?: RequestOptions): APIPromise<CustomFieldList>;
+}
+export interface CustomField {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * Field label displayed to users
+     */
+    label: string;
+    /**
+     * Object type identifier
+     */
+    object: 'custom_field';
+    /**
+     * Field type
+     */
+    type: 'text' | 'number' | 'select' | 'multi-select' | 'checkbox' | 'date' | 'file';
+    /**
+     * Whether multiple files can be uploaded (file fields only)
+     */
+    allowMultiple?: boolean;
+    /**
+     * ISO timestamp when created
+     */
+    createdAt?: string;
+    /**
+     * Whether the field is for internal use only
+     */
+    internal?: boolean;
+    /**
+     * Options for select/multi-select fields
+     */
+    options?: Array<CustomField.Option>;
+    /**
+     * Placeholder text
+     */
+    placeholder?: string;
+    /**
+     * Whether the field value is publicly visible
+     */
+    public?: boolean;
+    /**
+     * Whether the field is required
+     */
+    required?: boolean;
+    /**
+     * ISO timestamp when last updated
+     */
+    updatedAt?: string;
+}
+export declare namespace CustomField {
+    interface Option {
+        /**
+         * Option unique identifier
+         */
+        id: string;
+        /**
+         * Option display label
+         */
+        label: string;
+    }
+}
+export interface CustomFieldList {
+    /**
+     * Array of custom fields
+     */
+    data: Array<CustomField>;
+    /**
+     * Cursor for fetching the next page (cursor-based pagination)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+    /**
+     * Pagination metadata for page-based requests
+     */
+    pagination?: CustomFieldList.Pagination;
+}
+export declare namespace CustomFieldList {
+    /**
+     * Pagination metadata for page-based requests
+     */
+    interface Pagination {
+        /**
+         * Items per page
+         */
+        limit: number;
+        /**
+         * Current page number
+         */
+        page: number;
+        /**
+         * Total number of items
+         */
+        total: number;
+        /**
+         * Total number of pages
+         */
+        totalPages: number;
+    }
+}
+export interface CustomFieldRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface CustomFieldListParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace CustomFields {
+    export { type CustomField as CustomField, type CustomFieldList as CustomFieldList, type CustomFieldRetrieveParams as CustomFieldRetrieveParams, type CustomFieldListParams as CustomFieldListParams, };
+}
+//# sourceMappingURL=custom-fields.d.ts.map

package/resources/custom-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAW1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAU/B;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAEnF;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;CACzC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/custom-fields.js

@@ -0,0 +1,92 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFields = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
+ */
+class CustomFields extends resource_1.APIResource {
+    /**
+     * Retrieves a single custom field by its unique identifier.
+     *
+     * Returns the custom field object if found in your organization.
+     *
+     * ### Response
+     *
+     * Returns a custom field object with:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Errors
+     *
+     * - `404` - Custom field not found in your organization
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/custom_fields/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all custom fields configured in your organization.
+     *
+     * This endpoint returns all custom fields at once (typically a small list). No
+     * pagination is supported.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of custom field objects
+     * - `nextCursor` - Always null
+     *
+     * ### Custom Field Object
+     *
+     * Each custom field includes:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Field Types
+     *
+     * - `text` - Single line text input
+     * - `number` - Numeric input
+     * - `select` - Single-choice dropdown
+     * - `multi-select` - Multiple-choice dropdown
+     * - `checkbox` - Boolean checkbox
+     * - `date` - Date picker
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/custom_fields', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.CustomFields = CustomFields;
+//# sourceMappingURL=custom-fields.js.map

package/resources/custom-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.js","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CACN,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,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;AAvFD,oCAuFC"}

package/resources/custom-fields.mjs

@@ -0,0 +1,88 @@
+// 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";
+/**
+ * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
+ */
+export class CustomFields extends APIResource {
+    /**
+     * Retrieves a single custom field by its unique identifier.
+     *
+     * Returns the custom field object if found in your organization.
+     *
+     * ### Response
+     *
+     * Returns a custom field object with:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Errors
+     *
+     * - `404` - Custom field not found in your organization
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/custom_fields/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all custom fields configured in your organization.
+     *
+     * This endpoint returns all custom fields at once (typically a small list). No
+     * pagination is supported.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of custom field objects
+     * - `nextCursor` - Always null
+     *
+     * ### Custom Field Object
+     *
+     * Each custom field includes:
+     *
+     * - `id` - Unique field identifier
+     * - `label` - Field label displayed to users
+     * - `type` - Field type (text, number, select, multi-select, checkbox, date)
+     * - `required` - Whether the field is required
+     * - `placeholder` - Placeholder text (for text/number fields)
+     * - `public` - Whether the field value is publicly visible
+     * - `internal` - Whether the field is for internal use only
+     * - `options` - Array of options (for select/multi-select fields)
+     *
+     * ### Field Types
+     *
+     * - `text` - Single line text input
+     * - `number` - Numeric input
+     * - `select` - Single-choice dropdown
+     * - `multi-select` - Multiple-choice dropdown
+     * - `checkbox` - Boolean checkbox
+     * - `date` - Date picker
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/custom_fields', {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=custom-fields.mjs.map

package/resources/custom-fields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.mjs","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CACN,EAAU,EACV,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,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"}