featurebase-node 0.1.0 → 0.2.0

package/src/client.ts

@@ -17,78 +17,6 @@ import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
-import {
-  Admin,
-  AdminListParams,
-  AdminListResponse,
-  AdminListRolesParams,
-  AdminListRolesResponse,
-  AdminRetrieveParams,
-  Admins,
-} from './resources/admins';
-import { Board, BoardListParams, BoardListResponse, BoardRetrieveParams, Boards } from './resources/boards';
-import { Brand, BrandListParams, BrandListResponse, BrandRetrieveParams, Brands } from './resources/brands';
-import {
-  Comment,
-  CommentCreateParams,
-  CommentDelete0Params,
-  CommentDelete0Response,
-  CommentDelete1Params,
-  CommentDelete1Response,
-  CommentListParams,
-  CommentListResponse,
-  CommentRetrieveParams,
-  CommentUpdateParams,
-  Comments,
-} from './resources/comments';
-import {
-  CustomField,
-  CustomFieldList,
-  CustomFieldListParams,
-  CustomFieldRetrieveParams,
-  CustomFields,
-} from './resources/custom-fields';
-import {
-  PostStatus,
-  PostStatusListParams,
-  PostStatusListResponse,
-  PostStatusRetrieveParams,
-  PostStatuses,
-} from './resources/post-statuses';
-import {
-  Survey,
-  SurveyListParams,
-  SurveyListResponse,
-  SurveyNextAction,
-  SurveyRetrieveParams,
-  SurveyRetrieveResponsesParams,
-  SurveyRetrieveResponsesResponse,
-  Surveys,
-} from './resources/surveys';
-import {
-  ConversationTag,
-  TagCreateOrRenameParams,
-  TagDeleteParams,
-  TagDeleteResponse,
-  TagListParams,
-  TagListResponse,
-  TagRetrieveParams,
-  Tags,
-} from './resources/tags';
-import { Team, TeamListParams, TeamListResponse, TeamRetrieveParams, Teams } from './resources/teams';
-import {
-  Webhook,
-  WebhookCreateParams,
-  WebhookDeleteParams,
-  WebhookDeleteResponse,
-  WebhookListParams,
-  WebhookListResponse,
-  WebhookRefreshSecretParams,
-  WebhookRequestConfigInput,
-  WebhookRetrieveParams,
-  WebhookUpdateParams,
-  Webhooks,
-} from './resources/webhooks';
 import {
   Changelog,
   ChangelogCreateParams,
@@ -103,79 +31,12 @@ import {
   Changelogs,
   PublishUnpublishSuccess,
 } from './resources/changelogs/changelogs';
-import {
-  Companies,
-  Company,
-  CompanyCreateOrUpdateParams,
-  CompanyDeleteByCompanyIDParams,
-  CompanyDeleteParams,
-  CompanyListParams,
-  CompanyListResponse,
-  CompanyRetrieveParams,
-  DeletedCompany,
-} from './resources/companies/companies';
-import {
-  Contact,
-  ContactBlockParams,
-  ContactBlockResponse,
-  ContactCreateOrUpdateParams,
-  ContactCreateOrUpdateResponse,
-  ContactDeleteParams,
-  ContactList,
-  ContactListParams,
-  ContactRetrieveParams,
-  ContactRetrieveResponse,
-  ContactUnblockParams,
-  ContactUnblockResponse,
-  Contacts,
-  DeletedContact,
-} from './resources/contacts/contacts';
-import {
-  Conversation,
-  ConversationCreateParams,
-  ConversationDeleteParams,
-  ConversationDeleteResponse,
-  ConversationListParams,
-  ConversationListResponse,
-  ConversationPart,
-  ConversationPartAuthor,
-  ConversationParticipant,
-  ConversationRedactParams,
-  ConversationReplyParams,
-  ConversationRetrieveParams,
-  ConversationTagApplication,
-  ConversationUpdateParams,
-  Conversations,
-  CsatEmailDelivery,
-  CsatRatedAgent,
-  CsatWorkflowLink,
-  EmailRecipients,
-} from './resources/conversations/conversations';
+import { Feedback } from './resources/feedback/feedback';
 import { HelpCenter } from './resources/help-center/help-center';
-import {
-  Post,
-  PostCreateParams,
-  PostDeleteParams,
-  PostDeleteResponse,
-  PostListParams,
-  PostListResponse,
-  PostRetrieveParams,
-  PostUpdateParams,
-  Posts,
-} from './resources/posts/posts';
-import {
-  AuthorInput,
-  Ticket,
-  TicketCreateParams,
-  TicketDeleteParams,
-  TicketDeleteResponse,
-  TicketListParams,
-  TicketListResponse,
-  TicketReplyParams,
-  TicketRetrieveParams,
-  TicketUpdateParams,
-  Tickets,
-} from './resources/tickets/tickets';
+import { Integrations } from './resources/integrations/integrations';
+import { Organization } from './resources/organization/organization';
+import { Products } from './resources/products/products';
+import { Users } from './resources/users/users';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -885,121 +746,30 @@ export class Featurebase {
 
   static toFile = Uploads.toFile;
 
-  /**
-   * Boards (post categories) organize feedback into distinct containers with their own settings.
-   */
-  boards: API.Boards = new API.Boards(this);
-  /**
-   * User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.
-   */
-  posts: API.Posts = new API.Posts(this);
-  /**
-   * Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).
-   */
-  postStatuses: API.PostStatuses = new API.PostStatuses(this);
+  feedback: API.Feedback = new API.Feedback(this);
   /**
    * Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.
    */
   changelogs: API.Changelogs = new API.Changelogs(this);
-  /**
-   * Team members who manage your Featurebase organization. Admins have roles that define their permissions.
-   */
-  admins: API.Admins = new API.Admins(this);
-  /**
-   * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
-   */
-  customFields: API.CustomFields = new API.CustomFields(this);
-  /**
-   * Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
-   */
-  surveys: API.Surveys = new API.Surveys(this);
+  organization: API.Organization = new API.Organization(this);
+  users: API.Users = new API.Users(this);
+  products: API.Products = new API.Products(this);
   helpCenter: API.HelpCenter = new API.HelpCenter(this);
-  /**
-   * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
-   */
-  contacts: API.Contacts = new API.Contacts(this);
-  /**
-   * Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.
-   */
-  teams: API.Teams = new API.Teams(this);
-  /**
-   * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
-   */
-  companies: API.Companies = new API.Companies(this);
-  /**
-   * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
-   */
-  brands: API.Brands = new API.Brands(this);
-  /**
-   * Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.
-   */
-  conversations: API.Conversations = new API.Conversations(this);
-  /**
-   * Conversation tags let you organize, filter, and automate around inbox conversations. Use these endpoints to list, look up, create, rename, and delete workspace conversation tags.
-   */
-  tags: API.Tags = new API.Tags(this);
-  /**
-   * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
-   */
-  tickets: API.Tickets = new API.Tickets(this);
-  /**
-   * Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.
-   */
-  webhooks: API.Webhooks = new API.Webhooks(this);
-  /**
-   * Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.
-   */
-  comments: API.Comments = new API.Comments(this);
+  integrations: API.Integrations = new API.Integrations(this);
 }
 
-Featurebase.Boards = Boards;
-Featurebase.Posts = Posts;
-Featurebase.PostStatuses = PostStatuses;
+Featurebase.Feedback = Feedback;
 Featurebase.Changelogs = Changelogs;
-Featurebase.Admins = Admins;
-Featurebase.CustomFields = CustomFields;
-Featurebase.Surveys = Surveys;
+Featurebase.Organization = Organization;
+Featurebase.Users = Users;
+Featurebase.Products = Products;
 Featurebase.HelpCenter = HelpCenter;
-Featurebase.Contacts = Contacts;
-Featurebase.Teams = Teams;
-Featurebase.Companies = Companies;
-Featurebase.Brands = Brands;
-Featurebase.Conversations = Conversations;
-Featurebase.Tags = Tags;
-Featurebase.Tickets = Tickets;
-Featurebase.Webhooks = Webhooks;
-Featurebase.Comments = Comments;
+Featurebase.Integrations = Integrations;
 
 export declare namespace Featurebase {
   export type RequestOptions = Opts.RequestOptions;
 
-  export {
-    Boards as Boards,
-    type Board as Board,
-    type BoardListResponse as BoardListResponse,
-    type BoardRetrieveParams as BoardRetrieveParams,
-    type BoardListParams as BoardListParams,
-  };
-
-  export {
-    Posts as Posts,
-    type Post as Post,
-    type PostListResponse as PostListResponse,
-    type PostDeleteResponse as PostDeleteResponse,
-    type PostCreateParams as PostCreateParams,
-    type PostRetrieveParams as PostRetrieveParams,
-    type PostUpdateParams as PostUpdateParams,
-    type PostListParams as PostListParams,
-    type PostDeleteParams as PostDeleteParams,
-  };
-
-  export {
-    PostStatuses as PostStatuses,
-    type PostStatus as PostStatus,
-    type PostStatusListResponse as PostStatusListResponse,
-    type PostStatusRetrieveParams as PostStatusRetrieveParams,
-    type PostStatusListParams as PostStatusListParams,
-  };
+  export { Feedback as Feedback };
 
   export {
     Changelogs as Changelogs,
@@ -1016,154 +786,13 @@ export declare namespace Featurebase {
     type ChangelogUnpublishParams as ChangelogUnpublishParams,
   };
 
-  export {
-    Admins as Admins,
-    type Admin as Admin,
-    type AdminListResponse as AdminListResponse,
-    type AdminListRolesResponse as AdminListRolesResponse,
-    type AdminRetrieveParams as AdminRetrieveParams,
-    type AdminListParams as AdminListParams,
-    type AdminListRolesParams as AdminListRolesParams,
-  };
+  export { Organization as Organization };
 
-  export {
-    CustomFields as CustomFields,
-    type CustomField as CustomField,
-    type CustomFieldList as CustomFieldList,
-    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
-    type CustomFieldListParams as CustomFieldListParams,
-  };
+  export { Users as Users };
 
-  export {
-    Surveys as Surveys,
-    type Survey as Survey,
-    type SurveyNextAction as SurveyNextAction,
-    type SurveyListResponse as SurveyListResponse,
-    type SurveyRetrieveResponsesResponse as SurveyRetrieveResponsesResponse,
-    type SurveyRetrieveParams as SurveyRetrieveParams,
-    type SurveyListParams as SurveyListParams,
-    type SurveyRetrieveResponsesParams as SurveyRetrieveResponsesParams,
-  };
+  export { Products as Products };
 
   export { HelpCenter as HelpCenter };
 
-  export {
-    Contacts as Contacts,
-    type Contact as Contact,
-    type ContactList as ContactList,
-    type DeletedContact as DeletedContact,
-    type ContactRetrieveResponse as ContactRetrieveResponse,
-    type ContactBlockResponse as ContactBlockResponse,
-    type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse,
-    type ContactUnblockResponse as ContactUnblockResponse,
-    type ContactRetrieveParams as ContactRetrieveParams,
-    type ContactListParams as ContactListParams,
-    type ContactDeleteParams as ContactDeleteParams,
-    type ContactBlockParams as ContactBlockParams,
-    type ContactCreateOrUpdateParams as ContactCreateOrUpdateParams,
-    type ContactUnblockParams as ContactUnblockParams,
-  };
-
-  export {
-    Teams as Teams,
-    type Team as Team,
-    type TeamListResponse as TeamListResponse,
-    type TeamRetrieveParams as TeamRetrieveParams,
-    type TeamListParams as TeamListParams,
-  };
-
-  export {
-    Companies as Companies,
-    type Company as Company,
-    type DeletedCompany as DeletedCompany,
-    type CompanyListResponse as CompanyListResponse,
-    type CompanyRetrieveParams as CompanyRetrieveParams,
-    type CompanyListParams as CompanyListParams,
-    type CompanyDeleteParams as CompanyDeleteParams,
-    type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams,
-    type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams,
-  };
-
-  export {
-    Brands as Brands,
-    type Brand as Brand,
-    type BrandListResponse as BrandListResponse,
-    type BrandRetrieveParams as BrandRetrieveParams,
-    type BrandListParams as BrandListParams,
-  };
-
-  export {
-    Conversations as Conversations,
-    type Conversation as Conversation,
-    type ConversationPart as ConversationPart,
-    type ConversationPartAuthor as ConversationPartAuthor,
-    type ConversationParticipant as ConversationParticipant,
-    type ConversationTagApplication as ConversationTagApplication,
-    type CsatEmailDelivery as CsatEmailDelivery,
-    type CsatRatedAgent as CsatRatedAgent,
-    type CsatWorkflowLink as CsatWorkflowLink,
-    type EmailRecipients as EmailRecipients,
-    type ConversationListResponse as ConversationListResponse,
-    type ConversationDeleteResponse as ConversationDeleteResponse,
-    type ConversationCreateParams as ConversationCreateParams,
-    type ConversationRetrieveParams as ConversationRetrieveParams,
-    type ConversationUpdateParams as ConversationUpdateParams,
-    type ConversationListParams as ConversationListParams,
-    type ConversationDeleteParams as ConversationDeleteParams,
-    type ConversationRedactParams as ConversationRedactParams,
-    type ConversationReplyParams as ConversationReplyParams,
-  };
-
-  export {
-    Tags as Tags,
-    type ConversationTag as ConversationTag,
-    type TagListResponse as TagListResponse,
-    type TagDeleteResponse as TagDeleteResponse,
-    type TagRetrieveParams as TagRetrieveParams,
-    type TagListParams as TagListParams,
-    type TagDeleteParams as TagDeleteParams,
-    type TagCreateOrRenameParams as TagCreateOrRenameParams,
-  };
-
-  export {
-    Tickets as Tickets,
-    type AuthorInput as AuthorInput,
-    type Ticket as Ticket,
-    type TicketListResponse as TicketListResponse,
-    type TicketDeleteResponse as TicketDeleteResponse,
-    type TicketCreateParams as TicketCreateParams,
-    type TicketRetrieveParams as TicketRetrieveParams,
-    type TicketUpdateParams as TicketUpdateParams,
-    type TicketListParams as TicketListParams,
-    type TicketDeleteParams as TicketDeleteParams,
-    type TicketReplyParams as TicketReplyParams,
-  };
-
-  export {
-    Webhooks as Webhooks,
-    type Webhook as Webhook,
-    type WebhookRequestConfigInput as WebhookRequestConfigInput,
-    type WebhookListResponse as WebhookListResponse,
-    type WebhookDeleteResponse as WebhookDeleteResponse,
-    type WebhookCreateParams as WebhookCreateParams,
-    type WebhookRetrieveParams as WebhookRetrieveParams,
-    type WebhookUpdateParams as WebhookUpdateParams,
-    type WebhookListParams as WebhookListParams,
-    type WebhookDeleteParams as WebhookDeleteParams,
-    type WebhookRefreshSecretParams as WebhookRefreshSecretParams,
-  };
-
-  export {
-    Comments as Comments,
-    type Comment as Comment,
-    type CommentListResponse as CommentListResponse,
-    type CommentDelete0Response as CommentDelete0Response,
-    type CommentDelete1Response as CommentDelete1Response,
-    type CommentCreateParams as CommentCreateParams,
-    type CommentRetrieveParams as CommentRetrieveParams,
-    type CommentUpdateParams as CommentUpdateParams,
-    type CommentListParams as CommentListParams,
-    type CommentDelete0Params as CommentDelete0Params,
-    type CommentDelete1Params as CommentDelete1Params,
-  };
+  export { Integrations as Integrations };
 }

package/src/resources/{boards.ts → feedback/boards.ts}

@@ -1,10 +1,10 @@
 // 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';
+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';
 
 /**
  * Boards (post categories) organize feedback into distinct containers with their own settings.
@@ -15,6 +15,13 @@ export class Boards extends APIResource {
    *
    * Returns the full board object including all access controls, feature toggles,
    * and localization settings.
+   *
+   * @example
+   * ```ts
+   * const board = await client.feedback.boards.retrieve(
+   *   '507f1f77bcf86cd799439011',
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -42,6 +49,11 @@ export class Boards extends APIResource {
    *
    * This endpoint returns all boards without pagination. Organizations typically
    * have a small number of boards.
+   *
+   * @example
+   * ```ts
+   * const boards = await client.feedback.boards.list();
+   * ```
    */
   list(
     params: BoardListParams | null | undefined = {},

package/src/resources/{comments.ts → feedback/comments.ts}

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import * as TicketsAPI from './tickets/tickets';
-import { APIPromise } from '../core/api-promise';
-import { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
+import { APIResource } from '../../core/resource';
+import * as TicketsAPI from '../products/tickets/tickets';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.
@@ -71,7 +71,7 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const comment = await client.comments.create({
+   * const comment = await client.feedback.comments.create({
    *   content: '<p>This is a great idea!</p>',
    * });
    * ```
@@ -110,7 +110,7 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const comment = await client.comments.retrieve(
+   * const comment = await client.feedback.comments.retrieve(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -169,7 +169,7 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const comment = await client.comments.update(
+   * const comment = await client.feedback.comments.update(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -258,7 +258,7 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const comments = await client.comments.list();
+   * const comments = await client.feedback.comments.list();
    * ```
    */
   list(
@@ -319,7 +319,7 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.comments.delete0(
+   * const response = await client.feedback.comments.delete0(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -394,7 +394,7 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.comments.delete1({
+   * const response = await client.feedback.comments.delete1({
    *   id: '507f1f77bcf86cd799439011',
    * });
    * ```

package/src/resources/{custom-fields.ts → feedback/custom-fields.ts}

@@ -1,10 +1,10 @@
 // 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';
+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';
 
 /**
  * Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.
@@ -31,6 +31,14 @@ export class CustomFields extends APIResource {
    * ### Errors
    *
    * - `404` - Custom field not found in your organization
+   *
+   * @example
+   * ```ts
+   * const customField =
+   *   await client.feedback.customFields.retrieve(
+   *     '65d26304b2e65b1e1278170c',
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -82,6 +90,12 @@ export class CustomFields extends APIResource {
    * - `multi-select` - Multiple-choice dropdown
    * - `checkbox` - Boolean checkbox
    * - `date` - Date picker
+   *
+   * @example
+   * ```ts
+   * const customFieldList =
+   *   await client.feedback.customFields.list();
+   * ```
    */
   list(
     params: CustomFieldListParams | null | undefined = {},