featurebase-node 0.0.2 → 0.2.0

package/src/resources/feedback/feedback.ts

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BoardsAPI from './boards';
+import { Board, BoardListParams, BoardListResponse, BoardRetrieveParams, Boards } from './boards';
+import * as CommentsAPI from './comments';
+import {
+  Comment,
+  CommentCreateParams,
+  CommentDelete0Params,
+  CommentDelete0Response,
+  CommentDelete1Params,
+  CommentDelete1Response,
+  CommentListParams,
+  CommentListResponse,
+  CommentRetrieveParams,
+  CommentUpdateParams,
+  Comments,
+} from './comments';
+import * as CustomFieldsAPI from './custom-fields';
+import {
+  CustomField,
+  CustomFieldList,
+  CustomFieldListParams,
+  CustomFieldRetrieveParams,
+  CustomFields,
+} from './custom-fields';
+import * as PostStatusesAPI from './post-statuses';
+import {
+  PostStatus,
+  PostStatusListParams,
+  PostStatusListResponse,
+  PostStatusRetrieveParams,
+  PostStatuses,
+} from './post-statuses';
+import * as PostsAPI from './posts/posts';
+import {
+  Post,
+  PostCreateParams,
+  PostDeleteParams,
+  PostDeleteResponse,
+  PostListParams,
+  PostListResponse,
+  PostRetrieveParams,
+  PostUpdateParams,
+  Posts,
+} from './posts/posts';
+
+export class Feedback extends APIResource {
+  boards: BoardsAPI.Boards = new BoardsAPI.Boards(this._client);
+  posts: PostsAPI.Posts = new PostsAPI.Posts(this._client);
+  postStatuses: PostStatusesAPI.PostStatuses = new PostStatusesAPI.PostStatuses(this._client);
+  comments: CommentsAPI.Comments = new CommentsAPI.Comments(this._client);
+  customFields: CustomFieldsAPI.CustomFields = new CustomFieldsAPI.CustomFields(this._client);
+}
+
+Feedback.Boards = Boards;
+Feedback.Posts = Posts;
+Feedback.PostStatuses = PostStatuses;
+Feedback.Comments = Comments;
+Feedback.CustomFields = CustomFields;
+
+export declare namespace Feedback {
+  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 {
+    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 {
+    CustomFields as CustomFields,
+    type CustomField as CustomField,
+    type CustomFieldList as CustomFieldList,
+    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
+    type CustomFieldListParams as CustomFieldListParams,
+  };
+}

package/src/resources/feedback/index.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Boards,
+  type Board,
+  type BoardListResponse,
+  type BoardRetrieveParams,
+  type BoardListParams,
+} from './boards';
+export {
+  Comments,
+  type Comment,
+  type CommentListResponse,
+  type CommentDelete0Response,
+  type CommentDelete1Response,
+  type CommentCreateParams,
+  type CommentRetrieveParams,
+  type CommentUpdateParams,
+  type CommentListParams,
+  type CommentDelete0Params,
+  type CommentDelete1Params,
+} from './comments';
+export {
+  CustomFields,
+  type CustomField,
+  type CustomFieldList,
+  type CustomFieldRetrieveParams,
+  type CustomFieldListParams,
+} from './custom-fields';
+export { Feedback } from './feedback';
+export {
+  PostStatuses,
+  type PostStatus,
+  type PostStatusListResponse,
+  type PostStatusRetrieveParams,
+  type PostStatusListParams,
+} from './post-statuses';
+export {
+  Posts,
+  type Post,
+  type PostListResponse,
+  type PostDeleteResponse,
+  type PostCreateParams,
+  type PostRetrieveParams,
+  type PostUpdateParams,
+  type PostListParams,
+  type PostDeleteParams,
+} from './posts/index';

package/src/resources/{post-statuses.ts → feedback/post-statuses.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';
 
 /**
  * Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).
@@ -15,6 +15,14 @@ export class PostStatuses extends APIResource {
    *
    * Returns the full post status object including name, color, type, and default
    * flag.
+   *
+   * @example
+   * ```ts
+   * const postStatus =
+   *   await client.feedback.postStatuses.retrieve(
+   *     '507f1f77bcf86cd799439011',
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -43,6 +51,12 @@ export class PostStatuses extends APIResource {
    *
    * This endpoint returns all post statuses without pagination. Organizations
    * typically have a small number of statuses.
+   *
+   * @example
+   * ```ts
+   * const postStatuses =
+   *   await client.feedback.postStatuses.list();
+   * ```
    */
   list(
     params: PostStatusListParams | null | undefined = {},

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

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
+import { APIResource } from '../../../core/resource';
 import * as PostStatusesAPI from '../post-statuses';
 import * as VotersAPI from './voters';
 import {
@@ -12,11 +12,11 @@ import {
   VoterRemoveResponse,
   Voters,
 } from './voters';
-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 * 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';
 
 /**
  * User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.
@@ -69,7 +69,7 @@ export class Posts extends APIResource {
    *
    * @example
    * ```ts
-   * const post = await client.posts.create({
+   * const post = await client.feedback.posts.create({
    *   boardId: '507f1f77bcf86cd799439011',
    *   title: 'Add dark mode support',
    * });
@@ -101,7 +101,7 @@ export class Posts extends APIResource {
    *
    * @example
    * ```ts
-   * const post = await client.posts.retrieve(
+   * const post = await client.feedback.posts.retrieve(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -154,7 +154,7 @@ export class Posts extends APIResource {
    *
    * @example
    * ```ts
-   * const post = await client.posts.update(
+   * const post = await client.feedback.posts.update(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -225,7 +225,7 @@ export class Posts extends APIResource {
    *
    * @example
    * ```ts
-   * const posts = await client.posts.list();
+   * const posts = await client.feedback.posts.list();
    * ```
    */
   list(
@@ -269,7 +269,7 @@ export class Posts extends APIResource {
    *
    * @example
    * ```ts
-   * const post = await client.posts.delete(
+   * const post = await client.feedback.posts.delete(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```

package/src/resources/{posts → feedback/posts}/voters.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 CompaniesAPI from '../companies/companies';
-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 CompaniesAPI from '../../users/companies/companies';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.
@@ -50,7 +50,7 @@ export class Voters extends APIResource {
    *
    * @example
    * ```ts
-   * const voters = await client.posts.voters.list(
+   * const voters = await client.feedback.posts.voters.list(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -111,7 +111,7 @@ export class Voters extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.posts.voters.add(
+   * const response = await client.feedback.posts.voters.add(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -158,7 +158,7 @@ export class Voters extends APIResource {
    *
    * @example
    * ```ts
-   * const voter = await client.posts.voters.remove(
+   * const voter = await client.feedback.posts.voters.remove(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```

package/src/resources/feedback.ts

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

package/src/resources/index.ts

@@ -1,28 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Admins,
-  type Admin,
-  type AdminListResponse,
-  type AdminListRolesResponse,
-  type AdminRetrieveParams,
-  type AdminListParams,
-  type AdminListRolesParams,
-} from './admins';
-export {
-  Boards,
-  type Board,
-  type BoardListResponse,
-  type BoardRetrieveParams,
-  type BoardListParams,
-} from './boards';
-export {
-  Brands,
-  type Brand,
-  type BrandListResponse,
-  type BrandRetrieveParams,
-  type BrandListParams,
-} from './brands';
 export {
   Changelogs,
   type Changelog,
@@ -37,143 +14,9 @@ export {
   type ChangelogPublishParams,
   type ChangelogUnpublishParams,
 } from './changelogs/changelogs';
-export {
-  Comments,
-  type Comment,
-  type CommentListResponse,
-  type CommentDelete0Response,
-  type CommentDelete1Response,
-  type CommentCreateParams,
-  type CommentRetrieveParams,
-  type CommentUpdateParams,
-  type CommentListParams,
-  type CommentDelete0Params,
-  type CommentDelete1Params,
-} from './comments';
-export {
-  Companies,
-  type Company,
-  type DeletedCompany,
-  type CompanyListResponse,
-  type CompanyRetrieveParams,
-  type CompanyListParams,
-  type CompanyDeleteParams,
-  type CompanyCreateOrUpdateParams,
-  type CompanyDeleteByCompanyIDParams,
-} from './companies/companies';
-export {
-  Contacts,
-  type Contact,
-  type ContactList,
-  type DeletedContact,
-  type ContactRetrieveResponse,
-  type ContactBlockResponse,
-  type ContactCreateOrUpdateResponse,
-  type ContactUnblockResponse,
-  type ContactRetrieveParams,
-  type ContactListParams,
-  type ContactDeleteParams,
-  type ContactBlockParams,
-  type ContactCreateOrUpdateParams,
-  type ContactUnblockParams,
-} from './contacts/contacts';
-export {
-  Conversations,
-  type Conversation,
-  type ConversationPart,
-  type ConversationPartAuthor,
-  type ConversationParticipant,
-  type ConversationTagApplication,
-  type CsatEmailDelivery,
-  type CsatRatedAgent,
-  type CsatWorkflowLink,
-  type EmailRecipients,
-  type ConversationListResponse,
-  type ConversationDeleteResponse,
-  type ConversationCreateParams,
-  type ConversationRetrieveParams,
-  type ConversationUpdateParams,
-  type ConversationListParams,
-  type ConversationDeleteParams,
-  type ConversationRedactParams,
-  type ConversationReplyParams,
-} from './conversations/conversations';
-export {
-  CustomFields,
-  type CustomField,
-  type CustomFieldList,
-  type CustomFieldRetrieveParams,
-  type CustomFieldListParams,
-} from './custom-fields';
+export { Feedback } from './feedback/feedback';
 export { HelpCenter } from './help-center/help-center';
-export {
-  PostStatuses,
-  type PostStatus,
-  type PostStatusListResponse,
-  type PostStatusRetrieveParams,
-  type PostStatusListParams,
-} from './post-statuses';
-export {
-  Posts,
-  type Post,
-  type PostListResponse,
-  type PostDeleteResponse,
-  type PostCreateParams,
-  type PostRetrieveParams,
-  type PostUpdateParams,
-  type PostListParams,
-  type PostDeleteParams,
-} from './posts/posts';
-export {
-  Surveys,
-  type Survey,
-  type SurveyNextAction,
-  type SurveyListResponse,
-  type SurveyRetrieveResponsesResponse,
-  type SurveyRetrieveParams,
-  type SurveyListParams,
-  type SurveyRetrieveResponsesParams,
-} from './surveys';
-export {
-  Tags,
-  type ConversationTag,
-  type TagListResponse,
-  type TagDeleteResponse,
-  type TagRetrieveParams,
-  type TagListParams,
-  type TagDeleteParams,
-  type TagCreateOrRenameParams,
-} from './tags';
-export {
-  Teams,
-  type Team,
-  type TeamListResponse,
-  type TeamRetrieveParams,
-  type TeamListParams,
-} from './teams';
-export {
-  Tickets,
-  type AuthorInput,
-  type Ticket,
-  type TicketListResponse,
-  type TicketDeleteResponse,
-  type TicketCreateParams,
-  type TicketRetrieveParams,
-  type TicketUpdateParams,
-  type TicketListParams,
-  type TicketDeleteParams,
-  type TicketReplyParams,
-} from './tickets/tickets';
-export {
-  Webhooks,
-  type Webhook,
-  type WebhookRequestConfigInput,
-  type WebhookListResponse,
-  type WebhookDeleteResponse,
-  type WebhookCreateParams,
-  type WebhookRetrieveParams,
-  type WebhookUpdateParams,
-  type WebhookListParams,
-  type WebhookDeleteParams,
-  type WebhookRefreshSecretParams,
-} from './webhooks';
+export { Integrations } from './integrations/integrations';
+export { Organization } from './organization/organization';
+export { Products } from './products/products';
+export { Users } from './users/users';

package/src/resources/integrations/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Integrations } from './integrations';
+export {
+  Webhooks,
+  type Webhook,
+  type WebhookRequestConfigInput,
+  type WebhookListResponse,
+  type WebhookDeleteResponse,
+  type WebhookCreateParams,
+  type WebhookRetrieveParams,
+  type WebhookUpdateParams,
+  type WebhookListParams,
+  type WebhookDeleteParams,
+  type WebhookRefreshSecretParams,
+} from './webhooks';

package/src/resources/integrations/integrations.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as WebhooksAPI from './webhooks';
+import {
+  Webhook,
+  WebhookCreateParams,
+  WebhookDeleteParams,
+  WebhookDeleteResponse,
+  WebhookListParams,
+  WebhookListResponse,
+  WebhookRefreshSecretParams,
+  WebhookRequestConfigInput,
+  WebhookRetrieveParams,
+  WebhookUpdateParams,
+  Webhooks,
+} from './webhooks';
+
+export class Integrations extends APIResource {
+  webhooks: WebhooksAPI.Webhooks = new WebhooksAPI.Webhooks(this._client);
+}
+
+Integrations.Webhooks = Webhooks;
+
+export declare namespace Integrations {
+  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,
+  };
+}

package/src/resources/{webhooks.ts → integrations/webhooks.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';
 
 /**
  * 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.
@@ -85,7 +85,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.webhooks.create({
+   * const webhook = await client.integrations.webhooks.create({
    *   name: 'Production Webhook',
    *   topics: ['post.created', 'post.updated'],
    *   url: 'https://example.com/webhooks',
@@ -168,7 +168,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.webhooks.retrieve(
+   * const webhook = await client.integrations.webhooks.retrieve(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -258,7 +258,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.webhooks.update(
+   * const webhook = await client.integrations.webhooks.update(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -331,7 +331,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhooks = await client.webhooks.list();
+   * const webhooks = await client.integrations.webhooks.list();
    * ```
    */
   list(
@@ -380,7 +380,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.webhooks.delete(
+   * const webhook = await client.integrations.webhooks.delete(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -439,9 +439,10 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.webhooks.refreshSecret(
-   *   '507f1f77bcf86cd799439011',
-   * );
+   * const webhook =
+   *   await client.integrations.webhooks.refreshSecret(
+   *     '507f1f77bcf86cd799439011',
+   *   );
    * ```
    */
   refreshSecret(

package/src/resources/integrations.ts

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

package/src/resources/{admins.ts → organization/admins.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';
 
 /**
  * Team members who manage your Featurebase organization. Admins have roles that define their permissions.

package/src/resources/{brands.ts → organization/brands.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';
 
 /**
  * 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.