featurebase-node 0.1.0 → 0.3.0

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 '../../support/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,93 +14,10 @@ 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 { Organization } from './organization/organization';
+export { Support } from './support/support';
 export {
   Surveys,
   type Survey,
@@ -134,36 +28,7 @@ export {
   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 { Users } from './users/users';
 export {
   Webhooks,
   type Webhook,

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.

package/src/resources/organization/index.ts

@@ -0,0 +1,26 @@
+// 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 {
+  Brands,
+  type Brand,
+  type BrandListResponse,
+  type BrandRetrieveParams,
+  type BrandListParams,
+} from './brands';
+export { Organization } from './organization';
+export {
+  Teams,
+  type Team,
+  type TeamListResponse,
+  type TeamRetrieveParams,
+  type TeamListParams,
+} from './teams';

package/src/resources/organization/organization.ts

@@ -0,0 +1,55 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AdminsAPI from './admins';
+import {
+  Admin,
+  AdminListParams,
+  AdminListResponse,
+  AdminListRolesParams,
+  AdminListRolesResponse,
+  AdminRetrieveParams,
+  Admins,
+} from './admins';
+import * as BrandsAPI from './brands';
+import { Brand, BrandListParams, BrandListResponse, BrandRetrieveParams, Brands } from './brands';
+import * as TeamsAPI from './teams';
+import { Team, TeamListParams, TeamListResponse, TeamRetrieveParams, Teams } from './teams';
+
+export class Organization extends APIResource {
+  admins: AdminsAPI.Admins = new AdminsAPI.Admins(this._client);
+  teams: TeamsAPI.Teams = new TeamsAPI.Teams(this._client);
+  brands: BrandsAPI.Brands = new BrandsAPI.Brands(this._client);
+}
+
+Organization.Admins = Admins;
+Organization.Teams = Teams;
+Organization.Brands = Brands;
+
+export declare namespace Organization {
+  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 {
+    Teams as Teams,
+    type Team as Team,
+    type TeamListResponse as TeamListResponse,
+    type TeamRetrieveParams as TeamRetrieveParams,
+    type TeamListParams as TeamListParams,
+  };
+
+  export {
+    Brands as Brands,
+    type Brand as Brand,
+    type BrandListResponse as BrandListResponse,
+    type BrandRetrieveParams as BrandRetrieveParams,
+    type BrandListParams as BrandListParams,
+  };
+}

package/src/resources/{teams.ts → organization/teams.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';
 
 /**
  * Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.

package/src/resources/organization.ts

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