helprange 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -5,7 +5,14 @@ All notable changes to this package are documented here. The format follows
 
 ## [Unreleased]
 
-## [0.1.0] – unreleased
+## [0.1.1] – 2026-11-15
+
+- `links.list` uses the `data_room_id` filter (`room_id` still accepted by the API but deprecated); date filters accept a date or date-time.
+- Webhook endpoint deliveries can be paged (`page`, `limit`, `total`, `next_page`).
+- `disabled_reason` on webhook endpoints may be `null`.
+- Data room guest details use a named schema; removing guests or documents requires a body.
+
+## [0.1.0] – 2026-11-15
 
 First release, generated from HelpRange API spec version 2026-11-15 (not published yet; this entry describes
 everything that will ship in it).

package/dist/cjs/client.d.ts

@@ -67,7 +67,7 @@ export declare class HelpRange implements Requester {
     rateLimit: RateLimitInfo;
     /** Spec version this SDK was generated from. */
     static readonly API_VERSION = "2026-11-15";
-    static readonly VERSION = "0.1.0";
+    static readonly VERSION = "0.1.1";
     constructor(options?: HelpRangeOptions);
     /** True for a test-mode key (`hr_test_…`): every call works on your team's sandbox, never on live data. */
     get testMode(): boolean;

package/dist/cjs/generated/resources.d.ts

@@ -26,7 +26,7 @@ export declare class DataRoomsGuests {
     /**
      * Remove a guest.
      *
-     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen.
+     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen. Send email or guest_id – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/guests/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).
@@ -190,7 +190,7 @@ export declare class DataRoomsDocuments {
     /**
      * Remove documents from a data room.
      *
-     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen.
+     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen. Send document_ids and / or room_link_ids – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/documents/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).

package/dist/cjs/generated/resources.js

@@ -35,7 +35,7 @@ class DataRoomsGuests {
     /**
      * Remove a guest.
      *
-     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen.
+     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen. Send email or guest_id – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/guests/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).
@@ -245,7 +245,7 @@ class DataRoomsDocuments {
     /**
      * Remove documents from a data room.
      *
-     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen.
+     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen. Send document_ids and / or room_link_ids – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/documents/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).

package/dist/cjs/generated/types.d.ts

@@ -310,6 +310,17 @@ export interface RoomGuest {
     /** The guest's own invitation link (what the invitation e-mail carries). */
     link: string;
 }
+/** A guest of the room with views, last visit and NDA status (nda and nda_signed_at only when the room asks for an NDA). */
+export interface DataRoomGuestDetail {
+    id: number;
+    email: string;
+    /** The guest's own invitation link (what the invitation e-mail carries). */
+    link: string;
+    views: number;
+    last_view_at: string | null;
+    nda?: "signed" | "signed an older version" | "not signed";
+    nda_signed_at?: string | null;
+}
 export interface WebhookEndpoint {
     id: number;
     url: string;
@@ -637,14 +648,16 @@ export interface ListLinksQuery {
     document_id?: number;
     /** Only links of documents in this folder. */
     folder_id?: number;
-    /** Only links of this data room (data_room_id is accepted too). */
+    /** Only links of this data room. */
+    data_room_id?: number;
+    /** Deprecated alias of data_room_id (still accepted; data_room_id wins when both are sent). */
     room_id?: number;
     /** Label contains this text (case-insensitive); "default" = the documents' default links. */
     label?: string;
     /** Created on or after: YYYY-MM-DD (UTC) or an ISO 8601 date-time. */
-    created_after?: string;
+    created_after?: unknown | unknown;
     /** Created on or before: YYYY-MM-DD (the whole day, UTC) or an ISO 8601 date-time. */
-    created_before?: string;
+    created_before?: unknown | unknown;
     /** active, expired (past its expiry date or views limit used up) or disabled (turned off in the panel). Missing or all: every link. */
     status?: "active" | "expired" | "disabled" | "all";
     /** Page number, 1 or more (default 1). next_page in the response is the next one, or null. */
@@ -998,16 +1011,6 @@ export interface CreateDataRoomBody {
     /** Only the settings sent change (unknown keys: 400). They may also be sent at the top level. A setting the plan does not include: 402 naming the plan – never dropped silently. */
     settings?: CreateDataRoomBodySettings;
 }
-export interface CreateDataRoomResponseGuest {
-    id: number;
-    email: string;
-    /** The guest's own invitation link. */
-    link: string;
-    views: number;
-    last_view_at: string | null;
-    nda?: "signed" | "signed an older version" | "not signed";
-    nda_signed_at?: string | null;
-}
 export interface CreateDataRoomResponseDocument {
     id: number;
     name: string;
@@ -1055,7 +1058,7 @@ export interface CreateDataRoomResponse {
     /** The room's folders in order (empty while folders are off). */
     folders: Array<ListFoldersResponseFolder>;
     approval_workflow: boolean;
-    guests: Array<CreateDataRoomResponseGuest>;
+    guests: Array<DataRoomGuestDetail>;
     pending_access_requests: number;
     documents: Array<CreateDataRoomResponseDocument>;
     expires_at: string | null;
@@ -1653,13 +1656,20 @@ export interface SendWebhookTestEventResponse {
 export interface ListWebhookDeliveriesQuery {
     /** Only this status. */
     status?: "pending" | "delivered" | "failed";
-    /** 1–100 (default 100). */
+    /** Items per page, 1–100 (default 100). */
     limit?: number;
+    /** Page number, 1 or more (default 1). next_page in the response is the next one, or null. */
+    page?: number;
 }
 export interface ListWebhookDeliveriesResponse {
     webhook_endpoint_id: number;
     retention_days: number;
     deliveries: Array<WebhookDelivery>;
+    page: number;
+    limit: number;
+    /** Deliveries matching the filter. */
+    total: number;
+    next_page: number | null;
     /** false for test-mode (hr_test_) keys, true for live keys. */
     livemode?: boolean;
 }

package/dist/cjs/version.d.ts

@@ -1,2 +1,2 @@
 /** SDK version – keep equal to package.json "version" (a test checks it). */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";

package/dist/cjs/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 /** SDK version – keep equal to package.json "version" (a test checks it). */
-exports.VERSION = '0.1.0';
+exports.VERSION = '0.1.1';
 //# sourceMappingURL=version.js.map

package/dist/esm/client.d.ts

@@ -67,7 +67,7 @@ export declare class HelpRange implements Requester {
     rateLimit: RateLimitInfo;
     /** Spec version this SDK was generated from. */
     static readonly API_VERSION = "2026-11-15";
-    static readonly VERSION = "0.1.0";
+    static readonly VERSION = "0.1.1";
     constructor(options?: HelpRangeOptions);
     /** True for a test-mode key (`hr_test_…`): every call works on your team's sandbox, never on live data. */
     get testMode(): boolean;

package/dist/esm/generated/resources.d.ts

@@ -26,7 +26,7 @@ export declare class DataRoomsGuests {
     /**
      * Remove a guest.
      *
-     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen.
+     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen. Send email or guest_id – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/guests/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).
@@ -190,7 +190,7 @@ export declare class DataRoomsDocuments {
     /**
      * Remove documents from a data room.
      *
-     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen.
+     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen. Send document_ids and / or room_link_ids – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/documents/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).

package/dist/esm/generated/resources.js

@@ -31,7 +31,7 @@ export class DataRoomsGuests {
     /**
      * Remove a guest.
      *
-     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen.
+     * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen. Send email or guest_id – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/guests/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).
@@ -235,7 +235,7 @@ export class DataRoomsDocuments {
     /**
      * Remove documents from a data room.
      *
-     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen.
+     * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen. Send document_ids and / or room_link_ids – an empty body is a 400.
      *
      * `POST /api/v2/data-rooms/{data_room_id}/documents/remove` – scope `rooms:write`
      * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).

package/dist/esm/generated/types.d.ts

@@ -310,6 +310,17 @@ export interface RoomGuest {
     /** The guest's own invitation link (what the invitation e-mail carries). */
     link: string;
 }
+/** A guest of the room with views, last visit and NDA status (nda and nda_signed_at only when the room asks for an NDA). */
+export interface DataRoomGuestDetail {
+    id: number;
+    email: string;
+    /** The guest's own invitation link (what the invitation e-mail carries). */
+    link: string;
+    views: number;
+    last_view_at: string | null;
+    nda?: "signed" | "signed an older version" | "not signed";
+    nda_signed_at?: string | null;
+}
 export interface WebhookEndpoint {
     id: number;
     url: string;
@@ -637,14 +648,16 @@ export interface ListLinksQuery {
     document_id?: number;
     /** Only links of documents in this folder. */
     folder_id?: number;
-    /** Only links of this data room (data_room_id is accepted too). */
+    /** Only links of this data room. */
+    data_room_id?: number;
+    /** Deprecated alias of data_room_id (still accepted; data_room_id wins when both are sent). */
     room_id?: number;
     /** Label contains this text (case-insensitive); "default" = the documents' default links. */
     label?: string;
     /** Created on or after: YYYY-MM-DD (UTC) or an ISO 8601 date-time. */
-    created_after?: string;
+    created_after?: unknown | unknown;
     /** Created on or before: YYYY-MM-DD (the whole day, UTC) or an ISO 8601 date-time. */
-    created_before?: string;
+    created_before?: unknown | unknown;
     /** active, expired (past its expiry date or views limit used up) or disabled (turned off in the panel). Missing or all: every link. */
     status?: "active" | "expired" | "disabled" | "all";
     /** Page number, 1 or more (default 1). next_page in the response is the next one, or null. */
@@ -998,16 +1011,6 @@ export interface CreateDataRoomBody {
     /** Only the settings sent change (unknown keys: 400). They may also be sent at the top level. A setting the plan does not include: 402 naming the plan – never dropped silently. */
     settings?: CreateDataRoomBodySettings;
 }
-export interface CreateDataRoomResponseGuest {
-    id: number;
-    email: string;
-    /** The guest's own invitation link. */
-    link: string;
-    views: number;
-    last_view_at: string | null;
-    nda?: "signed" | "signed an older version" | "not signed";
-    nda_signed_at?: string | null;
-}
 export interface CreateDataRoomResponseDocument {
     id: number;
     name: string;
@@ -1055,7 +1058,7 @@ export interface CreateDataRoomResponse {
     /** The room's folders in order (empty while folders are off). */
     folders: Array<ListFoldersResponseFolder>;
     approval_workflow: boolean;
-    guests: Array<CreateDataRoomResponseGuest>;
+    guests: Array<DataRoomGuestDetail>;
     pending_access_requests: number;
     documents: Array<CreateDataRoomResponseDocument>;
     expires_at: string | null;
@@ -1653,13 +1656,20 @@ export interface SendWebhookTestEventResponse {
 export interface ListWebhookDeliveriesQuery {
     /** Only this status. */
     status?: "pending" | "delivered" | "failed";
-    /** 1–100 (default 100). */
+    /** Items per page, 1–100 (default 100). */
     limit?: number;
+    /** Page number, 1 or more (default 1). next_page in the response is the next one, or null. */
+    page?: number;
 }
 export interface ListWebhookDeliveriesResponse {
     webhook_endpoint_id: number;
     retention_days: number;
     deliveries: Array<WebhookDelivery>;
+    page: number;
+    limit: number;
+    /** Deliveries matching the filter. */
+    total: number;
+    next_page: number | null;
     /** false for test-mode (hr_test_) keys, true for live keys. */
     livemode?: boolean;
 }

package/dist/esm/version.d.ts

@@ -1,2 +1,2 @@
 /** SDK version – keep equal to package.json "version" (a test checks it). */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 /** SDK version – keep equal to package.json "version" (a test checks it). */
-export const VERSION = '0.1.0';
+export const VERSION = '0.1.1';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "helprange",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Official HelpRange API client for Node.js and TypeScript: upload documents, create tracked share links, run data rooms, e-signature, offers and analytics.",
   "license": "MIT",
   "author": "HelpRange <hello@helprange.com> (https://www.helprange.com)",

package/src/generated/resources.ts

@@ -38,7 +38,7 @@ export class DataRoomsGuests {
   /**
    * Remove a guest.
    *
-   * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen.
+   * Takes a guest out of this room (by email or guest_id); they keep access to other rooms they are in. 409 when the room is frozen. Send email or guest_id – an empty body is a 400.
    *
    * `POST /api/v2/data-rooms/{data_room_id}/guests/remove` – scope `rooms:write`
    * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).
@@ -256,7 +256,7 @@ export class DataRoomsDocuments {
   /**
    * Remove documents from a data room.
    *
-   * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen.
+   * Like "Remove" on the room page: the documents leave the room (guests no longer see them); the files stay in their folders. Ids not in the room are listed in not_in_room. 409 when the room is frozen. Send document_ids and / or room_link_ids – an empty body is a 400.
    *
    * `POST /api/v2/data-rooms/{data_room_id}/documents/remove` – scope `rooms:write`
    * Sent with an Idempotency-Key, so retries are safe (set your own with `options.idempotencyKey`).

package/src/generated/types.ts

@@ -340,6 +340,18 @@ export interface RoomGuest {
   link: string;
 }
 
+/** A guest of the room with views, last visit and NDA status (nda and nda_signed_at only when the room asks for an NDA). */
+export interface DataRoomGuestDetail {
+  id: number;
+  email: string;
+  /** The guest's own invitation link (what the invitation e-mail carries). */
+  link: string;
+  views: number;
+  last_view_at: string | null;
+  nda?: "signed" | "signed an older version" | "not signed";
+  nda_signed_at?: string | null;
+}
+
 export interface WebhookEndpoint {
   id: number;
   url: string;
@@ -701,14 +713,16 @@ export interface ListLinksQuery {
   document_id?: number;
   /** Only links of documents in this folder. */
   folder_id?: number;
-  /** Only links of this data room (data_room_id is accepted too). */
+  /** Only links of this data room. */
+  data_room_id?: number;
+  /** Deprecated alias of data_room_id (still accepted; data_room_id wins when both are sent). */
   room_id?: number;
   /** Label contains this text (case-insensitive); "default" = the documents' default links. */
   label?: string;
   /** Created on or after: YYYY-MM-DD (UTC) or an ISO 8601 date-time. */
-  created_after?: string;
+  created_after?: unknown | unknown;
   /** Created on or before: YYYY-MM-DD (the whole day, UTC) or an ISO 8601 date-time. */
-  created_before?: string;
+  created_before?: unknown | unknown;
   /** active, expired (past its expiry date or views limit used up) or disabled (turned off in the panel). Missing or all: every link. */
   status?: "active" | "expired" | "disabled" | "all";
   /** Page number, 1 or more (default 1). next_page in the response is the next one, or null. */
@@ -1097,17 +1111,6 @@ export interface CreateDataRoomBody {
   settings?: CreateDataRoomBodySettings;
 }
 
-export interface CreateDataRoomResponseGuest {
-  id: number;
-  email: string;
-  /** The guest's own invitation link. */
-  link: string;
-  views: number;
-  last_view_at: string | null;
-  nda?: "signed" | "signed an older version" | "not signed";
-  nda_signed_at?: string | null;
-}
-
 export interface CreateDataRoomResponseDocument {
   id: number;
   name: string;
@@ -1159,7 +1162,7 @@ export interface CreateDataRoomResponse {
   /** The room's folders in order (empty while folders are off). */
   folders: Array<ListFoldersResponseFolder>;
   approval_workflow: boolean;
-  guests: Array<CreateDataRoomResponseGuest>;
+  guests: Array<DataRoomGuestDetail>;
   pending_access_requests: number;
   documents: Array<CreateDataRoomResponseDocument>;
   expires_at: string | null;
@@ -1827,14 +1830,21 @@ export interface SendWebhookTestEventResponse {
 export interface ListWebhookDeliveriesQuery {
   /** Only this status. */
   status?: "pending" | "delivered" | "failed";
-  /** 1–100 (default 100). */
+  /** Items per page, 1–100 (default 100). */
   limit?: number;
+  /** Page number, 1 or more (default 1). next_page in the response is the next one, or null. */
+  page?: number;
 }
 
 export interface ListWebhookDeliveriesResponse {
   webhook_endpoint_id: number;
   retention_days: number;
   deliveries: Array<WebhookDelivery>;
+  page: number;
+  limit: number;
+  /** Deliveries matching the filter. */
+  total: number;
+  next_page: number | null;
   /** false for test-mode (hr_test_) keys, true for live keys. */
   livemode?: boolean;
 }

package/src/version.ts

@@ -1,2 +1,2 @@
 /** SDK version – keep equal to package.json "version" (a test checks it). */
-export const VERSION = '0.1.0';
+export const VERSION = '0.1.1';