@graph8/sdk 0.294.0 → 0.295.1
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 +5 -6
- package/dist/index.d.ts +5 -6
- 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 +5 -6
- package/dist/react.d.ts +5 -6
- 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/appointments.md +3 -3
- package/docs/api/quotes.d.ts +4 -5
- package/docs/api/quotes.md +5 -4
- 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.1";
|
|
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.1";
|
package/docs/api/appointments.md
CHANGED
|
@@ -598,7 +598,7 @@ Body fields (`CreateEventTypeRequest`):
|
|
|
598
598
|
|
|
599
599
|
| Field | Type | Required | Description |
|
|
600
600
|
|---|---|---|---|
|
|
601
|
-
| `body.length` | `integer` | yes |
|
|
601
|
+
| `body.length` | `integer` | yes | min 5, max 525600 |
|
|
602
602
|
| `body.slug` | `string` | yes | |
|
|
603
603
|
| `body.title` | `string` | yes | |
|
|
604
604
|
| `body.after_event_buffer` | `integer` | no | default `0` |
|
|
@@ -636,7 +636,7 @@ Body fields (`CreateEventTypeRequest`):
|
|
|
636
636
|
**Example**
|
|
637
637
|
|
|
638
638
|
```ts
|
|
639
|
-
const result = await g8.api.appointments.createEventType({ body: { length:
|
|
639
|
+
const result = await g8.api.appointments.createEventType({ body: { length: 5, slug: "example", title: "Example" } });
|
|
640
640
|
```
|
|
641
641
|
|
|
642
642
|
---
|
|
@@ -3335,7 +3335,7 @@ Body fields (`UpdateEventTypeRequest`):
|
|
|
3335
3335
|
| `body.event_name` | `string \| null` | no | |
|
|
3336
3336
|
| `body.hidden` | `boolean \| null` | no | |
|
|
3337
3337
|
| `body.layouts` | `Array<string> \| null` | no | |
|
|
3338
|
-
| `body.length` | `integer \| null` | no |
|
|
3338
|
+
| `body.length` | `integer \| null` | no | min 5, max 525600 |
|
|
3339
3339
|
| `body.locations` | `Array<Record<string, unknown>> \| null` | no | |
|
|
3340
3340
|
| `body.metadata` | `Record<string, unknown> \| null` | no | |
|
|
3341
3341
|
| `body.minimum_booking_notice` | `integer \| null` | no | |
|
package/docs/api/quotes.d.ts
CHANGED
|
@@ -379,7 +379,6 @@ export interface QuotesOperations {
|
|
|
379
379
|
get_company_revenue_summary_stripe_companies__company_id__revenue_summary_get: {
|
|
380
380
|
input: {
|
|
381
381
|
path: {
|
|
382
|
-
/** graph8 company id. */
|
|
383
382
|
company_id: number;
|
|
384
383
|
};
|
|
385
384
|
headers?: {
|
|
@@ -396,7 +395,6 @@ export interface QuotesOperations {
|
|
|
396
395
|
get_company_stripe_invoices_stripe_companies__company_id__invoices_get: {
|
|
397
396
|
input: {
|
|
398
397
|
path: {
|
|
399
|
-
/** graph8 company id. */
|
|
400
398
|
company_id: number;
|
|
401
399
|
};
|
|
402
400
|
query?: {
|
|
@@ -418,7 +416,6 @@ export interface QuotesOperations {
|
|
|
418
416
|
get_company_stripe_subscriptions_stripe_companies__company_id__subscriptions_get: {
|
|
419
417
|
input: {
|
|
420
418
|
path: {
|
|
421
|
-
/** graph8 company id. */
|
|
422
419
|
company_id: number;
|
|
423
420
|
};
|
|
424
421
|
headers?: {
|
|
@@ -1254,7 +1251,9 @@ export interface QuoteContactCreateRequest {
|
|
|
1254
1251
|
*
|
|
1255
1252
|
* Mirrors ``CreateQuoteDTO``. At least one of ``signer_contact_id`` or
|
|
1256
1253
|
* ``signer_email`` is required. ``line_items`` must be non-empty —
|
|
1257
|
-
* 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.
|
|
1258
1257
|
*/
|
|
1259
1258
|
export interface QuoteCreateRequest {
|
|
1260
1259
|
accepted_payment_methods?: (Array<"ach" | "credit_card" | "wire">) | null;
|
|
@@ -1269,7 +1268,7 @@ export interface QuoteCreateRequest {
|
|
|
1269
1268
|
contract_months?: number | null;
|
|
1270
1269
|
contract_start_date?: string | null;
|
|
1271
1270
|
currency?: string;
|
|
1272
|
-
deal_id
|
|
1271
|
+
deal_id: string;
|
|
1273
1272
|
line_items: Array<QuoteLineItemRequest>;
|
|
1274
1273
|
marketing_rights?: (Array<"logo" | "quote" | "case_study">) | null;
|
|
1275
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
|
},
|
|
@@ -898,7 +899,7 @@ Total paid, MRR, invoice count and customer-since date for one company.
|
|
|
898
899
|
|
|
899
900
|
| Field | Type | Required | Description |
|
|
900
901
|
|---|---|---|---|
|
|
901
|
-
| `path.company_id` | `integer` | yes |
|
|
902
|
+
| `path.company_id` | `integer` | yes | |
|
|
902
903
|
|
|
903
904
|
**Returns** `ApiResponse_BillingPayload_`: the envelope `{ data: BillingPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
904
905
|
|
|
@@ -929,7 +930,7 @@ A company's Stripe invoice history, newest first.
|
|
|
929
930
|
|
|
930
931
|
| Field | Type | Required | Description |
|
|
931
932
|
|---|---|---|---|
|
|
932
|
-
| `path.company_id` | `integer` | yes |
|
|
933
|
+
| `path.company_id` | `integer` | yes | |
|
|
933
934
|
| `query.page` | `integer` | no | 1-based page. default `1` |
|
|
934
935
|
| `query.limit` | `integer` | no | default `50` |
|
|
935
936
|
|
|
@@ -968,7 +969,7 @@ A company's current Stripe subscriptions, through its customer mapping.
|
|
|
968
969
|
|
|
969
970
|
| Field | Type | Required | Description |
|
|
970
971
|
|---|---|---|---|
|
|
971
|
-
| `path.company_id` | `integer` | yes |
|
|
972
|
+
| `path.company_id` | `integer` | yes | |
|
|
972
973
|
|
|
973
974
|
**Returns** `ApiResponse_BillingListPayload_`: the envelope `{ data: BillingListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
974
975
|
|
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