@graph8/sdk 0.265.0 → 0.293.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/index.d.mts +734 -28
- package/dist/index.d.ts +734 -28
- package/dist/index.js +15 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +15 -5
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +728 -26
- package/dist/react.d.ts +728 -26
- package/dist/react.js +14 -4
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +14 -4
- package/dist/react.mjs.map +1 -1
- package/dist/types/core.d.ts +2 -0
- package/dist/types/enrich.d.ts +11 -4
- package/dist/types/index.d.ts +1 -1
- package/dist/types/react.d.ts +6 -2
- package/dist/types/search.d.ts +25 -1
- package/dist/types/version.d.ts +2 -2
- package/docs/agents.md +8 -7
- package/docs/api/README.md +4 -4
- package/docs/api/accounts.d.ts +6 -0
- package/docs/api/adCampaigns.d.ts +6 -0
- package/docs/api/adCreatives.d.ts +6 -0
- package/docs/api/agency.d.ts +6 -0
- package/docs/api/agent.d.ts +6 -0
- package/docs/api/agents.d.ts +6 -0
- package/docs/api/aiInbox.d.ts +6 -0
- package/docs/api/analytics.d.ts +32 -1
- package/docs/api/analytics.md +2 -0
- package/docs/api/apiKeys.d.ts +6 -0
- package/docs/api/appDeployments.d.ts +6 -0
- package/docs/api/appDomains.d.ts +6 -0
- package/docs/api/appLogs.d.ts +6 -0
- package/docs/api/appObjects.d.ts +6 -0
- package/docs/api/appPages.d.ts +6 -0
- package/docs/api/appPlatformTokens.d.ts +6 -0
- package/docs/api/appointments.d.ts +20 -2
- package/docs/api/appointments.md +27 -11
- package/docs/api/apps.d.ts +6 -0
- package/docs/api/apps.md +7 -5
- package/docs/api/assertUpsert.d.ts +14 -0
- package/docs/api/assertUpsert.md +5 -0
- package/docs/api/audienceSyncs.d.ts +14 -0
- package/docs/api/audienceSyncs.md +16 -0
- package/docs/api/brandKit.d.ts +6 -0
- package/docs/api/bugReports.d.ts +6 -0
- package/docs/api/by-path.md +3 -0
- package/docs/api/calendarInvites.d.ts +6 -0
- package/docs/api/campaignWorkflows.d.ts +6 -0
- package/docs/api/campaigns.d.ts +6 -0
- package/docs/api/channels.d.ts +6 -0
- package/docs/api/cliCampaigns.d.ts +6 -0
- package/docs/api/cliPipelines.d.ts +6 -0
- package/docs/api/clickHouse.d.ts +6 -0
- package/docs/api/companies.d.ts +17 -3
- package/docs/api/companies.md +13 -3
- package/docs/api/companyIntelligence.d.ts +6 -0
- package/docs/api/contacts.d.ts +26 -5
- package/docs/api/contacts.md +17 -6
- package/docs/api/content.d.ts +6 -0
- package/docs/api/contentGridSkills.d.ts +6 -0
- package/docs/api/copilot.d.ts +6 -0
- package/docs/api/crmSyncs.d.ts +6 -0
- package/docs/api/customerSuccess.d.ts +6 -0
- package/docs/api/deals.d.ts +6 -0
- package/docs/api/deliverability.d.ts +6 -0
- package/docs/api/desk.d.ts +6 -0
- package/docs/api/dialer.d.ts +6 -0
- package/docs/api/documents.d.ts +6 -0
- package/docs/api/duplicates.d.ts +6 -0
- package/docs/api/eSignature.d.ts +6 -0
- package/docs/api/enrichment.d.ts +82 -2
- package/docs/api/enrichment.md +76 -1
- package/docs/api/events.d.ts +6 -0
- package/docs/api/fields.d.ts +30 -3
- package/docs/api/fields.md +15 -4
- package/docs/api/forms.d.ts +6 -0
- package/docs/api/gtmCampaigns.d.ts +6 -0
- package/docs/api/gtmContext.d.ts +6 -0
- package/docs/api/gtmDeliverability.d.ts +6 -0
- package/docs/api/gtmKnowledgeBase.d.ts +6 -0
- package/docs/api/gtmLibrary.d.ts +6 -0
- package/docs/api/imageLibrary.d.ts +6 -0
- package/docs/api/imports.d.ts +6 -0
- package/docs/api/inbox.d.ts +6 -0
- package/docs/api/install.d.ts +32 -0
- package/docs/api/install.md +18 -0
- package/docs/api/installedApps.d.ts +6 -0
- package/docs/api/integrationStatus.d.ts +6 -0
- package/docs/api/integrations.d.ts +6 -0
- package/docs/api/intent.d.ts +32 -1
- package/docs/api/intent.md +23 -0
- package/docs/api/knowledge.d.ts +6 -0
- package/docs/api/knowledgeBase.d.ts +6 -0
- package/docs/api/landingPages.d.ts +6 -0
- package/docs/api/leads.d.ts +6 -0
- package/docs/api/library.d.ts +6 -0
- package/docs/api/linkedIn.d.ts +6 -0
- package/docs/api/linkedInOutreach.d.ts +6 -0
- package/docs/api/lists.d.ts +22 -0
- package/docs/api/lists.md +24 -2
- package/docs/api/logs.d.ts +6 -0
- package/docs/api/mailboxes.d.ts +6 -0
- package/docs/api/marketingIntelligence.d.ts +40 -0
- package/docs/api/marketingIntelligence.md +20 -0
- package/docs/api/marketplace.d.ts +6 -0
- package/docs/api/mcp.d.ts +6 -0
- package/docs/api/me.d.ts +6 -0
- package/docs/api/meetings.d.ts +6 -0
- package/docs/api/newsletter.d.ts +6 -0
- package/docs/api/notes.d.ts +6 -0
- package/docs/api/notifications.d.ts +6 -0
- package/docs/api/objects.d.ts +6 -0
- package/docs/api/openSearch.d.ts +6 -0
- package/docs/api/ops.d.ts +6 -0
- package/docs/api/orgGovernance.d.ts +6 -0
- package/docs/api/orgVideos.d.ts +6 -0
- package/docs/api/organizationSettings.d.ts +6 -0
- package/docs/api/phoneNumbers.d.ts +6 -0
- package/docs/api/profile.d.ts +6 -0
- package/docs/api/programmaticPages.d.ts +6 -0
- package/docs/api/providerDomains.d.ts +6 -0
- package/docs/api/providerUsage.d.ts +6 -0
- package/docs/api/public.d.ts +6 -0
- package/docs/api/publicCopilot.d.ts +6 -0
- package/docs/api/publicSignals.d.ts +6 -0
- package/docs/api/publicVisitors.d.ts +6 -0
- package/docs/api/quotes.d.ts +6 -0
- package/docs/api/radarReports.d.ts +6 -0
- package/docs/api/recordRoles.d.ts +6 -0
- package/docs/api/repos.d.ts +6 -0
- package/docs/api/research.d.ts +6 -0
- package/docs/api/revenue.d.ts +6 -0
- package/docs/api/revenueAnalytics.d.ts +6 -0
- package/docs/api/revenueLifecycle.d.ts +11 -1
- package/docs/api/revenueLifecycle.md +11 -2
- package/docs/api/revenueRecords.d.ts +6 -0
- package/docs/api/roles.d.ts +49 -2
- package/docs/api/roles.md +65 -1
- package/docs/api/salesCoach.d.ts +6 -0
- package/docs/api/scans.d.ts +6 -0
- package/docs/api/scheduleBuy.d.ts +6 -0
- package/docs/api/scraping.d.ts +6 -0
- package/docs/api/search.d.ts +9 -1
- package/docs/api/search.md +3 -2
- package/docs/api/seo.d.ts +6 -0
- package/docs/api/sequenceLifecycle.d.ts +6 -0
- package/docs/api/sequences.d.ts +6 -0
- package/docs/api/settings.d.ts +6 -0
- package/docs/api/signals.d.ts +6 -0
- package/docs/api/signatures.d.ts +6 -0
- package/docs/api/snippet.d.ts +72 -2
- package/docs/api/snippet.md +73 -4
- package/docs/api/socialPublishing.d.ts +6 -0
- package/docs/api/studioDocuments.d.ts +6 -0
- package/docs/api/support.d.ts +6 -0
- package/docs/api/suppressions.d.ts +10 -0
- package/docs/api/suppressions.md +2 -0
- package/docs/api/surveys.d.ts +6 -0
- package/docs/api/tasks.d.ts +6 -0
- package/docs/api/teamMembers.d.ts +6 -0
- package/docs/api/teams.d.ts +6 -0
- package/docs/api/usage.d.ts +6 -0
- package/docs/api/visitors.d.ts +32 -0
- package/docs/api/visitors.md +12 -0
- package/docs/api/voice.d.ts +6 -0
- package/docs/api/webAnalytics.d.ts +288 -0
- package/docs/api/webAnalytics.md +144 -0
- package/docs/api/webChat.d.ts +6 -0
- package/docs/api/webhooks.d.ts +6 -0
- package/docs/api/websiteEditor.d.ts +6 -0
- package/docs/api/work.d.ts +6 -0
- package/docs/api/workbench.d.ts +6 -0
- package/docs/api/workflows.d.ts +6 -0
- package/docs/api/workflows.md +6 -0
- package/docs/sdk-clients.md +5 -5
- package/package.json +1 -1
package/docs/api/workbench.d.ts
CHANGED
|
@@ -2404,10 +2404,16 @@ export interface PaginationMeta {
|
|
|
2404
2404
|
limit: number;
|
|
2405
2405
|
/** 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. */
|
|
2406
2406
|
next_cursor?: string | null;
|
|
2407
|
+
/** 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. */
|
|
2408
|
+
notes?: Array<string> | null;
|
|
2407
2409
|
/** Current page number (1-indexed) */
|
|
2408
2410
|
page: number;
|
|
2409
2411
|
/** Total number of items */
|
|
2410
2412
|
total: number;
|
|
2413
|
+
/** 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. */
|
|
2414
|
+
total_available?: number | null;
|
|
2415
|
+
/** 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. */
|
|
2416
|
+
total_is_lower_bound?: boolean | null;
|
|
2411
2417
|
}
|
|
2412
2418
|
|
|
2413
2419
|
/** Import a rectangle of values - the paste path, no file involved. */
|
package/docs/api/workflows.d.ts
CHANGED
|
@@ -1174,10 +1174,16 @@ export interface PaginationMeta {
|
|
|
1174
1174
|
limit: number;
|
|
1175
1175
|
/** 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. */
|
|
1176
1176
|
next_cursor?: string | null;
|
|
1177
|
+
/** 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. */
|
|
1178
|
+
notes?: Array<string> | null;
|
|
1177
1179
|
/** Current page number (1-indexed) */
|
|
1178
1180
|
page: number;
|
|
1179
1181
|
/** Total number of items */
|
|
1180
1182
|
total: number;
|
|
1183
|
+
/** 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. */
|
|
1184
|
+
total_available?: number | null;
|
|
1185
|
+
/** 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. */
|
|
1186
|
+
total_is_lower_bound?: boolean | null;
|
|
1181
1187
|
}
|
|
1182
1188
|
|
|
1183
1189
|
/** voice `SkillTestRunRequest`: one dry run, from a saved case OR ad-hoc inputs. */
|
package/docs/api/workflows.md
CHANGED
|
@@ -577,6 +577,12 @@ Pins ``org_id`` server-side; the caller cannot override which org's
|
|
|
577
577
|
execution row is created. ``triggered_by`` defaults to the caller's
|
|
578
578
|
user id when not supplied.
|
|
579
579
|
|
|
580
|
+
If the workflow service takes the request but does not answer in time,
|
|
581
|
+
the answer is ``202`` with ``outcome`` ``started`` (run found, with its
|
|
582
|
+
``execution_id``) or ``unknown`` (check the executions list first), not a
|
|
583
|
+
502: the run may well be going. Send an ``Idempotency-Key`` to make retries
|
|
584
|
+
safe; a retry with the same key returns the first answer.
|
|
585
|
+
|
|
580
586
|
**Input**
|
|
581
587
|
|
|
582
588
|
| Field | Type | Required | Description |
|
package/docs/sdk-clients.md
CHANGED
|
@@ -1320,7 +1320,7 @@ Types: `dist/types/enrich.d.ts`
|
|
|
1320
1320
|
g8.enrich.company: (params: { domain?: string; name?: string; }) => Promise<CompanyEnrichment>
|
|
1321
1321
|
```
|
|
1322
1322
|
|
|
1323
|
-
Look up a company by domain or name. Costs
|
|
1323
|
+
Look up a company by domain or name. Costs 2 credits per lookup, charged even when no match is found (`found: false`).
|
|
1324
1324
|
|
|
1325
1325
|
- Calls `POST /api/v1/enrichment/lookup/company` ([`g8.api.enrichment.lookupCompany`](api/enrichment.md#op-lookupcompany), tier `billable`, scope `enrichment:run`)
|
|
1326
1326
|
|
|
@@ -1334,7 +1334,7 @@ Look up a company by domain or name. Costs 1 credit.
|
|
|
1334
1334
|
g8.enrich.person: (params: { email?: string; linkedin_url?: string; first_name?: string; last_name?: string; company_domain?: string; }) => Promise<PersonEnrichment>
|
|
1335
1335
|
```
|
|
1336
1336
|
|
|
1337
|
-
Look up a person by email, LinkedIn, or name + company. Costs
|
|
1337
|
+
Look up a person by email, LinkedIn, or name + company. Costs 2 credits per lookup, charged even when no match is found (`found: false`).
|
|
1338
1338
|
|
|
1339
1339
|
- Calls `POST /api/v1/enrichment/lookup/person` ([`g8.api.enrichment.lookupPerson`](api/enrichment.md#op-lookupperson), tier `billable`, scope `enrichment:run`)
|
|
1340
1340
|
|
|
@@ -1348,7 +1348,7 @@ Look up a person by email, LinkedIn, or name + company. Costs 1 credit.
|
|
|
1348
1348
|
g8.enrich.search: (filters: SearchFilter[], page?: number, limit?: number) => Promise<SearchResults>
|
|
1349
1349
|
```
|
|
1350
1350
|
|
|
1351
|
-
Search 700M+ contacts with filters.
|
|
1351
|
+
Search 700M+ contacts with filters. Does not consume credits.
|
|
1352
1352
|
|
|
1353
1353
|
- Calls `POST /api/v1/search/contacts` ([`g8.api.search.searchContacts`](api/search.md#op-searchcontacts), tier `billable`, scope `search:run`)
|
|
1354
1354
|
|
|
@@ -3025,7 +3025,7 @@ Types: `dist/types/search.d.ts`
|
|
|
3025
3025
|
### `g8.search.companies`
|
|
3026
3026
|
|
|
3027
3027
|
```ts
|
|
3028
|
-
g8.search.companies: (params?: SearchParams) => Promise<{ data: SearchCompanyItem[]; }>
|
|
3028
|
+
g8.search.companies: (params?: SearchParams) => Promise<{ data: SearchCompanyItem[]; pagination?: SearchPagination; }>
|
|
3029
3029
|
```
|
|
3030
3030
|
|
|
3031
3031
|
Search open-data companies by filter.
|
|
@@ -3039,7 +3039,7 @@ Search open-data companies by filter.
|
|
|
3039
3039
|
### `g8.search.contacts`
|
|
3040
3040
|
|
|
3041
3041
|
```ts
|
|
3042
|
-
g8.search.contacts: (params?: SearchParams) => Promise<{ data: SearchContactItem[]; }>
|
|
3042
|
+
g8.search.contacts: (params?: SearchParams) => Promise<{ data: SearchContactItem[]; pagination?: SearchPagination; }>
|
|
3043
3043
|
```
|
|
3044
3044
|
|
|
3045
3045
|
Search open-data contacts by filter.
|
package/package.json
CHANGED