featurebase-node 0.2.0 → 0.3.0

package/src/client.ts

@@ -17,6 +17,29 @@ 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 {
+  Survey,
+  SurveyListParams,
+  SurveyListResponse,
+  SurveyNextAction,
+  SurveyRetrieveParams,
+  SurveyRetrieveResponsesParams,
+  SurveyRetrieveResponsesResponse,
+  Surveys,
+} from './resources/surveys';
+import {
+  Webhook,
+  WebhookCreateParams,
+  WebhookDeleteParams,
+  WebhookDeleteResponse,
+  WebhookListParams,
+  WebhookListResponse,
+  WebhookRefreshSecretParams,
+  WebhookRequestConfigInput,
+  WebhookRetrieveParams,
+  WebhookUpdateParams,
+  Webhooks,
+} from './resources/webhooks';
 import {
   Changelog,
   ChangelogCreateParams,
@@ -33,9 +56,8 @@ import {
 } from './resources/changelogs/changelogs';
 import { Feedback } from './resources/feedback/feedback';
 import { HelpCenter } from './resources/help-center/help-center';
-import { Integrations } from './resources/integrations/integrations';
 import { Organization } from './resources/organization/organization';
-import { Products } from './resources/products/products';
+import { Support } from './resources/support/support';
 import { Users } from './resources/users/users';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
@@ -746,29 +768,39 @@ export class Featurebase {
 
   static toFile = Uploads.toFile;
 
+  support: API.Support = new API.Support(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);
+  helpCenter: API.HelpCenter = new API.HelpCenter(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);
-  integrations: API.Integrations = new API.Integrations(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);
+  /**
+   * 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);
 }
 
+Featurebase.Support = Support;
 Featurebase.Feedback = Feedback;
 Featurebase.Changelogs = Changelogs;
+Featurebase.HelpCenter = HelpCenter;
 Featurebase.Organization = Organization;
 Featurebase.Users = Users;
-Featurebase.Products = Products;
-Featurebase.HelpCenter = HelpCenter;
-Featurebase.Integrations = Integrations;
+Featurebase.Surveys = Surveys;
+Featurebase.Webhooks = Webhooks;
 
 export declare namespace Featurebase {
   export type RequestOptions = Opts.RequestOptions;
 
+  export { Support as Support };
+
   export { Feedback as Feedback };
 
   export {
@@ -786,13 +818,34 @@ export declare namespace Featurebase {
     type ChangelogUnpublishParams as ChangelogUnpublishParams,
   };
 
+  export { HelpCenter as HelpCenter };
+
   export { Organization as Organization };
 
   export { Users as Users };
 
-  export { Products as Products };
-
-  export { HelpCenter as HelpCenter };
+  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 { Integrations as 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/feedback/comments.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as TicketsAPI from '../products/tickets/tickets';
+import * as TicketsAPI from '../support/tickets/tickets';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';

package/src/resources/feedback/posts/posts.ts

@@ -12,7 +12,7 @@ import {
   VoterRemoveResponse,
   Voters,
 } from './voters';
-import * as TicketsAPI from '../../products/tickets/tickets';
+import * as TicketsAPI from '../../support/tickets/tickets';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';

package/src/resources/index.ts

@@ -16,7 +16,29 @@ export {
 } from './changelogs/changelogs';
 export { Feedback } from './feedback/feedback';
 export { HelpCenter } from './help-center/help-center';
-export { Integrations } from './integrations/integrations';
 export { Organization } from './organization/organization';
-export { Products } from './products/products';
+export { Support } from './support/support';
+export {
+  Surveys,
+  type Survey,
+  type SurveyNextAction,
+  type SurveyListResponse,
+  type SurveyRetrieveResponsesResponse,
+  type SurveyRetrieveParams,
+  type SurveyListParams,
+  type SurveyRetrieveResponsesParams,
+} from './surveys';
 export { Users } from './users/users';
+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/{products → support}/conversation-tags.ts

@@ -17,7 +17,7 @@ export class ConversationTags extends APIResource {
    * @example
    * ```ts
    * const conversationTag =
-   *   await client.products.conversationTags.retrieve(
+   *   await client.support.conversationTags.retrieve(
    *     '67ec1234abcd5678ef901234',
    *   );
    * ```
@@ -45,7 +45,7 @@ export class ConversationTags extends APIResource {
    * @example
    * ```ts
    * const conversationTags =
-   *   await client.products.conversationTags.list();
+   *   await client.support.conversationTags.list();
    * ```
    */
   list(
@@ -70,7 +70,7 @@ export class ConversationTags extends APIResource {
    * @example
    * ```ts
    * const conversationTag =
-   *   await client.products.conversationTags.delete(
+   *   await client.support.conversationTags.delete(
    *     '67ec1234abcd5678ef901234',
    *   );
    * ```
@@ -98,7 +98,7 @@ export class ConversationTags extends APIResource {
    * @example
    * ```ts
    * const conversationTag =
-   *   await client.products.conversationTags.createOrRename({
+   *   await client.support.conversationTags.createOrRename({
    *     name: 'Churn',
    *   });
    * ```

package/src/resources/{products → support}/conversations/conversations.ts

@@ -149,7 +149,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.create({
+   *   await client.support.conversations.create({
    *     bodyMarkdown:
    *       'Hello, I have a question about your product.\n\n![screenshot](https://example.com/image.png)',
    *     from: {
@@ -271,7 +271,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.retrieve('12345');
+   *   await client.support.conversations.retrieve('12345');
    * ```
    */
   retrieve(
@@ -413,7 +413,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.update('12345');
+   *   await client.support.conversations.update('12345');
    * ```
    */
   update(id: string, params: ConversationUpdateParams, options?: RequestOptions): APIPromise<Conversation> {
@@ -493,7 +493,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversations =
-   *   await client.products.conversations.list();
+   *   await client.support.conversations.list();
    * ```
    */
   list(
@@ -542,7 +542,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.delete('12345');
+   *   await client.support.conversations.delete('12345');
    * ```
    */
   delete(
@@ -631,7 +631,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.redact({
+   *   await client.support.conversations.redact({
    *     conversationId: '12345',
    *     conversationPartId: '67890',
    *     type: 'conversation_part',
@@ -752,7 +752,7 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversationPart =
-   *   await client.products.conversations.reply('12345', {
+   *   await client.support.conversations.reply('12345', {
    *     bodyMarkdown: 'Thank you for your help!',
    *     messageType: 'reply',
    *     type: 'contact',

package/src/resources/{products → support}/conversations/participants.ts

@@ -96,7 +96,7 @@ export class Participants extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.participants.add(
+   *   await client.support.conversations.participants.add(
    *     '12345',
    *     { participant: {} },
    *   );
@@ -172,7 +172,7 @@ export class Participants extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.products.conversations.participants.remove(
+   *   await client.support.conversations.participants.remove(
    *     '12345',
    *     { id: '676f0f6765bdaa7d7d760f88' },
    *   );

package/src/resources/{products → support}/conversations/tags.ts

@@ -54,7 +54,7 @@ export class Tags extends APIResource {
    * @example
    * ```ts
    * const attachedConversationTag =
-   *   await client.products.conversations.tags.attach('12345', {
+   *   await client.support.conversations.tags.attach('12345', {
    *     actingAdminId: '507f1f77bcf86cd799439011',
    *     tagId: '67ec1234abcd5678ef901234',
    *   });
@@ -115,7 +115,7 @@ export class Tags extends APIResource {
    * @example
    * ```ts
    * const attachedConversationTag =
-   *   await client.products.conversations.tags.detach(
+   *   await client.support.conversations.tags.detach(
    *     '67ec1234abcd5678ef901234',
    *     {
    *       id: '12345',

package/src/resources/{products → support}/index.ts

@@ -31,17 +31,7 @@ export {
   type ConversationRedactParams,
   type ConversationReplyParams,
 } from './conversations/index';
-export { Products } from './products';
-export {
-  Surveys,
-  type Survey,
-  type SurveyNextAction,
-  type SurveyListResponse,
-  type SurveyRetrieveResponsesResponse,
-  type SurveyRetrieveParams,
-  type SurveyListParams,
-  type SurveyRetrieveResponsesParams,
-} from './surveys';
+export { Support } from './support';
 export {
   Tickets,
   type AuthorInput,

package/src/resources/{products/products.ts → support/support.ts}

@@ -12,17 +12,6 @@ import {
   ConversationTagRetrieveParams,
   ConversationTags,
 } from './conversation-tags';
-import * as SurveysAPI from './surveys';
-import {
-  Survey,
-  SurveyListParams,
-  SurveyListResponse,
-  SurveyNextAction,
-  SurveyRetrieveParams,
-  SurveyRetrieveResponsesParams,
-  SurveyRetrieveResponsesResponse,
-  Surveys,
-} from './surveys';
 import * as ConversationsAPI from './conversations/conversations';
 import {
   Conversation,
@@ -60,8 +49,7 @@ import {
   Tickets,
 } from './tickets/tickets';
 
-export class Products extends APIResource {
-  surveys: SurveysAPI.Surveys = new SurveysAPI.Surveys(this._client);
+export class Support extends APIResource {
   conversations: ConversationsAPI.Conversations = new ConversationsAPI.Conversations(this._client);
   conversationTags: ConversationTagsAPI.ConversationTags = new ConversationTagsAPI.ConversationTags(
     this._client,
@@ -69,23 +57,11 @@ export class Products extends APIResource {
   tickets: TicketsAPI.Tickets = new TicketsAPI.Tickets(this._client);
 }
 
-Products.Surveys = Surveys;
-Products.Conversations = Conversations;
-Products.ConversationTags = ConversationTags;
-Products.Tickets = Tickets;
-
-export declare namespace Products {
-  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,
-  };
+Support.Conversations = Conversations;
+Support.ConversationTags = ConversationTags;
+Support.Tickets = Tickets;
 
+export declare namespace Support {
   export {
     Conversations as Conversations,
     type Conversation as Conversation,

package/src/resources/{products → support}/tickets/categories.ts

@@ -20,7 +20,7 @@ export class Categories extends APIResource {
    * @example
    * ```ts
    * const board =
-   *   await client.products.tickets.categories.retrieve(
+   *   await client.support.tickets.categories.retrieve(
    *     '507f1f77bcf86cd799439011',
    *   );
    * ```
@@ -58,7 +58,7 @@ export class Categories extends APIResource {
    * @example
    * ```ts
    * const boards =
-   *   await client.products.tickets.categories.list();
+   *   await client.support.tickets.categories.list();
    * ```
    */
   list(

package/src/resources/{products → support}/tickets/custom-fields.ts

@@ -31,7 +31,7 @@ export class CustomFields extends APIResource {
    * @example
    * ```ts
    * const customField =
-   *   await client.products.tickets.customFields.retrieve(
+   *   await client.support.tickets.customFields.retrieve(
    *     '65d26304b2e65b1e1278170c',
    *   );
    * ```
@@ -74,7 +74,7 @@ export class CustomFields extends APIResource {
    * @example
    * ```ts
    * const customFieldList =
-   *   await client.products.tickets.customFields.list();
+   *   await client.support.tickets.customFields.list();
    * ```
    */
   list(

package/src/resources/{products → support}/tickets/statuses.ts

@@ -19,7 +19,7 @@ export class Statuses extends APIResource {
    * @example
    * ```ts
    * const postStatus =
-   *   await client.products.tickets.statuses.retrieve(
+   *   await client.support.tickets.statuses.retrieve(
    *     '507f1f77bcf86cd799439011',
    *   );
    * ```
@@ -54,7 +54,7 @@ export class Statuses extends APIResource {
    * @example
    * ```ts
    * const postStatuses =
-   *   await client.products.tickets.statuses.list();
+   *   await client.support.tickets.statuses.list();
    * ```
    */
   list(

package/src/resources/{products → support}/tickets/tickets.ts

@@ -78,7 +78,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.create({
+   * const ticket = await client.support.tickets.create({
    *   author: {},
    *   ticketCategoryId: '507f1f77bcf86cd799439011',
    *   title: 'Cannot login to dashboard',
@@ -111,7 +111,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.retrieve(1);
+   * const ticket = await client.support.tickets.retrieve(1);
    * ```
    */
   retrieve(
@@ -172,7 +172,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.update(1);
+   * const ticket = await client.support.tickets.update(1);
    * ```
    */
   update(id: number, params: TicketUpdateParams, options?: RequestOptions): APIPromise<Ticket> {
@@ -210,7 +210,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const tickets = await client.products.tickets.list();
+   * const tickets = await client.support.tickets.list();
    * ```
    */
   list(
@@ -259,7 +259,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.delete(1);
+   * const ticket = await client.support.tickets.delete(1);
    * ```
    */
   delete(
@@ -318,7 +318,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.reply(1, {
+   * const ticket = await client.support.tickets.reply(1, {
    *   body: '<p>Thank you for your help!</p>',
    *   type: 'contact',
    * });
@@ -835,7 +835,8 @@ export interface TicketListParams {
   categoryType?: 'customer' | 'tracker' | 'back-office';
 
   /**
-   * Query param
+   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+   * previous response to fetch the next page of results.
    */
   cursor?: string;
 

package/src/resources/{products.ts → support.ts}

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

package/src/resources/{products/surveys.ts → surveys.ts}

@@ -1,12 +1,12 @@
 // 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 SurveysAPI from './surveys';
-import * as ContactsAPI from '../users/contacts/contacts';
-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 ContactsAPI from './users/contacts/contacts';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 /**
  * 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.
@@ -44,13 +44,6 @@ export class Surveys extends APIResource {
    * ### Errors
    *
    * - `404` - Survey not found in your organization
-   *
-   * @example
-   * ```ts
-   * const survey = await client.products.surveys.retrieve(
-   *   '6743752ca81ae59d25cf834b',
-   * );
-   * ```
    */
   retrieve(
     id: string,
@@ -98,11 +91,6 @@ export class Surveys extends APIResource {
    * - `pages` - Array of survey pages/questions
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
-   *
-   * @example
-   * ```ts
-   * const surveys = await client.products.surveys.list();
-   * ```
    */
   list(
     params: SurveyListParams | null | undefined = {},
@@ -156,14 +144,6 @@ export class Surveys extends APIResource {
    * ### Errors
    *
    * - `404` - Survey not found in your organization
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.products.surveys.retrieveResponses(
-   *     '6743752ca81ae59d25cf834b',
-   *   );
-   * ```
    */
   retrieveResponses(
     id: string,

package/src/resources/{integrations/webhooks.ts → 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.integrations.webhooks.create({
+   * const webhook = await client.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.integrations.webhooks.retrieve(
+   * const webhook = await client.webhooks.retrieve(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -258,7 +258,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.integrations.webhooks.update(
+   * const webhook = await client.webhooks.update(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -331,7 +331,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhooks = await client.integrations.webhooks.list();
+   * const webhooks = await client.webhooks.list();
    * ```
    */
   list(
@@ -380,7 +380,7 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook = await client.integrations.webhooks.delete(
+   * const webhook = await client.webhooks.delete(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -439,10 +439,9 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhook =
-   *   await client.integrations.webhooks.refreshSecret(
-   *     '507f1f77bcf86cd799439011',
-   *   );
+   * const webhook = await client.webhooks.refreshSecret(
+   *   '507f1f77bcf86cd799439011',
+   * );
    * ```
    */
   refreshSecret(

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0'; // x-release-please-version
+export const VERSION = '0.3.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.3.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.3.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0'; // x-release-please-version
+exports.VERSION = '0.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map