featurebase-node 0.2.0 → 0.4.0

package/src/resources/help-center/index.ts

@@ -7,13 +7,13 @@ export {
   type ArticleIconInputNova,
   type ArticleTranslation,
   type ArticleTranslationInputNova,
-  type ArticleListResponse,
   type ArticleDeleteResponse,
   type ArticleCreateParams,
   type ArticleRetrieveParams,
   type ArticleUpdateParams,
   type ArticleListParams,
   type ArticleDeleteParams,
+  type ArticlesCursorPage,
 } from './articles';
 export {
   Collections,
@@ -21,27 +21,26 @@ export {
   type CollectionIconNova,
   type CollectionTranslation,
   type CollectionTranslationInputNova,
-  type CollectionListResponse,
   type CollectionDeleteResponse,
   type CollectionCreateParams,
   type CollectionRetrieveParams,
   type CollectionUpdateParams,
   type CollectionListParams,
   type CollectionDeleteParams,
+  type CollectionsCursorPage,
 } from './collections';
 export { HelpCenter } from './help-center';
 export {
   HelpCenters,
   type HelpCenterNavItem,
   type HelpCenterTranslation,
-  type HelpCenterListResponse,
   type HelpCenterRetrieveParams,
   type HelpCenterListParams,
+  type HelpCentersCursorPage,
 } from './help-centers';
 export {
   RedirectRules,
   type RedirectRule,
-  type RedirectRuleListResponse,
   type RedirectRuleDeleteResponse,
   type RedirectRuleCreateParams,
   type RedirectRuleRetrieveParams,
@@ -49,4 +48,5 @@ export {
   type RedirectRuleListParams,
   type RedirectRuleDeleteParams,
   type RedirectRuleRetrieveByURLParams,
+  type RedirectRulesCursorPage,
 } from './redirect-rules';

package/src/resources/help-center/redirect-rules.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -198,16 +199,18 @@ export class RedirectRules extends APIResource {
    *
    * @example
    * ```ts
-   * const redirectRules =
-   *   await client.helpCenter.redirectRules.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: RedirectRuleListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<RedirectRuleListResponse> {
+  ): PagePromise<RedirectRulesCursorPage, RedirectRule> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/help_center/redirect_rules', {
+    return this._client.getAPIList('/v2/help_center/redirect_rules', CursorPage<RedirectRule>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -311,6 +314,8 @@ export class RedirectRules extends APIResource {
   }
 }
 
+export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
+
 export interface RedirectRule {
   /**
    * Redirect rule unique identifier
@@ -400,23 +405,6 @@ export interface RedirectRule {
   updatedAt: string;
 }
 
-export interface RedirectRuleListResponse {
-  /**
-   * Array of redirect rules
-   */
-  data: Array<RedirectRule>;
-
-  /**
-   * Cursor for fetching the next page. Null if there are no more results.
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface RedirectRuleDeleteResponse {
   /**
    * Unique identifier of the deleted redirect rule
@@ -597,23 +585,12 @@ export interface RedirectRuleUpdateParams {
   'Featurebase-Version'?: string;
 }
 
-export interface RedirectRuleListParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page.
-   */
-  cursor?: string;
-
+export interface RedirectRuleListParams extends CursorPageParams {
   /**
    * Query param: Filter redirect rules by help center ID
    */
   helpCenterId?: string;
 
-  /**
-   * Query param: A limit on the number of objects to be returned, between 1 and 100.
-   */
-  limit?: number;
-
   /**
    * Query param: Filter redirect rules by locale
    */
@@ -699,8 +676,8 @@ export interface RedirectRuleRetrieveByURLParams {
 export declare namespace RedirectRules {
   export {
     type RedirectRule as RedirectRule,
-    type RedirectRuleListResponse as RedirectRuleListResponse,
     type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse,
+    type RedirectRulesCursorPage as RedirectRulesCursorPage,
     type RedirectRuleCreateParams as RedirectRuleCreateParams,
     type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams,
     type RedirectRuleUpdateParams as RedirectRuleUpdateParams,

package/src/resources/index.ts

@@ -4,7 +4,6 @@ export {
   Changelogs,
   type Changelog,
   type PublishUnpublishSuccess,
-  type ChangelogListResponse,
   type ChangelogDeleteResponse,
   type ChangelogCreateParams,
   type ChangelogRetrieveParams,
@@ -13,10 +12,34 @@ export {
   type ChangelogDeleteParams,
   type ChangelogPublishParams,
   type ChangelogUnpublishParams,
+  type ChangelogsCursorPage,
 } 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 SurveyListResponsesResponse,
+  type SurveyRetrieveParams,
+  type SurveyListParams,
+  type SurveyListResponsesParams,
+  type SurveysCursorPage,
+  type SurveyListResponsesResponsesCursorPage,
+} from './surveys';
 export { Users } from './users/users';
+export {
+  Webhooks,
+  type Webhook,
+  type WebhookRequestConfigInput,
+  type WebhookDeleteResponse,
+  type WebhookCreateParams,
+  type WebhookRetrieveParams,
+  type WebhookUpdateParams,
+  type WebhookListParams,
+  type WebhookDeleteParams,
+  type WebhookRefreshSecretParams,
+  type WebhooksCursorPage,
+} from './webhooks';

package/src/resources/organization/brands.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -123,9 +124,9 @@ export class Brands extends APIResource {
   list(
     params: BrandListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<BrandListResponse> {
+  ): PagePromise<BrandsCursorPage, Brand> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/brands', {
+    return this._client.getAPIList('/v2/brands', CursorPage<Brand>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -136,6 +137,8 @@ export class Brands extends APIResource {
   }
 }
 
+export type BrandsCursorPage = CursorPage<Brand>;
+
 export interface Brand {
   /**
    * Featurebase internal ID
@@ -178,23 +181,6 @@ export interface Brand {
   updatedAt: string | null;
 }
 
-export interface BrandListResponse {
-  /**
-   * Array of brands
-   */
-  data: Array<Brand>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface BrandRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -203,18 +189,7 @@ export interface BrandRetrieveParams {
   'Featurebase-Version'?: string;
 }
 
-export interface BrandListParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page of results.
-   */
-  cursor?: string;
-
-  /**
-   * Query param: A limit on the number of brands to be returned, between 1 and 100.
-   */
-  limit?: number;
-
+export interface BrandListParams extends CursorPageParams {
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
@@ -225,7 +200,7 @@ export interface BrandListParams {
 export declare namespace Brands {
   export {
     type Brand as Brand,
-    type BrandListResponse as BrandListResponse,
+    type BrandsCursorPage as BrandsCursorPage,
     type BrandRetrieveParams as BrandRetrieveParams,
     type BrandListParams as BrandListParams,
   };

package/src/resources/organization/index.ts

@@ -12,9 +12,9 @@ export {
 export {
   Brands,
   type Brand,
-  type BrandListResponse,
   type BrandRetrieveParams,
   type BrandListParams,
+  type BrandsCursorPage,
 } from './brands';
 export { Organization } from './organization';
 export {

package/src/resources/organization/organization.ts

@@ -12,7 +12,7 @@ import {
   Admins,
 } from './admins';
 import * as BrandsAPI from './brands';
-import { Brand, BrandListParams, BrandListResponse, BrandRetrieveParams, Brands } from './brands';
+import { Brand, BrandListParams, BrandRetrieveParams, Brands, BrandsCursorPage } from './brands';
 import * as TeamsAPI from './teams';
 import { Team, TeamListParams, TeamListResponse, TeamRetrieveParams, Teams } from './teams';
 
@@ -48,7 +48,7 @@ export declare namespace Organization {
   export {
     Brands as Brands,
     type Brand as Brand,
-    type BrandListResponse as BrandListResponse,
+    type BrandsCursorPage as BrandsCursorPage,
     type BrandRetrieveParams as BrandRetrieveParams,
     type BrandListParams as BrandListParams,
   };

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

@@ -14,6 +14,7 @@ import {
   Tags,
 } from './tags';
 import { APIPromise } from '../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -149,7 +150,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 +272,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 +414,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> {
@@ -492,16 +493,18 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const conversations =
-   *   await client.products.conversations.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const conversation of client.support.conversations.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: ConversationListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ConversationListResponse> {
+  ): PagePromise<ConversationsCursorPage, Conversation> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/conversations', {
+    return this._client.getAPIList('/v2/conversations', CursorPage<Conversation>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -542,7 +545,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 +634,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 +755,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',
@@ -772,6 +775,8 @@ export class Conversations extends APIResource {
   }
 }
 
+export type ConversationsCursorPage = CursorPage<Conversation>;
+
 export interface Conversation {
   /**
    * Unique conversation identifier
@@ -2310,23 +2315,6 @@ export interface EmailRecipients {
   ids?: Array<string>;
 }
 
-export interface ConversationListResponse {
-  /**
-   * Array of conversations
-   */
-  data: Array<Conversation>;
-
-  /**
-   * Cursor for fetching the next page
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface ConversationDeleteResponse {
   /**
    * Unique identifier of the deleted conversation
@@ -2534,18 +2522,7 @@ export namespace ConversationUpdateParams {
   }
 }
 
-export interface ConversationListParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page of results.
-   */
-  cursor?: string;
-
-  /**
-   * Query param: A limit on the number of objects to be returned, between 1 and 100.
-   */
-  limit?: number;
-
+export interface ConversationListParams extends CursorPageParams {
   /**
    * Query param: Filter conversations by one or more tag IDs using a comma-separated
    * list. Conversations must contain all provided tags.
@@ -2695,8 +2672,8 @@ export declare namespace Conversations {
     type CsatRatedAgent as CsatRatedAgent,
     type CsatWorkflowLink as CsatWorkflowLink,
     type EmailRecipients as EmailRecipients,
-    type ConversationListResponse as ConversationListResponse,
     type ConversationDeleteResponse as ConversationDeleteResponse,
+    type ConversationsCursorPage as ConversationsCursorPage,
     type ConversationCreateParams as ConversationCreateParams,
     type ConversationRetrieveParams as ConversationRetrieveParams,
     type ConversationUpdateParams as ConversationUpdateParams,

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

@@ -11,7 +11,6 @@ export {
   type CsatRatedAgent,
   type CsatWorkflowLink,
   type EmailRecipients,
-  type ConversationListResponse,
   type ConversationDeleteResponse,
   type ConversationCreateParams,
   type ConversationRetrieveParams,
@@ -20,6 +19,7 @@ export {
   type ConversationDeleteParams,
   type ConversationRedactParams,
   type ConversationReplyParams,
+  type ConversationsCursorPage,
 } from './conversations';
 export { Participants, type ParticipantAddParams, type ParticipantRemoveParams } from './participants';
 export {

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

@@ -21,7 +21,6 @@ export {
   type CsatRatedAgent,
   type CsatWorkflowLink,
   type EmailRecipients,
-  type ConversationListResponse,
   type ConversationDeleteResponse,
   type ConversationCreateParams,
   type ConversationRetrieveParams,
@@ -30,23 +29,13 @@ export {
   type ConversationDeleteParams,
   type ConversationRedactParams,
   type ConversationReplyParams,
+  type ConversationsCursorPage,
 } 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,
   type Ticket,
-  type TicketListResponse,
   type TicketDeleteResponse,
   type TicketCreateParams,
   type TicketRetrieveParams,
@@ -54,4 +43,5 @@ export {
   type TicketListParams,
   type TicketDeleteParams,
   type TicketReplyParams,
+  type TicketsCursorPage,
 } from './tickets/index';

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,
@@ -30,7 +19,6 @@ import {
   ConversationDeleteParams,
   ConversationDeleteResponse,
   ConversationListParams,
-  ConversationListResponse,
   ConversationPart,
   ConversationPartAuthor,
   ConversationParticipant,
@@ -40,6 +28,7 @@ import {
   ConversationTagApplication,
   ConversationUpdateParams,
   Conversations,
+  ConversationsCursorPage,
   CsatEmailDelivery,
   CsatRatedAgent,
   CsatWorkflowLink,
@@ -53,15 +42,14 @@ import {
   TicketDeleteParams,
   TicketDeleteResponse,
   TicketListParams,
-  TicketListResponse,
   TicketReplyParams,
   TicketRetrieveParams,
   TicketUpdateParams,
   Tickets,
+  TicketsCursorPage,
 } 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,
@@ -97,8 +73,8 @@ export declare namespace Products {
     type CsatRatedAgent as CsatRatedAgent,
     type CsatWorkflowLink as CsatWorkflowLink,
     type EmailRecipients as EmailRecipients,
-    type ConversationListResponse as ConversationListResponse,
     type ConversationDeleteResponse as ConversationDeleteResponse,
+    type ConversationsCursorPage as ConversationsCursorPage,
     type ConversationCreateParams as ConversationCreateParams,
     type ConversationRetrieveParams as ConversationRetrieveParams,
     type ConversationUpdateParams as ConversationUpdateParams,
@@ -123,8 +99,8 @@ export declare namespace Products {
     Tickets as Tickets,
     type AuthorInput as AuthorInput,
     type Ticket as Ticket,
-    type TicketListResponse as TicketListResponse,
     type TicketDeleteResponse as TicketDeleteResponse,
+    type TicketsCursorPage as TicketsCursorPage,
     type TicketCreateParams as TicketCreateParams,
     type TicketRetrieveParams as TicketRetrieveParams,
     type TicketUpdateParams as TicketUpdateParams,