featurebase-node 0.0.2

package/src/resources/changelogs/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+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';
+export {
+  Subscribers,
+  type SubscriberAddResponse,
+  type SubscriberRemoveResponse,
+  type SubscriberAddParams,
+  type SubscriberRemoveParams,
+} from './subscribers';

package/src/resources/changelogs/subscribers.ts

@@ -0,0 +1,226 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.
+ */
+export 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> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post('/v2/changelogs/subscribers', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.delete('/v2/changelogs/subscribers', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+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,
+  };
+}

package/src/resources/changelogs.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './changelogs/index';