@graph8/sdk 0.294.1 → 0.295.2
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 +13 -3
- package/dist/index.d.ts +13 -3
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +13 -3
- package/dist/react.d.ts +13 -3
- package/dist/react.js +1 -1
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +1 -1
- package/dist/react.mjs.map +1 -1
- package/dist/types/version.d.ts +2 -2
- package/docs/api/dialerAnalytics.d.ts +8 -0
- package/docs/api/dialerAnalytics.md +6 -1
- package/docs/api/quotes.d.ts +4 -2
- package/docs/api/quotes.md +2 -1
- package/docs/api/scraping.d.ts +1 -1
- package/docs/api/scraping.md +1 -1
- package/package.json +1 -1
package/dist/types/version.d.ts
CHANGED
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
* both together (the version-parity gate already pins package.json, the
|
|
6
6
|
* lockfile and the CHANGELOG to each other).
|
|
7
7
|
*/
|
|
8
|
-
export declare const SDK_VERSION = "0.
|
|
8
|
+
export declare const SDK_VERSION = "0.295.2";
|
|
9
9
|
/** Value of the `X-G8-Client` header every SDK request carries (I-13). */
|
|
10
|
-
export declare const SDK_CLIENT_ID = "js-sdk/0.
|
|
10
|
+
export declare const SDK_CLIENT_ID = "js-sdk/0.295.2";
|
|
@@ -37,6 +37,8 @@ export interface DialerAnalyticsOperations {
|
|
|
37
37
|
start_date?: string | null;
|
|
38
38
|
/** End date (YYYY-MM-DD) */
|
|
39
39
|
end_date?: string | null;
|
|
40
|
+
/** Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. */
|
|
41
|
+
tz?: string | null;
|
|
40
42
|
};
|
|
41
43
|
headers?: {
|
|
42
44
|
"X-Org-Id"?: string | null;
|
|
@@ -58,6 +60,8 @@ export interface DialerAnalyticsOperations {
|
|
|
58
60
|
start_date?: string | null;
|
|
59
61
|
/** End date (YYYY-MM-DD). Defaults to today. */
|
|
60
62
|
end_date?: string | null;
|
|
63
|
+
/** Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. */
|
|
64
|
+
tz?: string | null;
|
|
61
65
|
};
|
|
62
66
|
headers?: {
|
|
63
67
|
"X-Org-Id"?: string | null;
|
|
@@ -81,6 +85,8 @@ export interface DialerAnalyticsOperations {
|
|
|
81
85
|
start_date?: string | null;
|
|
82
86
|
/** End date (YYYY-MM-DD) */
|
|
83
87
|
end_date?: string | null;
|
|
88
|
+
/** Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. */
|
|
89
|
+
tz?: string | null;
|
|
84
90
|
};
|
|
85
91
|
headers?: {
|
|
86
92
|
"X-Org-Id"?: string | null;
|
|
@@ -102,6 +108,8 @@ export interface DialerAnalyticsOperations {
|
|
|
102
108
|
start_date?: string | null;
|
|
103
109
|
/** End date (YYYY-MM-DD) */
|
|
104
110
|
end_date?: string | null;
|
|
111
|
+
/** Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. */
|
|
112
|
+
tz?: string | null;
|
|
105
113
|
};
|
|
106
114
|
headers?: {
|
|
107
115
|
"X-Org-Id"?: string | null;
|
|
@@ -54,6 +54,7 @@ If neither is provided, defaults to today.
|
|
|
54
54
|
| `query.period` | `"today" \| "week" \| "month" \| null` | no | Time period preset (fallback if no dates) |
|
|
55
55
|
| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
|
|
56
56
|
| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
|
|
57
|
+
| `query.tz` | `string \| null` | no | Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. |
|
|
57
58
|
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
58
59
|
|
|
59
60
|
**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
@@ -86,7 +87,8 @@ yesterday (for trends), daily breakdown, disposition distribution,
|
|
|
86
87
|
personal bests, and current streak.
|
|
87
88
|
|
|
88
89
|
Pass `sdr_email` to view another SDR's performance (e.g. as a manager).
|
|
89
|
-
Pass `start_date`/`end_date` for a custom date range
|
|
90
|
+
Pass `start_date`/`end_date` for a custom date range; personal bests and
|
|
91
|
+
the streak are then measured within that range too.
|
|
90
92
|
|
|
91
93
|
**Input**
|
|
92
94
|
|
|
@@ -95,6 +97,7 @@ Pass `start_date`/`end_date` for a custom date range.
|
|
|
95
97
|
| `query.sdr_email` | `string \| null` | no | SDR email to view. Defaults to current user. |
|
|
96
98
|
| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD). Defaults to today. |
|
|
97
99
|
| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD). Defaults to today. |
|
|
100
|
+
| `query.tz` | `string \| null` | no | Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. |
|
|
98
101
|
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
99
102
|
|
|
100
103
|
**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
@@ -133,6 +136,7 @@ handling, value delivery, closing technique) and a daily quality trend.
|
|
|
133
136
|
| `query.days` | `integer` | no | Rolling window in days default `30` |
|
|
134
137
|
| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
|
|
135
138
|
| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
|
|
139
|
+
| `query.tz` | `string \| null` | no | Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. |
|
|
136
140
|
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
137
141
|
|
|
138
142
|
**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
@@ -170,6 +174,7 @@ Used for the leaderboard quality column.
|
|
|
170
174
|
| `query.days` | `integer` | no | Rolling window in days default `30` |
|
|
171
175
|
| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
|
|
172
176
|
| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
|
|
177
|
+
| `query.tz` | `string \| null` | no | Viewer's IANA timezone (e.g. Asia/Karachi). start_date/end_date and the daily buckets are read as calendar days in it. Omit for UTC days. |
|
|
173
178
|
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
174
179
|
|
|
175
180
|
**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
package/docs/api/quotes.d.ts
CHANGED
|
@@ -1251,7 +1251,9 @@ export interface QuoteContactCreateRequest {
|
|
|
1251
1251
|
*
|
|
1252
1252
|
* Mirrors ``CreateQuoteDTO``. At least one of ``signer_contact_id`` or
|
|
1253
1253
|
* ``signer_email`` is required. ``line_items`` must be non-empty —
|
|
1254
|
-
* zero-line quotes can't be invoiced.
|
|
1254
|
+
* zero-line quotes can't be invoiced. ``deal_id`` is required: every new
|
|
1255
|
+
* quote must be linked to an existing deal (422 otherwise); the company
|
|
1256
|
+
* defaults to the deal's company when omitted.
|
|
1255
1257
|
*/
|
|
1256
1258
|
export interface QuoteCreateRequest {
|
|
1257
1259
|
accepted_payment_methods?: (Array<"ach" | "credit_card" | "wire">) | null;
|
|
@@ -1266,7 +1268,7 @@ export interface QuoteCreateRequest {
|
|
|
1266
1268
|
contract_months?: number | null;
|
|
1267
1269
|
contract_start_date?: string | null;
|
|
1268
1270
|
currency?: string;
|
|
1269
|
-
deal_id
|
|
1271
|
+
deal_id: string;
|
|
1270
1272
|
line_items: Array<QuoteLineItemRequest>;
|
|
1271
1273
|
marketing_rights?: (Array<"logo" | "quote" | "case_study">) | null;
|
|
1272
1274
|
mashup_company_id?: number | null;
|
package/docs/api/quotes.md
CHANGED
|
@@ -354,6 +354,7 @@ Body fields (`QuoteCreateRequest`):
|
|
|
354
354
|
|
|
355
355
|
| Field | Type | Required | Description |
|
|
356
356
|
|---|---|---|---|
|
|
357
|
+
| `body.deal_id` | `string` | yes | |
|
|
357
358
|
| `body.line_items` | `Array<QuoteLineItemRequest>` | yes | min items 1 |
|
|
358
359
|
| `body.title` | `string` | yes | min length 1, max length 500 |
|
|
359
360
|
| `body.accepted_payment_methods` | `Array<"ach" \| "credit_card" \| "wire"> \| null` | no | |
|
|
@@ -368,7 +369,6 @@ Body fields (`QuoteCreateRequest`):
|
|
|
368
369
|
| `body.contract_months` | `number \| null` | no | min 0.1, max 120 |
|
|
369
370
|
| `body.contract_start_date` | `string \| null` | no | |
|
|
370
371
|
| `body.currency` | `string` | no | default `"USD"`, min length 3, max length 3 |
|
|
371
|
-
| `body.deal_id` | `string \| null` | no | |
|
|
372
372
|
| `body.marketing_rights` | `Array<"logo" \| "quote" \| "case_study"> \| null` | no | |
|
|
373
373
|
| `body.mashup_company_id` | `integer \| null` | no | |
|
|
374
374
|
| `body.notes` | `string \| null` | no | max length 10000 |
|
|
@@ -406,6 +406,7 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
406
406
|
// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
|
|
407
407
|
const result = await g8.api.quotes.createQuote({
|
|
408
408
|
body: {
|
|
409
|
+
deal_id: "id",
|
|
409
410
|
line_items: [{ product_name: "Example", unit_amount: 0 }],
|
|
410
411
|
title: "Example",
|
|
411
412
|
},
|
package/docs/api/scraping.d.ts
CHANGED
|
@@ -261,7 +261,7 @@ export interface SubmitScrapeRequest {
|
|
|
261
261
|
requirement: string;
|
|
262
262
|
/** Re-run rows that already have a result. */
|
|
263
263
|
rescrape?: boolean;
|
|
264
|
-
/** Limit the run to these rows. */
|
|
264
|
+
/** Limit the run to these rows. Omit it to run every row; an empty list is rejected. */
|
|
265
265
|
row_ids?: Array<number> | null;
|
|
266
266
|
/** Cold start: add these as rows in `source_column` before scraping. */
|
|
267
267
|
seed_targets?: Array<string> | null;
|
package/docs/api/scraping.md
CHANGED
|
@@ -327,7 +327,7 @@ Body fields (`SubmitScrapeRequest`):
|
|
|
327
327
|
| `body.params` | `Record<string, unknown>` | no | |
|
|
328
328
|
| `body.preview` | `boolean` | no | Hold the run behind a 5-row preview. Leave it on for a first run. default `true` |
|
|
329
329
|
| `body.rescrape` | `boolean` | no | Re-run rows that already have a result. default `false` |
|
|
330
|
-
| `body.row_ids` | `Array<integer> \| null` | no | Limit the run to these rows. |
|
|
330
|
+
| `body.row_ids` | `Array<integer> \| null` | no | Limit the run to these rows. Omit it to run every row; an empty list is rejected. |
|
|
331
331
|
| `body.seed_targets` | `Array<string> \| null` | no | Cold start: add these as rows in `source_column` before scraping. |
|
|
332
332
|
| `body.source_column` | `string \| null` | no | Column holding the values to scrape from. |
|
|
333
333
|
| `body.staging_table_id` | `string \| null` | no | Staging table to read from and write into. |
|
package/package.json
CHANGED