featurebase-node 0.12.0 → 0.14.0

package/src/resources/support/conversations/index.ts

@@ -2,28 +2,33 @@
 
 export {
   Conversations,
+  type AttachedConversationTag,
   type Conversation,
+  type ConversationAttributeValue,
   type ConversationPart,
   type ConversationPartAuthor,
   type ConversationParticipant,
   type ConversationTagApplication,
+  type ConversationTagMutationActor,
   type CsatEmailDelivery,
   type CsatRatedAgent,
+  type CsatSlackDelivery,
   type CsatWorkflowLink,
   type EmailRecipients,
+  type MessageSource,
+  type SearchMatchingPartAuthor,
+  type SlackMessageDetails,
   type ConversationDeleteResponse,
-  type ConversationAttachTagResponse,
-  type ConversationDetachTagResponse,
   type ConversationSearchResponse,
+  type ConversationListParams,
   type ConversationCreateParams,
   type ConversationRetrieveParams,
-  type ConversationUpdateParams,
-  type ConversationListParams,
   type ConversationDeleteParams,
+  type ConversationUpdateParams,
+  type ConversationReplyParams,
+  type ConversationRedactParams,
   type ConversationAttachTagParams,
   type ConversationDetachTagParams,
-  type ConversationRedactParams,
-  type ConversationReplyParams,
   type ConversationSearchParams,
   type ConversationsCursorPage,
 } from './conversations';

package/src/resources/support/index.ts

@@ -5,35 +5,40 @@ export {
   type ConversationTag,
   type ConversationTagListResponse,
   type ConversationTagDeleteResponse,
-  type ConversationTagRetrieveParams,
   type ConversationTagListParams,
-  type ConversationTagDeleteParams,
   type ConversationTagCreateOrRenameParams,
+  type ConversationTagRetrieveParams,
+  type ConversationTagDeleteParams,
 } from './conversation-tags';
 export {
   Conversations,
+  type AttachedConversationTag,
   type Conversation,
+  type ConversationAttributeValue,
   type ConversationPart,
   type ConversationPartAuthor,
   type ConversationParticipant,
   type ConversationTagApplication,
+  type ConversationTagMutationActor,
   type CsatEmailDelivery,
   type CsatRatedAgent,
+  type CsatSlackDelivery,
   type CsatWorkflowLink,
   type EmailRecipients,
+  type MessageSource,
+  type SearchMatchingPartAuthor,
+  type SlackMessageDetails,
   type ConversationDeleteResponse,
-  type ConversationAttachTagResponse,
-  type ConversationDetachTagResponse,
   type ConversationSearchResponse,
+  type ConversationListParams,
   type ConversationCreateParams,
   type ConversationRetrieveParams,
-  type ConversationUpdateParams,
-  type ConversationListParams,
   type ConversationDeleteParams,
+  type ConversationUpdateParams,
+  type ConversationReplyParams,
+  type ConversationRedactParams,
   type ConversationAttachTagParams,
   type ConversationDetachTagParams,
-  type ConversationRedactParams,
-  type ConversationReplyParams,
   type ConversationSearchParams,
   type ConversationsCursorPage,
 } from './conversations/index';
@@ -43,10 +48,10 @@ export {
   type AuthorInput,
   type Ticket,
   type TicketDeleteResponse,
+  type TicketListParams,
   type TicketCreateParams,
   type TicketRetrieveParams,
   type TicketUpdateParams,
-  type TicketListParams,
   type TicketDeleteParams,
   type TicketReplyParams,
   type TicketsCursorPage,

package/src/resources/support/support.ts

@@ -14,14 +14,14 @@ import {
 } from './conversation-tags';
 import * as ConversationsAPI from './conversations/conversations';
 import {
+  AttachedConversationTag,
   Conversation,
   ConversationAttachTagParams,
-  ConversationAttachTagResponse,
+  ConversationAttributeValue,
   ConversationCreateParams,
   ConversationDeleteParams,
   ConversationDeleteResponse,
   ConversationDetachTagParams,
-  ConversationDetachTagResponse,
   ConversationListParams,
   ConversationPart,
   ConversationPartAuthor,
@@ -32,13 +32,18 @@ import {
   ConversationSearchParams,
   ConversationSearchResponse,
   ConversationTagApplication,
+  ConversationTagMutationActor,
   ConversationUpdateParams,
   Conversations,
   ConversationsCursorPage,
   CsatEmailDelivery,
   CsatRatedAgent,
+  CsatSlackDelivery,
   CsatWorkflowLink,
   EmailRecipients,
+  MessageSource,
+  SearchMatchingPartAuthor,
+  SlackMessageDetails,
 } from './conversations/conversations';
 import * as TicketsAPI from './tickets/tickets';
 import {
@@ -70,29 +75,34 @@ Support.Tickets = Tickets;
 export declare namespace Support {
   export {
     Conversations as Conversations,
+    type AttachedConversationTag as AttachedConversationTag,
     type Conversation as Conversation,
+    type ConversationAttributeValue as ConversationAttributeValue,
     type ConversationPart as ConversationPart,
     type ConversationPartAuthor as ConversationPartAuthor,
     type ConversationParticipant as ConversationParticipant,
     type ConversationTagApplication as ConversationTagApplication,
+    type ConversationTagMutationActor as ConversationTagMutationActor,
     type CsatEmailDelivery as CsatEmailDelivery,
     type CsatRatedAgent as CsatRatedAgent,
+    type CsatSlackDelivery as CsatSlackDelivery,
     type CsatWorkflowLink as CsatWorkflowLink,
     type EmailRecipients as EmailRecipients,
+    type MessageSource as MessageSource,
+    type SearchMatchingPartAuthor as SearchMatchingPartAuthor,
+    type SlackMessageDetails as SlackMessageDetails,
     type ConversationDeleteResponse as ConversationDeleteResponse,
-    type ConversationAttachTagResponse as ConversationAttachTagResponse,
-    type ConversationDetachTagResponse as ConversationDetachTagResponse,
     type ConversationSearchResponse as ConversationSearchResponse,
     type ConversationsCursorPage as ConversationsCursorPage,
+    type ConversationListParams as ConversationListParams,
     type ConversationCreateParams as ConversationCreateParams,
     type ConversationRetrieveParams as ConversationRetrieveParams,
-    type ConversationUpdateParams as ConversationUpdateParams,
-    type ConversationListParams as ConversationListParams,
     type ConversationDeleteParams as ConversationDeleteParams,
+    type ConversationUpdateParams as ConversationUpdateParams,
+    type ConversationReplyParams as ConversationReplyParams,
+    type ConversationRedactParams as ConversationRedactParams,
     type ConversationAttachTagParams as ConversationAttachTagParams,
     type ConversationDetachTagParams as ConversationDetachTagParams,
-    type ConversationRedactParams as ConversationRedactParams,
-    type ConversationReplyParams as ConversationReplyParams,
     type ConversationSearchParams as ConversationSearchParams,
   };
 
@@ -101,10 +111,10 @@ export declare namespace Support {
     type ConversationTag as ConversationTag,
     type ConversationTagListResponse as ConversationTagListResponse,
     type ConversationTagDeleteResponse as ConversationTagDeleteResponse,
-    type ConversationTagRetrieveParams as ConversationTagRetrieveParams,
     type ConversationTagListParams as ConversationTagListParams,
-    type ConversationTagDeleteParams as ConversationTagDeleteParams,
     type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams,
+    type ConversationTagRetrieveParams as ConversationTagRetrieveParams,
+    type ConversationTagDeleteParams as ConversationTagDeleteParams,
   };
 
   export {
@@ -113,10 +123,10 @@ export declare namespace Support {
     type Ticket as Ticket,
     type TicketDeleteResponse as TicketDeleteResponse,
     type TicketsCursorPage as TicketsCursorPage,
+    type TicketListParams as TicketListParams,
     type TicketCreateParams as TicketCreateParams,
     type TicketRetrieveParams as TicketRetrieveParams,
     type TicketUpdateParams as TicketUpdateParams,
-    type TicketListParams as TicketListParams,
     type TicketDeleteParams as TicketDeleteParams,
     type TicketReplyParams as TicketReplyParams,
   };

package/src/resources/support/tickets/categories.ts

@@ -12,26 +12,32 @@ import { path } from '../../../internal/utils/path';
  */
 export class Categories extends APIResource {
   /**
-   * Retrieves a single ticket category by its unique identifier.
+   * Returns all ticket categories for the authenticated organization.
    *
-   * Returns the full category object including access controls, feature toggles, and
-   * localization settings.
+   * Ticket categories organize tickets into distinct containers. Each category can
+   * have different:
+   *
+   * - Access controls (public, private, segment-restricted)
+   * - Feature toggles (comments, posting enabled)
+   * - Custom fields
+   *
+   * Use the `supportBoard` and `supportBoardType` fields to identify ticket
+   * categories.
+   *
+   * This endpoint returns all categories without pagination.
    *
    * @example
    * ```ts
-   * const board =
-   *   await client.support.tickets.categories.retrieve(
-   *     '507f1f77bcf86cd799439011',
-   *   );
+   * const boards =
+   *   await client.support.tickets.categories.list();
    * ```
    */
-  retrieve(
-    id: string,
-    params: CategoryRetrieveParams | null | undefined = {},
+  list(
+    params: CategoryListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<BoardsAPI.Board> {
+  ): APIPromise<CategoryListResponse> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/tickets/categories/${id}`, {
+    return this._client.get('/v2/tickets/categories', {
       ...options,
       headers: buildHeaders([
         {
@@ -45,32 +51,26 @@ export class Categories extends APIResource {
   }
 
   /**
-   * Returns all ticket categories for the authenticated organization.
-   *
-   * Ticket categories organize tickets into distinct containers. Each category can
-   * have different:
-   *
-   * - Access controls (public, private, segment-restricted)
-   * - Feature toggles (comments, posting enabled)
-   * - Custom fields
-   *
-   * Use the `supportBoard` and `supportBoardType` fields to identify ticket
-   * categories.
+   * Retrieves a single ticket category by its unique identifier.
    *
-   * This endpoint returns all categories without pagination.
+   * Returns the full category object including access controls, feature toggles, and
+   * localization settings.
    *
    * @example
    * ```ts
-   * const boards =
-   *   await client.support.tickets.categories.list();
+   * const board =
+   *   await client.support.tickets.categories.retrieve(
+   *     '507f1f77bcf86cd799439011',
+   *   );
    * ```
    */
-  list(
-    params: CategoryListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: CategoryRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CategoryListResponse> {
+  ): APIPromise<BoardsAPI.Board> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get('/v2/tickets/categories', {
+    return this._client.get(path`/v2/tickets/categories/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -86,7 +86,7 @@ export class Categories extends APIResource {
 
 export type CategoryListResponse = Array<BoardsAPI.Board>;
 
-export interface CategoryRetrieveParams {
+export interface CategoryListParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -94,7 +94,7 @@ export interface CategoryRetrieveParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface CategoryListParams {
+export interface CategoryRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -105,7 +105,7 @@ export interface CategoryListParams {
 export declare namespace Categories {
   export {
     type CategoryListResponse as CategoryListResponse,
-    type CategoryRetrieveParams as CategoryRetrieveParams,
     type CategoryListParams as CategoryListParams,
+    type CategoryRetrieveParams as CategoryRetrieveParams,
   };
 }

package/src/resources/support/tickets/custom-fields.ts

@@ -12,11 +12,14 @@ import { path } from '../../../internal/utils/path';
  */
 export class CustomFields extends APIResource {
   /**
-   * Retrieves a single custom field by its unique identifier.
+   * Returns all custom fields configured in your organization that can be used on
+   * tickets.
    *
-   * ### Response
+   * This endpoint returns all custom fields at once. No pagination is supported.
    *
-   * Returns a custom field object with:
+   * ### Custom Field Object
+   *
+   * Each custom field includes:
    *
    * - `id` - Unique field identifier
    * - `label` - Field label displayed to users
@@ -30,19 +33,16 @@ export class CustomFields extends APIResource {
    *
    * @example
    * ```ts
-   * const customField =
-   *   await client.support.tickets.customFields.retrieve(
-   *     '65d26304b2e65b1e1278170c',
-   *   );
+   * const customFieldList =
+   *   await client.support.tickets.customFields.list();
    * ```
    */
-  retrieve(
-    id: string,
-    params: CustomFieldRetrieveParams | null | undefined = {},
+  list(
+    params: CustomFieldListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomFieldsAPI.CustomField> {
+  ): APIPromise<CustomFieldsAPI.CustomFieldList> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/tickets/custom_fields/${id}`, {
+    return this._client.get('/v2/tickets/custom_fields', {
       ...options,
       headers: buildHeaders([
         {
@@ -56,14 +56,11 @@ export class CustomFields extends APIResource {
   }
 
   /**
-   * Returns all custom fields configured in your organization that can be used on
-   * tickets.
-   *
-   * This endpoint returns all custom fields at once. No pagination is supported.
+   * Retrieves a single custom field by its unique identifier.
    *
-   * ### Custom Field Object
+   * ### Response
    *
-   * Each custom field includes:
+   * Returns a custom field object with:
    *
    * - `id` - Unique field identifier
    * - `label` - Field label displayed to users
@@ -77,16 +74,19 @@ export class CustomFields extends APIResource {
    *
    * @example
    * ```ts
-   * const customFieldList =
-   *   await client.support.tickets.customFields.list();
+   * const customField =
+   *   await client.support.tickets.customFields.retrieve(
+   *     '65d26304b2e65b1e1278170c',
+   *   );
    * ```
    */
-  list(
-    params: CustomFieldListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: CustomFieldRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomFieldsAPI.CustomFieldList> {
+  ): APIPromise<CustomFieldsAPI.CustomField> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get('/v2/tickets/custom_fields', {
+    return this._client.get(path`/v2/tickets/custom_fields/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -100,7 +100,7 @@ export class CustomFields extends APIResource {
   }
 }
 
-export interface CustomFieldRetrieveParams {
+export interface CustomFieldListParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -108,7 +108,7 @@ export interface CustomFieldRetrieveParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface CustomFieldListParams {
+export interface CustomFieldRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -118,7 +118,7 @@ export interface CustomFieldListParams {
 
 export declare namespace CustomFields {
   export {
-    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
     type CustomFieldListParams as CustomFieldListParams,
+    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
   };
 }

package/src/resources/support/tickets/index.ts

@@ -3,25 +3,25 @@
 export {
   Categories,
   type CategoryListResponse,
-  type CategoryRetrieveParams,
   type CategoryListParams,
+  type CategoryRetrieveParams,
 } from './categories';
-export { CustomFields, type CustomFieldRetrieveParams, type CustomFieldListParams } from './custom-fields';
+export { CustomFields, type CustomFieldListParams, type CustomFieldRetrieveParams } from './custom-fields';
 export {
   Statuses,
   type StatusListResponse,
-  type StatusRetrieveParams,
   type StatusListParams,
+  type StatusRetrieveParams,
 } from './statuses';
 export {
   Tickets,
   type AuthorInput,
   type Ticket,
   type TicketDeleteResponse,
+  type TicketListParams,
   type TicketCreateParams,
   type TicketRetrieveParams,
   type TicketUpdateParams,
-  type TicketListParams,
   type TicketDeleteParams,
   type TicketReplyParams,
   type TicketsCursorPage,

package/src/resources/support/tickets/statuses.ts

@@ -12,25 +12,29 @@ import { path } from '../../../internal/utils/path';
  */
 export class Statuses extends APIResource {
   /**
-   * Retrieves a single ticket status by its unique identifier.
+   * Returns all ticket statuses for the authenticated organization.
    *
-   * Returns the status object including name, color, type, and default flag.
+   * Ticket statuses define workflow stages. Each status has:
+   *
+   * - A display name and color
+   * - A type indicating the workflow stage (reviewing, unstarted, active, completed,
+   *   canceled)
+   * - A flag indicating if it's the default status for new tickets
+   *
+   * This endpoint returns all statuses without pagination.
    *
    * @example
    * ```ts
-   * const postStatus =
-   *   await client.support.tickets.statuses.retrieve(
-   *     '507f1f77bcf86cd799439011',
-   *   );
+   * const postStatuses =
+   *   await client.support.tickets.statuses.list();
    * ```
    */
-  retrieve(
-    id: string,
-    params: StatusRetrieveParams | null | undefined = {},
+  list(
+    params: StatusListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<PostStatusesAPI.PostStatus> {
+  ): APIPromise<StatusListResponse> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/tickets/statuses/${id}`, {
+    return this._client.get('/v2/tickets/statuses', {
       ...options,
       headers: buildHeaders([
         {
@@ -44,29 +48,25 @@ export class Statuses extends APIResource {
   }
 
   /**
-   * Returns all ticket statuses for the authenticated organization.
-   *
-   * Ticket statuses define workflow stages. Each status has:
-   *
-   * - A display name and color
-   * - A type indicating the workflow stage (reviewing, unstarted, active, completed,
-   *   canceled)
-   * - A flag indicating if it's the default status for new tickets
+   * Retrieves a single ticket status by its unique identifier.
    *
-   * This endpoint returns all statuses without pagination.
+   * Returns the status object including name, color, type, and default flag.
    *
    * @example
    * ```ts
-   * const postStatuses =
-   *   await client.support.tickets.statuses.list();
+   * const postStatus =
+   *   await client.support.tickets.statuses.retrieve(
+   *     '507f1f77bcf86cd799439011',
+   *   );
    * ```
    */
-  list(
-    params: StatusListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: StatusRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<StatusListResponse> {
+  ): APIPromise<PostStatusesAPI.PostStatus> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get('/v2/tickets/statuses', {
+    return this._client.get(path`/v2/tickets/statuses/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -82,7 +82,7 @@ export class Statuses extends APIResource {
 
 export type StatusListResponse = Array<PostStatusesAPI.PostStatus>;
 
-export interface StatusRetrieveParams {
+export interface StatusListParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -90,7 +90,7 @@ export interface StatusRetrieveParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface StatusListParams {
+export interface StatusRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -101,7 +101,7 @@ export interface StatusListParams {
 export declare namespace Statuses {
   export {
     type StatusListResponse as StatusListResponse,
-    type StatusRetrieveParams as StatusRetrieveParams,
     type StatusListParams as StatusListParams,
+    type StatusRetrieveParams as StatusRetrieveParams,
   };
 }