@graph8/sdk 0.264.0 → 0.277.0

package/docs/api/studioDocuments.d.ts

@@ -215,10 +215,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/support.d.ts

@@ -83,8 +83,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/suppressions.d.ts

@@ -178,10 +178,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 ReinstateSkip {

package/docs/api/surveys.d.ts

@@ -621,10 +621,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 PerSurveyDTO {

package/docs/api/tasks.d.ts

@@ -561,10 +561,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/teamMembers.d.ts

@@ -661,8 +661,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/teams.d.ts

@@ -709,10 +709,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/usage.d.ts

@@ -209,10 +209,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/visitors.d.ts

@@ -576,10 +576,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;
 }
 
 /** One handler response. Open-shaped - these payloads come from the tracking pipeline. */

package/docs/api/voice.d.ts

@@ -4308,10 +4308,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/webChat.d.ts

@@ -1549,10 +1549,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/webhooks.d.ts

@@ -194,10 +194,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 WebhookCreateRequest {

package/docs/api/websiteEditor.d.ts

@@ -241,10 +241,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/work.d.ts

@@ -1311,10 +1311,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;
 }
 
 /** One entry in the Work activity feed. */

package/docs/api/workbench.d.ts

@@ -2404,10 +2404,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;
 }
 
 /** Import a rectangle of values - the paste path, no file involved. */

package/docs/api/workflows.d.ts

@@ -1174,10 +1174,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;
 }
 
 /** voice `SkillTestRunRequest`: one dry run, from a saved case OR ad-hoc inputs. */

package/docs/sdk-clients.md

@@ -1320,7 +1320,7 @@ Types: `dist/types/enrich.d.ts`
 g8.enrich.company: (params: { domain?: string; name?: string; }) => Promise<CompanyEnrichment>
 ```
 
-Look up a company by domain or name. Costs 1 credit.
+Look up a company by domain or name. Costs 2 credits per lookup, charged even when no match is found (`found: false`).
 
 - Calls `POST /api/v1/enrichment/lookup/company` ([`g8.api.enrichment.lookupCompany`](api/enrichment.md#op-lookupcompany), tier `billable`, scope `enrichment:run`)
 
@@ -1334,7 +1334,7 @@ Look up a company by domain or name. Costs 1 credit.
 g8.enrich.person: (params: { email?: string; linkedin_url?: string; first_name?: string; last_name?: string; company_domain?: string; }) => Promise<PersonEnrichment>
 ```
 
-Look up a person by email, LinkedIn, or name + company. Costs 1 credit.
+Look up a person by email, LinkedIn, or name + company. Costs 2 credits per lookup, charged even when no match is found (`found: false`).
 
 - Calls `POST /api/v1/enrichment/lookup/person` ([`g8.api.enrichment.lookupPerson`](api/enrichment.md#op-lookupperson), tier `billable`, scope `enrichment:run`)
 
@@ -1348,7 +1348,7 @@ Look up a person by email, LinkedIn, or name + company. Costs 1 credit.
 g8.enrich.search: (filters: SearchFilter[], page?: number, limit?: number) => Promise<SearchResults>
 ```
 
-Search 700M+ contacts with filters. Credits charged per result.
+Search 700M+ contacts with filters. Does not consume credits.
 
 - Calls `POST /api/v1/search/contacts` ([`g8.api.search.searchContacts`](api/search.md#op-searchcontacts), tier `billable`, scope `search:run`)
 
@@ -3025,7 +3025,7 @@ Types: `dist/types/search.d.ts`
 ### `g8.search.companies`
 
 ```ts
-g8.search.companies: (params?: SearchParams) => Promise<{ data: SearchCompanyItem[]; }>
+g8.search.companies: (params?: SearchParams) => Promise<{ data: SearchCompanyItem[]; pagination?: SearchPagination; }>
 ```
 
 Search open-data companies by filter.
@@ -3039,7 +3039,7 @@ Search open-data companies by filter.
 ### `g8.search.contacts`
 
 ```ts
-g8.search.contacts: (params?: SearchParams) => Promise<{ data: SearchContactItem[]; }>
+g8.search.contacts: (params?: SearchParams) => Promise<{ data: SearchContactItem[]; pagination?: SearchPagination; }>
 ```
 
 Search open-data contacts by filter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graph8/sdk",
-  "version": "0.264.0",
+  "version": "0.277.0",
   "description": "graph8 SDK - CRM, enrichment, sequences, campaigns, and tracking for B2B",
   "license": "MIT",
   "author": "graph8 <support@graph8.com> (https://graph8.com)",