@graph8/sdk 0.293.0 → 0.294.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 +2 -2
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +4 -6
- package/dist/react.d.ts +4 -6
- package/dist/react.js +3 -3
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +3 -3
- package/dist/react.mjs.map +1 -1
- package/dist/types/enrich.d.ts +2 -2
- package/dist/types/react.d.ts +1 -3
- package/dist/types/version.d.ts +2 -2
- package/docs/agents.md +2 -2
- package/docs/api/contacts.d.ts +1 -1
- package/docs/api/contacts.md +1 -1
- package/docs/sdk-clients.md +2 -2
- package/package.json +1 -1
package/dist/types/enrich.d.ts
CHANGED
|
@@ -34,7 +34,7 @@ export interface SearchResults {
|
|
|
34
34
|
export declare const createEnrichClient: (apiKey: string, apiUrl?: string) => {
|
|
35
35
|
/**
|
|
36
36
|
* Look up a person by email, LinkedIn, or name + company. Costs 2 credits per
|
|
37
|
-
* lookup, charged
|
|
37
|
+
* lookup, charged only when a match is found (`found: false` costs nothing).
|
|
38
38
|
*/
|
|
39
39
|
person(params: {
|
|
40
40
|
email?: string;
|
|
@@ -45,7 +45,7 @@ export declare const createEnrichClient: (apiKey: string, apiUrl?: string) => {
|
|
|
45
45
|
}): Promise<PersonEnrichment>;
|
|
46
46
|
/**
|
|
47
47
|
* Look up a company by domain or name. Costs 2 credits per lookup, charged
|
|
48
|
-
*
|
|
48
|
+
* only when a match is found (`found: false` costs nothing).
|
|
49
49
|
*/
|
|
50
50
|
company(params: {
|
|
51
51
|
domain?: string;
|
package/dist/types/react.d.ts
CHANGED
|
@@ -128,9 +128,7 @@ export declare const useG8: () => {
|
|
|
128
128
|
company_domain?: string;
|
|
129
129
|
}): Promise<import("./enrich").PersonEnrichment>;
|
|
130
130
|
company(params: {
|
|
131
|
-
domain
|
|
132
|
-
/** Progressive form helpers (read lazily, so useG8() never throws on its own) */
|
|
133
|
-
? /** Progressive form helpers (read lazily, so useG8() never throws on its own) */: string;
|
|
131
|
+
domain?: string;
|
|
134
132
|
name?: string;
|
|
135
133
|
}): Promise<import("./enrich").CompanyEnrichment>;
|
|
136
134
|
verifyEmail(email: string): Promise<import("./enrich").EmailVerification>;
|
package/dist/types/version.d.ts
CHANGED
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
* both together (the version-parity gate already pins package.json, the
|
|
6
6
|
* lockfile and the CHANGELOG to each other).
|
|
7
7
|
*/
|
|
8
|
-
export declare const SDK_VERSION = "0.
|
|
8
|
+
export declare const SDK_VERSION = "0.294.0";
|
|
9
9
|
/** Value of the `X-G8-Client` header every SDK request carries (I-13). */
|
|
10
|
-
export declare const SDK_CLIENT_ID = "js-sdk/0.
|
|
10
|
+
export declare const SDK_CLIENT_ID = "js-sdk/0.294.0";
|
package/docs/agents.md
CHANGED
|
@@ -220,7 +220,7 @@ What you must do:
|
|
|
220
220
|
- Get a human's confirmation before calling an `external`, `billable` or `destructive` operation, and say
|
|
221
221
|
what it will do ("this sends the email to 240 contacts").
|
|
222
222
|
- Keep bulk billable jobs small until the user confirms the cost (a person or company lookup is 2 credits,
|
|
223
|
-
charged
|
|
223
|
+
charged only when a match is found).
|
|
224
224
|
|
|
225
225
|
## 8. Errors
|
|
226
226
|
|
|
@@ -376,7 +376,7 @@ for (const person of results.contacts) {
|
|
|
376
376
|
|
|
377
377
|
### Enrich one person or company
|
|
378
378
|
|
|
379
|
-
You have an email, LinkedIn URL, name + company, or a domain and need the full profile. Each lookup costs 2 credits, charged
|
|
379
|
+
You have an email, LinkedIn URL, name + company, or a domain and need the full profile. Each lookup costs 2 credits, charged only when a match is found, and an email verify costs 1 (tier `billable`), so the SDK will not blindly retry them on a 5xx.
|
|
380
380
|
|
|
381
381
|
```ts
|
|
382
382
|
import { g8 } from "@graph8/sdk";
|
package/docs/api/contacts.d.ts
CHANGED
|
@@ -852,7 +852,7 @@ export interface ContactsOperations {
|
|
|
852
852
|
name?: string | null;
|
|
853
853
|
/** Filter by job title (partial match) */
|
|
854
854
|
job_title?: string | null;
|
|
855
|
-
/** Filter by seniority level (exact match, case-insensitive). Spellings of the same level match each other: VP = Vice President; SVP/EVP = SVP = EVP = Senior/Executive Vice President; C-Suite = C-Level = CXO. Pass several levels comma-separated to match any of them, e.g. `VP
|
|
855
|
+
/** Filter by seniority level (exact match, case-insensitive). Spellings of the same level match each other: VP = Vice President; SVP/EVP = SVP = EVP = Senior/Executive Vice President; C-Suite = C-Level = CXO. `VP` (or `Vice President`) means VP and above, so it also returns the SVP/EVP band; `SVP/EVP` alone returns only that band. Pass several levels comma-separated to match any of them, e.g. `Director,VP`. */
|
|
856
856
|
seniority_level?: string | null;
|
|
857
857
|
/** Filter by company name (partial match) */
|
|
858
858
|
company_name?: string | null;
|
package/docs/api/contacts.md
CHANGED
|
@@ -1887,7 +1887,7 @@ List contacts with optional filtering and pagination.
|
|
|
1887
1887
|
| `query.list_id` | `integer \| null` | no | Filter by list ID |
|
|
1888
1888
|
| `query.name` | `string \| null` | no | Filter by first or last name (partial match) |
|
|
1889
1889
|
| `query.job_title` | `string \| null` | no | Filter by job title (partial match) |
|
|
1890
|
-
| `query.seniority_level` | `string \| null` | no | Filter by seniority level (exact match, case-insensitive). Spellings of the same level match each other: VP = Vice President; SVP/EVP = SVP = EVP = Senior/Executive Vice President; C-Suite = C-Level = CXO. Pass several levels comma-separated to match any of them, e.g. `
|
|
1890
|
+
| `query.seniority_level` | `string \| null` | no | Filter by seniority level (exact match, case-insensitive). Spellings of the same level match each other: VP = Vice President; SVP/EVP = SVP = EVP = Senior/Executive Vice President; C-Suite = C-Level = CXO. `VP` (or `Vice President`) means VP and above, so it also returns the SVP/EVP band; `SVP/EVP` alone returns only that band. Pass several levels comma-separated to match any of them, e.g. `Direc… |
|
|
1891
1891
|
| `query.company_name` | `string \| null` | no | Filter by company name (partial match) |
|
|
1892
1892
|
| `query.company_id` | `integer \| null` | no | Filter by company ID |
|
|
1893
1893
|
| `query.country` | `string \| null` | no | Filter by country (exact match, case-insensitive; surrounding spaces ignored). Common aliases match each other: United States = US = USA; United Kingdom = UK. |
|
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 2 credits per lookup, charged
|
|
1323
|
+
Look up a company by domain or name. Costs 2 credits per lookup, charged only when a match is found (`found: false` costs nothing).
|
|
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 2 credits per lookup, charged even wh
|
|
|
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 2 credits per lookup, charged
|
|
1337
|
+
Look up a person by email, LinkedIn, or name + company. Costs 2 credits per lookup, charged only when a match is found (`found: false` costs nothing).
|
|
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
|
|
package/package.json
CHANGED