featurebase-node 0.0.2

package/resources/changelogs/subscribers.d.ts

@@ -0,0 +1,145 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * 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.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subscribers.d.ts","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"}

package/resources/changelogs/subscribers.js

@@ -0,0 +1,119 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscribers = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+/**
+ * Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.
+ */
+class Subscribers extends resource_1.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, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/changelogs/subscribers', {
+            body,
+            ...options,
+            headers: (0, headers_1.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, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.delete('/v2/changelogs/subscribers', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Subscribers = Subscribers;
+//# sourceMappingURL=subscribers.js.map

package/resources/changelogs/subscribers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribers.js","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAGtD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAA2B,EAAE,OAAwB;QACvD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;YACvD,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;AA5GD,kCA4GC"}

package/resources/changelogs/subscribers.mjs

@@ -0,0 +1,115 @@
+// 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";
+/**
+ * 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, options) {
+        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, options) {
+        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,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=subscribers.mjs.map

package/resources/changelogs/subscribers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribers.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAA2B,EAAE,OAAwB;QACvD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,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,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;YACvD,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"}

package/resources/changelogs.d.mts

@@ -0,0 +1,2 @@
+export * from "./changelogs/index.mjs";
+//# sourceMappingURL=changelogs.d.mts.map

package/resources/changelogs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelogs.d.mts","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":""}

package/resources/changelogs.d.ts

@@ -0,0 +1,2 @@
+export * from "./changelogs/index.js";
+//# sourceMappingURL=changelogs.d.ts.map

package/resources/changelogs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelogs.d.ts","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":""}

package/resources/changelogs.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./changelogs/index.js"), exports);
+//# sourceMappingURL=changelogs.js.map

package/resources/changelogs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelogs.js","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gEAAmC"}

package/resources/changelogs.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./changelogs/index.mjs";
+//# sourceMappingURL=changelogs.mjs.map

package/resources/changelogs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../src/resources/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF"}