@graph8/sdk 0.5.1 → 0.5.3
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 +31 -2
- package/dist/index.d.ts +31 -2
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -1
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +30 -1
- package/dist/react.d.ts +30 -1
- package/dist/react.js +3 -1
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +3 -1
- package/dist/react.mjs.map +1 -1
- package/package.json +1 -1
package/dist/react.d.mts
CHANGED
|
@@ -135,10 +135,13 @@ interface ResearchReport {
|
|
|
135
135
|
* GET /api/v1/research-reports
|
|
136
136
|
*/
|
|
137
137
|
declare const createStudioClient: (apiKey: string, apiUrl?: string) => {
|
|
138
|
-
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
|
|
138
|
+
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
|
|
139
|
+
* `include_content` defaults to true server-side, so each document includes
|
|
140
|
+
* its `content` body unless you explicitly pass `include_content: false`. */
|
|
139
141
|
globalContext(params?: {
|
|
140
142
|
category?: string;
|
|
141
143
|
limit?: number;
|
|
144
|
+
include_content?: boolean;
|
|
142
145
|
}): Promise<{
|
|
143
146
|
data: GlobalContextDocument[];
|
|
144
147
|
}>;
|
|
@@ -2213,6 +2216,8 @@ interface SequenceListParams {
|
|
|
2213
2216
|
limit?: number;
|
|
2214
2217
|
/** Filter by sequence status (e.g. "live", "draft", "paused"). */
|
|
2215
2218
|
status?: string;
|
|
2219
|
+
/** Filter by sequence kind ("cold_outbound" or "nurture"). Omit to list all kinds. */
|
|
2220
|
+
sequence_kind?: SequenceKind;
|
|
2216
2221
|
}
|
|
2217
2222
|
interface SequenceDetail {
|
|
2218
2223
|
id: string;
|
|
@@ -2226,6 +2231,10 @@ interface SequenceDetail {
|
|
|
2226
2231
|
wait_for_new_contacts: boolean;
|
|
2227
2232
|
paused_at: string | null;
|
|
2228
2233
|
resumed_at: string | null;
|
|
2234
|
+
/** Sequence kind. Immutable after creation. "cold_outbound" (default) or "nurture". */
|
|
2235
|
+
sequence_kind?: string | null;
|
|
2236
|
+
/** Pinned mailbox for nurture sequences; null for cold_outbound. Immutable. */
|
|
2237
|
+
pinned_mailbox_id?: number | null;
|
|
2229
2238
|
created_at: string | null;
|
|
2230
2239
|
updated_at: string | null;
|
|
2231
2240
|
}
|
|
@@ -2270,6 +2279,13 @@ interface SequenceChannelConfig {
|
|
|
2270
2279
|
channel_type: string;
|
|
2271
2280
|
channel_data?: Record<string, unknown>;
|
|
2272
2281
|
}
|
|
2282
|
+
/**
|
|
2283
|
+
* Sequence kind. A "nurture" is an ordinary sequence with `sequence_kind:
|
|
2284
|
+
* "nurture"` — same step types as cold outreach, but pinned to a single mailbox
|
|
2285
|
+
* with a higher daily email cap. There is no separate nurture client; create one
|
|
2286
|
+
* via `sequences.create({ sequence_kind: "nurture", pinned_mailbox_id })`.
|
|
2287
|
+
*/
|
|
2288
|
+
type SequenceKind = "cold_outbound" | "nurture";
|
|
2273
2289
|
interface SequenceCreateParams {
|
|
2274
2290
|
name: string;
|
|
2275
2291
|
user_email: string;
|
|
@@ -2281,6 +2297,18 @@ interface SequenceCreateParams {
|
|
|
2281
2297
|
steps?: SequenceStepConfig[];
|
|
2282
2298
|
channels?: SequenceChannelConfig[];
|
|
2283
2299
|
campaign_id?: string;
|
|
2300
|
+
/**
|
|
2301
|
+
* Sequence kind. Defaults to "cold_outbound" server-side. Immutable after
|
|
2302
|
+
* creation. "nurture" requires `pinned_mailbox_id` and is gated by the
|
|
2303
|
+
* ENABLE_NURTURE feature flag.
|
|
2304
|
+
*/
|
|
2305
|
+
sequence_kind?: SequenceKind;
|
|
2306
|
+
/**
|
|
2307
|
+
* Mailbox to pin for a nurture sequence. Required when
|
|
2308
|
+
* `sequence_kind: "nurture"`; all email channels must use this mailbox.
|
|
2309
|
+
* Ignored for cold_outbound sequences.
|
|
2310
|
+
*/
|
|
2311
|
+
pinned_mailbox_id?: number;
|
|
2284
2312
|
}
|
|
2285
2313
|
interface SequenceCreateResult {
|
|
2286
2314
|
id: string;
|
|
@@ -3346,6 +3374,7 @@ declare const useG8: () => {
|
|
|
3346
3374
|
globalContext(params?: {
|
|
3347
3375
|
category?: string;
|
|
3348
3376
|
limit?: number;
|
|
3377
|
+
include_content?: boolean;
|
|
3349
3378
|
}): Promise<{
|
|
3350
3379
|
data: GlobalContextDocument[];
|
|
3351
3380
|
}>;
|
package/dist/react.d.ts
CHANGED
|
@@ -135,10 +135,13 @@ interface ResearchReport {
|
|
|
135
135
|
* GET /api/v1/research-reports
|
|
136
136
|
*/
|
|
137
137
|
declare const createStudioClient: (apiKey: string, apiUrl?: string) => {
|
|
138
|
-
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
|
|
138
|
+
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
|
|
139
|
+
* `include_content` defaults to true server-side, so each document includes
|
|
140
|
+
* its `content` body unless you explicitly pass `include_content: false`. */
|
|
139
141
|
globalContext(params?: {
|
|
140
142
|
category?: string;
|
|
141
143
|
limit?: number;
|
|
144
|
+
include_content?: boolean;
|
|
142
145
|
}): Promise<{
|
|
143
146
|
data: GlobalContextDocument[];
|
|
144
147
|
}>;
|
|
@@ -2213,6 +2216,8 @@ interface SequenceListParams {
|
|
|
2213
2216
|
limit?: number;
|
|
2214
2217
|
/** Filter by sequence status (e.g. "live", "draft", "paused"). */
|
|
2215
2218
|
status?: string;
|
|
2219
|
+
/** Filter by sequence kind ("cold_outbound" or "nurture"). Omit to list all kinds. */
|
|
2220
|
+
sequence_kind?: SequenceKind;
|
|
2216
2221
|
}
|
|
2217
2222
|
interface SequenceDetail {
|
|
2218
2223
|
id: string;
|
|
@@ -2226,6 +2231,10 @@ interface SequenceDetail {
|
|
|
2226
2231
|
wait_for_new_contacts: boolean;
|
|
2227
2232
|
paused_at: string | null;
|
|
2228
2233
|
resumed_at: string | null;
|
|
2234
|
+
/** Sequence kind. Immutable after creation. "cold_outbound" (default) or "nurture". */
|
|
2235
|
+
sequence_kind?: string | null;
|
|
2236
|
+
/** Pinned mailbox for nurture sequences; null for cold_outbound. Immutable. */
|
|
2237
|
+
pinned_mailbox_id?: number | null;
|
|
2229
2238
|
created_at: string | null;
|
|
2230
2239
|
updated_at: string | null;
|
|
2231
2240
|
}
|
|
@@ -2270,6 +2279,13 @@ interface SequenceChannelConfig {
|
|
|
2270
2279
|
channel_type: string;
|
|
2271
2280
|
channel_data?: Record<string, unknown>;
|
|
2272
2281
|
}
|
|
2282
|
+
/**
|
|
2283
|
+
* Sequence kind. A "nurture" is an ordinary sequence with `sequence_kind:
|
|
2284
|
+
* "nurture"` — same step types as cold outreach, but pinned to a single mailbox
|
|
2285
|
+
* with a higher daily email cap. There is no separate nurture client; create one
|
|
2286
|
+
* via `sequences.create({ sequence_kind: "nurture", pinned_mailbox_id })`.
|
|
2287
|
+
*/
|
|
2288
|
+
type SequenceKind = "cold_outbound" | "nurture";
|
|
2273
2289
|
interface SequenceCreateParams {
|
|
2274
2290
|
name: string;
|
|
2275
2291
|
user_email: string;
|
|
@@ -2281,6 +2297,18 @@ interface SequenceCreateParams {
|
|
|
2281
2297
|
steps?: SequenceStepConfig[];
|
|
2282
2298
|
channels?: SequenceChannelConfig[];
|
|
2283
2299
|
campaign_id?: string;
|
|
2300
|
+
/**
|
|
2301
|
+
* Sequence kind. Defaults to "cold_outbound" server-side. Immutable after
|
|
2302
|
+
* creation. "nurture" requires `pinned_mailbox_id` and is gated by the
|
|
2303
|
+
* ENABLE_NURTURE feature flag.
|
|
2304
|
+
*/
|
|
2305
|
+
sequence_kind?: SequenceKind;
|
|
2306
|
+
/**
|
|
2307
|
+
* Mailbox to pin for a nurture sequence. Required when
|
|
2308
|
+
* `sequence_kind: "nurture"`; all email channels must use this mailbox.
|
|
2309
|
+
* Ignored for cold_outbound sequences.
|
|
2310
|
+
*/
|
|
2311
|
+
pinned_mailbox_id?: number;
|
|
2284
2312
|
}
|
|
2285
2313
|
interface SequenceCreateResult {
|
|
2286
2314
|
id: string;
|
|
@@ -3346,6 +3374,7 @@ declare const useG8: () => {
|
|
|
3346
3374
|
globalContext(params?: {
|
|
3347
3375
|
category?: string;
|
|
3348
3376
|
limit?: number;
|
|
3377
|
+
include_content?: boolean;
|
|
3349
3378
|
}): Promise<{
|
|
3350
3379
|
data: GlobalContextDocument[];
|
|
3351
3380
|
}>;
|
package/dist/react.js
CHANGED
|
@@ -1994,7 +1994,9 @@ var createStudioClient = (apiKey, apiUrl) => {
|
|
|
1994
1994
|
return resp.json();
|
|
1995
1995
|
};
|
|
1996
1996
|
return {
|
|
1997
|
-
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
|
|
1997
|
+
/** Org-level Studio documents (brand_brief, value_props, messaging_house, etc.).
|
|
1998
|
+
* `include_content` defaults to true server-side, so each document includes
|
|
1999
|
+
* its `content` body unless you explicitly pass `include_content: false`. */
|
|
1998
2000
|
async globalContext(params = {}) {
|
|
1999
2001
|
return get("/global-context/documents", params);
|
|
2000
2002
|
},
|