featurebase-node 0.0.2

package/resources/changelogs/changelogs.mjs

@@ -0,0 +1,401 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as SubscribersAPI from "./subscribers.mjs";
+import { Subscribers, } from "./subscribers.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.
+ */
+export class Changelogs extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.subscribers = new SubscribersAPI.Subscribers(this._client);
+    }
+    /**
+     * Creates a new changelog for the authenticated organization.
+     *
+     * ### Required Fields
+     *
+     * - `title` - The title of the changelog
+     *
+     * ### Content
+     *
+     * Provide content in one of two formats (at least one is required):
+     *
+     * - `htmlContent` - HTML content of the changelog
+     * - `markdownContent` - Markdown content of the changelog
+     *
+     * **Note:** For images in content, you can use:
+     *
+     * - External URLs in img src attributes (automatically uploaded to our storage)
+     * - Base64 encoded data URIs (data:image/...) which are processed and stored
+     *
+     * ### Optional Fields
+     *
+     * - `categories` - Array of category names (e.g., ["New", "Fixed", "Improved"])
+     * - `featuredImage` - URL of the featured image (external URLs are uploaded to our
+     *   storage)
+     * - `allowedSegmentIds` - Array of segment IDs that are allowed to view the
+     *   changelog
+     * - `locale` - The locale of the changelog (defaults to organization default)
+     * - `date` - The date of the changelog
+     * - `state` - The state of the changelog: `draft` (default) or `live`
+     *
+     * ### Response
+     *
+     * Returns the created changelog object.
+     *
+     * @example
+     * ```ts
+     * const changelog = await client.changelogs.create({
+     *   title: 'New Features Update',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/changelogs', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a single changelog by its unique identifier or slug.
+     *
+     * Returns the full changelog object including:
+     *
+     * - Title and content (in HTML and markdown formats)
+     * - Featured image
+     * - Publication date
+     * - Categories
+     * - Comment count
+     * - Email notification status
+     *
+     * ### Localization
+     *
+     * The changelog content is returned in the organization's default locale. If the
+     * changelog doesn't exist in the default locale, the first available locale is
+     * used.
+     *
+     * ### State
+     *
+     * Both published (`live`) and draft changelogs can be retrieved. The `state` field
+     * indicates the current publication status.
+     *
+     * @example
+     * ```ts
+     * const changelog = await client.changelogs.retrieve(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/changelogs/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Updates an existing changelog by its unique identifier.
+     *
+     * You can update:
+     *
+     * - **title** - The changelog title
+     * - **htmlContent** - HTML content (one of htmlContent or markdownContent)
+     * - **markdownContent** - Markdown content (one of htmlContent or markdownContent)
+     * - **categories** - Array of category names
+     * - **featuredImage** - Featured image URL
+     * - **allowedSegmentIds** - Segment IDs for access control
+     * - **date** - The date of the changelog
+     *
+     * ### Content Format
+     *
+     * Provide content in one of two formats:
+     *
+     * - `htmlContent` - HTML content of the changelog
+     * - `markdownContent` - Markdown content of the changelog
+     *
+     * **Note:** For images in content, you can use:
+     *
+     * - External URLs in img src attributes (automatically uploaded to our storage)
+     * - Base64 encoded data URIs (data:image/...) which are processed and stored
+     *
+     * ### Categories
+     *
+     * Provide category names as an array. The categories must already exist in your
+     * organization.
+     *
+     * **Example:** `["New", "Fixed", "Improved"]`
+     *
+     * ### Response
+     *
+     * Returns the updated changelog object with all fields populated.
+     *
+     * ### Errors
+     *
+     * - `400` - Invalid changelog ID format or invalid input
+     * - `404` - Changelog not found or doesn't belong to your organization
+     *
+     * @example
+     * ```ts
+     * const changelog = await client.changelogs.update(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    update(id, params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.patch(path `/v2/changelogs/${id}`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all changelogs for the authenticated organization.
+     *
+     * Changelogs are release notes and updates that keep users informed about new
+     * features, improvements, and bug fixes. Each changelog can have:
+     *
+     * - Multiple translations (locales)
+     * - Categories for organization
+     * - Featured images
+     * - Scheduled publishing
+     *
+     * ### Pagination
+     *
+     * This endpoint uses **cursor-based pagination**:
+     *
+     * - `limit` - Number of changelogs to return (1-100, default 10)
+     * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
+     *
+     * **Example:** To paginate through results:
+     *
+     * 1. First request: `GET /v2/changelogs?limit=10`
+     * 2. If `nextCursor` is not null, use it for the next page
+     * 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of changelog objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Filtering
+     *
+     * Filter changelogs using query parameters:
+     *
+     * - `id` - Find a specific changelog by ID or slug
+     * - `q` - Search query for title/content
+     * - `categories` - Filter by category names
+     * - `locale` - Get changelogs in a specific locale (defaults to org default)
+     * - `state` - Filter by state: `live`, `draft`, or `all`
+     * - `startDate` - Include changelogs dated on or after this date
+     * - `endDate` - Include changelogs dated on or before this date
+     *
+     * ### Sorting
+     *
+     * Results are sorted by date (descending by default):
+     *
+     * - `sortBy` - Field to sort by (currently only `date`)
+     * - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
+     *
+     * @example
+     * ```ts
+     * const changelogs = await client.changelogs.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/changelogs', {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Deletes a changelog by its unique identifier.
+     *
+     * ### Deletion Behavior
+     *
+     * The changelog and all associated comments are permanently deleted. This action
+     * cannot be undone.
+     *
+     * ### Permissions
+     *
+     * Only organization admins can delete changelogs.
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation:
+     *
+     * ```json
+     * {
+     *   "id": "6457e3ff70afca5d8c27dccc",
+     *   "object": "changelog",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Errors
+     *
+     * - `400` - Invalid changelog ID format
+     * - `404` - Changelog not found or doesn't belong to your organization
+     *
+     * @example
+     * ```ts
+     * const changelog = await client.changelogs.delete(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete(path `/v2/changelogs/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Publishes a changelog and optionally sends an email notification to subscribers.
+     *
+     * ### Optional Fields
+     *
+     * - `sendEmail` - Whether to send an email notification to subscribers (default:
+     *   false)
+     * - `locales` - Array of locales to publish. An empty array publishes to all
+     *   available locales
+     * - `scheduledDate` - A future date/time when the changelog should be published
+     *
+     * ### Scheduling
+     *
+     * If `scheduledDate` is provided:
+     *
+     * - Must be a future date
+     * - The changelog will be scheduled for publishing at that time
+     * - Any existing scheduled publish for the same locales will be cancelled and
+     *   replaced
+     *
+     * ### Email Notifications
+     *
+     * If `sendEmail` is true:
+     *
+     * - Email notifications are sent to all subscribers in the published locales
+     * - Emails are only sent once per locale (won't resend on republish)
+     *
+     * ### Response
+     *
+     * Returns a success confirmation:
+     *
+     * ```json
+     * {
+     *   "success": true,
+     *   "state": "published"
+     * }
+     * ```
+     *
+     * Or for scheduled publishes:
+     *
+     * ```json
+     * {
+     *   "success": true,
+     *   "state": "scheduled"
+     * }
+     * ```
+     *
+     * ### Errors
+     *
+     * - `400` - Invalid changelog ID or scheduled date is not in the future
+     * - `404` - Changelog not found or doesn't belong to your organization
+     *
+     * @example
+     * ```ts
+     * const publishUnpublishSuccess =
+     *   await client.changelogs.publish(
+     *     '507f1f77bcf86cd799439011',
+     *   );
+     * ```
+     */
+    publish(id, params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post(path `/v2/changelogs/${id}/publish`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Unpublishes a changelog, removing it from public view.
+     *
+     * ### Optional Fields
+     *
+     * - `locales` - Array of locales to unpublish from. An empty array unpublishes
+     *   from all locales
+     *
+     * ### Behavior
+     *
+     * - The changelog content is preserved (reverts to draft state)
+     * - Any scheduled publishes for the specified locales are cancelled
+     * - The changelog can be re-published later
+     *
+     * ### Response
+     *
+     * Returns a success confirmation:
+     *
+     * ```json
+     * {
+     *   "success": true,
+     *   "state": "unpublished"
+     * }
+     * ```
+     *
+     * ### Errors
+     *
+     * - `400` - Invalid changelog ID format
+     * - `404` - Changelog not found or doesn't belong to your organization
+     *
+     * @example
+     * ```ts
+     * const publishUnpublishSuccess =
+     *   await client.changelogs.unpublish(
+     *     '507f1f77bcf86cd799439011',
+     *   );
+     * ```
+     */
+    unpublish(id, params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post(path `/v2/changelogs/${id}/unpublish`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+Changelogs.Subscribers = Subscribers;
+//# sourceMappingURL=changelogs.mjs.map

package/resources/changelogs/changelogs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAKL,WAAW,GACZ;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2ZzF,CAAC;IAzZC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,MAAM,CAAC,MAA6B,EAAE,OAAwB;QAC5D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YAClD,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+CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA6B,EAAE,OAAwB;QACxE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YACpD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,IAAI,CACF,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE;YACxC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,OAAO,CACL,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,UAAU,EAAE;YAC3D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,SAAS,CACP,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,YAAY,EAAE;YAC7D,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;AA2qBD,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC"}

package/resources/changelogs/index.d.mts

@@ -0,0 +1,3 @@
+export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogListResponse, type ChangelogDeleteResponse, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogListParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, } from "./changelogs.mjs";
+export { Subscribers, type SubscriberAddResponse, type SubscriberRemoveResponse, type SubscriberAddParams, type SubscriberRemoveParams, } from "./subscribers.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/changelogs/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"OAEO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,GAC9B;OACM,EACL,WAAW,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B"}

package/resources/changelogs/index.d.ts

@@ -0,0 +1,3 @@
+export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogListResponse, type ChangelogDeleteResponse, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogListParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, } from "./changelogs.js";
+export { Subscribers, type SubscriberAddResponse, type SubscriberRemoveResponse, type SubscriberAddParams, type SubscriberRemoveParams, } from "./subscribers.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/changelogs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"OAEO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,GAC9B;OACM,EACL,WAAW,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B"}

package/resources/changelogs/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscribers = exports.Changelogs = void 0;
+var changelogs_1 = require("./changelogs.js");
+Object.defineProperty(exports, "Changelogs", { enumerable: true, get: function () { return changelogs_1.Changelogs; } });
+var subscribers_1 = require("./subscribers.js");
+Object.defineProperty(exports, "Subscribers", { enumerable: true, get: function () { return subscribers_1.Subscribers; } });
+//# sourceMappingURL=index.js.map

package/resources/changelogs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAasB;AAZpB,wGAAA,UAAU,OAAA;AAaZ,gDAMuB;AALrB,0GAAA,WAAW,OAAA"}

package/resources/changelogs/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Changelogs, } from "./changelogs.mjs";
+export { Subscribers, } from "./subscribers.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/changelogs/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,UAAU,GAYX;OACM,EACL,WAAW,GAKZ"}

package/resources/changelogs/subscribers.d.mts

@@ -0,0 +1,145 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.
+ */
+export declare class Subscribers extends APIResource {
+    /**
+     * Adds email addresses as changelog subscribers in bulk.
+     *
+     * Subscribers will receive email notifications when new changelogs are published
+     * (if email notifications are enabled during publishing).
+     *
+     * ### Request Body
+     *
+     * - `emails` - Array of email addresses to add (required, 1-1000 emails)
+     * - `locale` - Locale for the subscribers (optional, defaults to organization
+     *   default)
+     *
+     * ### Email Validation
+     *
+     * - Invalid email addresses are automatically filtered out
+     * - Emails are normalized (trimmed, lowercased)
+     * - Duplicate emails are deduplicated
+     *
+     * ### Rate Limiting
+     *
+     * This endpoint is rate limited to prevent abuse. If you need to import more
+     * subscribers, please contact support.
+     *
+     * ### Response
+     *
+     * Returns a confirmation with the count of processed emails:
+     *
+     * ```json
+     * {
+     *   "object": "changelog_subscribers_import",
+     *   "count": 150
+     * }
+     * ```
+     *
+     * ### Errors
+     *
+     * - `400` - Invalid request (empty emails array, too many emails)
+     * - `429` - Rate limit exceeded
+     *
+     * @example
+     * ```ts
+     * const response = await client.changelogs.subscribers.add({
+     *   emails: ['john@example.com', 'jane@example.com'],
+     * });
+     * ```
+     */
+    add(params: SubscriberAddParams, options?: RequestOptions): APIPromise<SubscriberAddResponse>;
+    /**
+     * Removes email addresses from changelog subscribers in bulk.
+     *
+     * Removed subscribers will no longer receive email notifications when new
+     * changelogs are published.
+     *
+     * ### Request Body
+     *
+     * - `emails` - Array of email addresses to remove (required, 1-1000 emails)
+     *
+     * ### Email Handling
+     *
+     * - Emails that don't exist as subscribers are silently ignored
+     * - Emails are normalized (trimmed, lowercased) before matching
+     *
+     * ### Response
+     *
+     * Returns a confirmation with the count of processed emails:
+     *
+     * ```json
+     * {
+     *   "object": "changelog_subscribers_removal",
+     *   "count": 150
+     * }
+     * ```
+     *
+     * ### Errors
+     *
+     * - `400` - Invalid request (empty emails array, too many emails)
+     *
+     * @example
+     * ```ts
+     * const subscriber =
+     *   await client.changelogs.subscribers.remove({
+     *     emails: ['john@example.com', 'jane@example.com'],
+     *   });
+     * ```
+     */
+    remove(params: SubscriberRemoveParams, options?: RequestOptions): APIPromise<SubscriberRemoveResponse>;
+}
+export interface SubscriberAddResponse {
+    /**
+     * Number of email addresses processed
+     */
+    count: number;
+    /**
+     * Object type identifier
+     */
+    object: 'changelog_subscribers_import';
+}
+export interface SubscriberRemoveResponse {
+    /**
+     * Number of email addresses processed
+     */
+    count: number;
+    /**
+     * Object type identifier
+     */
+    object: 'changelog_subscribers_removal';
+}
+export interface SubscriberAddParams {
+    /**
+     * Body param: Array of email addresses to add as changelog subscribers
+     */
+    emails: Array<string>;
+    /**
+     * Body param: The locale for the subscribers. Defaults to organization default
+     * locale.
+     */
+    locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface SubscriberRemoveParams {
+    /**
+     * Body param: Array of email addresses to remove from changelog subscribers
+     */
+    emails: Array<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 Subscribers {
+    export { type SubscriberAddResponse as SubscriberAddResponse, type SubscriberRemoveResponse as SubscriberRemoveResponse, type SubscriberAddParams as SubscriberAddParams, type SubscriberRemoveParams as SubscriberRemoveParams, };
+}
+//# sourceMappingURL=subscribers.d.mts.map

package/resources/changelogs/subscribers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribers.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAY7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAWvG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}