@graph8/sdk 0.265.0 → 0.277.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/README.md +3 -3
- package/dist/index.d.mts +137 -21
- package/dist/index.d.ts +137 -21
- package/dist/index.js +13 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +13 -5
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +136 -19
- package/dist/react.d.ts +136 -19
- package/dist/react.js +12 -4
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +12 -4
- package/dist/react.mjs.map +1 -1
- package/dist/types/core.d.ts +2 -0
- package/dist/types/enrich.d.ts +11 -4
- package/dist/types/index.d.ts +1 -1
- package/dist/types/react.d.ts +6 -2
- package/dist/types/search.d.ts +25 -1
- package/dist/types/version.d.ts +2 -2
- package/docs/agents.md +7 -6
- package/docs/api/README.md +2 -2
- package/docs/api/accounts.d.ts +6 -0
- package/docs/api/adCampaigns.d.ts +6 -0
- package/docs/api/adCreatives.d.ts +6 -0
- package/docs/api/agency.d.ts +6 -0
- package/docs/api/agent.d.ts +6 -0
- package/docs/api/agents.d.ts +6 -0
- package/docs/api/aiInbox.d.ts +6 -0
- package/docs/api/analytics.d.ts +6 -0
- package/docs/api/apiKeys.d.ts +6 -0
- package/docs/api/appDeployments.d.ts +6 -0
- package/docs/api/appDomains.d.ts +6 -0
- package/docs/api/appLogs.d.ts +6 -0
- package/docs/api/appObjects.d.ts +6 -0
- package/docs/api/appPages.d.ts +6 -0
- package/docs/api/appPlatformTokens.d.ts +6 -0
- package/docs/api/appointments.d.ts +20 -2
- package/docs/api/appointments.md +27 -11
- package/docs/api/apps.d.ts +6 -0
- package/docs/api/apps.md +7 -5
- package/docs/api/assertUpsert.d.ts +12 -0
- package/docs/api/assertUpsert.md +4 -0
- package/docs/api/audienceSyncs.d.ts +6 -0
- package/docs/api/brandKit.d.ts +6 -0
- package/docs/api/bugReports.d.ts +6 -0
- package/docs/api/by-path.md +1 -0
- package/docs/api/calendarInvites.d.ts +6 -0
- package/docs/api/campaignWorkflows.d.ts +6 -0
- package/docs/api/campaigns.d.ts +6 -0
- package/docs/api/channels.d.ts +6 -0
- package/docs/api/cliCampaigns.d.ts +6 -0
- package/docs/api/cliPipelines.d.ts +6 -0
- package/docs/api/clickHouse.d.ts +6 -0
- package/docs/api/companies.d.ts +10 -2
- package/docs/api/companies.md +9 -2
- package/docs/api/companyIntelligence.d.ts +6 -0
- package/docs/api/contacts.d.ts +19 -4
- package/docs/api/contacts.md +13 -5
- package/docs/api/content.d.ts +6 -0
- package/docs/api/contentGridSkills.d.ts +6 -0
- package/docs/api/copilot.d.ts +6 -0
- package/docs/api/crmSyncs.d.ts +6 -0
- package/docs/api/customerSuccess.d.ts +6 -0
- package/docs/api/deals.d.ts +6 -0
- package/docs/api/deliverability.d.ts +6 -0
- package/docs/api/desk.d.ts +6 -0
- package/docs/api/dialer.d.ts +6 -0
- package/docs/api/documents.d.ts +6 -0
- package/docs/api/duplicates.d.ts +6 -0
- package/docs/api/eSignature.d.ts +6 -0
- package/docs/api/enrichment.d.ts +6 -0
- package/docs/api/events.d.ts +6 -0
- package/docs/api/fields.d.ts +6 -0
- package/docs/api/forms.d.ts +6 -0
- package/docs/api/gtmCampaigns.d.ts +6 -0
- package/docs/api/gtmContext.d.ts +6 -0
- package/docs/api/gtmDeliverability.d.ts +6 -0
- package/docs/api/gtmKnowledgeBase.d.ts +6 -0
- package/docs/api/gtmLibrary.d.ts +6 -0
- package/docs/api/imageLibrary.d.ts +6 -0
- package/docs/api/imports.d.ts +6 -0
- package/docs/api/inbox.d.ts +6 -0
- package/docs/api/install.d.ts +6 -0
- package/docs/api/installedApps.d.ts +6 -0
- package/docs/api/integrationStatus.d.ts +6 -0
- package/docs/api/integrations.d.ts +6 -0
- package/docs/api/intent.d.ts +6 -0
- package/docs/api/knowledge.d.ts +6 -0
- package/docs/api/knowledgeBase.d.ts +6 -0
- package/docs/api/landingPages.d.ts +6 -0
- package/docs/api/leads.d.ts +6 -0
- package/docs/api/library.d.ts +6 -0
- package/docs/api/linkedIn.d.ts +6 -0
- package/docs/api/linkedInOutreach.d.ts +6 -0
- package/docs/api/lists.d.ts +13 -0
- package/docs/api/lists.md +7 -0
- package/docs/api/logs.d.ts +6 -0
- package/docs/api/mailboxes.d.ts +6 -0
- package/docs/api/marketplace.d.ts +6 -0
- package/docs/api/mcp.d.ts +6 -0
- package/docs/api/me.d.ts +6 -0
- package/docs/api/meetings.d.ts +6 -0
- package/docs/api/newsletter.d.ts +6 -0
- package/docs/api/notes.d.ts +6 -0
- package/docs/api/notifications.d.ts +6 -0
- package/docs/api/objects.d.ts +6 -0
- package/docs/api/openSearch.d.ts +6 -0
- package/docs/api/ops.d.ts +6 -0
- package/docs/api/orgGovernance.d.ts +6 -0
- package/docs/api/orgVideos.d.ts +6 -0
- package/docs/api/organizationSettings.d.ts +6 -0
- package/docs/api/phoneNumbers.d.ts +6 -0
- package/docs/api/profile.d.ts +6 -0
- package/docs/api/programmaticPages.d.ts +6 -0
- package/docs/api/providerDomains.d.ts +6 -0
- package/docs/api/providerUsage.d.ts +6 -0
- package/docs/api/public.d.ts +6 -0
- package/docs/api/publicCopilot.d.ts +6 -0
- package/docs/api/publicSignals.d.ts +6 -0
- package/docs/api/publicVisitors.d.ts +6 -0
- package/docs/api/quotes.d.ts +6 -0
- package/docs/api/radarReports.d.ts +6 -0
- package/docs/api/recordRoles.d.ts +6 -0
- package/docs/api/repos.d.ts +6 -0
- package/docs/api/research.d.ts +6 -0
- package/docs/api/revenue.d.ts +6 -0
- package/docs/api/revenueAnalytics.d.ts +6 -0
- package/docs/api/revenueLifecycle.d.ts +11 -1
- package/docs/api/revenueLifecycle.md +11 -2
- package/docs/api/revenueRecords.d.ts +6 -0
- package/docs/api/roles.d.ts +49 -2
- package/docs/api/roles.md +65 -1
- package/docs/api/salesCoach.d.ts +6 -0
- package/docs/api/scans.d.ts +6 -0
- package/docs/api/scheduleBuy.d.ts +6 -0
- package/docs/api/scraping.d.ts +6 -0
- package/docs/api/search.d.ts +9 -1
- package/docs/api/search.md +3 -2
- package/docs/api/seo.d.ts +6 -0
- package/docs/api/sequenceLifecycle.d.ts +6 -0
- package/docs/api/sequences.d.ts +6 -0
- package/docs/api/settings.d.ts +6 -0
- package/docs/api/signals.d.ts +6 -0
- package/docs/api/signatures.d.ts +6 -0
- package/docs/api/snippet.d.ts +6 -0
- package/docs/api/socialPublishing.d.ts +6 -0
- package/docs/api/studioDocuments.d.ts +6 -0
- package/docs/api/support.d.ts +6 -0
- package/docs/api/suppressions.d.ts +6 -0
- package/docs/api/surveys.d.ts +6 -0
- package/docs/api/tasks.d.ts +6 -0
- package/docs/api/teamMembers.d.ts +6 -0
- package/docs/api/teams.d.ts +6 -0
- package/docs/api/usage.d.ts +6 -0
- package/docs/api/visitors.d.ts +6 -0
- package/docs/api/voice.d.ts +6 -0
- package/docs/api/webChat.d.ts +6 -0
- package/docs/api/webhooks.d.ts +6 -0
- package/docs/api/websiteEditor.d.ts +6 -0
- package/docs/api/work.d.ts +6 -0
- package/docs/api/workbench.d.ts +6 -0
- package/docs/api/workflows.d.ts +6 -0
- package/docs/sdk-clients.md +5 -5
- package/package.json +1 -1
package/docs/api/mailboxes.d.ts
CHANGED
|
@@ -980,10 +980,16 @@ export interface PaginationMeta {
|
|
|
980
980
|
limit: number;
|
|
981
981
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
982
982
|
next_cursor?: string | null;
|
|
983
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
984
|
+
notes?: Array<string> | null;
|
|
983
985
|
/** Current page number (1-indexed) */
|
|
984
986
|
page: number;
|
|
985
987
|
/** Total number of items */
|
|
986
988
|
total: number;
|
|
989
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
990
|
+
total_available?: number | null;
|
|
991
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
992
|
+
total_is_lower_bound?: boolean | null;
|
|
987
993
|
}
|
|
988
994
|
|
|
989
995
|
/**
|
|
@@ -2971,10 +2971,16 @@ export interface PaginationMeta {
|
|
|
2971
2971
|
limit: number;
|
|
2972
2972
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
2973
2973
|
next_cursor?: string | null;
|
|
2974
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
2975
|
+
notes?: Array<string> | null;
|
|
2974
2976
|
/** Current page number (1-indexed) */
|
|
2975
2977
|
page: number;
|
|
2976
2978
|
/** Total number of items */
|
|
2977
2979
|
total: number;
|
|
2980
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
2981
|
+
total_available?: number | null;
|
|
2982
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
2983
|
+
total_is_lower_bound?: boolean | null;
|
|
2978
2984
|
}
|
|
2979
2985
|
|
|
2980
2986
|
export interface PlanTerms {
|
package/docs/api/mcp.d.ts
CHANGED
|
@@ -62,8 +62,14 @@ export interface PaginationMeta {
|
|
|
62
62
|
limit: number;
|
|
63
63
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
64
64
|
next_cursor?: string | null;
|
|
65
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
66
|
+
notes?: Array<string> | null;
|
|
65
67
|
/** Current page number (1-indexed) */
|
|
66
68
|
page: number;
|
|
67
69
|
/** Total number of items */
|
|
68
70
|
total: number;
|
|
71
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
72
|
+
total_available?: number | null;
|
|
73
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
74
|
+
total_is_lower_bound?: boolean | null;
|
|
69
75
|
}
|
package/docs/api/me.d.ts
CHANGED
|
@@ -47,8 +47,14 @@ export interface PaginationMeta {
|
|
|
47
47
|
limit: number;
|
|
48
48
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
49
49
|
next_cursor?: string | null;
|
|
50
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
51
|
+
notes?: Array<string> | null;
|
|
50
52
|
/** Current page number (1-indexed) */
|
|
51
53
|
page: number;
|
|
52
54
|
/** Total number of items */
|
|
53
55
|
total: number;
|
|
56
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
57
|
+
total_available?: number | null;
|
|
58
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
59
|
+
total_is_lower_bound?: boolean | null;
|
|
54
60
|
}
|
package/docs/api/meetings.d.ts
CHANGED
|
@@ -532,8 +532,14 @@ export interface PaginationMeta {
|
|
|
532
532
|
limit: number;
|
|
533
533
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
534
534
|
next_cursor?: string | null;
|
|
535
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
536
|
+
notes?: Array<string> | null;
|
|
535
537
|
/** Current page number (1-indexed) */
|
|
536
538
|
page: number;
|
|
537
539
|
/** Total number of items */
|
|
538
540
|
total: number;
|
|
541
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
542
|
+
total_available?: number | null;
|
|
543
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
544
|
+
total_is_lower_bound?: boolean | null;
|
|
539
545
|
}
|
package/docs/api/newsletter.d.ts
CHANGED
|
@@ -1422,10 +1422,16 @@ export interface PaginationMeta {
|
|
|
1422
1422
|
limit: number;
|
|
1423
1423
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
1424
1424
|
next_cursor?: string | null;
|
|
1425
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
1426
|
+
notes?: Array<string> | null;
|
|
1425
1427
|
/** Current page number (1-indexed) */
|
|
1426
1428
|
page: number;
|
|
1427
1429
|
/** Total number of items */
|
|
1428
1430
|
total: number;
|
|
1431
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
1432
|
+
total_available?: number | null;
|
|
1433
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
1434
|
+
total_is_lower_bound?: boolean | null;
|
|
1429
1435
|
}
|
|
1430
1436
|
|
|
1431
1437
|
/** Rewrite ONE element with an AI instruction. THIS SPENDS AI CREDIT. */
|
package/docs/api/notes.d.ts
CHANGED
|
@@ -483,10 +483,16 @@ export interface PaginationMeta {
|
|
|
483
483
|
limit: number;
|
|
484
484
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
485
485
|
next_cursor?: string | null;
|
|
486
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
487
|
+
notes?: Array<string> | null;
|
|
486
488
|
/** Current page number (1-indexed) */
|
|
487
489
|
page: number;
|
|
488
490
|
/** Total number of items */
|
|
489
491
|
total: number;
|
|
492
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
493
|
+
total_available?: number | null;
|
|
494
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
495
|
+
total_is_lower_bound?: boolean | null;
|
|
490
496
|
}
|
|
491
497
|
|
|
492
498
|
/** Mirrors `GlobalNoteCreateRequest`. */
|
|
@@ -87,8 +87,14 @@ export interface PaginationMeta {
|
|
|
87
87
|
limit: number;
|
|
88
88
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
89
89
|
next_cursor?: string | null;
|
|
90
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
91
|
+
notes?: Array<string> | null;
|
|
90
92
|
/** Current page number (1-indexed) */
|
|
91
93
|
page: number;
|
|
92
94
|
/** Total number of items */
|
|
93
95
|
total: number;
|
|
96
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
97
|
+
total_available?: number | null;
|
|
98
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
99
|
+
total_is_lower_bound?: boolean | null;
|
|
94
100
|
}
|
package/docs/api/objects.d.ts
CHANGED
|
@@ -527,10 +527,16 @@ export interface PaginationMeta {
|
|
|
527
527
|
limit: number;
|
|
528
528
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
529
529
|
next_cursor?: string | null;
|
|
530
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
531
|
+
notes?: Array<string> | null;
|
|
530
532
|
/** Current page number (1-indexed) */
|
|
531
533
|
page: number;
|
|
532
534
|
/** Total number of items */
|
|
533
535
|
total: number;
|
|
536
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
537
|
+
total_available?: number | null;
|
|
538
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
539
|
+
total_is_lower_bound?: boolean | null;
|
|
534
540
|
}
|
|
535
541
|
|
|
536
542
|
/**
|
package/docs/api/openSearch.d.ts
CHANGED
|
@@ -227,8 +227,14 @@ export interface PaginationMeta {
|
|
|
227
227
|
limit: number;
|
|
228
228
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
229
229
|
next_cursor?: string | null;
|
|
230
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
231
|
+
notes?: Array<string> | null;
|
|
230
232
|
/** Current page number (1-indexed) */
|
|
231
233
|
page: number;
|
|
232
234
|
/** Total number of items */
|
|
233
235
|
total: number;
|
|
236
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
237
|
+
total_available?: number | null;
|
|
238
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
239
|
+
total_is_lower_bound?: boolean | null;
|
|
234
240
|
}
|
package/docs/api/ops.d.ts
CHANGED
|
@@ -292,8 +292,14 @@ export interface PaginationMeta {
|
|
|
292
292
|
limit: number;
|
|
293
293
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
294
294
|
next_cursor?: string | null;
|
|
295
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
296
|
+
notes?: Array<string> | null;
|
|
295
297
|
/** Current page number (1-indexed) */
|
|
296
298
|
page: number;
|
|
297
299
|
/** Total number of items */
|
|
298
300
|
total: number;
|
|
301
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
302
|
+
total_available?: number | null;
|
|
303
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
304
|
+
total_is_lower_bound?: boolean | null;
|
|
299
305
|
}
|
|
@@ -359,10 +359,16 @@ export interface PaginationMeta {
|
|
|
359
359
|
limit: number;
|
|
360
360
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
361
361
|
next_cursor?: string | null;
|
|
362
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
363
|
+
notes?: Array<string> | null;
|
|
362
364
|
/** Current page number (1-indexed) */
|
|
363
365
|
page: number;
|
|
364
366
|
/** Total number of items */
|
|
365
367
|
total: number;
|
|
368
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
369
|
+
total_available?: number | null;
|
|
370
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
371
|
+
total_is_lower_bound?: boolean | null;
|
|
366
372
|
}
|
|
367
373
|
|
|
368
374
|
export interface RepLimitsOverrideRequest {
|
package/docs/api/orgVideos.d.ts
CHANGED
|
@@ -177,8 +177,14 @@ export interface PaginationMeta {
|
|
|
177
177
|
limit: number;
|
|
178
178
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
179
179
|
next_cursor?: string | null;
|
|
180
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
181
|
+
notes?: Array<string> | null;
|
|
180
182
|
/** Current page number (1-indexed) */
|
|
181
183
|
page: number;
|
|
182
184
|
/** Total number of items */
|
|
183
185
|
total: number;
|
|
186
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
187
|
+
total_available?: number | null;
|
|
188
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
189
|
+
total_is_lower_bound?: boolean | null;
|
|
184
190
|
}
|
|
@@ -578,10 +578,16 @@ export interface PaginationMeta {
|
|
|
578
578
|
limit: number;
|
|
579
579
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
580
580
|
next_cursor?: string | null;
|
|
581
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
582
|
+
notes?: Array<string> | null;
|
|
581
583
|
/** Current page number (1-indexed) */
|
|
582
584
|
page: number;
|
|
583
585
|
/** Total number of items */
|
|
584
586
|
total: number;
|
|
587
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
588
|
+
total_available?: number | null;
|
|
589
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
590
|
+
total_is_lower_bound?: boolean | null;
|
|
585
591
|
}
|
|
586
592
|
|
|
587
593
|
/**
|
|
@@ -303,10 +303,16 @@ export interface PaginationMeta {
|
|
|
303
303
|
limit: number;
|
|
304
304
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
305
305
|
next_cursor?: string | null;
|
|
306
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
307
|
+
notes?: Array<string> | null;
|
|
306
308
|
/** Current page number (1-indexed) */
|
|
307
309
|
page: number;
|
|
308
310
|
/** Total number of items */
|
|
309
311
|
total: number;
|
|
312
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
313
|
+
total_available?: number | null;
|
|
314
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
315
|
+
total_is_lower_bound?: boolean | null;
|
|
310
316
|
}
|
|
311
317
|
|
|
312
318
|
/** The org's A2P brand and campaign registration state. */
|
package/docs/api/profile.d.ts
CHANGED
|
@@ -248,10 +248,16 @@ export interface PaginationMeta {
|
|
|
248
248
|
limit: number;
|
|
249
249
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
250
250
|
next_cursor?: string | null;
|
|
251
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
252
|
+
notes?: Array<string> | null;
|
|
251
253
|
/** Current page number (1-indexed) */
|
|
252
254
|
page: number;
|
|
253
255
|
/** Total number of items */
|
|
254
256
|
total: number;
|
|
257
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
258
|
+
total_available?: number | null;
|
|
259
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
260
|
+
total_is_lower_bound?: boolean | null;
|
|
255
261
|
}
|
|
256
262
|
|
|
257
263
|
/**
|
|
@@ -327,10 +327,16 @@ export interface PaginationMeta {
|
|
|
327
327
|
limit: number;
|
|
328
328
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
329
329
|
next_cursor?: string | null;
|
|
330
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
331
|
+
notes?: Array<string> | null;
|
|
330
332
|
/** Current page number (1-indexed) */
|
|
331
333
|
page: number;
|
|
332
334
|
/** Total number of items */
|
|
333
335
|
total: number;
|
|
336
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
337
|
+
total_available?: number | null;
|
|
338
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
339
|
+
total_is_lower_bound?: boolean | null;
|
|
334
340
|
}
|
|
335
341
|
|
|
336
342
|
/** A lifecycle action on many generated pages (or all, for the deploy actions). */
|
|
@@ -832,10 +832,16 @@ export interface PaginationMeta {
|
|
|
832
832
|
limit: number;
|
|
833
833
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
834
834
|
next_cursor?: string | null;
|
|
835
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
836
|
+
notes?: Array<string> | null;
|
|
835
837
|
/** Current page number (1-indexed) */
|
|
836
838
|
page: number;
|
|
837
839
|
/** Total number of items */
|
|
838
840
|
total: number;
|
|
841
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
842
|
+
total_available?: number | null;
|
|
843
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
844
|
+
total_is_lower_bound?: boolean | null;
|
|
839
845
|
}
|
|
840
846
|
|
|
841
847
|
/** A sending domain owned (or connected) by the org. */
|
|
@@ -112,10 +112,16 @@ export interface PaginationMeta {
|
|
|
112
112
|
limit: number;
|
|
113
113
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
114
114
|
next_cursor?: string | null;
|
|
115
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
116
|
+
notes?: Array<string> | null;
|
|
115
117
|
/** Current page number (1-indexed) */
|
|
116
118
|
page: number;
|
|
117
119
|
/** Total number of items */
|
|
118
120
|
total: number;
|
|
121
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
122
|
+
total_available?: number | null;
|
|
123
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
124
|
+
total_is_lower_bound?: boolean | null;
|
|
119
125
|
}
|
|
120
126
|
|
|
121
127
|
/** Usage figures per provider, or the result of a refresh/sync. */
|
package/docs/api/public.d.ts
CHANGED
|
@@ -48,10 +48,16 @@ export interface PaginationMeta {
|
|
|
48
48
|
limit: number;
|
|
49
49
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
50
50
|
next_cursor?: string | null;
|
|
51
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
52
|
+
notes?: Array<string> | null;
|
|
51
53
|
/** Current page number (1-indexed) */
|
|
52
54
|
page: number;
|
|
53
55
|
/** Total number of items */
|
|
54
56
|
total: number;
|
|
57
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
58
|
+
total_available?: number | null;
|
|
59
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
60
|
+
total_is_lower_bound?: boolean | null;
|
|
55
61
|
}
|
|
56
62
|
|
|
57
63
|
export interface PublicEnrichRequest {
|
|
@@ -48,10 +48,16 @@ export interface PaginationMeta {
|
|
|
48
48
|
limit: number;
|
|
49
49
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
50
50
|
next_cursor?: string | null;
|
|
51
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
52
|
+
notes?: Array<string> | null;
|
|
51
53
|
/** Current page number (1-indexed) */
|
|
52
54
|
page: number;
|
|
53
55
|
/** Total number of items */
|
|
54
56
|
total: number;
|
|
57
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
58
|
+
total_available?: number | null;
|
|
59
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
60
|
+
total_is_lower_bound?: boolean | null;
|
|
55
61
|
}
|
|
56
62
|
|
|
57
63
|
export interface PublicCopilotRequest {
|
|
@@ -59,8 +59,14 @@ export interface PaginationMeta {
|
|
|
59
59
|
limit: number;
|
|
60
60
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
61
61
|
next_cursor?: string | null;
|
|
62
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
63
|
+
notes?: Array<string> | null;
|
|
62
64
|
/** Current page number (1-indexed) */
|
|
63
65
|
page: number;
|
|
64
66
|
/** Total number of items */
|
|
65
67
|
total: number;
|
|
68
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
69
|
+
total_available?: number | null;
|
|
70
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
71
|
+
total_is_lower_bound?: boolean | null;
|
|
66
72
|
}
|
|
@@ -74,10 +74,16 @@ export interface PaginationMeta {
|
|
|
74
74
|
limit: number;
|
|
75
75
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
76
76
|
next_cursor?: string | null;
|
|
77
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
78
|
+
notes?: Array<string> | null;
|
|
77
79
|
/** Current page number (1-indexed) */
|
|
78
80
|
page: number;
|
|
79
81
|
/** Total number of items */
|
|
80
82
|
total: number;
|
|
83
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
84
|
+
total_available?: number | null;
|
|
85
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
86
|
+
total_is_lower_bound?: boolean | null;
|
|
81
87
|
}
|
|
82
88
|
|
|
83
89
|
export interface VisitorCompanyResponse {
|
package/docs/api/quotes.d.ts
CHANGED
|
@@ -1171,10 +1171,16 @@ export interface PaginationMeta {
|
|
|
1171
1171
|
limit: number;
|
|
1172
1172
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
1173
1173
|
next_cursor?: string | null;
|
|
1174
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
1175
|
+
notes?: Array<string> | null;
|
|
1174
1176
|
/** Current page number (1-indexed) */
|
|
1175
1177
|
page: number;
|
|
1176
1178
|
/** Total number of items */
|
|
1177
1179
|
total: number;
|
|
1180
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
1181
|
+
total_available?: number | null;
|
|
1182
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
1183
|
+
total_is_lower_bound?: boolean | null;
|
|
1178
1184
|
}
|
|
1179
1185
|
|
|
1180
1186
|
/**
|
|
@@ -182,10 +182,16 @@ export interface PaginationMeta {
|
|
|
182
182
|
limit: number;
|
|
183
183
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
184
184
|
next_cursor?: string | null;
|
|
185
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
186
|
+
notes?: Array<string> | null;
|
|
185
187
|
/** Current page number (1-indexed) */
|
|
186
188
|
page: number;
|
|
187
189
|
/** Total number of items */
|
|
188
190
|
total: number;
|
|
191
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
192
|
+
total_available?: number | null;
|
|
193
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
194
|
+
total_is_lower_bound?: boolean | null;
|
|
189
195
|
}
|
|
190
196
|
|
|
191
197
|
export interface RadarCaseFileActionRequest {
|
|
@@ -125,10 +125,16 @@ export interface PaginationMeta {
|
|
|
125
125
|
limit: number;
|
|
126
126
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
127
127
|
next_cursor?: string | null;
|
|
128
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
129
|
+
notes?: Array<string> | null;
|
|
128
130
|
/** Current page number (1-indexed) */
|
|
129
131
|
page: number;
|
|
130
132
|
/** Total number of items */
|
|
131
133
|
total: number;
|
|
134
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
135
|
+
total_available?: number | null;
|
|
136
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
137
|
+
total_is_lower_bound?: boolean | null;
|
|
132
138
|
}
|
|
133
139
|
|
|
134
140
|
export interface RecordRoleAssignRequest {
|
package/docs/api/repos.d.ts
CHANGED
|
@@ -125,10 +125,16 @@ export interface PaginationMeta {
|
|
|
125
125
|
limit: number;
|
|
126
126
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
127
127
|
next_cursor?: string | null;
|
|
128
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
129
|
+
notes?: Array<string> | null;
|
|
128
130
|
/** Current page number (1-indexed) */
|
|
129
131
|
page: number;
|
|
130
132
|
/** Total number of items */
|
|
131
133
|
total: number;
|
|
134
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
135
|
+
total_available?: number | null;
|
|
136
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
137
|
+
total_is_lower_bound?: boolean | null;
|
|
132
138
|
}
|
|
133
139
|
|
|
134
140
|
export interface RepoResponse {
|
package/docs/api/research.d.ts
CHANGED
|
@@ -265,10 +265,16 @@ export interface PaginationMeta {
|
|
|
265
265
|
limit: number;
|
|
266
266
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
267
267
|
next_cursor?: string | null;
|
|
268
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
269
|
+
notes?: Array<string> | null;
|
|
268
270
|
/** Current page number (1-indexed) */
|
|
269
271
|
page: number;
|
|
270
272
|
/** Total number of items */
|
|
271
273
|
total: number;
|
|
274
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
275
|
+
total_available?: number | null;
|
|
276
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
277
|
+
total_is_lower_bound?: boolean | null;
|
|
272
278
|
}
|
|
273
279
|
|
|
274
280
|
/** Re-run one failed report. SPENDS CREDIT. */
|
package/docs/api/revenue.d.ts
CHANGED
|
@@ -318,10 +318,16 @@ export interface PaginationMeta {
|
|
|
318
318
|
limit: number;
|
|
319
319
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
320
320
|
next_cursor?: string | null;
|
|
321
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
322
|
+
notes?: Array<string> | null;
|
|
321
323
|
/** Current page number (1-indexed) */
|
|
322
324
|
page: number;
|
|
323
325
|
/** Total number of items */
|
|
324
326
|
total: number;
|
|
327
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
328
|
+
total_available?: number | null;
|
|
329
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
330
|
+
total_is_lower_bound?: boolean | null;
|
|
325
331
|
}
|
|
326
332
|
|
|
327
333
|
/**
|
|
@@ -137,10 +137,16 @@ export interface PaginationMeta {
|
|
|
137
137
|
limit: number;
|
|
138
138
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
139
139
|
next_cursor?: string | null;
|
|
140
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
141
|
+
notes?: Array<string> | null;
|
|
140
142
|
/** Current page number (1-indexed) */
|
|
141
143
|
page: number;
|
|
142
144
|
/** Total number of items */
|
|
143
145
|
total: number;
|
|
146
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
147
|
+
total_available?: number | null;
|
|
148
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
149
|
+
total_is_lower_bound?: boolean | null;
|
|
144
150
|
}
|
|
145
151
|
|
|
146
152
|
/** A dashboard or rollup, as the app computes it. */
|
|
@@ -153,7 +153,9 @@ export interface LifecycleRecordItem {
|
|
|
153
153
|
}
|
|
154
154
|
|
|
155
155
|
export interface LifecycleStageMoveRequest {
|
|
156
|
-
/**
|
|
156
|
+
/** Company moves only: run every check the move runs (company exists, stage known, Customers/Churned guards) and return the would-be transition without writing anything. Ignored for contact moves. */
|
|
157
|
+
dry_run?: boolean;
|
|
158
|
+
/** Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. Case and surrounding whitespace are ignored, and a stage's display name is accepted too. */
|
|
157
159
|
target_slug: string;
|
|
158
160
|
}
|
|
159
161
|
|
|
@@ -164,6 +166,8 @@ export interface LifecycleStageMoveRequest {
|
|
|
164
166
|
* ``previous_status``/``new_status`` are null on that path.
|
|
165
167
|
*/
|
|
166
168
|
export interface LifecycleStageMoveResponse {
|
|
169
|
+
/** True when this was a dry run: nothing was written. */
|
|
170
|
+
dry_run?: boolean;
|
|
167
171
|
new_custom_status?: string | null;
|
|
168
172
|
new_status?: string | null;
|
|
169
173
|
previous_custom_status?: string | null;
|
|
@@ -200,8 +204,14 @@ export interface PaginationMeta {
|
|
|
200
204
|
limit: number;
|
|
201
205
|
/** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
|
|
202
206
|
next_cursor?: string | null;
|
|
207
|
+
/** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
|
|
208
|
+
notes?: Array<string> | null;
|
|
203
209
|
/** Current page number (1-indexed) */
|
|
204
210
|
page: number;
|
|
205
211
|
/** Total number of items */
|
|
206
212
|
total: number;
|
|
213
|
+
/** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
|
|
214
|
+
total_available?: number | null;
|
|
215
|
+
/** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
|
|
216
|
+
total_is_lower_bound?: boolean | null;
|
|
207
217
|
}
|
|
@@ -186,6 +186,11 @@ records a `cb_lead_stage_history`-style audit row. `org_id` is always the
|
|
|
186
186
|
authenticated key's own organisation; there is no way to target another
|
|
187
187
|
org's company through this endpoint.
|
|
188
188
|
|
|
189
|
+
A move to `churned` (or any stage that writes status 'churned') is refused
|
|
190
|
+
with a 400 unless the company is or was a customer. `target_slug` ignores
|
|
191
|
+
case and surrounding whitespace. `dry_run: true` runs every check and
|
|
192
|
+
returns the would-be transition without writing anything.
|
|
193
|
+
|
|
189
194
|
**Input**
|
|
190
195
|
|
|
191
196
|
| Field | Type | Required | Description |
|
|
@@ -197,7 +202,8 @@ Body fields (`LifecycleStageMoveRequest`):
|
|
|
197
202
|
|
|
198
203
|
| Field | Type | Required | Description |
|
|
199
204
|
|---|---|---|---|
|
|
200
|
-
| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. |
|
|
205
|
+
| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. Case and surrounding whitespace are ignored, and a stage's display name is accepted too. |
|
|
206
|
+
| `body.dry_run` | `boolean` | no | Company moves only: run every check the move runs (company exists, stage known, Customers/Churned guards) and return the would-be transition without writing anything. Ignored for contact moves. default `false` |
|
|
201
207
|
|
|
202
208
|
**Returns** `ApiResponse_LifecycleStageMoveResponse_`: the envelope `{ data: LifecycleStageMoveResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
203
209
|
|
|
@@ -208,6 +214,7 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
208
214
|
| Field | Type | Required | Description |
|
|
209
215
|
|---|---|---|---|
|
|
210
216
|
| `target_slug` | `string` | yes | |
|
|
217
|
+
| `dry_run` | `boolean` | no | True when this was a dry run: nothing was written. default `false` |
|
|
211
218
|
| `new_custom_status` | `string \| null` | no | |
|
|
212
219
|
| `new_status` | `string \| null` | no | |
|
|
213
220
|
| `previous_custom_status` | `string \| null` | no | |
|
|
@@ -251,7 +258,8 @@ Body fields (`LifecycleStageMoveRequest`):
|
|
|
251
258
|
|
|
252
259
|
| Field | Type | Required | Description |
|
|
253
260
|
|---|---|---|---|
|
|
254
|
-
| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. |
|
|
261
|
+
| `body.target_slug` | `string` | yes | Destination lifecycle slug, e.g. 'suspects', 'leads', 'trials', 'customers', 'churned'. Case and surrounding whitespace are ignored, and a stage's display name is accepted too. |
|
|
262
|
+
| `body.dry_run` | `boolean` | no | Company moves only: run every check the move runs (company exists, stage known, Customers/Churned guards) and return the would-be transition without writing anything. Ignored for contact moves. default `false` |
|
|
255
263
|
|
|
256
264
|
**Returns** `ApiResponse_LifecycleStageMoveResponse_`: the envelope `{ data: LifecycleStageMoveResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
257
265
|
|
|
@@ -262,6 +270,7 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
262
270
|
| Field | Type | Required | Description |
|
|
263
271
|
|---|---|---|---|
|
|
264
272
|
| `target_slug` | `string` | yes | |
|
|
273
|
+
| `dry_run` | `boolean` | no | True when this was a dry run: nothing was written. default `false` |
|
|
265
274
|
| `new_custom_status` | `string \| null` | no | |
|
|
266
275
|
| `new_status` | `string \| null` | no | |
|
|
267
276
|
| `previous_custom_status` | `string \| null` | no | |
|