@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.
Files changed (178) hide show
  1. package/README.md +3 -3
  2. package/dist/index.d.mts +734 -28
  3. package/dist/index.d.ts +734 -28
  4. package/dist/index.js +15 -5
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +15 -5
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/react.d.mts +728 -26
  9. package/dist/react.d.ts +728 -26
  10. package/dist/react.js +14 -4
  11. package/dist/react.js.map +1 -1
  12. package/dist/react.mjs +14 -4
  13. package/dist/react.mjs.map +1 -1
  14. package/dist/types/core.d.ts +2 -0
  15. package/dist/types/enrich.d.ts +11 -4
  16. package/dist/types/index.d.ts +1 -1
  17. package/dist/types/react.d.ts +6 -2
  18. package/dist/types/search.d.ts +25 -1
  19. package/dist/types/version.d.ts +2 -2
  20. package/docs/agents.md +8 -7
  21. package/docs/api/README.md +4 -4
  22. package/docs/api/accounts.d.ts +6 -0
  23. package/docs/api/adCampaigns.d.ts +6 -0
  24. package/docs/api/adCreatives.d.ts +6 -0
  25. package/docs/api/agency.d.ts +6 -0
  26. package/docs/api/agent.d.ts +6 -0
  27. package/docs/api/agents.d.ts +6 -0
  28. package/docs/api/aiInbox.d.ts +6 -0
  29. package/docs/api/analytics.d.ts +32 -1
  30. package/docs/api/analytics.md +2 -0
  31. package/docs/api/apiKeys.d.ts +6 -0
  32. package/docs/api/appDeployments.d.ts +6 -0
  33. package/docs/api/appDomains.d.ts +6 -0
  34. package/docs/api/appLogs.d.ts +6 -0
  35. package/docs/api/appObjects.d.ts +6 -0
  36. package/docs/api/appPages.d.ts +6 -0
  37. package/docs/api/appPlatformTokens.d.ts +6 -0
  38. package/docs/api/appointments.d.ts +20 -2
  39. package/docs/api/appointments.md +27 -11
  40. package/docs/api/apps.d.ts +6 -0
  41. package/docs/api/apps.md +7 -5
  42. package/docs/api/assertUpsert.d.ts +14 -0
  43. package/docs/api/assertUpsert.md +5 -0
  44. package/docs/api/audienceSyncs.d.ts +14 -0
  45. package/docs/api/audienceSyncs.md +16 -0
  46. package/docs/api/brandKit.d.ts +6 -0
  47. package/docs/api/bugReports.d.ts +6 -0
  48. package/docs/api/by-path.md +3 -0
  49. package/docs/api/calendarInvites.d.ts +6 -0
  50. package/docs/api/campaignWorkflows.d.ts +6 -0
  51. package/docs/api/campaigns.d.ts +6 -0
  52. package/docs/api/channels.d.ts +6 -0
  53. package/docs/api/cliCampaigns.d.ts +6 -0
  54. package/docs/api/cliPipelines.d.ts +6 -0
  55. package/docs/api/clickHouse.d.ts +6 -0
  56. package/docs/api/companies.d.ts +17 -3
  57. package/docs/api/companies.md +13 -3
  58. package/docs/api/companyIntelligence.d.ts +6 -0
  59. package/docs/api/contacts.d.ts +26 -5
  60. package/docs/api/contacts.md +17 -6
  61. package/docs/api/content.d.ts +6 -0
  62. package/docs/api/contentGridSkills.d.ts +6 -0
  63. package/docs/api/copilot.d.ts +6 -0
  64. package/docs/api/crmSyncs.d.ts +6 -0
  65. package/docs/api/customerSuccess.d.ts +6 -0
  66. package/docs/api/deals.d.ts +6 -0
  67. package/docs/api/deliverability.d.ts +6 -0
  68. package/docs/api/desk.d.ts +6 -0
  69. package/docs/api/dialer.d.ts +6 -0
  70. package/docs/api/documents.d.ts +6 -0
  71. package/docs/api/duplicates.d.ts +6 -0
  72. package/docs/api/eSignature.d.ts +6 -0
  73. package/docs/api/enrichment.d.ts +82 -2
  74. package/docs/api/enrichment.md +76 -1
  75. package/docs/api/events.d.ts +6 -0
  76. package/docs/api/fields.d.ts +30 -3
  77. package/docs/api/fields.md +15 -4
  78. package/docs/api/forms.d.ts +6 -0
  79. package/docs/api/gtmCampaigns.d.ts +6 -0
  80. package/docs/api/gtmContext.d.ts +6 -0
  81. package/docs/api/gtmDeliverability.d.ts +6 -0
  82. package/docs/api/gtmKnowledgeBase.d.ts +6 -0
  83. package/docs/api/gtmLibrary.d.ts +6 -0
  84. package/docs/api/imageLibrary.d.ts +6 -0
  85. package/docs/api/imports.d.ts +6 -0
  86. package/docs/api/inbox.d.ts +6 -0
  87. package/docs/api/install.d.ts +32 -0
  88. package/docs/api/install.md +18 -0
  89. package/docs/api/installedApps.d.ts +6 -0
  90. package/docs/api/integrationStatus.d.ts +6 -0
  91. package/docs/api/integrations.d.ts +6 -0
  92. package/docs/api/intent.d.ts +32 -1
  93. package/docs/api/intent.md +23 -0
  94. package/docs/api/knowledge.d.ts +6 -0
  95. package/docs/api/knowledgeBase.d.ts +6 -0
  96. package/docs/api/landingPages.d.ts +6 -0
  97. package/docs/api/leads.d.ts +6 -0
  98. package/docs/api/library.d.ts +6 -0
  99. package/docs/api/linkedIn.d.ts +6 -0
  100. package/docs/api/linkedInOutreach.d.ts +6 -0
  101. package/docs/api/lists.d.ts +22 -0
  102. package/docs/api/lists.md +24 -2
  103. package/docs/api/logs.d.ts +6 -0
  104. package/docs/api/mailboxes.d.ts +6 -0
  105. package/docs/api/marketingIntelligence.d.ts +40 -0
  106. package/docs/api/marketingIntelligence.md +20 -0
  107. package/docs/api/marketplace.d.ts +6 -0
  108. package/docs/api/mcp.d.ts +6 -0
  109. package/docs/api/me.d.ts +6 -0
  110. package/docs/api/meetings.d.ts +6 -0
  111. package/docs/api/newsletter.d.ts +6 -0
  112. package/docs/api/notes.d.ts +6 -0
  113. package/docs/api/notifications.d.ts +6 -0
  114. package/docs/api/objects.d.ts +6 -0
  115. package/docs/api/openSearch.d.ts +6 -0
  116. package/docs/api/ops.d.ts +6 -0
  117. package/docs/api/orgGovernance.d.ts +6 -0
  118. package/docs/api/orgVideos.d.ts +6 -0
  119. package/docs/api/organizationSettings.d.ts +6 -0
  120. package/docs/api/phoneNumbers.d.ts +6 -0
  121. package/docs/api/profile.d.ts +6 -0
  122. package/docs/api/programmaticPages.d.ts +6 -0
  123. package/docs/api/providerDomains.d.ts +6 -0
  124. package/docs/api/providerUsage.d.ts +6 -0
  125. package/docs/api/public.d.ts +6 -0
  126. package/docs/api/publicCopilot.d.ts +6 -0
  127. package/docs/api/publicSignals.d.ts +6 -0
  128. package/docs/api/publicVisitors.d.ts +6 -0
  129. package/docs/api/quotes.d.ts +6 -0
  130. package/docs/api/radarReports.d.ts +6 -0
  131. package/docs/api/recordRoles.d.ts +6 -0
  132. package/docs/api/repos.d.ts +6 -0
  133. package/docs/api/research.d.ts +6 -0
  134. package/docs/api/revenue.d.ts +6 -0
  135. package/docs/api/revenueAnalytics.d.ts +6 -0
  136. package/docs/api/revenueLifecycle.d.ts +11 -1
  137. package/docs/api/revenueLifecycle.md +11 -2
  138. package/docs/api/revenueRecords.d.ts +6 -0
  139. package/docs/api/roles.d.ts +49 -2
  140. package/docs/api/roles.md +65 -1
  141. package/docs/api/salesCoach.d.ts +6 -0
  142. package/docs/api/scans.d.ts +6 -0
  143. package/docs/api/scheduleBuy.d.ts +6 -0
  144. package/docs/api/scraping.d.ts +6 -0
  145. package/docs/api/search.d.ts +9 -1
  146. package/docs/api/search.md +3 -2
  147. package/docs/api/seo.d.ts +6 -0
  148. package/docs/api/sequenceLifecycle.d.ts +6 -0
  149. package/docs/api/sequences.d.ts +6 -0
  150. package/docs/api/settings.d.ts +6 -0
  151. package/docs/api/signals.d.ts +6 -0
  152. package/docs/api/signatures.d.ts +6 -0
  153. package/docs/api/snippet.d.ts +72 -2
  154. package/docs/api/snippet.md +73 -4
  155. package/docs/api/socialPublishing.d.ts +6 -0
  156. package/docs/api/studioDocuments.d.ts +6 -0
  157. package/docs/api/support.d.ts +6 -0
  158. package/docs/api/suppressions.d.ts +10 -0
  159. package/docs/api/suppressions.md +2 -0
  160. package/docs/api/surveys.d.ts +6 -0
  161. package/docs/api/tasks.d.ts +6 -0
  162. package/docs/api/teamMembers.d.ts +6 -0
  163. package/docs/api/teams.d.ts +6 -0
  164. package/docs/api/usage.d.ts +6 -0
  165. package/docs/api/visitors.d.ts +32 -0
  166. package/docs/api/visitors.md +12 -0
  167. package/docs/api/voice.d.ts +6 -0
  168. package/docs/api/webAnalytics.d.ts +288 -0
  169. package/docs/api/webAnalytics.md +144 -0
  170. package/docs/api/webChat.d.ts +6 -0
  171. package/docs/api/webhooks.d.ts +6 -0
  172. package/docs/api/websiteEditor.d.ts +6 -0
  173. package/docs/api/work.d.ts +6 -0
  174. package/docs/api/workbench.d.ts +6 -0
  175. package/docs/api/workflows.d.ts +6 -0
  176. package/docs/api/workflows.md +6 -0
  177. package/docs/sdk-clients.md +5 -5
  178. package/package.json +1 -1
package/dist/react.js CHANGED
@@ -898,6 +898,7 @@ var EXTERNAL_ROUTES = {
898
898
  "/quotes/{quote_id}/unarchive",
899
899
  "/radar/alerts/dispatch",
900
900
  "/repos/{repo_id}/campaigns/{campaign_id}/launch",
901
+ "/roles/invite",
901
902
  "/sales-coach/interviews/{interview_id}/members",
902
903
  "/sales-coach/interviews/{interview_id}/members/{member_id}/send-invite",
903
904
  "/sequencer/content/voice/test-call",
@@ -980,7 +981,7 @@ var EXTERNAL_ROUTES = {
980
981
  };
981
982
 
982
983
  // src/version.ts
983
- var SDK_VERSION = "0.265.0";
984
+ var SDK_VERSION = "0.293.0";
984
985
  var SDK_CLIENT_ID = `js-sdk/${SDK_VERSION}`;
985
986
 
986
987
  // src/http.ts
@@ -1244,7 +1245,10 @@ var DEFAULT_API6 = "https://be.graph8.com";
1244
1245
  var createEnrichClient = (apiKey, apiUrl) => {
1245
1246
  const baseUrl = apiUrl || DEFAULT_API6;
1246
1247
  return {
1247
- /** Look up a person by email, LinkedIn, or name + company. Costs 1 credit. */
1248
+ /**
1249
+ * Look up a person by email, LinkedIn, or name + company. Costs 2 credits per
1250
+ * lookup, charged even when no match is found (`found: false`).
1251
+ */
1248
1252
  async person(params) {
1249
1253
  const resp = await request(baseUrl, "/api/v1/enrichment/lookup/person", apiKey, {
1250
1254
  method: "POST",
@@ -1252,7 +1256,10 @@ var createEnrichClient = (apiKey, apiUrl) => {
1252
1256
  });
1253
1257
  return resp.data ?? resp;
1254
1258
  },
1255
- /** Look up a company by domain or name. Costs 1 credit. */
1259
+ /**
1260
+ * Look up a company by domain or name. Costs 2 credits per lookup, charged
1261
+ * even when no match is found (`found: false`).
1262
+ */
1256
1263
  async company(params) {
1257
1264
  const resp = await request(baseUrl, "/api/v1/enrichment/lookup/company", apiKey, {
1258
1265
  method: "POST",
@@ -1268,7 +1275,7 @@ var createEnrichClient = (apiKey, apiUrl) => {
1268
1275
  });
1269
1276
  return resp.data ?? resp;
1270
1277
  },
1271
- /** Search 700M+ contacts with filters. Credits charged per result. */
1278
+ /** Search 700M+ contacts with filters. Does not consume credits. */
1272
1279
  async search(filters, page = 1, limit = 25) {
1273
1280
  const resp = await request(baseUrl, "/api/v1/search/contacts", apiKey, {
1274
1281
  method: "POST",
@@ -3832,6 +3839,7 @@ var API_OPERATIONS = {
3832
3839
  infer_skill_variable_skills_infer_variable_post: ["POST", "/skills/infer-variable", "workflows", "inferSkillVariable", "write", "workflows:write"],
3833
3840
  install_app_installed_apps_post: ["POST", "/installed-apps", "installedApps", "installApp", "write", "apps:write"],
3834
3841
  intent_stats_intent_stats_get: ["GET", "/intent/stats", "intent", "intentStats", "read", "intent:read"],
3842
+ invite_member_roles_invite_post: ["POST", "/roles/invite", "roles", "inviteMember", "external", "account:run"],
3835
3843
  invoke_app_page_action_app_pages__page_id__actions__alias___action_name__post: ["POST", "/app-pages/{page_id}/actions/{alias}/{action_name}", "appPages", "invokeAppPageAction", "write", "apps:write"],
3836
3844
  issue_my_work_certificate_marketplace_me_work_certificates_post: ["POST", "/marketplace/me/work-certificates", "marketplace", "issueMyWorkCertificate", "billable", "marketplace:run"],
3837
3845
  issue_service_token_service_token_post: ["POST", "/service-token", "appPlatformTokens", "issueServiceToken", "write", null],
@@ -4179,6 +4187,7 @@ var API_OPERATIONS = {
4179
4187
  list_org_marketplace_meetings_marketplace_org_meetings_get: ["GET", "/marketplace/org/meetings", "marketplace", "listOrgMarketplaceMeetings", "read", "marketplace:read"],
4180
4188
  list_org_service_statements_marketplace_org_service_statements_get: ["GET", "/marketplace/org/service-statements", "marketplace", "listOrgServiceStatements", "read", "marketplace:read"],
4181
4189
  list_org_statement_line_items_marketplace_org_service_statements__statement_id__line_items_get: ["GET", "/marketplace/org/service-statements/{statement_id}/line-items", "marketplace", "listOrgStatementLineItems", "read", "marketplace:read"],
4190
+ list_org_streams_streams_get: ["GET", "/streams", "snippet", "listOrgStreams", "read", "integrations:read"],
4182
4191
  list_org_users_roles_org_users_get: ["GET", "/roles/org-users", "roles", "listOrgUsers", "read", "account:read"],
4183
4192
  list_org_videos_org_videos_get: ["GET", "/org-videos", "orgVideos", "listOrgVideos", "read", "campaigns:read"],
4184
4193
  list_outreach_campaigns_integrations_linkedin_outreach_campaigns_get: ["GET", "/integrations/linkedin-outreach/campaigns", "linkedInOutreach", "listOutreachCampaigns", "read", "integrations:read"],
@@ -4495,6 +4504,7 @@ var API_OPERATIONS = {
4495
4504
  post_agent_session_message_agent_sessions__session_id__messages_post: ["POST", "/agent/sessions/{session_id}/messages", "agents", "postAgentSessionMessage", "write", "workflows:write"],
4496
4505
  post_data_quality_analytics_sales_report_data_quality_post: ["POST", "/analytics/sales-report/data-quality", "analytics", "postDataQuality", "read", "analytics:read"],
4497
4506
  post_desk_voice_memo_desk_voice_memo_post: ["POST", "/desk/voice-memo", "desk", "postDeskVoiceMemo", "billable", "deals:run"],
4507
+ preflight_enrichment_enrichment_preflight_post: ["POST", "/enrichment/preflight", "enrichment", "preflightEnrichment", "read", "enrichment:read"],
4498
4508
  preview_account_plan_desk_accounts__account_id__plan_preview_post: ["POST", "/desk/accounts/{account_id}/plan/preview", "desk", "previewAccountPlan", "read", "deals:read"],
4499
4509
  preview_ad_campaign_edit_ad_campaigns__campaign_id__edit_preview_post: ["POST", "/ad-campaigns/{campaign_id}/edit-preview", "adCampaigns", "previewAdCampaignEdit", "external", "ads:run"],
4500
4510
  preview_campaign_audience_profile_campaigns_audience_profile_preview_post: ["POST", "/campaigns/audience-profile/preview", "campaigns", "previewCampaignAudienceProfile", "read", "campaigns:read"],