featurebase-node 0.0.2

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { FeaturebaseError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new FeaturebaseError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new FeaturebaseError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new FeaturebaseError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new FeaturebaseError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new FeaturebaseError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';
+export * from './utils/query';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/admins.ts

@@ -0,0 +1,557 @@
+// 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';
+import { path } from '../internal/utils/path';
+
+/**
+ * Team members who manage your Featurebase organization. Admins have roles that define their permissions.
+ */
+export class Admins extends APIResource {
+  /**
+   * Retrieves a single admin by their unique identifier.
+   *
+   * Returns the admin object if found and they belong to your organization.
+   *
+   * ### Response
+   *
+   * Returns an admin object with:
+   *
+   * - `id` - Unique admin identifier
+   * - `name` - Admin's display name
+   * - `email` - Admin's email address
+   * - `picture` - Profile picture URL
+   * - `roleId` - ID of the role assigned to this admin
+   *
+   * ### Errors
+   *
+   * - `404` - Admin not found or doesn't belong to your organization
+   */
+  retrieve(
+    id: string,
+    params: AdminRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Admin> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/admins/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns all admins for your organization.
+   *
+   * This endpoint returns all admins at once (typically a small list). No pagination
+   * is supported.
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of admin objects
+   * - `nextCursor` - Always null
+   *
+   * ### Admin Object
+   *
+   * Each admin includes:
+   *
+   * - `id` - Unique admin identifier
+   * - `name` - Admin's display name
+   * - `email` - Admin's email address
+   * - `picture` - Profile picture URL
+   * - `roleId` - ID of the role assigned to this admin
+   */
+  list(
+    params: AdminListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AdminListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/admins', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns all available admin roles and their permissions.
+   *
+   * This endpoint returns all roles at once (typically a small list). No pagination
+   * is supported.
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of admin role objects
+   * - `nextCursor` - Always null
+   *
+   * ### Admin Role Object
+   *
+   * Each role includes:
+   *
+   * - `id` - Unique role identifier
+   * - `name` - Role name (e.g., "Admin", "Viewer")
+   * - `permissions` - Object containing permission flags
+   *
+   * ### Permissions
+   *
+   * The permissions object contains boolean flags for each permission:
+   *
+   * - `view_comments_private` - Can view private comments
+   * - `manage_comments` - Can manage comments
+   * - `manage_comments_private` - Can manage private comments
+   * - `set_comment_pinned` - Can pin comments
+   * - `moderate_comments` - Can moderate comments
+   * - `set_post_category` - Can change post categories
+   * - `set_post_pinned` - Can pin posts
+   * - `set_post_eta` - Can set post ETA
+   * - `set_post_tags` - Can manage post tags
+   * - `set_post_author` - Can change post author
+   * - `set_post_status` - Can change post status
+   * - `set_post_assignee` - Can assign posts
+   * - `set_post_custom_fields` - Can edit custom fields
+   * - `post_vote_on_behalf` - Can vote on behalf of users
+   * - `post_merge` - Can merge posts
+   * - `post_import` - Can import posts
+   * - `post_export` - Can export posts
+   * - `moderate_posts` - Can moderate posts
+   * - `view_users` - Can view users
+   * - `manage_users` - Can manage users
+   * - `view_posts_private` - Can view private posts
+   * - `view_private_post_tags` - Can view private tags
+   * - `manage_changelogs` - Can manage changelogs
+   * - `manage_surveys` - Can manage surveys
+   * - `manage_branding` - Can manage branding
+   * - `manage_billing` - Can manage billing
+   * - `manage_team_members` - Can manage team members
+   * - `manage_sso` - Can manage SSO settings
+   * - `manage_api` - Can manage API settings
+   * - `manage_statuses` - Can manage statuses
+   * - `manage_boards` - Can manage boards
+   * - `manage_post_tags` - Can manage post tags
+   * - `manage_custom_fields` - Can manage custom fields
+   * - `manage_moderation_settings` - Can manage moderation
+   * - `manage_roadmap` - Can manage roadmap
+   * - `manage_user_roles` - Can manage user roles
+   * - `manage_prioritization` - Can manage prioritization
+   * - `manage_notifications` - Can manage notifications
+   * - `manage_custom_domain` - Can manage custom domain
+   * - `manage_integrations` - Can manage integrations
+   * - `use_integrations` - Can use integrations
+   * - `manage_help_center` - Can manage help center
+   * - `auto_approve_posts` - Posts auto-approved
+   */
+  listRoles(
+    params: AdminListRolesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AdminListRolesResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/admins/roles', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface Admin {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Object type identifier
+   */
+  object: 'admin';
+
+  /**
+   * Admin email address
+   */
+  email?: string;
+
+  /**
+   * Admin display name
+   */
+  name?: string;
+
+  /**
+   * Profile picture URL
+   */
+  profilePicture?: string | null;
+
+  /**
+   * Role ID assigned to this admin
+   */
+  roleId?: string;
+}
+
+export interface AdminListResponse {
+  /**
+   * Array of admins
+   */
+  data: Array<Admin>;
+
+  /**
+   * Cursor for fetching the next page (cursor-based pagination)
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+
+  /**
+   * Pagination metadata for page-based requests
+   */
+  pagination?: AdminListResponse.Pagination;
+}
+
+export namespace AdminListResponse {
+  /**
+   * Pagination metadata for page-based requests
+   */
+  export 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 AdminListRolesResponse {
+  /**
+   * Array of admin roles
+   */
+  data: Array<AdminListRolesResponse.Data>;
+
+  /**
+   * Cursor for fetching the next page (cursor-based pagination)
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export namespace AdminListRolesResponse {
+  export interface Data {
+    /**
+     * Role unique identifier
+     */
+    id: string;
+
+    /**
+     * Role name
+     */
+    name: string;
+
+    /**
+     * Object type identifier
+     */
+    object: 'admin_role';
+
+    /**
+     * Role permissions
+     */
+    permissions: Data.Permissions;
+  }
+
+  export namespace Data {
+    /**
+     * Role permissions
+     */
+    export interface Permissions {
+      /**
+       * Auto-approve posts
+       */
+      auto_approve_posts?: boolean;
+
+      /**
+       * Manage API settings
+       */
+      manage_api?: boolean;
+
+      /**
+       * Manage billing
+       */
+      manage_billing?: boolean;
+
+      /**
+       * Manage boards
+       */
+      manage_boards?: boolean;
+
+      /**
+       * Manage branding
+       */
+      manage_branding?: boolean;
+
+      /**
+       * Manage changelogs
+       */
+      manage_changelogs?: boolean;
+
+      /**
+       * Manage comments
+       */
+      manage_comments?: boolean;
+
+      /**
+       * Manage private comments
+       */
+      manage_comments_private?: boolean;
+
+      /**
+       * Manage conversation tag definitions
+       */
+      manage_conversation_tags?: boolean;
+
+      /**
+       * Manage custom domain
+       */
+      manage_custom_domain?: boolean;
+
+      /**
+       * Manage custom fields
+       */
+      manage_custom_fields?: boolean;
+
+      /**
+       * Manage help center
+       */
+      manage_help_center?: boolean;
+
+      /**
+       * Manage integrations
+       */
+      manage_integrations?: boolean;
+
+      /**
+       * Manage moderation settings
+       */
+      manage_moderation_settings?: boolean;
+
+      /**
+       * Manage notifications
+       */
+      manage_notifications?: boolean;
+
+      /**
+       * Manage post tags
+       */
+      manage_post_tags?: boolean;
+
+      /**
+       * Manage prioritization
+       */
+      manage_prioritization?: boolean;
+
+      /**
+       * Manage roadmap
+       */
+      manage_roadmap?: boolean;
+
+      /**
+       * Manage SSO
+       */
+      manage_sso?: boolean;
+
+      /**
+       * Manage post statuses
+       */
+      manage_statuses?: boolean;
+
+      /**
+       * Manage surveys
+       */
+      manage_surveys?: boolean;
+
+      /**
+       * Manage team members
+       */
+      manage_team_members?: boolean;
+
+      /**
+       * Manage user roles
+       */
+      manage_user_roles?: boolean;
+
+      /**
+       * Manage users
+       */
+      manage_users?: boolean;
+
+      /**
+       * Moderate comments
+       */
+      moderate_comments?: boolean;
+
+      /**
+       * Moderate posts
+       */
+      moderate_posts?: boolean;
+
+      /**
+       * Export posts
+       */
+      post_export?: boolean;
+
+      /**
+       * Import posts
+       */
+      post_import?: boolean;
+
+      /**
+       * Merge posts
+       */
+      post_merge?: boolean;
+
+      /**
+       * Vote on posts on behalf of users
+       */
+      post_vote_on_behalf?: boolean;
+
+      /**
+       * Pin/unpin comments
+       */
+      set_comment_pinned?: boolean;
+
+      /**
+       * Apply and remove conversation tags
+       */
+      set_conversation_tags?: boolean;
+
+      /**
+       * Assign posts
+       */
+      set_post_assignee?: boolean;
+
+      /**
+       * Set post author
+       */
+      set_post_author?: boolean;
+
+      /**
+       * Set post category/board
+       */
+      set_post_category?: boolean;
+
+      /**
+       * Set post custom fields
+       */
+      set_post_custom_fields?: boolean;
+
+      /**
+       * Set post ETA
+       */
+      set_post_eta?: boolean;
+
+      /**
+       * Pin/unpin posts
+       */
+      set_post_pinned?: boolean;
+
+      /**
+       * Set post status
+       */
+      set_post_status?: boolean;
+
+      /**
+       * Set post tags
+       */
+      set_post_tags?: boolean;
+
+      /**
+       * Use integrations
+       */
+      use_integrations?: boolean;
+
+      /**
+       * View private comments
+       */
+      view_comments_private?: boolean;
+
+      /**
+       * View private posts
+       */
+      view_posts_private?: boolean;
+
+      /**
+       * View private post tags
+       */
+      view_private_post_tags?: boolean;
+
+      /**
+       * View users
+       */
+      view_users?: boolean;
+    }
+  }
+}
+
+export interface AdminRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface AdminListParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface AdminListRolesParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace Admins {
+  export {
+    type Admin as Admin,
+    type AdminListResponse as AdminListResponse,
+    type AdminListRolesResponse as AdminListRolesResponse,
+    type AdminRetrieveParams as AdminRetrieveParams,
+    type AdminListParams as AdminListParams,
+    type AdminListRolesParams as AdminListRolesParams,
+  };
+}