featurebase-node 0.3.0 → 0.5.0

package/src/resources/users/contacts/by-user-id/email-preferences.ts

@@ -72,7 +72,11 @@ export class EmailPreferences extends APIResource {
     return this._client.get(path`/v2/contacts/by-user-id/${userID}/email-preferences`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -177,7 +181,11 @@ export class EmailPreferences extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -189,7 +197,7 @@ export interface EmailPreferenceRetrieveParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface EmailPreferenceUpdateParams {
@@ -202,7 +210,7 @@ export interface EmailPreferenceUpdateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export namespace EmailPreferenceUpdateParams {

package/src/resources/users/contacts/contacts.ts

@@ -20,6 +20,7 @@ import {
   ByUserIDRetrieveResponse,
 } from './by-user-id/by-user-id';
 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';
@@ -92,7 +93,11 @@ export class Contacts extends APIResource {
     return this._client.get(path`/v2/contacts/${id}`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -157,16 +162,26 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contactList = await client.users.contacts.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const contact of client.users.contacts.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: ContactListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ContactList> {
+  list(
+    params: ContactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ContactListDataCursorPage, ContactList.Data> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/contacts', {
+    return this._client.getAPIList('/v2/contacts', CursorPage<ContactList.Data>, {
       query,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -228,7 +243,11 @@ export class Contacts extends APIResource {
     return this._client.delete(path`/v2/contacts/${id}`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -295,7 +314,11 @@ export class Contacts extends APIResource {
     return this._client.post(path`/v2/contacts/${id}/block`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -405,7 +428,11 @@ export class Contacts extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -471,13 +498,19 @@ export class Contacts extends APIResource {
     return this._client.post(path`/v2/contacts/${id}/unblock`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
   }
 }
 
+export type ContactListDataCursorPage = CursorPage<ContactList.Data>;
+
 /**
  * User who submitted the response
  */
@@ -668,31 +701,20 @@ export interface ContactRetrieveParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface ContactListParams {
+export interface ContactListParams extends CursorPageParams {
   /**
    * Query param: Filter contacts by type. Defaults to "customer".
    */
   contactType?: 'customer' | 'lead' | 'all';
 
-  /**
-   * 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;
-
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface ContactDeleteParams {
@@ -700,7 +722,7 @@ export interface ContactDeleteParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface ContactBlockParams {
@@ -708,7 +730,7 @@ export interface ContactBlockParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface ContactCreateOrUpdateParams {
@@ -779,7 +801,7 @@ export interface ContactCreateOrUpdateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export namespace ContactCreateOrUpdateParams {
@@ -868,7 +890,7 @@ export interface ContactUnblockParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 Contacts.ByUserID = ByUserID;
@@ -883,6 +905,7 @@ export declare namespace Contacts {
     type ContactBlockResponse as ContactBlockResponse,
     type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse,
     type ContactUnblockResponse as ContactUnblockResponse,
+    type ContactListDataCursorPage as ContactListDataCursorPage,
     type ContactRetrieveParams as ContactRetrieveParams,
     type ContactListParams as ContactListParams,
     type ContactDeleteParams as ContactDeleteParams,

package/src/resources/users/contacts/email-preferences.ts

@@ -90,7 +90,11 @@ export class EmailPreferences extends APIResource {
     return this._client.get(path`/v2/contacts/${id}/email-preferences`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -220,7 +224,11 @@ export class EmailPreferences extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -342,7 +350,7 @@ export interface EmailPreferenceRetrieveParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface EmailPreferenceUpdateParams {
@@ -355,7 +363,7 @@ export interface EmailPreferenceUpdateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export namespace EmailPreferenceUpdateParams {

package/src/resources/users/contacts/index.ts

@@ -21,6 +21,7 @@ export {
   type ContactBlockParams,
   type ContactCreateOrUpdateParams,
   type ContactUnblockParams,
+  type ContactListDataCursorPage,
 } from './contacts';
 export {
   EmailPreferences,

package/src/resources/users/index.ts

@@ -4,12 +4,12 @@ export {
   Companies,
   type Company,
   type DeletedCompany,
-  type CompanyListResponse,
   type CompanyRetrieveParams,
   type CompanyListParams,
   type CompanyDeleteParams,
   type CompanyCreateOrUpdateParams,
   type CompanyDeleteByCompanyIDParams,
+  type CompaniesCursorPage,
 } from './companies/index';
 export {
   Contacts,
@@ -26,5 +26,6 @@ export {
   type ContactBlockParams,
   type ContactCreateOrUpdateParams,
   type ContactUnblockParams,
+  type ContactListDataCursorPage,
 } from './contacts/index';
 export { Users } from './users';

package/src/resources/users/users.ts

@@ -4,12 +4,12 @@ import { APIResource } from '../../core/resource';
 import * as CompaniesAPI from './companies/companies';
 import {
   Companies,
+  CompaniesCursorPage,
   Company,
   CompanyCreateOrUpdateParams,
   CompanyDeleteByCompanyIDParams,
   CompanyDeleteParams,
   CompanyListParams,
-  CompanyListResponse,
   CompanyRetrieveParams,
   DeletedCompany,
 } from './companies/companies';
@@ -22,6 +22,7 @@ import {
   ContactCreateOrUpdateResponse,
   ContactDeleteParams,
   ContactList,
+  ContactListDataCursorPage,
   ContactListParams,
   ContactRetrieveParams,
   ContactRetrieveResponse,
@@ -49,6 +50,7 @@ export declare namespace Users {
     type ContactBlockResponse as ContactBlockResponse,
     type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse,
     type ContactUnblockResponse as ContactUnblockResponse,
+    type ContactListDataCursorPage as ContactListDataCursorPage,
     type ContactRetrieveParams as ContactRetrieveParams,
     type ContactListParams as ContactListParams,
     type ContactDeleteParams as ContactDeleteParams,
@@ -61,7 +63,7 @@ export declare namespace Users {
     Companies as Companies,
     type Company as Company,
     type DeletedCompany as DeletedCompany,
-    type CompanyListResponse as CompanyListResponse,
+    type CompaniesCursorPage as CompaniesCursorPage,
     type CompanyRetrieveParams as CompanyRetrieveParams,
     type CompanyListParams as CompanyListParams,
     type CompanyDeleteParams as CompanyDeleteParams,

package/src/resources/webhooks.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';
@@ -98,7 +99,11 @@ export class Webhooks extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -182,7 +187,11 @@ export class Webhooks extends APIResource {
     return this._client.get(path`/v2/webhooks/${id}`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -269,7 +278,11 @@ export class Webhooks extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -331,19 +344,26 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhooks = await client.webhooks.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const webhook of client.webhooks.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: WebhookListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<WebhookListResponse> {
+  ): PagePromise<WebhooksCursorPage, Webhook> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/webhooks', {
+    return this._client.getAPIList('/v2/webhooks', CursorPage<Webhook>, {
       query,
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -394,7 +414,11 @@ export class Webhooks extends APIResource {
     return this._client.delete(path`/v2/webhooks/${id}`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -453,13 +477,19 @@ export class Webhooks extends APIResource {
     return this._client.post(path`/v2/webhooks/${id}/secret`, {
       ...options,
       headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
         options?.headers,
       ]),
     });
   }
 }
 
+export type WebhooksCursorPage = CursorPage<Webhook>;
+
 export interface Webhook {
   /**
    * Unique identifier
@@ -625,23 +655,6 @@ export interface WebhookRequestConfigInput {
   headers?: { [key: string]: string };
 }
 
-export interface WebhookListResponse {
-  /**
-   * Array of webhooks
-   */
-  data: Array<Webhook>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface WebhookDeleteResponse {
   /**
    * Unique identifier of the deleted webhook
@@ -717,7 +730,7 @@ export interface WebhookCreateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface WebhookRetrieveParams {
@@ -725,7 +738,7 @@ export interface WebhookRetrieveParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface WebhookUpdateParams {
@@ -791,21 +804,10 @@ export interface WebhookUpdateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface WebhookListParams {
-  /**
-   * 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 WebhookListParams extends CursorPageParams {
   /**
    * Query param: Filter webhooks by status
    */
@@ -815,7 +817,7 @@ export interface WebhookListParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface WebhookDeleteParams {
@@ -823,7 +825,7 @@ export interface WebhookDeleteParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface WebhookRefreshSecretParams {
@@ -831,15 +833,15 @@ export interface WebhookRefreshSecretParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: string;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export declare namespace Webhooks {
   export {
     type Webhook as Webhook,
     type WebhookRequestConfigInput as WebhookRequestConfigInput,
-    type WebhookListResponse as WebhookListResponse,
     type WebhookDeleteResponse as WebhookDeleteResponse,
+    type WebhooksCursorPage as WebhooksCursorPage,
     type WebhookCreateParams as WebhookCreateParams,
     type WebhookRetrieveParams as WebhookRetrieveParams,
     type WebhookUpdateParams as WebhookUpdateParams,

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.5.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.3.0'; // x-release-please-version
+exports.VERSION = '0.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.5.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map