@graph8/sdk 0.264.0 → 0.277.0

package/docs/api/repos.d.ts

@@ -125,10 +125,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface RepoResponse {

package/docs/api/research.d.ts

@@ -265,10 +265,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** Re-run one failed report. SPENDS CREDIT. */

package/docs/api/revenue.d.ts

@@ -318,10 +318,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/revenueAnalytics.d.ts

@@ -137,10 +137,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** A dashboard or rollup, as the app computes it. */

package/docs/api/revenueLifecycle.d.ts

@@ -153,7 +153,9 @@ export interface LifecycleRecordItem {
 }
 
 export interface LifecycleStageMoveRequest {
-  /** Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. */
+  /** Company moves only: run every check the move runs (company exists, stage known, Customers/Churned guards) and return the would-be transition without writing anything. Ignored for contact moves. */
+  dry_run?: boolean;
+  /** Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. Case and surrounding whitespace are ignored, and a stage's display name is accepted too. */
   target_slug: string;
 }
 
@@ -164,6 +166,8 @@ export interface LifecycleStageMoveRequest {
  * ``previous_status``/``new_status`` are null on that path.
  */
 export interface LifecycleStageMoveResponse {
+  /** True when this was a dry run: nothing was written. */
+  dry_run?: boolean;
   new_custom_status?: string | null;
   new_status?: string | null;
   previous_custom_status?: string | null;
@@ -200,8 +204,14 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }

package/docs/api/revenueLifecycle.md

@@ -186,6 +186,11 @@ records a `cb_lead_stage_history`-style audit row. `org_id` is always the
 authenticated key's own organisation; there is no way to target another
 org's company through this endpoint.
 
+A move to `churned` (or any stage that writes status 'churned') is refused
+with a 400 unless the company is or was a customer. `target_slug` ignores
+case and surrounding whitespace. `dry_run: true` runs every check and
+returns the would-be transition without writing anything.
+
 **Input**
 
 | Field | Type | Required | Description |
@@ -197,7 +202,8 @@ Body fields (`LifecycleStageMoveRequest`):
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. |
+| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. Case and surrounding whitespace are ignored, and a stage's display name is accepted too. |
+| `body.dry_run` | `boolean` | no | Company moves only: run every check the move runs (company exists, stage known, Customers/Churned guards) and return the would-be transition without writing anything. Ignored for contact moves. default `false` |
 
 **Returns** `ApiResponse_LifecycleStageMoveResponse_`: the envelope `{ data: LifecycleStageMoveResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
@@ -208,6 +214,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `target_slug` | `string` | yes |  |
+| `dry_run` | `boolean` | no | True when this was a dry run: nothing was written. default `false` |
 | `new_custom_status` | `string \| null` | no |  |
 | `new_status` | `string \| null` | no |  |
 | `previous_custom_status` | `string \| null` | no |  |
@@ -251,7 +258,8 @@ Body fields (`LifecycleStageMoveRequest`):
 
 | Field | Type | Required | Description |
 |---|---|---|---|
-| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. |
+| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. Case and surrounding whitespace are ignored, and a stage's display name is accepted too. |
+| `body.dry_run` | `boolean` | no | Company moves only: run every check the move runs (company exists, stage known, Customers/Churned guards) and return the would-be transition without writing anything. Ignored for contact moves. default `false` |
 
 **Returns** `ApiResponse_LifecycleStageMoveResponse_`: the envelope `{ data: LifecycleStageMoveResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
@@ -262,6 +270,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `target_slug` | `string` | yes |  |
+| `dry_run` | `boolean` | no | True when this was a dry run: nothing was written. default `false` |
 | `new_custom_status` | `string \| null` | no |  |
 | `new_status` | `string \| null` | no |  |
 | `previous_custom_status` | `string \| null` | no |  |

package/docs/api/revenueRecords.d.ts

@@ -340,10 +340,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface RevenuePlanCreateRequest {

package/docs/api/roles.d.ts

@@ -1,7 +1,7 @@
 /* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
 
 /**
- * Types for `g8.api.roles` (Roles): 20 operations.
+ * Types for `g8.api.roles` (Roles): 21 operations.
  *
  * For reading. In code, import from the package instead:
  *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
@@ -21,6 +21,7 @@ export interface RolesMembers {
   getMyPermissions: "get_my_permissions_roles_me_permissions_get";
   getRole: "get_role_roles__role_id__get";
   getUserRole: "get_user_role_roles_users__user_id__get";
+  inviteMember: "invite_member_roles_invite_post";
   listJoinRequests: "list_join_requests_roles_join_requests_get";
   listOrgUsers: "list_org_users_roles_org_users_get";
   listPendingInvites: "list_pending_invites_roles_pending_invites_get";
@@ -158,6 +159,20 @@ export interface RolesOperations {
   };
     output: ApiResponse_OrgPayload_;
   };
+  /**
+   * POST /roles/invite
+   * Invite Member
+   * tier: external · scope: account:run
+   */
+  invite_member_roles_invite_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: InviteMemberRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
   /**
    * GET /roles/join-requests
    * List Join Requests
@@ -333,7 +348,7 @@ export interface RolesOperations {
   };
 }
 
-// 8 schemas referenced above (the same as G8Contract.<Name>).
+// 9 schemas referenced above (the same as G8Contract.<Name>).
 
 export interface ApiResponse_OrgListPayload_ {
   data: OrgListPayload;
@@ -345,6 +360,32 @@ export interface ApiResponse_OrgPayload_ {
   pagination?: PaginationMeta | null;
 }
 
+/**
+ * Invite one person into the organisation. Mirrors `roles.InviteUserRequest`
+ * with ONE addition: the role may be named instead of identified by UUID.
+ *
+ * The app model takes `role_id: UUID` only, because its caller is a role
+ * picker that already holds the id. An API caller holds a NAME - "Engineer",
+ * "Member" - and making it fetch `GET /roles` first to translate is a round
+ * trip this contract can absorb. So exactly one of `role_id` or `role` is
+ * required; `role` is resolved against this organisation's own roles by slug
+ * first, then by case-insensitive display name.
+ *
+ * `role` is deliberately NOT defaulted to "Member". An absent role on an
+ * invitation is a caller mistake, and silently picking the fallback is how
+ * someone ends up in an organisation at a permission level nobody chose.
+ */
+export interface InviteMemberRequest {
+  /** Email address to invite. Matched case-insensitively against existing members and invitations. */
+  email: string;
+  /** List ids to assign. Honoured for the `service_provider` role only, as in the app. */
+  list_ids?: Array<number> | null;
+  /** Role slug or display name to grant, resolved within this organisation (slug first, then case-insensitive name). Mutually exclusive with `role_id`. */
+  role?: string | null;
+  /** Id of the role to grant, from `GET /roles`. Mutually exclusive with `role`. */
+  role_id?: string | null;
+}
+
 /**
  * An open envelope for a LIST result, so a bare list keeps its shape.
  *
@@ -377,10 +418,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/roles.md

@@ -2,7 +2,7 @@
 
 # `g8.api.roles`: Roles
 
-20 operations (14 read, 2 write, 4 destructive).
+21 operations (14 read, 2 write, 4 destructive, 1 external).
 
 No hand-written client covers this area. Call it through `g8.api.roles.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
 
@@ -30,6 +30,7 @@ Exact TypeScript types for every operation on this page, and every schema they u
 | [`getMyPermissions`](#op-getmypermissions) | `GET /api/v1/roles/me/permissions` | read | `account:read` | Get My Permissions |
 | [`getRole`](#op-getrole) | `GET /api/v1/roles/{role_id}` | read | `account:read` | Get Role |
 | [`getUserRole`](#op-getuserrole) | `GET /api/v1/roles/users/{user_id}` | read | `account:read` | Get User Role |
+| [`inviteMember`](#op-invitemember) | `POST /api/v1/roles/invite` | external | `account:run` | Invite Member |
 | [`listJoinRequests`](#op-listjoinrequests) | `GET /api/v1/roles/join-requests` | read | `account:read` | List Join Requests |
 | [`listOrgUsers`](#op-listorgusers) | `GET /api/v1/roles/org-users` | read | `account:read` | List Org Users |
 | [`listPendingInvites`](#op-listpendinginvites) | `GET /api/v1/roles/pending-invites` | read | `account:read` | List Pending Invites |
@@ -333,6 +334,69 @@ const result = await g8.api.roles.getUserRole({ path: { user_id: "id" } });
 
 ---
 
+<a id="op-invitemember"></a>
+
+### `g8.api.roles.inviteMember(input)`
+
+**Invite Member**
+
+- HTTP: `POST /api/v1/roles/invite`
+- operationId: `invite_member_roles_invite_post` (also callable as `g8.api.call("invite_member_roles_invite_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `account:run`
+
+Invite one person into the organisation, at a role below administrator.
+
+`status` in the response is the app's own: `invited` when an invitation
+email went out to someone with no graph8 account, `added` when the person
+already had one and now holds the role immediately. Re-inviting the same
+address is safe - the pending invitation is UPDATED to the new role rather
+than duplicated - so a reconciliation loop may call this once per row.
+
+ADMINISTRATOR ROLES ARE REFUSED HERE, AND THAT IS WHY THIS ROUTE CAN EXIST
+AT ALL. The module docstring withholds every route that can end with a
+person holding PropelAuth `Owner` or `Admin`. The reason is specific:
+`build_api_principal` can answer AS an org administrator, and the app's
+`_assert_can_grant_permissions` bypasses its non-escalation check for a
+privileged org role - so a bare proxy of the app handler would let a
+credential mint an administrator. Capping the role here removes exactly
+that, and leaves the capability that was actually asked for: admitting
+members and project roles in bulk from a script, a workflow or an agent.
+Granting administration stays a decision for a person, in the product.
+
+422 when neither or both of `role_id`/`role` are given; 404 when the role is
+not this organisation's; 403 when the role is administrator-equivalent, or
+when the app refuses the grant because the key's own permissions do not
+cover the role's.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `InviteMemberRequest` | yes | Request body; fields below. |
+
+Body fields (`InviteMemberRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.email` | `string` | yes | Email address to invite. Matched case-insensitively against existing members and invitations. min length 3, max length 255 |
+| `body.list_ids` | `Array<integer> \| null` | no | List ids to assign. Honoured for the `service_provider` role only, as in the app. |
+| `body.role` | `string \| null` | no | Role slug or display name to grant, resolved within this organisation (slug first, then case-insensitive name). Mutually exclusive with `role_id`. min length 1, max length 100 |
+| `body.role_id` | `string (uuid) \| null` | no | Id of the role to grant, from `GET /roles`. Mutually exclusive with `role`. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.roles.inviteMember({ body: { email: "jane@acme.com" } });
+```
+
+---
+
 <a id="op-listjoinrequests"></a>
 
 ### `g8.api.roles.listJoinRequests(input?)`

package/docs/api/salesCoach.d.ts

@@ -808,10 +808,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** A ROTATION of leaderboards - what a wall display cycles through. */

package/docs/api/scans.d.ts

@@ -70,10 +70,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface ScanResponse {

package/docs/api/scheduleBuy.d.ts

@@ -206,10 +206,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** Validate edited candidate names: owned-by-you, and available. SPENDS NOTHING. */

package/docs/api/scraping.d.ts

@@ -201,10 +201,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** Change how the org crawls. Only what you send is written. */

package/docs/api/search.d.ts

@@ -428,10 +428,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**
@@ -497,6 +503,8 @@ export interface SearchContactItem {
   last_name?: string | null;
   linkedin_headline?: string | null;
   linkedin_url?: string | null;
+  /** Fields whose value exists but is locked (shown as "***") until the contact is added to a list. A null field has no value. */
+  locked_fields?: Array<string>;
   middle_name?: string | null;
   mobile_phone?: string | null;
   personal_emails?: string | null;
@@ -528,7 +536,7 @@ export interface SearchRequest {
   filters?: Array<SearchFilter>;
   /** Results per page (max 100) */
   limit?: number;
-  /** Page number (1-indexed) */
+  /** Page number (1-indexed). page * limit may not exceed 10,000 (the paging window); narrow the filters to reach records beyond it. */
   page?: number;
 }
 

package/docs/api/search.md

@@ -566,7 +566,7 @@ Body fields (`SearchRequest`):
 |---|---|---|---|
 | `body.filters` | `Array<SearchFilter>` | no | Filter conditions (AND logic) |
 | `body.limit` | `integer` | no | Results per page (max 100) default `25`, min 1, max 100 |
-| `body.page` | `integer` | no | Page number (1-indexed) default `1`, min 1, max 100 |
+| `body.page` | `integer` | no | Page number (1-indexed). page * limit may not exceed 10,000 (the paging window); narrow the filters to reach records beyond it. default `1`, min 1 |
 
 **Returns** `ApiResponse_list_SearchCompanyItem__`: the envelope `{ data: Array<SearchCompanyItem>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
@@ -633,7 +633,7 @@ Body fields (`SearchRequest`):
 |---|---|---|---|
 | `body.filters` | `Array<SearchFilter>` | no | Filter conditions (AND logic) |
 | `body.limit` | `integer` | no | Results per page (max 100) default `25`, min 1, max 100 |
-| `body.page` | `integer` | no | Page number (1-indexed) default `1`, min 1, max 100 |
+| `body.page` | `integer` | no | Page number (1-indexed). page * limit may not exceed 10,000 (the paging window); narrow the filters to reach records beyond it. default `1`, min 1 |
 
 **Returns** `ApiResponse_list_SearchContactItem__`: the envelope `{ data: Array<SearchContactItem>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
 
@@ -658,6 +658,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `last_name` | `string \| null` | no |  |
 | `linkedin_headline` | `string \| null` | no |  |
 | `linkedin_url` | `string \| null` | no |  |
+| `locked_fields` | `Array<string>` | no | Fields whose value exists but is locked (shown as "***") until the contact is added to a list. A null field has no value. |
 | `middle_name` | `string \| null` | no |  |
 | `mobile_phone` | `string \| null` | no |  |
 | `personal_emails` | `string \| null` | no |  |

package/docs/api/seo.d.ts

@@ -260,10 +260,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** Mirrors `AuditDTO`. */

package/docs/api/sequenceLifecycle.d.ts

@@ -259,10 +259,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface PreviewChannelItem {

package/docs/api/sequences.d.ts

@@ -1672,10 +1672,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** Detach senders from a sequence. Mirrors `BulkArchiveChannelParams`. */

package/docs/api/settings.d.ts

@@ -393,10 +393,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/signals.d.ts

@@ -1276,10 +1276,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/signatures.d.ts

@@ -504,10 +504,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface SignatureArchiveResponse {

package/docs/api/snippet.d.ts

@@ -66,10 +66,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface SnippetResponse {

package/docs/api/socialPublishing.d.ts

@@ -494,10 +494,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** A connected social account. `id` is what `account_ref` takes everywhere else. */