@graph8/sdk 0.4.0 → 0.5.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/dist/index.d.mts +1466 -2
- package/dist/index.d.ts +1466 -2
- package/dist/index.js +758 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +758 -2
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +1445 -0
- package/dist/react.d.ts +1445 -0
- package/dist/react.js +758 -2
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +758 -2
- package/dist/react.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,1026 @@
|
|
|
1
1
|
import { AnalyticsInterface } from '@jitsu/js';
|
|
2
2
|
|
|
3
|
+
interface MeetingAttendee {
|
|
4
|
+
name: string | null;
|
|
5
|
+
email: string;
|
|
6
|
+
role: "host" | "prospect" | "guest" | string;
|
|
7
|
+
contact_id?: number | null;
|
|
8
|
+
}
|
|
9
|
+
interface MeetingTranscriptLine {
|
|
10
|
+
speaker: string;
|
|
11
|
+
text: string;
|
|
12
|
+
timestamp: number;
|
|
13
|
+
}
|
|
14
|
+
interface MeetingAnalysis {
|
|
15
|
+
sentiment: "positive" | "neutral" | "negative";
|
|
16
|
+
summary: string;
|
|
17
|
+
next_steps: string[];
|
|
18
|
+
objections: string[];
|
|
19
|
+
talk_listen_ratio: number | null;
|
|
20
|
+
}
|
|
21
|
+
interface MeetingSummary {
|
|
22
|
+
id: string;
|
|
23
|
+
status: "scheduled" | "completed" | "cancelled" | "no_show";
|
|
24
|
+
event_type: string | null;
|
|
25
|
+
scheduled_at: string;
|
|
26
|
+
duration_minutes: number;
|
|
27
|
+
attendees: MeetingAttendee[];
|
|
28
|
+
contact_id: number | null;
|
|
29
|
+
conferencing_provider: string | null;
|
|
30
|
+
conferencing_url: string | null;
|
|
31
|
+
recording_url: string | null;
|
|
32
|
+
created_at: string;
|
|
33
|
+
}
|
|
34
|
+
interface MeetingDetail extends MeetingSummary {
|
|
35
|
+
transcript: MeetingTranscriptLine[] | null;
|
|
36
|
+
analysis: MeetingAnalysis | null;
|
|
37
|
+
}
|
|
38
|
+
interface MeetingListParams {
|
|
39
|
+
status?: "scheduled" | "completed" | "cancelled" | "no_show";
|
|
40
|
+
date_from?: string;
|
|
41
|
+
date_to?: string;
|
|
42
|
+
attendee_id?: string;
|
|
43
|
+
event_type?: string;
|
|
44
|
+
contact_id?: number;
|
|
45
|
+
page?: number;
|
|
46
|
+
limit?: number;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Meetings API - read-only access to scheduled, completed, and cancelled meetings.
|
|
50
|
+
* Booking happens via `g8.calendar.*` (write-key safe, browser only) — this surface
|
|
51
|
+
* is for reading meeting records, transcripts, and AI analysis.
|
|
52
|
+
*
|
|
53
|
+
* Requires API key (server-side).
|
|
54
|
+
*
|
|
55
|
+
* Backed by:
|
|
56
|
+
* GET /api/v1/inbox/meetings
|
|
57
|
+
* GET /api/v1/inbox/meetings/{meeting_id}
|
|
58
|
+
*/
|
|
59
|
+
declare const createMeetingsClient: (apiKey: string, apiUrl?: string) => {
|
|
60
|
+
/** List meetings with optional filters. Returns summary rows without transcript / analysis. */
|
|
61
|
+
list(params?: MeetingListParams): Promise<{
|
|
62
|
+
data: MeetingSummary[];
|
|
63
|
+
pagination?: {
|
|
64
|
+
page: number;
|
|
65
|
+
limit: number;
|
|
66
|
+
total: number;
|
|
67
|
+
has_next: boolean;
|
|
68
|
+
};
|
|
69
|
+
}>;
|
|
70
|
+
/** Get full meeting detail including transcript + AI analysis (transcript available 1-5 min after meeting ends). */
|
|
71
|
+
get(meetingId: string): Promise<MeetingDetail>;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
interface GlobalContextDocument {
|
|
75
|
+
id: string;
|
|
76
|
+
category: string;
|
|
77
|
+
title: string;
|
|
78
|
+
content: string;
|
|
79
|
+
metadata: Record<string, unknown> | null;
|
|
80
|
+
created_at: string | null;
|
|
81
|
+
updated_at: string | null;
|
|
82
|
+
}
|
|
83
|
+
interface Persona {
|
|
84
|
+
id: string;
|
|
85
|
+
name: string;
|
|
86
|
+
description: string | null;
|
|
87
|
+
status: string;
|
|
88
|
+
pain_points: string[];
|
|
89
|
+
goals: string[];
|
|
90
|
+
channels: string[];
|
|
91
|
+
created_at: string | null;
|
|
92
|
+
}
|
|
93
|
+
interface ICP {
|
|
94
|
+
id: string;
|
|
95
|
+
name: string;
|
|
96
|
+
description: string | null;
|
|
97
|
+
status: string;
|
|
98
|
+
industry: string[] | null;
|
|
99
|
+
employee_count_min: number | null;
|
|
100
|
+
employee_count_max: number | null;
|
|
101
|
+
revenue_min: number | null;
|
|
102
|
+
revenue_max: number | null;
|
|
103
|
+
countries: string[] | null;
|
|
104
|
+
created_at: string | null;
|
|
105
|
+
}
|
|
106
|
+
interface IntelligenceData {
|
|
107
|
+
id: string;
|
|
108
|
+
source_type: string;
|
|
109
|
+
url: string | null;
|
|
110
|
+
title: string | null;
|
|
111
|
+
content_summary: string | null;
|
|
112
|
+
collected_at: string | null;
|
|
113
|
+
}
|
|
114
|
+
interface ResearchReport {
|
|
115
|
+
id: string;
|
|
116
|
+
category: "buyer_psychology" | "competitive_teardown" | "gtm_channel" | "industry_analyst" | "review_sentiment" | "voice_of_customer";
|
|
117
|
+
title: string;
|
|
118
|
+
summary: string | null;
|
|
119
|
+
created_at: string | null;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Studio context — org-level intelligence documents. The 44-doc engine that
|
|
123
|
+
* powers campaign ideation: brand brief, value props, messaging house, ICPs,
|
|
124
|
+
* personas, intelligence (scrapes + enrichment), and AI research reports.
|
|
125
|
+
*
|
|
126
|
+
* Requires API key (server-side).
|
|
127
|
+
*
|
|
128
|
+
* Backed by:
|
|
129
|
+
* GET /api/v1/global-context/documents
|
|
130
|
+
* GET /api/v1/icps
|
|
131
|
+
* GET /api/v1/personas
|
|
132
|
+
* GET /api/v1/intelligence-data
|
|
133
|
+
* GET /api/v1/research-reports
|
|
134
|
+
*/
|
|
135
|
+
declare const createStudioClient: (apiKey: string, apiUrl?: string) => {
|
|
136
|
+
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.). */
|
|
137
|
+
globalContext(params?: {
|
|
138
|
+
category?: string;
|
|
139
|
+
limit?: number;
|
|
140
|
+
}): Promise<{
|
|
141
|
+
data: GlobalContextDocument[];
|
|
142
|
+
}>;
|
|
143
|
+
/** ICP definitions. */
|
|
144
|
+
icps(params?: {
|
|
145
|
+
status?: string;
|
|
146
|
+
limit?: number;
|
|
147
|
+
}): Promise<{
|
|
148
|
+
data: ICP[];
|
|
149
|
+
}>;
|
|
150
|
+
/** Buyer persona definitions. */
|
|
151
|
+
personas(params?: {
|
|
152
|
+
status?: string;
|
|
153
|
+
limit?: number;
|
|
154
|
+
}): Promise<{
|
|
155
|
+
data: Persona[];
|
|
156
|
+
}>;
|
|
157
|
+
/** Intelligence data (website scrapes, enrichment, competitor research). */
|
|
158
|
+
intelligenceData(params?: {
|
|
159
|
+
source_type?: string;
|
|
160
|
+
limit?: number;
|
|
161
|
+
}): Promise<{
|
|
162
|
+
data: IntelligenceData[];
|
|
163
|
+
}>;
|
|
164
|
+
/** AI research reports (buyer psychology, competitive teardown, GTM channel, etc.). */
|
|
165
|
+
researchReports(params?: {
|
|
166
|
+
category?: string;
|
|
167
|
+
limit?: number;
|
|
168
|
+
}): Promise<{
|
|
169
|
+
data: ResearchReport[];
|
|
170
|
+
}>;
|
|
171
|
+
};
|
|
172
|
+
|
|
173
|
+
interface IntentKeyword {
|
|
174
|
+
id: string;
|
|
175
|
+
keyword: string;
|
|
176
|
+
domain: string | null;
|
|
177
|
+
include_patterns: string[];
|
|
178
|
+
exclude_patterns: string[];
|
|
179
|
+
page_count: number;
|
|
180
|
+
visitor_count: number;
|
|
181
|
+
company_count: number;
|
|
182
|
+
contact_count: number;
|
|
183
|
+
created_at: string | null;
|
|
184
|
+
}
|
|
185
|
+
interface IntentPage {
|
|
186
|
+
url: string;
|
|
187
|
+
title: string | null;
|
|
188
|
+
keyword: string | null;
|
|
189
|
+
domain: string;
|
|
190
|
+
visitor_count: number;
|
|
191
|
+
last_seen: string | null;
|
|
192
|
+
}
|
|
193
|
+
interface IntentVisitor {
|
|
194
|
+
visitor_id: string;
|
|
195
|
+
company_domain: string | null;
|
|
196
|
+
company_name: string | null;
|
|
197
|
+
page_url: string;
|
|
198
|
+
first_seen: string | null;
|
|
199
|
+
last_seen: string | null;
|
|
200
|
+
visit_count: number;
|
|
201
|
+
}
|
|
202
|
+
interface IntentCompany {
|
|
203
|
+
domain: string;
|
|
204
|
+
name: string | null;
|
|
205
|
+
industry: string | null;
|
|
206
|
+
employee_count: string | null;
|
|
207
|
+
visit_count: number;
|
|
208
|
+
last_seen: string | null;
|
|
209
|
+
}
|
|
210
|
+
interface IntentContact {
|
|
211
|
+
contact_id: number | null;
|
|
212
|
+
email: string | null;
|
|
213
|
+
full_name: string | null;
|
|
214
|
+
company: string | null;
|
|
215
|
+
job_title: string | null;
|
|
216
|
+
last_seen: string | null;
|
|
217
|
+
}
|
|
218
|
+
interface IntentStats {
|
|
219
|
+
total_keywords: number;
|
|
220
|
+
total_pages: number;
|
|
221
|
+
total_visitors_30d: number;
|
|
222
|
+
total_companies_30d: number;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Intent + visitor tracking. Distinct from `g8.signals` (which is summary scoring) —
|
|
226
|
+
* this module exposes keyword tracking, page-level visitor data, and account-level
|
|
227
|
+
* intent signals from your own site (or from competitor URLs you've added).
|
|
228
|
+
*
|
|
229
|
+
* Requires API key (server-side).
|
|
230
|
+
*
|
|
231
|
+
* Backed by:
|
|
232
|
+
* GET /api/v1/intent/stats
|
|
233
|
+
* POST /api/v1/intent/keywords/list
|
|
234
|
+
* POST /api/v1/intent/keywords/create-from-domain
|
|
235
|
+
* DELETE /api/v1/intent/keywords/{keyword_id}
|
|
236
|
+
* POST /api/v1/intent/keywords/{keyword_id}/companies
|
|
237
|
+
* POST /api/v1/intent/keywords/{keyword_id}/contacts
|
|
238
|
+
* POST /api/v1/intent/keywords/{keyword_id}/urls
|
|
239
|
+
* POST /api/v1/intent/pages-by-domain
|
|
240
|
+
* POST /api/v1/intent/pages/search
|
|
241
|
+
* POST /api/v1/intent/pages/visitors
|
|
242
|
+
* POST /api/v1/intent/pages/contacts
|
|
243
|
+
* POST /api/v1/intent/pages/visitor-counts
|
|
244
|
+
* POST /intent-search/url-companies (note: bare host, no /api/v1 prefix)
|
|
245
|
+
*/
|
|
246
|
+
declare const createIntentClient: (apiKey: string, apiUrl?: string) => {
|
|
247
|
+
/** Org-level intent stats (totals over the last 30 days). */
|
|
248
|
+
stats(): Promise<{
|
|
249
|
+
data: IntentStats;
|
|
250
|
+
}>;
|
|
251
|
+
/** List tracked keywords with optional pagination. */
|
|
252
|
+
listKeywords(params?: {
|
|
253
|
+
page?: number;
|
|
254
|
+
limit?: number;
|
|
255
|
+
search?: string;
|
|
256
|
+
}): Promise<{
|
|
257
|
+
data: IntentKeyword[];
|
|
258
|
+
}>;
|
|
259
|
+
/** Create a keyword group from a domain (auto-tracks all pages). */
|
|
260
|
+
createFromDomain(domain: string): Promise<{
|
|
261
|
+
data: IntentKeyword;
|
|
262
|
+
}>;
|
|
263
|
+
/** Stop tracking a keyword (irreversible — historical data is retained). */
|
|
264
|
+
deleteKeyword(keywordId: string): Promise<{
|
|
265
|
+
data: {
|
|
266
|
+
deleted: boolean;
|
|
267
|
+
};
|
|
268
|
+
}>;
|
|
269
|
+
/** Companies showing interest in a tracked keyword. */
|
|
270
|
+
keywordCompanies(keywordId: string, params?: {
|
|
271
|
+
limit?: number;
|
|
272
|
+
date_from?: string;
|
|
273
|
+
date_to?: string;
|
|
274
|
+
}): Promise<{
|
|
275
|
+
data: IntentCompany[];
|
|
276
|
+
}>;
|
|
277
|
+
/** Contacts showing interest in a tracked keyword. */
|
|
278
|
+
keywordContacts(keywordId: string, params?: {
|
|
279
|
+
limit?: number;
|
|
280
|
+
date_from?: string;
|
|
281
|
+
date_to?: string;
|
|
282
|
+
}): Promise<{
|
|
283
|
+
data: IntentContact[];
|
|
284
|
+
}>;
|
|
285
|
+
/** URLs associated with a keyword (pages visitors landed on while interested). */
|
|
286
|
+
keywordUrls(keywordId: string, params?: {
|
|
287
|
+
limit?: number;
|
|
288
|
+
}): Promise<{
|
|
289
|
+
data: IntentPage[];
|
|
290
|
+
}>;
|
|
291
|
+
/** Pages tracked on a specific domain. */
|
|
292
|
+
pagesByDomain(domain: string, params?: {
|
|
293
|
+
limit?: number;
|
|
294
|
+
}): Promise<{
|
|
295
|
+
data: IntentPage[];
|
|
296
|
+
}>;
|
|
297
|
+
/** Search tracked pages by URL fragment or keyword. */
|
|
298
|
+
searchPages(query: string, params?: {
|
|
299
|
+
limit?: number;
|
|
300
|
+
}): Promise<{
|
|
301
|
+
data: IntentPage[];
|
|
302
|
+
}>;
|
|
303
|
+
/** Get visitor records for a specific page URL. */
|
|
304
|
+
pageVisitors(pageUrl: string, params?: {
|
|
305
|
+
limit?: number;
|
|
306
|
+
date_from?: string;
|
|
307
|
+
date_to?: string;
|
|
308
|
+
}): Promise<{
|
|
309
|
+
data: IntentVisitor[];
|
|
310
|
+
}>;
|
|
311
|
+
/** Get contacts who visited a specific page URL. */
|
|
312
|
+
pageContacts(pageUrl: string, params?: {
|
|
313
|
+
limit?: number;
|
|
314
|
+
}): Promise<{
|
|
315
|
+
data: IntentContact[];
|
|
316
|
+
}>;
|
|
317
|
+
/** Visitor count aggregates by page (pass an array of URLs). */
|
|
318
|
+
pageVisitorCounts(urls: string[]): Promise<{
|
|
319
|
+
data: Array<{
|
|
320
|
+
url: string;
|
|
321
|
+
visitor_count: number;
|
|
322
|
+
}>;
|
|
323
|
+
}>;
|
|
324
|
+
/**
|
|
325
|
+
* Find companies whose users visited a specific URL (intent search).
|
|
326
|
+
*
|
|
327
|
+
* Note: this endpoint lives at the bare host (no `/api/v1` prefix), unlike the rest
|
|
328
|
+
* of the intent surface — we call it directly here instead of through the shared `post()` helper.
|
|
329
|
+
*/
|
|
330
|
+
urlCompanies(url: string, params?: {
|
|
331
|
+
limit?: number;
|
|
332
|
+
date_from?: string;
|
|
333
|
+
date_to?: string;
|
|
334
|
+
}): Promise<{
|
|
335
|
+
data: IntentCompany[];
|
|
336
|
+
}>;
|
|
337
|
+
};
|
|
338
|
+
|
|
339
|
+
type SkillType = "llm" | "api";
|
|
340
|
+
interface SkillInputField {
|
|
341
|
+
name: string;
|
|
342
|
+
type: string;
|
|
343
|
+
required: boolean;
|
|
344
|
+
description?: string;
|
|
345
|
+
}
|
|
346
|
+
interface Skill {
|
|
347
|
+
id: string;
|
|
348
|
+
title: string;
|
|
349
|
+
description: string | null;
|
|
350
|
+
type: SkillType;
|
|
351
|
+
/** Only present on `type=llm`. */
|
|
352
|
+
prompt?: string;
|
|
353
|
+
/** Only present on `type=llm`. */
|
|
354
|
+
model?: string;
|
|
355
|
+
/** Only present on `type=api`. */
|
|
356
|
+
method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
|
|
357
|
+
/** Only present on `type=api`. */
|
|
358
|
+
url?: string;
|
|
359
|
+
/** Only present on `type=api`. */
|
|
360
|
+
headers?: Record<string, string>;
|
|
361
|
+
/** Only present on `type=api`. */
|
|
362
|
+
body_template?: string;
|
|
363
|
+
input_schema: {
|
|
364
|
+
fields: SkillInputField[];
|
|
365
|
+
};
|
|
366
|
+
output_schema: Record<string, unknown> | null;
|
|
367
|
+
created_at: string | null;
|
|
368
|
+
updated_at: string | null;
|
|
369
|
+
}
|
|
370
|
+
interface SkillCreateLLMParams {
|
|
371
|
+
title: string;
|
|
372
|
+
description?: string;
|
|
373
|
+
prompt: string;
|
|
374
|
+
model: string;
|
|
375
|
+
input_schema: {
|
|
376
|
+
fields: SkillInputField[];
|
|
377
|
+
};
|
|
378
|
+
output_schema?: Record<string, unknown>;
|
|
379
|
+
}
|
|
380
|
+
interface SkillCreateAPIParams {
|
|
381
|
+
title: string;
|
|
382
|
+
description?: string;
|
|
383
|
+
method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
|
|
384
|
+
url: string;
|
|
385
|
+
headers?: Record<string, string>;
|
|
386
|
+
body_template?: string;
|
|
387
|
+
response_mapping?: Record<string, string>;
|
|
388
|
+
input_schema: {
|
|
389
|
+
fields: SkillInputField[];
|
|
390
|
+
};
|
|
391
|
+
}
|
|
392
|
+
interface SkillUpdateLLMParams {
|
|
393
|
+
title?: string;
|
|
394
|
+
description?: string;
|
|
395
|
+
prompt?: string;
|
|
396
|
+
model?: string;
|
|
397
|
+
input_schema?: {
|
|
398
|
+
fields: SkillInputField[];
|
|
399
|
+
};
|
|
400
|
+
output_schema?: Record<string, unknown>;
|
|
401
|
+
}
|
|
402
|
+
interface SkillUpdateAPIParams {
|
|
403
|
+
title?: string;
|
|
404
|
+
description?: string;
|
|
405
|
+
method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
|
|
406
|
+
url?: string;
|
|
407
|
+
headers?: Record<string, string>;
|
|
408
|
+
body_template?: string;
|
|
409
|
+
response_mapping?: Record<string, string>;
|
|
410
|
+
input_schema?: {
|
|
411
|
+
fields: SkillInputField[];
|
|
412
|
+
};
|
|
413
|
+
}
|
|
414
|
+
interface SkillTemplate {
|
|
415
|
+
id: string;
|
|
416
|
+
title: string;
|
|
417
|
+
description: string;
|
|
418
|
+
type: SkillType;
|
|
419
|
+
use_cases: string[];
|
|
420
|
+
}
|
|
421
|
+
interface SkillListParams {
|
|
422
|
+
page?: number;
|
|
423
|
+
limit?: number;
|
|
424
|
+
type?: SkillType;
|
|
425
|
+
search?: string;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* Skills API - LLM and API building blocks that workflows compose into runs.
|
|
429
|
+
* Requires API key (server-side).
|
|
430
|
+
*
|
|
431
|
+
* Backed by:
|
|
432
|
+
* GET /api/v1/skills
|
|
433
|
+
* GET /api/v1/skills/{id}
|
|
434
|
+
* GET /api/v1/skills/{id}/variables
|
|
435
|
+
* GET /api/v1/skills/models
|
|
436
|
+
* GET /api/v1/skills/templates
|
|
437
|
+
* POST /api/v1/skills (both llm + api types via `type` field)
|
|
438
|
+
* POST /api/v1/skills/from-template
|
|
439
|
+
* POST /api/v1/skills/from-node
|
|
440
|
+
* PUT /api/v1/skills/{id}
|
|
441
|
+
* DELETE /api/v1/skills/{id}
|
|
442
|
+
* POST /api/v1/skills/validate
|
|
443
|
+
* POST /api/v1/skills/{id}/execute
|
|
444
|
+
*/
|
|
445
|
+
declare const createSkillsClient: (apiKey: string, apiUrl?: string) => {
|
|
446
|
+
/** List skills. */
|
|
447
|
+
list(params?: SkillListParams): Promise<{
|
|
448
|
+
data: Skill[];
|
|
449
|
+
}>;
|
|
450
|
+
/** Get a skill by ID. */
|
|
451
|
+
get(skillId: string): Promise<Skill>;
|
|
452
|
+
/** Get the variables required by a skill (extracted from prompt or body template). */
|
|
453
|
+
getVariables(skillId: string): Promise<{
|
|
454
|
+
data: SkillInputField[];
|
|
455
|
+
}>;
|
|
456
|
+
/** List available LLM models. */
|
|
457
|
+
listModels(): Promise<{
|
|
458
|
+
data: Array<{
|
|
459
|
+
id: string;
|
|
460
|
+
label: string;
|
|
461
|
+
provider: string;
|
|
462
|
+
}>;
|
|
463
|
+
}>;
|
|
464
|
+
/** List skill templates. */
|
|
465
|
+
listTemplates(params?: {
|
|
466
|
+
type?: SkillType;
|
|
467
|
+
}): Promise<{
|
|
468
|
+
data: SkillTemplate[];
|
|
469
|
+
}>;
|
|
470
|
+
/** Create an LLM skill (prompt + model + schemas). */
|
|
471
|
+
createLLM(params: SkillCreateLLMParams): Promise<Skill>;
|
|
472
|
+
/** Create an API skill (HTTP request wrapper). */
|
|
473
|
+
createAPI(params: SkillCreateAPIParams): Promise<Skill>;
|
|
474
|
+
/** Create a skill from a built-in template. */
|
|
475
|
+
createFromTemplate(params: {
|
|
476
|
+
title: string;
|
|
477
|
+
template_id: string;
|
|
478
|
+
overrides?: Record<string, unknown>;
|
|
479
|
+
}): Promise<Skill>;
|
|
480
|
+
/** Lift a workflow node into a reusable skill. */
|
|
481
|
+
createFromNode(params: {
|
|
482
|
+
title: string;
|
|
483
|
+
description?: string;
|
|
484
|
+
node_id: string;
|
|
485
|
+
input_mapping?: Record<string, string>;
|
|
486
|
+
output_mapping?: Record<string, string>;
|
|
487
|
+
}): Promise<Skill>;
|
|
488
|
+
/** Update an LLM skill. */
|
|
489
|
+
updateLLM(skillId: string, fields: SkillUpdateLLMParams): Promise<Skill>;
|
|
490
|
+
/** Update an API skill. */
|
|
491
|
+
updateAPI(skillId: string, fields: SkillUpdateAPIParams): Promise<Skill>;
|
|
492
|
+
/** Delete a skill (irreversible if in-use workflows exist). */
|
|
493
|
+
delete(skillId: string): Promise<{
|
|
494
|
+
data: {
|
|
495
|
+
deleted: boolean;
|
|
496
|
+
};
|
|
497
|
+
}>;
|
|
498
|
+
/** Validate a skill definition (without saving). */
|
|
499
|
+
validate(skill: Partial<Skill>): Promise<{
|
|
500
|
+
data: {
|
|
501
|
+
valid: boolean;
|
|
502
|
+
errors: string[];
|
|
503
|
+
};
|
|
504
|
+
}>;
|
|
505
|
+
/** Execute a skill immediately with an input payload (test / preview). */
|
|
506
|
+
execute(skillId: string, inputPayload: Record<string, unknown>): Promise<{
|
|
507
|
+
data: {
|
|
508
|
+
output: Record<string, unknown>;
|
|
509
|
+
latency_ms: number;
|
|
510
|
+
tokens?: number;
|
|
511
|
+
error: string | null;
|
|
512
|
+
};
|
|
513
|
+
}>;
|
|
514
|
+
};
|
|
515
|
+
|
|
516
|
+
interface WorkflowNode {
|
|
517
|
+
id: string;
|
|
518
|
+
type: string;
|
|
519
|
+
config: Record<string, unknown>;
|
|
520
|
+
position?: {
|
|
521
|
+
x: number;
|
|
522
|
+
y: number;
|
|
523
|
+
};
|
|
524
|
+
/** Mapping from this node's output to the next node's input. */
|
|
525
|
+
input_mappings?: Record<string, string>;
|
|
526
|
+
}
|
|
527
|
+
interface WorkflowConnection {
|
|
528
|
+
from_node_id: string;
|
|
529
|
+
to_node_id: string;
|
|
530
|
+
condition?: string | null;
|
|
531
|
+
}
|
|
532
|
+
interface WorkflowConfig {
|
|
533
|
+
nodes: WorkflowNode[];
|
|
534
|
+
connections: WorkflowConnection[];
|
|
535
|
+
trigger?: Record<string, unknown> | null;
|
|
536
|
+
}
|
|
537
|
+
interface Workflow {
|
|
538
|
+
id: string;
|
|
539
|
+
name: string;
|
|
540
|
+
description: string | null;
|
|
541
|
+
config: WorkflowConfig;
|
|
542
|
+
trigger_config: Record<string, unknown> | null;
|
|
543
|
+
is_active: boolean;
|
|
544
|
+
created_at: string | null;
|
|
545
|
+
updated_at: string | null;
|
|
546
|
+
}
|
|
547
|
+
interface WorkflowCreateParams {
|
|
548
|
+
name: string;
|
|
549
|
+
description?: string;
|
|
550
|
+
config?: WorkflowConfig;
|
|
551
|
+
trigger_config?: Record<string, unknown>;
|
|
552
|
+
}
|
|
553
|
+
interface WorkflowUpdateParams {
|
|
554
|
+
name?: string;
|
|
555
|
+
description?: string;
|
|
556
|
+
config?: WorkflowConfig;
|
|
557
|
+
trigger_config?: Record<string, unknown>;
|
|
558
|
+
is_active?: boolean;
|
|
559
|
+
}
|
|
560
|
+
interface WorkflowExecution {
|
|
561
|
+
id: string;
|
|
562
|
+
workflow_id: string;
|
|
563
|
+
status: "pending" | "running" | "paused" | "completed" | "failed" | "stopped";
|
|
564
|
+
trigger_payload: Record<string, unknown>;
|
|
565
|
+
outputs: Record<string, unknown>;
|
|
566
|
+
error: string | null;
|
|
567
|
+
started_at: string | null;
|
|
568
|
+
ended_at: string | null;
|
|
569
|
+
}
|
|
570
|
+
interface NodeTypeSchema {
|
|
571
|
+
type: string;
|
|
572
|
+
label: string;
|
|
573
|
+
description: string;
|
|
574
|
+
config_schema: Record<string, unknown>;
|
|
575
|
+
output_schema: Record<string, unknown>;
|
|
576
|
+
}
|
|
577
|
+
interface WorkflowListParams {
|
|
578
|
+
page?: number;
|
|
579
|
+
limit?: number;
|
|
580
|
+
is_active?: boolean;
|
|
581
|
+
search?: string;
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
* Workflows API - automation workflows with nodes, connections, and execution lifecycle.
|
|
585
|
+
* Requires API key (server-side).
|
|
586
|
+
*
|
|
587
|
+
* The graph8 workflow surface treats the whole workflow definition as a single
|
|
588
|
+
* record updated via `update()` — there are no per-node CRUD endpoints. To edit
|
|
589
|
+
* nodes or connections, fetch the workflow, mutate `config.nodes` / `config.connections`,
|
|
590
|
+
* and PUT it back.
|
|
591
|
+
*
|
|
592
|
+
* Backed by:
|
|
593
|
+
* GET /api/v1/workflows
|
|
594
|
+
* GET /api/v1/workflows/{id}
|
|
595
|
+
* POST /api/v1/workflows
|
|
596
|
+
* PUT /api/v1/workflows/{id}
|
|
597
|
+
* DELETE /api/v1/workflows/{id}
|
|
598
|
+
* POST /api/v1/workflows/validate
|
|
599
|
+
* POST /api/v1/workflows/{id}/execute
|
|
600
|
+
* GET /api/v1/workflows/executions/{exec_id}
|
|
601
|
+
* POST /api/v1/workflows/executions/{exec_id}/pause
|
|
602
|
+
* POST /api/v1/workflows/executions/{exec_id}/resume
|
|
603
|
+
* POST /api/v1/workflows/executions/{exec_id}/stop
|
|
604
|
+
* GET /api/v1/workflows/{id}/trigger-status
|
|
605
|
+
* POST /api/v1/workflows/{id}/trigger-reset
|
|
606
|
+
* GET /api/v1/workflows/node-types/schema
|
|
607
|
+
* GET /api/v1/workflows/integrations/slack/users|channels
|
|
608
|
+
* GET /api/v1/workflows/integrations/roam/users|groups
|
|
609
|
+
* GET /api/v1/workflows/mcp-servers
|
|
610
|
+
* GET /api/v1/workflows/dispositions
|
|
611
|
+
* GET /api/v1/workflows/forms/{form_id}/fields
|
|
612
|
+
*/
|
|
613
|
+
declare const createWorkflowsClient: (apiKey: string, apiUrl?: string) => {
|
|
614
|
+
/** List workflows org-wide. */
|
|
615
|
+
list(params?: WorkflowListParams): Promise<{
|
|
616
|
+
data: Workflow[];
|
|
617
|
+
}>;
|
|
618
|
+
/** Get full workflow definition (nodes, connections, trigger, execution state). */
|
|
619
|
+
get(workflowId: string): Promise<Workflow>;
|
|
620
|
+
/** Create a new workflow. */
|
|
621
|
+
create(params: WorkflowCreateParams): Promise<Workflow>;
|
|
622
|
+
/**
|
|
623
|
+
* Update a workflow. Pass the full `config` (nodes + connections) to edit
|
|
624
|
+
* the graph — node-level CRUD is performed client-side by mutating the
|
|
625
|
+
* config and submitting the updated record.
|
|
626
|
+
*/
|
|
627
|
+
update(workflowId: string, fields: WorkflowUpdateParams): Promise<Workflow>;
|
|
628
|
+
/** Delete a workflow. */
|
|
629
|
+
delete(workflowId: string): Promise<{
|
|
630
|
+
data: {
|
|
631
|
+
deleted: boolean;
|
|
632
|
+
};
|
|
633
|
+
}>;
|
|
634
|
+
/** Validate a workflow definition (orphans, dangling connections, required fields). */
|
|
635
|
+
validate(workflow: {
|
|
636
|
+
config: WorkflowConfig;
|
|
637
|
+
trigger_config?: Record<string, unknown>;
|
|
638
|
+
}): Promise<{
|
|
639
|
+
data: {
|
|
640
|
+
valid: boolean;
|
|
641
|
+
errors: Array<{
|
|
642
|
+
node_id?: string;
|
|
643
|
+
field?: string;
|
|
644
|
+
message: string;
|
|
645
|
+
}>;
|
|
646
|
+
};
|
|
647
|
+
}>;
|
|
648
|
+
/** Execute a workflow immediately with a trigger payload. */
|
|
649
|
+
execute(workflowId: string, triggerPayload?: Record<string, unknown>): Promise<WorkflowExecution>;
|
|
650
|
+
/** Get the status + output of a workflow execution. */
|
|
651
|
+
getExecution(executionId: string): Promise<WorkflowExecution>;
|
|
652
|
+
/** Pause an in-flight execution. */
|
|
653
|
+
pauseExecution(executionId: string): Promise<{
|
|
654
|
+
data: {
|
|
655
|
+
paused: boolean;
|
|
656
|
+
};
|
|
657
|
+
}>;
|
|
658
|
+
/** Resume a paused execution. */
|
|
659
|
+
resumeExecution(executionId: string): Promise<{
|
|
660
|
+
data: {
|
|
661
|
+
resumed: boolean;
|
|
662
|
+
};
|
|
663
|
+
}>;
|
|
664
|
+
/** Stop an execution (terminal state — cannot resume). */
|
|
665
|
+
stopExecution(executionId: string): Promise<{
|
|
666
|
+
data: {
|
|
667
|
+
stopped: boolean;
|
|
668
|
+
};
|
|
669
|
+
}>;
|
|
670
|
+
/** Get the status of a workflow's external trigger (e.g. "waiting for webhook"). */
|
|
671
|
+
getTriggerStatus(workflowId: string): Promise<{
|
|
672
|
+
data: {
|
|
673
|
+
status: string;
|
|
674
|
+
details: Record<string, unknown>;
|
|
675
|
+
};
|
|
676
|
+
}>;
|
|
677
|
+
/** Reset the trigger cursor (e.g. for event-stream triggers — resume from beginning). */
|
|
678
|
+
resetTrigger(workflowId: string): Promise<{
|
|
679
|
+
data: {
|
|
680
|
+
reset: boolean;
|
|
681
|
+
};
|
|
682
|
+
}>;
|
|
683
|
+
/**
|
|
684
|
+
* List available node types with schemas. Pass a `type` param to fetch one type's full schema.
|
|
685
|
+
*/
|
|
686
|
+
nodeTypes(params?: {
|
|
687
|
+
type?: string;
|
|
688
|
+
}): Promise<{
|
|
689
|
+
data: NodeTypeSchema[];
|
|
690
|
+
}>;
|
|
691
|
+
/** Slack workspace users (for Slack action recipients). */
|
|
692
|
+
listSlackUsers(): Promise<{
|
|
693
|
+
data: Array<{
|
|
694
|
+
id: string;
|
|
695
|
+
name: string;
|
|
696
|
+
email: string | null;
|
|
697
|
+
}>;
|
|
698
|
+
}>;
|
|
699
|
+
/** Slack channels. */
|
|
700
|
+
listSlackChannels(): Promise<{
|
|
701
|
+
data: Array<{
|
|
702
|
+
id: string;
|
|
703
|
+
name: string;
|
|
704
|
+
is_private: boolean;
|
|
705
|
+
}>;
|
|
706
|
+
}>;
|
|
707
|
+
/** Roam (Copilot chat) users. */
|
|
708
|
+
listRoamUsers(): Promise<{
|
|
709
|
+
data: Array<{
|
|
710
|
+
id: string;
|
|
711
|
+
name: string;
|
|
712
|
+
email: string | null;
|
|
713
|
+
}>;
|
|
714
|
+
}>;
|
|
715
|
+
/** Roam (Copilot chat) groups. */
|
|
716
|
+
listRoamGroups(): Promise<{
|
|
717
|
+
data: Array<{
|
|
718
|
+
id: string;
|
|
719
|
+
name: string;
|
|
720
|
+
}>;
|
|
721
|
+
}>;
|
|
722
|
+
/** Available MCP servers (for Agent-node integrations). */
|
|
723
|
+
listMcpServers(): Promise<{
|
|
724
|
+
data: Array<{
|
|
725
|
+
id: string;
|
|
726
|
+
name: string;
|
|
727
|
+
url: string;
|
|
728
|
+
}>;
|
|
729
|
+
}>;
|
|
730
|
+
/** Available call dispositions (voice workflow nodes). */
|
|
731
|
+
listDispositions(): Promise<{
|
|
732
|
+
data: Array<{
|
|
733
|
+
id: string;
|
|
734
|
+
label: string;
|
|
735
|
+
}>;
|
|
736
|
+
}>;
|
|
737
|
+
/** Form field schema for form-trigger nodes. */
|
|
738
|
+
listFormFields(formId: string): Promise<{
|
|
739
|
+
data: Array<{
|
|
740
|
+
name: string;
|
|
741
|
+
type: string;
|
|
742
|
+
required: boolean;
|
|
743
|
+
}>;
|
|
744
|
+
}>;
|
|
745
|
+
};
|
|
746
|
+
|
|
747
|
+
/**
|
|
748
|
+
* Stage Checklist v2 pipelines. A "pipeline" here is a multi-stage workflow
|
|
749
|
+
* (with evidence requirements and per-channel scripts) that lives parallel
|
|
750
|
+
* to deal pipelines. Use `g8.deals.pipelines()` for deal-pipeline reads.
|
|
751
|
+
*/
|
|
752
|
+
interface StagePipelineStage {
|
|
753
|
+
id: string;
|
|
754
|
+
name: string;
|
|
755
|
+
position: number;
|
|
756
|
+
/** Evidence keys that must be collected before the stage can be marked done. */
|
|
757
|
+
required_elements: string[];
|
|
758
|
+
/** Evidence keys that are recommended but not enforced. */
|
|
759
|
+
recommended_elements: string[];
|
|
760
|
+
/** Channel-specific scripts (call, email, linkedin, etc.). */
|
|
761
|
+
channel_scripts: Record<string, string>;
|
|
762
|
+
color: string | null;
|
|
763
|
+
stage_type: string | null;
|
|
764
|
+
}
|
|
765
|
+
interface StagePipeline {
|
|
766
|
+
id: string;
|
|
767
|
+
name: string;
|
|
768
|
+
target: string | null;
|
|
769
|
+
is_default: boolean;
|
|
770
|
+
stages: StagePipelineStage[];
|
|
771
|
+
created_at: string | null;
|
|
772
|
+
updated_at: string | null;
|
|
773
|
+
}
|
|
774
|
+
interface StagePipelineCreateParams {
|
|
775
|
+
name: string;
|
|
776
|
+
target?: string;
|
|
777
|
+
/** If true, creates an empty pipeline (no default stages). */
|
|
778
|
+
blank?: boolean;
|
|
779
|
+
}
|
|
780
|
+
interface StagePipelineUpdateParams {
|
|
781
|
+
name?: string;
|
|
782
|
+
target?: string;
|
|
783
|
+
}
|
|
784
|
+
interface StageCreateParams {
|
|
785
|
+
name: string;
|
|
786
|
+
position?: number;
|
|
787
|
+
required_elements?: string[];
|
|
788
|
+
recommended_elements?: string[];
|
|
789
|
+
channel_scripts?: Record<string, string>;
|
|
790
|
+
color?: string;
|
|
791
|
+
stage_type?: string;
|
|
792
|
+
}
|
|
793
|
+
interface StageUpdateParams {
|
|
794
|
+
name?: string;
|
|
795
|
+
position?: number;
|
|
796
|
+
required_elements?: string[];
|
|
797
|
+
recommended_elements?: string[];
|
|
798
|
+
channel_scripts?: Record<string, string>;
|
|
799
|
+
color?: string;
|
|
800
|
+
}
|
|
801
|
+
interface EvidenceKey {
|
|
802
|
+
key: string;
|
|
803
|
+
label: string;
|
|
804
|
+
description: string;
|
|
805
|
+
category: string;
|
|
806
|
+
}
|
|
807
|
+
interface PipelineSuggestion {
|
|
808
|
+
suggestion_id: string;
|
|
809
|
+
name: string;
|
|
810
|
+
target: string;
|
|
811
|
+
stages: Array<{
|
|
812
|
+
name: string;
|
|
813
|
+
required_elements: string[];
|
|
814
|
+
channel_scripts: Record<string, string>;
|
|
815
|
+
}>;
|
|
816
|
+
rationale: string;
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* Stage Checklist Pipelines API - workflow pipelines with evidence + scripts.
|
|
820
|
+
* Requires API key (server-side).
|
|
821
|
+
*
|
|
822
|
+
* Backed by:
|
|
823
|
+
* GET /api/v1/pipelines
|
|
824
|
+
* GET /api/v1/pipelines/{id}
|
|
825
|
+
* GET /api/v1/pipelines/evidence-library
|
|
826
|
+
* POST /api/v1/pipelines
|
|
827
|
+
* PUT /api/v1/pipelines/{id}
|
|
828
|
+
* DELETE /api/v1/pipelines/{id}
|
|
829
|
+
* POST /api/v1/pipelines/{id}/stages
|
|
830
|
+
* PUT /api/v1/pipelines/{id}/stages/{stage_id}
|
|
831
|
+
* DELETE /api/v1/pipelines/{id}/stages/{stage_id}
|
|
832
|
+
* PUT /api/v1/pipelines/{id}/stages/reorder
|
|
833
|
+
* POST /api/v1/pipelines/suggest
|
|
834
|
+
* POST /api/v1/pipelines/from-suggestion
|
|
835
|
+
*/
|
|
836
|
+
declare const createPipelinesClient: (apiKey: string, apiUrl?: string) => {
|
|
837
|
+
/** List all stage-checklist pipelines with stages, evidence, scripts. */
|
|
838
|
+
list(): Promise<{
|
|
839
|
+
data: StagePipeline[];
|
|
840
|
+
}>;
|
|
841
|
+
/** Get a single pipeline by ID. */
|
|
842
|
+
get(pipelineId: string): Promise<StagePipeline>;
|
|
843
|
+
/** Get the canonical evidence-key library (used when defining stages). */
|
|
844
|
+
evidenceLibrary(): Promise<{
|
|
845
|
+
data: EvidenceKey[];
|
|
846
|
+
}>;
|
|
847
|
+
/** Create a new pipeline. Defaults to a templated set of stages; pass blank=true for empty. */
|
|
848
|
+
create(params: StagePipelineCreateParams): Promise<StagePipeline>;
|
|
849
|
+
/** Update pipeline metadata (name, target). */
|
|
850
|
+
update(pipelineId: string, fields: StagePipelineUpdateParams): Promise<StagePipeline>;
|
|
851
|
+
/** Delete a pipeline. Only allowed when no deals reference it. */
|
|
852
|
+
delete(pipelineId: string): Promise<{
|
|
853
|
+
data: {
|
|
854
|
+
deleted: boolean;
|
|
855
|
+
};
|
|
856
|
+
}>;
|
|
857
|
+
/** Add a new stage to a pipeline. */
|
|
858
|
+
createStage(pipelineId: string, stage: StageCreateParams): Promise<StagePipelineStage>;
|
|
859
|
+
/** Update a stage (evidence, scripts, position). */
|
|
860
|
+
updateStage(pipelineId: string, stageId: string, fields: StageUpdateParams): Promise<StagePipelineStage>;
|
|
861
|
+
/** Reorder stages within a pipeline (pass full ordered list of stage IDs). */
|
|
862
|
+
reorderStages(pipelineId: string, stageIds: string[]): Promise<{
|
|
863
|
+
data: StagePipelineStage[];
|
|
864
|
+
}>;
|
|
865
|
+
/** Delete a stage from a pipeline. */
|
|
866
|
+
deleteStage(pipelineId: string, stageId: string): Promise<{
|
|
867
|
+
data: {
|
|
868
|
+
deleted: boolean;
|
|
869
|
+
};
|
|
870
|
+
}>;
|
|
871
|
+
/** Get an AI-suggested pipeline based on org context (brand, ICP, messaging). */
|
|
872
|
+
suggest(): Promise<{
|
|
873
|
+
data: PipelineSuggestion;
|
|
874
|
+
}>;
|
|
875
|
+
/** Create a real pipeline from an AI suggestion (optionally with overrides). */
|
|
876
|
+
fromSuggestion(suggestionId: string, overrides?: Partial<{
|
|
877
|
+
name: string;
|
|
878
|
+
target: string;
|
|
879
|
+
}>): Promise<StagePipeline>;
|
|
880
|
+
};
|
|
881
|
+
|
|
882
|
+
interface QuoteLineItem {
|
|
883
|
+
product_id?: string | null;
|
|
884
|
+
name?: string | null;
|
|
885
|
+
description?: string | null;
|
|
886
|
+
quantity: number;
|
|
887
|
+
unit_price: number;
|
|
888
|
+
currency?: string | null;
|
|
889
|
+
recurring?: boolean | null;
|
|
890
|
+
}
|
|
891
|
+
type QuoteStatus = "draft" | "sent" | "signed" | "declined" | "expired" | "void";
|
|
892
|
+
interface QuoteSummary {
|
|
893
|
+
id: string;
|
|
894
|
+
name: string | null;
|
|
895
|
+
status: QuoteStatus;
|
|
896
|
+
total: number | null;
|
|
897
|
+
currency: string | null;
|
|
898
|
+
contact_id: number | null;
|
|
899
|
+
company_id: number | null;
|
|
900
|
+
expires_at: string | null;
|
|
901
|
+
created_at: string | null;
|
|
902
|
+
updated_at: string | null;
|
|
903
|
+
signing_url: string | null;
|
|
904
|
+
payment_link_url: string | null;
|
|
905
|
+
}
|
|
906
|
+
interface QuoteDetail extends QuoteSummary {
|
|
907
|
+
line_items: QuoteLineItem[];
|
|
908
|
+
notes: string | null;
|
|
909
|
+
recipient_email: string | null;
|
|
910
|
+
signed_at: string | null;
|
|
911
|
+
sent_at: string | null;
|
|
912
|
+
}
|
|
913
|
+
interface QuoteCreateParams {
|
|
914
|
+
contact_id?: number;
|
|
915
|
+
company_id?: number;
|
|
916
|
+
line_items: QuoteLineItem[];
|
|
917
|
+
currency?: string;
|
|
918
|
+
notes?: string;
|
|
919
|
+
/** ISO 8601 timestamp. */
|
|
920
|
+
expires_at?: string;
|
|
921
|
+
name?: string;
|
|
922
|
+
}
|
|
923
|
+
interface QuoteUpdateParams {
|
|
924
|
+
line_items?: QuoteLineItem[];
|
|
925
|
+
notes?: string;
|
|
926
|
+
expires_at?: string;
|
|
927
|
+
name?: string;
|
|
928
|
+
}
|
|
929
|
+
interface QuoteSendParams {
|
|
930
|
+
recipient_email: string;
|
|
931
|
+
/** Whether to attach the signing link. Defaults to true. */
|
|
932
|
+
send_signing_link?: boolean;
|
|
933
|
+
}
|
|
934
|
+
interface QuoteListParams {
|
|
935
|
+
status?: QuoteStatus;
|
|
936
|
+
contact_id?: number;
|
|
937
|
+
company_id?: number;
|
|
938
|
+
page?: number;
|
|
939
|
+
limit?: number;
|
|
940
|
+
}
|
|
941
|
+
interface QuotableProduct {
|
|
942
|
+
id: string;
|
|
943
|
+
name: string;
|
|
944
|
+
description: string | null;
|
|
945
|
+
unit_price: number;
|
|
946
|
+
currency: string;
|
|
947
|
+
recurring: boolean;
|
|
948
|
+
}
|
|
949
|
+
interface QuoteSettings {
|
|
950
|
+
default_currency: string;
|
|
951
|
+
default_tax_rate: number | null;
|
|
952
|
+
payment_providers: string[];
|
|
953
|
+
logo_url: string | null;
|
|
954
|
+
signature_required: boolean;
|
|
955
|
+
}
|
|
956
|
+
interface PaginationMeta$2 {
|
|
957
|
+
page: number;
|
|
958
|
+
limit: number;
|
|
959
|
+
total: number;
|
|
960
|
+
has_next: boolean;
|
|
961
|
+
}
|
|
962
|
+
/**
|
|
963
|
+
* Quotes API - quote-to-cash lifecycle. Requires API key (server-side).
|
|
964
|
+
*
|
|
965
|
+
* Backed by:
|
|
966
|
+
* GET /api/v1/quotes
|
|
967
|
+
* GET /api/v1/quotes/{id}
|
|
968
|
+
* POST /api/v1/quotes
|
|
969
|
+
* PUT /api/v1/quotes/{id}
|
|
970
|
+
* DELETE /api/v1/quotes/{id}
|
|
971
|
+
* POST /api/v1/quotes/{id}/duplicate
|
|
972
|
+
* POST /api/v1/quotes/{id}/edit-as-draft
|
|
973
|
+
* POST /api/v1/quotes/{id}/send
|
|
974
|
+
* GET /api/v1/quotable-products
|
|
975
|
+
* GET /api/v1/quote-settings
|
|
976
|
+
* GET /api/v1/contacts/{contact_id}/quotes
|
|
977
|
+
* GET /api/v1/companies/{company_id}/quotes
|
|
978
|
+
*/
|
|
979
|
+
declare const createQuotesClient: (apiKey: string, apiUrl?: string) => {
|
|
980
|
+
/** List quotes org-wide with optional filters and pagination. */
|
|
981
|
+
list(params?: QuoteListParams): Promise<{
|
|
982
|
+
data: QuoteSummary[];
|
|
983
|
+
pagination?: PaginationMeta$2;
|
|
984
|
+
}>;
|
|
985
|
+
/** Get full details for a single quote. */
|
|
986
|
+
get(quoteId: string): Promise<QuoteDetail>;
|
|
987
|
+
/** Create a new quote from line items. */
|
|
988
|
+
create(quote: QuoteCreateParams): Promise<QuoteDetail>;
|
|
989
|
+
/** Update a draft quote (line items, expiry, notes). */
|
|
990
|
+
update(quoteId: string, fields: QuoteUpdateParams): Promise<QuoteDetail>;
|
|
991
|
+
/** Delete a draft quote (irreversible). */
|
|
992
|
+
delete(quoteId: string): Promise<{
|
|
993
|
+
data: {
|
|
994
|
+
deleted: boolean;
|
|
995
|
+
};
|
|
996
|
+
}>;
|
|
997
|
+
/** Duplicate an existing quote (all line items copied into a new draft). */
|
|
998
|
+
duplicate(quoteId: string): Promise<QuoteDetail>;
|
|
999
|
+
/** Convert a signed / sent quote back to editable draft state. */
|
|
1000
|
+
editAsDraft(quoteId: string): Promise<{
|
|
1001
|
+
data: {
|
|
1002
|
+
id: string;
|
|
1003
|
+
status: string;
|
|
1004
|
+
};
|
|
1005
|
+
}>;
|
|
1006
|
+
/** Send a quote to its recipient via email (with signature + optional payment link). */
|
|
1007
|
+
send(quoteId: string, params: QuoteSendParams): Promise<QuoteDetail>;
|
|
1008
|
+
/** List products available for line items. */
|
|
1009
|
+
products(): Promise<{
|
|
1010
|
+
data: QuotableProduct[];
|
|
1011
|
+
}>;
|
|
1012
|
+
/** Get org-level quote settings (currency, tax rate, payment providers, logo). */
|
|
1013
|
+
settings(): Promise<QuoteSettings>;
|
|
1014
|
+
/** Get all quotes associated with a contact. */
|
|
1015
|
+
forContact(contactId: number): Promise<{
|
|
1016
|
+
data: QuoteSummary[];
|
|
1017
|
+
}>;
|
|
1018
|
+
/** Get all quotes associated with a company. */
|
|
1019
|
+
forCompany(companyId: number): Promise<{
|
|
1020
|
+
data: QuoteSummary[];
|
|
1021
|
+
}>;
|
|
1022
|
+
};
|
|
1023
|
+
|
|
3
1024
|
/**
|
|
4
1025
|
* Inbox channel — `email`, `sms`, or `linkedin` (HeyReach internally).
|
|
5
1026
|
* Defaults to `email` on routes that accept this as a query param.
|
|
@@ -1013,6 +2034,44 @@ declare const createVoiceClient: (apiKey: string, apiUrl?: string) => {
|
|
|
1013
2034
|
callGrading(roomName: string): Promise<CallGradingResult>;
|
|
1014
2035
|
/** List voice agents available for dialer sessions (capped at 100; no pagination). */
|
|
1015
2036
|
agents(params?: DialerAgentsListParams): Promise<DialerAgentsListResult>;
|
|
2037
|
+
/** Fetch the full transcript for a single dialer call. */
|
|
2038
|
+
callTranscript(roomName: string): Promise<{
|
|
2039
|
+
data: {
|
|
2040
|
+
status: string;
|
|
2041
|
+
transcript: Array<{
|
|
2042
|
+
speaker: string;
|
|
2043
|
+
text: string;
|
|
2044
|
+
timestamp: number;
|
|
2045
|
+
}>;
|
|
2046
|
+
};
|
|
2047
|
+
}>;
|
|
2048
|
+
/** List dialer calls — pass `contact_id` or `user_email` to scope. */
|
|
2049
|
+
listCalls(params?: {
|
|
2050
|
+
contact_id?: number;
|
|
2051
|
+
user_email?: string;
|
|
2052
|
+
campaign_id?: string;
|
|
2053
|
+
date_from?: string;
|
|
2054
|
+
date_to?: string;
|
|
2055
|
+
limit?: number;
|
|
2056
|
+
page?: number;
|
|
2057
|
+
}): Promise<{
|
|
2058
|
+
data: Array<Record<string, unknown>>;
|
|
2059
|
+
pagination?: VoicePagination;
|
|
2060
|
+
}>;
|
|
2061
|
+
/** Convenience: list calls for a single contact. */
|
|
2062
|
+
listCallsForContact(contactId: number, extra?: {
|
|
2063
|
+
limit?: number;
|
|
2064
|
+
}): Promise<{
|
|
2065
|
+
data: Array<Record<string, unknown>>;
|
|
2066
|
+
}>;
|
|
2067
|
+
/** Convenience: list calls placed by a specific SDR. */
|
|
2068
|
+
listCallsForSdr(userEmail: string, extra?: {
|
|
2069
|
+
limit?: number;
|
|
2070
|
+
date_from?: string;
|
|
2071
|
+
date_to?: string;
|
|
2072
|
+
}): Promise<{
|
|
2073
|
+
data: Array<Record<string, unknown>>;
|
|
2074
|
+
}>;
|
|
1016
2075
|
};
|
|
1017
2076
|
};
|
|
1018
2077
|
|
|
@@ -1616,6 +2675,13 @@ declare class G8 {
|
|
|
1616
2675
|
/** @internal */ _fields: ReturnType<typeof createFieldsClient> | null;
|
|
1617
2676
|
/** @internal */ _deals: ReturnType<typeof createDealsClient> | null;
|
|
1618
2677
|
/** @internal */ _inbox: ReturnType<typeof createInboxClient> | null;
|
|
2678
|
+
/** @internal */ _quotes: ReturnType<typeof createQuotesClient> | null;
|
|
2679
|
+
/** @internal */ _pipelines: ReturnType<typeof createPipelinesClient> | null;
|
|
2680
|
+
/** @internal */ _workflows: ReturnType<typeof createWorkflowsClient> | null;
|
|
2681
|
+
/** @internal */ _skills: ReturnType<typeof createSkillsClient> | null;
|
|
2682
|
+
/** @internal */ _intent: ReturnType<typeof createIntentClient> | null;
|
|
2683
|
+
/** @internal */ _studio: ReturnType<typeof createStudioClient> | null;
|
|
2684
|
+
/** @internal */ _meetings: ReturnType<typeof createMeetingsClient> | null;
|
|
1619
2685
|
/**
|
|
1620
2686
|
* Initialize the graph8 SDK. Must be called before any other method.
|
|
1621
2687
|
* Safe to call on the server (SSR) - becomes a no-op for tracking.
|
|
@@ -1676,7 +2742,19 @@ declare class G8 {
|
|
|
1676
2742
|
company_domain?: string;
|
|
1677
2743
|
}): Promise<PersonEnrichment>;
|
|
1678
2744
|
company(params: {
|
|
1679
|
-
domain
|
|
2745
|
+
domain
|
|
2746
|
+
/**
|
|
2747
|
+
* graph8 SDK client.
|
|
2748
|
+
*
|
|
2749
|
+
* Handles event tracking, identity, and progressive forms.
|
|
2750
|
+
*
|
|
2751
|
+
* Usage:
|
|
2752
|
+
* import { g8 } from '@graph8/js';
|
|
2753
|
+
* g8.init({ writeKey: 'your_write_key' });
|
|
2754
|
+
* g8.track('page_view', { page: '/pricing' });
|
|
2755
|
+
* g8.identify('user@acme.com', { name: 'John', company: 'Acme' });
|
|
2756
|
+
*/
|
|
2757
|
+
?: string;
|
|
1680
2758
|
name?: string;
|
|
1681
2759
|
}): Promise<CompanyEnrichment>;
|
|
1682
2760
|
verifyEmail(email: string): Promise<EmailVerification>;
|
|
@@ -1752,6 +2830,40 @@ declare class G8 {
|
|
|
1752
2830
|
missedCallbacks(limit?: number): Promise<MissedCallbacksResult>;
|
|
1753
2831
|
callGrading(roomName: string): Promise<CallGradingResult>;
|
|
1754
2832
|
agents(params?: DialerAgentsListParams): Promise<DialerAgentsListResult>;
|
|
2833
|
+
callTranscript(roomName: string): Promise<{
|
|
2834
|
+
data: {
|
|
2835
|
+
status: string;
|
|
2836
|
+
transcript: Array<{
|
|
2837
|
+
speaker: string;
|
|
2838
|
+
text: string;
|
|
2839
|
+
timestamp: number;
|
|
2840
|
+
}>;
|
|
2841
|
+
};
|
|
2842
|
+
}>;
|
|
2843
|
+
listCalls(params?: {
|
|
2844
|
+
contact_id?: number;
|
|
2845
|
+
user_email?: string;
|
|
2846
|
+
campaign_id?: string;
|
|
2847
|
+
date_from?: string;
|
|
2848
|
+
date_to?: string;
|
|
2849
|
+
limit?: number;
|
|
2850
|
+
page?: number;
|
|
2851
|
+
}): Promise<{
|
|
2852
|
+
data: Array<Record<string, unknown>>;
|
|
2853
|
+
pagination?: VoicePagination;
|
|
2854
|
+
}>;
|
|
2855
|
+
listCallsForContact(contactId: number, extra?: {
|
|
2856
|
+
limit?: number;
|
|
2857
|
+
}): Promise<{
|
|
2858
|
+
data: Array<Record<string, unknown>>;
|
|
2859
|
+
}>;
|
|
2860
|
+
listCallsForSdr(userEmail: string, extra?: {
|
|
2861
|
+
limit?: number;
|
|
2862
|
+
date_from?: string;
|
|
2863
|
+
date_to?: string;
|
|
2864
|
+
}): Promise<{
|
|
2865
|
+
data: Array<Record<string, unknown>>;
|
|
2866
|
+
}>;
|
|
1755
2867
|
};
|
|
1756
2868
|
};
|
|
1757
2869
|
/** Landing pages (requires API key). */
|
|
@@ -1920,6 +3032,358 @@ declare class G8 {
|
|
|
1920
3032
|
draft(replyId: string, channel?: InboxChannel): Promise<InboxDraft>;
|
|
1921
3033
|
send(replyId: string, payload: InboxSendParams): Promise<InboxSendResult>;
|
|
1922
3034
|
};
|
|
3035
|
+
/** Quote-to-cash: draft, send, sign, payment-link quotes (requires API key). */
|
|
3036
|
+
get quotes(): {
|
|
3037
|
+
list(params?: QuoteListParams): Promise<{
|
|
3038
|
+
data: QuoteSummary[];
|
|
3039
|
+
pagination?: PaginationMeta$2;
|
|
3040
|
+
}>;
|
|
3041
|
+
get(quoteId: string): Promise<QuoteDetail>;
|
|
3042
|
+
create(quote: QuoteCreateParams): Promise<QuoteDetail>;
|
|
3043
|
+
update(quoteId: string, fields: QuoteUpdateParams): Promise<QuoteDetail>;
|
|
3044
|
+
delete(quoteId: string): Promise<{
|
|
3045
|
+
data: {
|
|
3046
|
+
deleted: boolean;
|
|
3047
|
+
};
|
|
3048
|
+
}>;
|
|
3049
|
+
duplicate(quoteId: string): Promise<QuoteDetail>;
|
|
3050
|
+
editAsDraft(quoteId: string): Promise<{
|
|
3051
|
+
data: {
|
|
3052
|
+
id: string;
|
|
3053
|
+
status: string;
|
|
3054
|
+
};
|
|
3055
|
+
}>;
|
|
3056
|
+
send(quoteId: string, params: QuoteSendParams): Promise<QuoteDetail>;
|
|
3057
|
+
products(): Promise<{
|
|
3058
|
+
data: QuotableProduct[];
|
|
3059
|
+
}>;
|
|
3060
|
+
settings(): Promise<QuoteSettings>;
|
|
3061
|
+
forContact(contactId: number): Promise<{
|
|
3062
|
+
data: QuoteSummary[];
|
|
3063
|
+
}>;
|
|
3064
|
+
forCompany(companyId: number): Promise<{
|
|
3065
|
+
data: QuoteSummary[];
|
|
3066
|
+
}>;
|
|
3067
|
+
};
|
|
3068
|
+
/** Stage Checklist v2 pipelines: workflow stages with evidence + scripts (requires API key). */
|
|
3069
|
+
get pipelines(): {
|
|
3070
|
+
list(): Promise<{
|
|
3071
|
+
data: StagePipeline[];
|
|
3072
|
+
}>;
|
|
3073
|
+
get(pipelineId: string): Promise<StagePipeline>;
|
|
3074
|
+
evidenceLibrary(): Promise<{
|
|
3075
|
+
data: EvidenceKey[];
|
|
3076
|
+
}>;
|
|
3077
|
+
create(params: StagePipelineCreateParams): Promise<StagePipeline>;
|
|
3078
|
+
update(pipelineId: string, fields: StagePipelineUpdateParams): Promise<StagePipeline>;
|
|
3079
|
+
delete(pipelineId: string): Promise<{
|
|
3080
|
+
data: {
|
|
3081
|
+
deleted: boolean;
|
|
3082
|
+
};
|
|
3083
|
+
}>;
|
|
3084
|
+
createStage(pipelineId: string, stage: StageCreateParams): Promise<StagePipelineStage>;
|
|
3085
|
+
updateStage(pipelineId: string, stageId: string, fields: StageUpdateParams): Promise<StagePipelineStage>;
|
|
3086
|
+
reorderStages(pipelineId: string, stageIds: string[]): Promise<{
|
|
3087
|
+
data: StagePipelineStage[];
|
|
3088
|
+
}>;
|
|
3089
|
+
deleteStage(pipelineId: string, stageId: string): Promise<{
|
|
3090
|
+
data: {
|
|
3091
|
+
deleted: boolean;
|
|
3092
|
+
};
|
|
3093
|
+
}>;
|
|
3094
|
+
suggest(): Promise<{
|
|
3095
|
+
data: PipelineSuggestion;
|
|
3096
|
+
}>;
|
|
3097
|
+
fromSuggestion(suggestionId: string, overrides?: Partial<{
|
|
3098
|
+
name: string;
|
|
3099
|
+
target: string;
|
|
3100
|
+
}>): Promise<StagePipeline>;
|
|
3101
|
+
};
|
|
3102
|
+
/** Workflow builder — multi-node automation graphs with execution lifecycle (requires API key). */
|
|
3103
|
+
get workflows(): {
|
|
3104
|
+
list(params?: WorkflowListParams): Promise<{
|
|
3105
|
+
data: Workflow[];
|
|
3106
|
+
}>;
|
|
3107
|
+
get(workflowId: string): Promise<Workflow>;
|
|
3108
|
+
create(params: WorkflowCreateParams): Promise<Workflow>;
|
|
3109
|
+
update(workflowId: string, fields: WorkflowUpdateParams): Promise<Workflow>;
|
|
3110
|
+
delete(workflowId: string): Promise<{
|
|
3111
|
+
data: {
|
|
3112
|
+
deleted: boolean;
|
|
3113
|
+
};
|
|
3114
|
+
}>;
|
|
3115
|
+
validate(workflow: {
|
|
3116
|
+
config: WorkflowConfig;
|
|
3117
|
+
trigger_config?: Record<string, unknown>;
|
|
3118
|
+
}): Promise<{
|
|
3119
|
+
data: {
|
|
3120
|
+
valid: boolean;
|
|
3121
|
+
errors: Array<{
|
|
3122
|
+
node_id?: string;
|
|
3123
|
+
field?: string;
|
|
3124
|
+
message: string;
|
|
3125
|
+
}>;
|
|
3126
|
+
};
|
|
3127
|
+
}>;
|
|
3128
|
+
execute(workflowId: string, triggerPayload?: Record<string, unknown>): Promise<WorkflowExecution>;
|
|
3129
|
+
getExecution(executionId: string): Promise<WorkflowExecution>;
|
|
3130
|
+
pauseExecution(executionId: string): Promise<{
|
|
3131
|
+
data: {
|
|
3132
|
+
paused: boolean;
|
|
3133
|
+
};
|
|
3134
|
+
}>;
|
|
3135
|
+
resumeExecution(executionId: string): Promise<{
|
|
3136
|
+
data: {
|
|
3137
|
+
resumed: boolean;
|
|
3138
|
+
};
|
|
3139
|
+
}>;
|
|
3140
|
+
stopExecution(executionId: string): Promise<{
|
|
3141
|
+
data: {
|
|
3142
|
+
stopped: boolean;
|
|
3143
|
+
};
|
|
3144
|
+
}>;
|
|
3145
|
+
getTriggerStatus(workflowId: string): Promise<{
|
|
3146
|
+
data: {
|
|
3147
|
+
status: string;
|
|
3148
|
+
details: Record<string, unknown>;
|
|
3149
|
+
};
|
|
3150
|
+
}>;
|
|
3151
|
+
resetTrigger(workflowId: string): Promise<{
|
|
3152
|
+
data: {
|
|
3153
|
+
reset: boolean;
|
|
3154
|
+
};
|
|
3155
|
+
}>;
|
|
3156
|
+
nodeTypes(params?: {
|
|
3157
|
+
type?: string;
|
|
3158
|
+
}): Promise<{
|
|
3159
|
+
data: NodeTypeSchema[];
|
|
3160
|
+
}>;
|
|
3161
|
+
listSlackUsers(): Promise<{
|
|
3162
|
+
data: Array<{
|
|
3163
|
+
id: string;
|
|
3164
|
+
name: string;
|
|
3165
|
+
email: string | null;
|
|
3166
|
+
}>;
|
|
3167
|
+
}>;
|
|
3168
|
+
listSlackChannels(): Promise<{
|
|
3169
|
+
data: Array<{
|
|
3170
|
+
id: string;
|
|
3171
|
+
name: string;
|
|
3172
|
+
is_private: boolean;
|
|
3173
|
+
}>;
|
|
3174
|
+
}>;
|
|
3175
|
+
listRoamUsers(): Promise<{
|
|
3176
|
+
data: Array<{
|
|
3177
|
+
id: string;
|
|
3178
|
+
name: string;
|
|
3179
|
+
email: string | null;
|
|
3180
|
+
}>;
|
|
3181
|
+
}>;
|
|
3182
|
+
listRoamGroups(): Promise<{
|
|
3183
|
+
data: Array<{
|
|
3184
|
+
id: string;
|
|
3185
|
+
name: string;
|
|
3186
|
+
}>;
|
|
3187
|
+
}>;
|
|
3188
|
+
listMcpServers(): Promise<{
|
|
3189
|
+
data: Array<{
|
|
3190
|
+
id: string;
|
|
3191
|
+
name: string;
|
|
3192
|
+
url: string;
|
|
3193
|
+
}>;
|
|
3194
|
+
}>;
|
|
3195
|
+
listDispositions(): Promise<{
|
|
3196
|
+
data: Array<{
|
|
3197
|
+
id: string;
|
|
3198
|
+
label: string;
|
|
3199
|
+
}>;
|
|
3200
|
+
}>;
|
|
3201
|
+
listFormFields(formId: string): Promise<{
|
|
3202
|
+
data: Array<{
|
|
3203
|
+
name: string;
|
|
3204
|
+
type: string;
|
|
3205
|
+
required: boolean;
|
|
3206
|
+
}>;
|
|
3207
|
+
}>;
|
|
3208
|
+
};
|
|
3209
|
+
/** Skill authoring — LLM and API building blocks that workflows compose (requires API key). */
|
|
3210
|
+
get skills(): {
|
|
3211
|
+
list(params?: SkillListParams): Promise<{
|
|
3212
|
+
data: Skill[];
|
|
3213
|
+
}>;
|
|
3214
|
+
get(skillId: string): Promise<Skill>;
|
|
3215
|
+
getVariables(skillId: string): Promise<{
|
|
3216
|
+
data: SkillInputField[];
|
|
3217
|
+
}>;
|
|
3218
|
+
listModels(): Promise<{
|
|
3219
|
+
data: Array<{
|
|
3220
|
+
id: string;
|
|
3221
|
+
label: string;
|
|
3222
|
+
provider: string;
|
|
3223
|
+
}>;
|
|
3224
|
+
}>;
|
|
3225
|
+
listTemplates(params?: {
|
|
3226
|
+
type?: SkillType;
|
|
3227
|
+
}): Promise<{
|
|
3228
|
+
data: SkillTemplate[];
|
|
3229
|
+
}>;
|
|
3230
|
+
createLLM(params: SkillCreateLLMParams): Promise<Skill>;
|
|
3231
|
+
createAPI(params: SkillCreateAPIParams): Promise<Skill>;
|
|
3232
|
+
createFromTemplate(params: {
|
|
3233
|
+
title: string;
|
|
3234
|
+
template_id: string;
|
|
3235
|
+
overrides?: Record<string, unknown>;
|
|
3236
|
+
}): Promise<Skill>;
|
|
3237
|
+
createFromNode(params: {
|
|
3238
|
+
title: string;
|
|
3239
|
+
description?: string;
|
|
3240
|
+
node_id: string;
|
|
3241
|
+
input_mapping?: Record<string, string>;
|
|
3242
|
+
output_mapping?: Record<string, string>;
|
|
3243
|
+
}): Promise<Skill>;
|
|
3244
|
+
updateLLM(skillId: string, fields: SkillUpdateLLMParams): Promise<Skill>;
|
|
3245
|
+
updateAPI(skillId: string, fields: SkillUpdateAPIParams): Promise<Skill>;
|
|
3246
|
+
delete(skillId: string): Promise<{
|
|
3247
|
+
data: {
|
|
3248
|
+
deleted: boolean;
|
|
3249
|
+
};
|
|
3250
|
+
}>;
|
|
3251
|
+
validate(skill: Partial<Skill>): Promise<{
|
|
3252
|
+
data: {
|
|
3253
|
+
valid: boolean;
|
|
3254
|
+
errors: string[];
|
|
3255
|
+
};
|
|
3256
|
+
}>;
|
|
3257
|
+
execute(skillId: string, inputPayload: Record<string, unknown>): Promise<{
|
|
3258
|
+
data: {
|
|
3259
|
+
output: Record<string, unknown>;
|
|
3260
|
+
latency_ms: number;
|
|
3261
|
+
tokens?: number;
|
|
3262
|
+
error: string | null;
|
|
3263
|
+
};
|
|
3264
|
+
}>;
|
|
3265
|
+
};
|
|
3266
|
+
/** Intent tracking — keyword groups, page visitors, account-level intent (requires API key). */
|
|
3267
|
+
get intent(): {
|
|
3268
|
+
stats(): Promise<{
|
|
3269
|
+
data: IntentStats;
|
|
3270
|
+
}>;
|
|
3271
|
+
listKeywords(params?: {
|
|
3272
|
+
page?: number;
|
|
3273
|
+
limit?: number;
|
|
3274
|
+
search?: string;
|
|
3275
|
+
}): Promise<{
|
|
3276
|
+
data: IntentKeyword[];
|
|
3277
|
+
}>;
|
|
3278
|
+
createFromDomain(domain: string): Promise<{
|
|
3279
|
+
data: IntentKeyword;
|
|
3280
|
+
}>;
|
|
3281
|
+
deleteKeyword(keywordId: string): Promise<{
|
|
3282
|
+
data: {
|
|
3283
|
+
deleted: boolean;
|
|
3284
|
+
};
|
|
3285
|
+
}>;
|
|
3286
|
+
keywordCompanies(keywordId: string, params?: {
|
|
3287
|
+
limit?: number;
|
|
3288
|
+
date_from?: string;
|
|
3289
|
+
date_to?: string;
|
|
3290
|
+
}): Promise<{
|
|
3291
|
+
data: IntentCompany[];
|
|
3292
|
+
}>;
|
|
3293
|
+
keywordContacts(keywordId: string, params?: {
|
|
3294
|
+
limit?: number;
|
|
3295
|
+
date_from? /** @internal */: string;
|
|
3296
|
+
date_to?: string;
|
|
3297
|
+
}): Promise<{
|
|
3298
|
+
data: IntentContact[];
|
|
3299
|
+
}>;
|
|
3300
|
+
keywordUrls(keywordId: string, params?: {
|
|
3301
|
+
limit?: number;
|
|
3302
|
+
}): Promise<{
|
|
3303
|
+
data: IntentPage[];
|
|
3304
|
+
}>;
|
|
3305
|
+
pagesByDomain(domain: string, params?: {
|
|
3306
|
+
limit?: number;
|
|
3307
|
+
}): Promise<{
|
|
3308
|
+
data: IntentPage[];
|
|
3309
|
+
}>;
|
|
3310
|
+
searchPages(query: string, params?: {
|
|
3311
|
+
limit?: number;
|
|
3312
|
+
}): Promise<{
|
|
3313
|
+
data: IntentPage[];
|
|
3314
|
+
}>;
|
|
3315
|
+
pageVisitors(pageUrl: string, params?: {
|
|
3316
|
+
limit?: number;
|
|
3317
|
+
date_from?: string;
|
|
3318
|
+
date_to?: string;
|
|
3319
|
+
}): Promise<{
|
|
3320
|
+
data: IntentVisitor[];
|
|
3321
|
+
}>;
|
|
3322
|
+
pageContacts(pageUrl: string, params?: {
|
|
3323
|
+
limit?: number;
|
|
3324
|
+
}): Promise<{
|
|
3325
|
+
data: IntentContact[];
|
|
3326
|
+
}>;
|
|
3327
|
+
pageVisitorCounts(urls: string[]): Promise<{
|
|
3328
|
+
data: Array<{
|
|
3329
|
+
url: string;
|
|
3330
|
+
visitor_count: number;
|
|
3331
|
+
}>;
|
|
3332
|
+
}>;
|
|
3333
|
+
urlCompanies(url: string, params?: {
|
|
3334
|
+
limit?: number;
|
|
3335
|
+
date_from?: string;
|
|
3336
|
+
date_to?: string;
|
|
3337
|
+
}): Promise<{
|
|
3338
|
+
data: IntentCompany[];
|
|
3339
|
+
}>;
|
|
3340
|
+
};
|
|
3341
|
+
/** Studio context — ICPs, personas, brand briefs, intelligence, AI research reports (requires API key). */
|
|
3342
|
+
get studio(): {
|
|
3343
|
+
globalContext(params?: {
|
|
3344
|
+
category?: string;
|
|
3345
|
+
limit?: number;
|
|
3346
|
+
}): Promise<{
|
|
3347
|
+
data: GlobalContextDocument[];
|
|
3348
|
+
}>;
|
|
3349
|
+
icps(params?: {
|
|
3350
|
+
status?: string;
|
|
3351
|
+
limit?: number;
|
|
3352
|
+
}): Promise<{
|
|
3353
|
+
data: ICP[];
|
|
3354
|
+
}>;
|
|
3355
|
+
personas(params?: {
|
|
3356
|
+
status?: string;
|
|
3357
|
+
limit?: number;
|
|
3358
|
+
}): Promise<{
|
|
3359
|
+
data: Persona[];
|
|
3360
|
+
}>;
|
|
3361
|
+
intelligenceData(params?: {
|
|
3362
|
+
source_type?: string;
|
|
3363
|
+
limit?: number;
|
|
3364
|
+
}): Promise<{
|
|
3365
|
+
data: IntelligenceData[];
|
|
3366
|
+
}>;
|
|
3367
|
+
researchReports(params?: {
|
|
3368
|
+
category?: string;
|
|
3369
|
+
limit?: number;
|
|
3370
|
+
}): Promise<{
|
|
3371
|
+
data: ResearchReport[];
|
|
3372
|
+
}>;
|
|
3373
|
+
};
|
|
3374
|
+
/** Meetings — read scheduled, completed, cancelled meetings with transcripts + AI analysis (requires API key). */
|
|
3375
|
+
get meetings(): {
|
|
3376
|
+
list(params?: MeetingListParams): Promise<{
|
|
3377
|
+
data: MeetingSummary[];
|
|
3378
|
+
pagination?: {
|
|
3379
|
+
page: number;
|
|
3380
|
+
limit: number;
|
|
3381
|
+
total: number;
|
|
3382
|
+
has_next: boolean;
|
|
3383
|
+
};
|
|
3384
|
+
}>;
|
|
3385
|
+
get(meetingId: string): Promise<MeetingDetail>;
|
|
3386
|
+
};
|
|
1923
3387
|
/** Whether the SDK has been initialized. */
|
|
1924
3388
|
get initialized(): boolean;
|
|
1925
3389
|
/** @internal */
|
|
@@ -1930,4 +3394,4 @@ declare class G8 {
|
|
|
1930
3394
|
/** Singleton g8 client instance. */
|
|
1931
3395
|
declare const g8: G8;
|
|
1932
3396
|
|
|
1933
|
-
export { type AddToSequenceConfig, type AnalyticsOverview, type Booking, type BookingRequest, type CalendarConfig, type CallAnalysis, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignStats, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type CopilotConfig, type CreatedField, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type EmailVerification, type EnrichLookupResult, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, type G8PrivacyConfig, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type Integration, type IntentSignals, type LandingPage, type ListContact, type MissedCallback, type MissedCallbacksResult, type Note, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Pipeline, type PipelineStage, type SearchFilter, type SearchResults, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type VoiceSession, type WebhookEvent, g8 };
|
|
3397
|
+
export { type AddToSequenceConfig, type AnalyticsOverview, type Booking, type BookingRequest, type CalendarConfig, type CallAnalysis, type CallGradingResult, type Campaign, type CampaignCreateConfig, type CampaignStats, type ChatConfig, type Company, type CompanyColumn, type CompanyColumnCreateParams, type CompanyContact, type CompanyEnrichment, type CompanyListParams, type CompanyUpdateParams, type Contact, type ContactColumn, type ContactColumnCreateParams, type ContactCreateParams, type ContactDeal, type ContactList, type ContactListParams, type ContactUpdateParams, type CopilotConfig, type CreatedField, type Deal, type DealCreateParams, type DealListParams, type DealUpdateParams, type DialerAgentSummary, type DialerAgentsListParams, type DialerAgentsListResult, type DialerNumberInfo, type DialerNumbersListResult, type DialerReportFilters, type DialerReportMetric, type DialerSessionCreateParams, type DialerSessionCreateResult, type DialerSessionResumeResult, type DialerSessionStatus, type DialerSessionStatusUpdateResult, type DialerSessionSummary, type DialerSessionsListParams, type DialerSessionsListResult, type DialerStatsParams, type DialerStatsResult, type EmailVerification, type EnrichLookupResult, type EvidenceKey, type Field, type FieldCreateParams, type FieldDeleteParams, type G8Config, type G8PrivacyConfig, type GlobalContextDocument, type ICP, type IdentifyProperties, type InboxAssignResult, type InboxAssignee, type InboxChannel, type InboxContact, type InboxDraft, type InboxListParams, type InboxMessage, type InboxSendParams, type InboxSendResult, type InboxTag, type InboxTagResult, type InboxThread, type Integration, type IntelligenceData, type IntentCompany, type IntentContact, type IntentKeyword, type IntentPage, type IntentSignals, type IntentStats, type IntentVisitor, type LandingPage, type ListContact, type MeetingAnalysis, type MeetingAttendee, type MeetingDetail, type MeetingListParams, type MeetingSummary, type MeetingTranscriptLine, type MissedCallback, type MissedCallbacksResult, type NodeTypeSchema, type Note, type PaginationMeta$1 as PaginationMeta, type PersonEnrichment, type Persona, type Pipeline, type PipelineStage, type PipelineSuggestion, type QuotableProduct, type QuoteCreateParams, type QuoteDetail, type QuoteLineItem, type QuoteListParams, type QuoteSendParams, type QuoteSettings, type QuoteStatus, type QuoteSummary, type QuoteUpdateParams, type ResearchReport, type SearchFilter, type SearchResults, type Sequence, type SequenceActionResult, type SequenceAnalytics, type SequenceChannelConfig, type SequenceContactItem, type SequenceContactsParams, type SequenceCreateParams, type SequenceCreateResult, type SequenceDetail, type SequenceListItem, type SequenceListParams, type SequencePreview, type SequencePreviewChannel, type SequencePreviewStep, type SequenceStepConfig, type SequenceStepInputType, type SequenceStepType, type SequenceStepUpdateParams, type SequenceUpdateParams, type SetFieldValueParams, type Skill, type SkillCreateAPIParams, type SkillCreateLLMParams, type SkillInputField, type SkillListParams, type SkillTemplate, type SkillType, type SkillUpdateAPIParams, type SkillUpdateLLMParams, type StageCreateParams, type StagePipeline, type StagePipelineCreateParams, type StagePipelineStage, type StagePipelineUpdateParams, type StageUpdateParams, type Task, type TaskCreateParams, type TaskListParams, type TaskUpdateParams, type TimeSlot, type TrackProperties, type VisitorCompany, type VisitorScore, type VoicePagination, type VoiceSession, type WebhookEvent, type Workflow, type WorkflowConfig, type WorkflowConnection, type WorkflowCreateParams, type WorkflowExecution, type WorkflowListParams, type WorkflowNode, type WorkflowUpdateParams, g8 };
|