lumnisai 0.5.25 → 0.5.27

package/dist/index.cjs

@@ -949,6 +949,9 @@ class CrmResource {
    * `crmRecordId`. Stale links (record deleted in the CRM) are detected
    * and re-created automatically.
    *
+   * Works with or without a `campaign_prospects` row — search-sourced
+   * prospects are enriched from profile cache when needed.
+   *
    * @example
    * ```typescript
    * const result = await client.crm.syncProspect({
@@ -968,16 +971,13 @@ class CrmResource {
    * render a "linked" indicator for the ones that come back true.
    *
    * Layered cache on the server side: persistent positive matches are
-   * served from the `campaign_prospects.crm_record_id` column, negative
-   * results are served from a Redis cache (TTL configured by
-   * `CRM_MATCH_NEGATIVE_CACHE_TTL_SECONDS`). Only the leftover unknowns
-   * fan out to the live CRM, bounded by
+   * served from the `campaign_prospects.crm_record_id` column and the
+   * local `crm_contacts` ledger; negative results are served from a Redis
+   * cache (TTL configured by `CRM_MATCH_NEGATIVE_CACHE_TTL_SECONDS`).
+   * Only the leftover unknowns fan out to the live CRM, bounded by
    * `CRM_MATCH_LIVE_SEARCH_PARALLELISM`.
    *
-   * Note: HubSpot does not expose a LinkedIn-URL search field through
-   * Composio, so for `provider: 'hubspot'` URLs that aren't already in
-   * the persistent cache will always come back `linked: false`. The
-   * sync endpoint still reconciles via email when available.
+   * Provider-id/URN inputs are resolved to vanity before matching.
    *
    * @example
    * ```typescript
@@ -994,6 +994,46 @@ class CrmResource {
   async matchBatch(data) {
     return this.http.post("/crm/prospects/match-batch", data);
   }
+  /**
+   * Trigger a full mirror of the owner's CRM contact book into the local
+   * `crm_contacts` ledger. Returns immediately (`202`); poll
+   * {@link getContactsSyncStatus} for progress.
+   */
+  async syncContacts(data) {
+    return this.http.post("/crm/contacts/sync", data);
+  }
+  /**
+   * Ledger sync freshness for an owner+provider: connection state, whether a
+   * sync is in progress, last reconcile time, and row count in the ledger.
+   */
+  async getContactsSyncStatus(userId, provider) {
+    return this.http.get("/crm/contacts/sync-status", {
+      params: { userId, provider }
+    });
+  }
+  /**
+   * Grant a member the right to exclude against an owner's synced CRM ledger
+   * (all providers for that owner). Typically called by the FE on org join.
+   */
+  async grantExclusionGrant(data) {
+    return this.http.post("/crm/exclusion-grants", data);
+  }
+  /**
+   * Revoke a member's access to an owner's CRM exclusion ledger.
+   */
+  async revokeExclusionGrant(data) {
+    return this.http.delete("/crm/exclusion-grants", {
+      body: data
+    });
+  }
+  /**
+   * List CRM owners whose exclusion ledger a member may read (via grants).
+   */
+  async listExclusionGrants(memberUserId) {
+    return this.http.get("/crm/exclusion-grants", {
+      params: { memberUserId }
+    });
+  }
 }
 
 class EmailResource {
@@ -1177,6 +1217,10 @@ class EnrichmentResource {
    * @param params.onlyVerifiedEmail - Only return verified emails (default: true)
    * @param params.enrichMobile - Include mobile enrichment, 10x cost (default: false)
    * @param params.onlyVerifiedMobile - Only return verified mobiles (default: false)
+   * @param params.deepWebFallback - For vendor-misses, discover contacts from the
+   *   organization's official public web pages. Findings come back in
+   *   `result.deepWebFindings` with source URLs + confidence tiers and never
+   *   overwrite `person.email`. Pass false to disable (default: true)
    * @returns Promise resolving to enrichment results
    *
    * @example
@@ -3508,6 +3552,9 @@ class ResponsesResource {
    * @param options - Optional search parameters
    * @param options.limit - Maximum number of results (1-100, default: 20)
    * @param options.dataSources - Specific data sources to use: ["PDL", "CORESIGNAL", "CRUST_DATA"]
+   * @param options.excludeCrmContacts - Exclude people in the acting user's synced CRM ledger; @default true (via request `options`)
+   * @param options.crmExclusionOwners - Granted owner ledgers to exclude against (user id or email)
+   * @param options.crmNameCompanyMatch - Also exclude by exact name+company; @default true
    * @returns Response with structured_response containing:
    *   - candidates: List of person results
    *   - totalFound: Total unique candidates found
@@ -3528,6 +3575,15 @@ class ResponsesResource {
         params.dataSources = options.dataSources;
       if (Object.keys(params).length > 0)
         request.specializedAgentParams = params;
+      const crmOptions = {};
+      if (options.excludeCrmContacts !== void 0)
+        crmOptions.excludeCrmContacts = options.excludeCrmContacts;
+      if (options.crmExclusionOwners)
+        crmOptions.crmExclusionOwners = options.crmExclusionOwners;
+      if (options.crmNameCompanyMatch !== void 0)
+        crmOptions.crmNameCompanyMatch = options.crmNameCompanyMatch;
+      if (Object.keys(crmOptions).length > 0)
+        request.options = crmOptions;
     }
     return this.create(request);
   }
@@ -3549,7 +3605,14 @@ class ResponsesResource {
    * @param options.excludeProfiles - LinkedIn URLs to exclude from results
    * @param options.excludePreviouslyContacted - Exclude previously contacted people
    * @param options.excludeNames - Names to exclude from results
+   * @param options.excludeCrmContacts - Exclude people in the acting user's synced CRM ledger; @default true
+   * @param options.crmExclusionOwners - Granted owner ledgers to exclude against (user id or email)
+   * @param options.crmNameCompanyMatch - Also exclude by exact name+company; @default true
    * @param options.searchJobSignal - CrustData job-listing signal search (decision makers at hiring companies); true | false | 'auto'
+   * @param options.deepVerify - Web verification for org/location/third-party criteria: 'auto' (default), 'always', or 'off'
+   * @param options.deepValidationUseRelevanceReranker - SLM relevance reranker for surfaced candidates (ranking-only); @default true
+   * @param options.deepValidationBackfillBelowCriteria - Pad with criteria-failed candidates when under count; @default true
+   * @param options.deepSearchCriteriaModel - Override criteria decomposition model (e.g. 'openai:gpt-5.4')
    * @returns Response with structured_response containing:
    *   - candidates: Validated and scored candidates
    *   - criteria: Generated/reused criteria definitions and classification
@@ -3560,8 +3623,11 @@ class ResponsesResource {
       messages: [{ role: "user", content: query }],
       specializedAgent: "deep_people_search"
     };
+    const params = {
+      deepValidationUseRelevanceReranker: options?.deepValidationUseRelevanceReranker ?? true,
+      deepValidationBackfillBelowCriteria: options?.deepValidationBackfillBelowCriteria ?? true
+    };
     if (options) {
-      const params = {};
       if (options.requestedCandidates !== void 0)
         params.requestedCandidates = options.requestedCandidates;
       if (options.dataSources)
@@ -3584,6 +3650,12 @@ class ResponsesResource {
         params.excludePreviouslyContacted = options.excludePreviouslyContacted;
       if (options.excludeNames)
         params.excludeNames = options.excludeNames;
+      if (options.excludeCrmContacts !== void 0)
+        params.excludeCrmContacts = options.excludeCrmContacts;
+      if (options.crmExclusionOwners)
+        params.crmExclusionOwners = options.crmExclusionOwners;
+      if (options.crmNameCompanyMatch !== void 0)
+        params.crmNameCompanyMatch = options.crmNameCompanyMatch;
       if (options.searchProfiles !== void 0)
         params.searchProfiles = options.searchProfiles;
       if (options.searchPosts !== void 0)
@@ -3612,9 +3684,12 @@ class ResponsesResource {
         params.postsExtractAuthor = options.postsExtractAuthor;
       if (options.searchJobSignal !== void 0)
         params.searchJobSignal = options.searchJobSignal;
-      if (Object.keys(params).length > 0)
-        request.specializedAgentParams = params;
+      if (options.deepVerify !== void 0)
+        params.deepVerify = options.deepVerify;
+      if (options.deepSearchCriteriaModel)
+        params.deepSearchCriteriaModel = options.deepSearchCriteriaModel;
     }
+    request.specializedAgentParams = params;
     return this.create(request);
   }
   /**
@@ -3631,6 +3706,9 @@ class ResponsesResource {
    *   Can be a string (criterion text) or an object with criterionText and optional suggestedColumnName.
    *   Example string: 'Must have 5+ years Python experience'
    *   Example object: { criterionText: 'Has ML experience', suggestedColumnName: 'ml_experience' }
+   * @param options.deepValidationUseRelevanceReranker - SLM relevance reranker for surfaced candidates (ranking-only); @default true
+   * @param options.deepValidationBackfillBelowCriteria - Pad with criteria-failed candidates when under count; @default true
+   * @param options.deepSearchCriteriaModel - Override criteria decomposition model (e.g. 'openai:gpt-5.4')
    * @returns Response with structured_response containing:
    *   - candidates: Scored candidates with validation results
    *   - criteria: Generated/reused criteria definitions and classification
@@ -3640,7 +3718,9 @@ class ResponsesResource {
       messages: [{ role: "user", content: query }],
       specializedAgent: "people_scoring",
       specializedAgentParams: {
-        candidateProfiles
+        candidateProfiles,
+        deepValidationUseRelevanceReranker: options?.deepValidationUseRelevanceReranker ?? true,
+        deepValidationBackfillBelowCriteria: options?.deepValidationBackfillBelowCriteria ?? true
       }
     };
     if (options) {
@@ -3656,6 +3736,8 @@ class ResponsesResource {
         request.specializedAgentParams.addCriterion = options.addCriterion;
       if (options.addAndRunCriterion)
         request.specializedAgentParams.addAndRunCriterion = options.addAndRunCriterion;
+      if (options.deepSearchCriteriaModel)
+        request.specializedAgentParams.deepSearchCriteriaModel = options.deepSearchCriteriaModel;
     }
     return this.create(request);
   }
@@ -3689,7 +3771,9 @@ class ResponsesResource {
       messages: [{ role: "user", content: query }],
       specializedAgent: "competitor_post_engagement"
     };
-    const params = {};
+    const params = {
+      deepValidationUseRelevanceReranker: options.deepValidationUseRelevanceReranker ?? true
+    };
     if (options.company)
       params.company = options.company;
     if (options.competitors)
@@ -3755,7 +3839,9 @@ class ResponsesResource {
       messages: [{ role: "user", content: query }],
       specializedAgent: "competitor_rep_engagement"
     };
-    const params = {};
+    const params = {
+      deepValidationUseRelevanceReranker: options.deepValidationUseRelevanceReranker ?? true
+    };
     if (options.company)
       params.company = options.company;
     if (options.competitors)