@graph8/sdk 0.293.0 → 0.294.1

package/README.md

@@ -311,8 +311,8 @@ Two things to know before reaching for it:
 
 | Method | Description |
 |--------|-------------|
-| `g8.enrich.person(params)` | Look up a person (2 credits, charged even when no match is found). REST: `POST /enrichment/lookup/person` (`POST /enrichment/person` is an alias) |
-| `g8.enrich.company(params)` | Look up a company (2 credits, charged even when no match is found) |
+| `g8.enrich.person(params)` | Look up a person (2 credits, charged only when a match is found). REST: `POST /enrichment/lookup/person` (`POST /enrichment/person` is an alias) |
+| `g8.enrich.company(params)` | Look up a company (2 credits, charged only when a match is found) |
 | `g8.enrich.verifyEmail(email)` | Verify email (1 credit) |
 | `g8.enrich.search(filters)` | Search 700M+ contacts (no credits) |
 

package/dist/index.d.mts

@@ -46299,7 +46299,6 @@ interface ApiOperationMap {
     get_company_revenue_summary_stripe_companies__company_id__revenue_summary_get: {
         input: {
             path: {
-                /** graph8 company id. */
                 company_id: number;
             };
             headers?: {
@@ -46367,7 +46366,6 @@ interface ApiOperationMap {
     get_company_stripe_invoices_stripe_companies__company_id__invoices_get: {
         input: {
             path: {
-                /** graph8 company id. */
                 company_id: number;
             };
             query?: {
@@ -46389,7 +46387,6 @@ interface ApiOperationMap {
     get_company_stripe_subscriptions_stripe_companies__company_id__subscriptions_get: {
         input: {
             path: {
-                /** graph8 company id. */
                 company_id: number;
             };
             headers?: {
@@ -60586,7 +60583,7 @@ interface ApiOperationMap {
                 name?: string | null;
                 /** Filter by job title (partial match) */
                 job_title?: string | null;
-                /** 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,SVP/EVP`. */
+                /** 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`. */
                 seniority_level?: string | null;
                 /** Filter by company name (partial match) */
                 company_name?: string | null;
@@ -93493,7 +93490,7 @@ interface SearchResults {
 declare const createEnrichClient: (apiKey: string, apiUrl?: string) => {
     /**
      * Look up a person by email, LinkedIn, or name + company. Costs 2 credits per
-     * lookup, charged even when no match is found (`found: false`).
+     * lookup, charged only when a match is found (`found: false` costs nothing).
      */
     person(params: {
         email?: string;
@@ -93504,7 +93501,7 @@ declare const createEnrichClient: (apiKey: string, apiUrl?: string) => {
     }): Promise<PersonEnrichment>;
     /**
      * Look up a company by domain or name. Costs 2 credits per lookup, charged
-     * even when no match is found (`found: false`).
+     * only when a match is found (`found: false` costs nothing).
      */
     company(params: {
         domain?: string;

package/dist/index.d.ts

@@ -46299,7 +46299,6 @@ interface ApiOperationMap {
     get_company_revenue_summary_stripe_companies__company_id__revenue_summary_get: {
         input: {
             path: {
-                /** graph8 company id. */
                 company_id: number;
             };
             headers?: {
@@ -46367,7 +46366,6 @@ interface ApiOperationMap {
     get_company_stripe_invoices_stripe_companies__company_id__invoices_get: {
         input: {
             path: {
-                /** graph8 company id. */
                 company_id: number;
             };
             query?: {
@@ -46389,7 +46387,6 @@ interface ApiOperationMap {
     get_company_stripe_subscriptions_stripe_companies__company_id__subscriptions_get: {
         input: {
             path: {
-                /** graph8 company id. */
                 company_id: number;
             };
             headers?: {
@@ -60586,7 +60583,7 @@ interface ApiOperationMap {
                 name?: string | null;
                 /** Filter by job title (partial match) */
                 job_title?: string | null;
-                /** 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,SVP/EVP`. */
+                /** 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`. */
                 seniority_level?: string | null;
                 /** Filter by company name (partial match) */
                 company_name?: string | null;
@@ -93493,7 +93490,7 @@ interface SearchResults {
 declare const createEnrichClient: (apiKey: string, apiUrl?: string) => {
     /**
      * Look up a person by email, LinkedIn, or name + company. Costs 2 credits per
-     * lookup, charged even when no match is found (`found: false`).
+     * lookup, charged only when a match is found (`found: false` costs nothing).
      */
     person(params: {
         email?: string;
@@ -93504,7 +93501,7 @@ declare const createEnrichClient: (apiKey: string, apiUrl?: string) => {
     }): Promise<PersonEnrichment>;
     /**
      * Look up a company by domain or name. Costs 2 credits per lookup, charged
-     * even when no match is found (`found: false`).
+     * only when a match is found (`found: false` costs nothing).
      */
     company(params: {
         domain?: string;

package/dist/index.js

@@ -991,7 +991,7 @@ var EXTERNAL_ROUTES = {
 };
 
 // src/version.ts
-var SDK_VERSION = "0.293.0";
+var SDK_VERSION = "0.294.1";
 var SDK_CLIENT_ID = `js-sdk/${SDK_VERSION}`;
 
 // src/http.ts
@@ -1257,7 +1257,7 @@ var createEnrichClient = (apiKey, apiUrl) => {
   return {
     /**
      * Look up a person by email, LinkedIn, or name + company. Costs 2 credits per
-     * lookup, charged even when no match is found (`found: false`).
+     * lookup, charged only when a match is found (`found: false` costs nothing).
      */
     async person(params) {
       const resp = await request(baseUrl, "/api/v1/enrichment/lookup/person", apiKey, {
@@ -1268,7 +1268,7 @@ var createEnrichClient = (apiKey, apiUrl) => {
     },
     /**
      * Look up a company by domain or name. Costs 2 credits per lookup, charged
-     * even when no match is found (`found: false`).
+     * only when a match is found (`found: false` costs nothing).
      */
     async company(params) {
       const resp = await request(baseUrl, "/api/v1/enrichment/lookup/company", apiKey, {