featurebase-node 0.0.2

package/resources/admins.d.mts

@@ -0,0 +1,437 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Team members who manage your Featurebase organization. Admins have roles that define their permissions.
+ */
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+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 declare namespace AdminListResponse {
+    /**
+     * 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 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 declare namespace AdminListRolesResponse {
+    interface Data {
+        /**
+         * Role unique identifier
+         */
+        id: string;
+        /**
+         * Role name
+         */
+        name: string;
+        /**
+         * Object type identifier
+         */
+        object: 'admin_role';
+        /**
+         * Role permissions
+         */
+        permissions: Data.Permissions;
+    }
+    namespace Data {
+        /**
+         * Role permissions
+         */
+        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, };
+}
+//# sourceMappingURL=admins.d.mts.map

package/resources/admins.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admins.d.mts","sourceRoot":"","sources":["../src/resources/admins.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAWpB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,SAAS,CACP,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAUtC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;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,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,YAAY,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;YAElC;;eAEG;YACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;YAEnC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}