@graph8/sdk 0.265.0 → 0.293.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 +734 -28
- package/dist/index.d.ts +734 -28
- package/dist/index.js +15 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +15 -5
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +728 -26
- package/dist/react.d.ts +728 -26
- package/dist/react.js +14 -4
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +14 -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 +8 -7
- package/docs/api/README.md +4 -4
- 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 +32 -1
- package/docs/api/analytics.md +2 -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 +14 -0
- package/docs/api/assertUpsert.md +5 -0
- package/docs/api/audienceSyncs.d.ts +14 -0
- package/docs/api/audienceSyncs.md +16 -0
- package/docs/api/brandKit.d.ts +6 -0
- package/docs/api/bugReports.d.ts +6 -0
- package/docs/api/by-path.md +3 -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 +17 -3
- package/docs/api/companies.md +13 -3
- package/docs/api/companyIntelligence.d.ts +6 -0
- package/docs/api/contacts.d.ts +26 -5
- package/docs/api/contacts.md +17 -6
- 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 +82 -2
- package/docs/api/enrichment.md +76 -1
- package/docs/api/events.d.ts +6 -0
- package/docs/api/fields.d.ts +30 -3
- package/docs/api/fields.md +15 -4
- 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 +32 -0
- package/docs/api/install.md +18 -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 +32 -1
- package/docs/api/intent.md +23 -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 +22 -0
- package/docs/api/lists.md +24 -2
- package/docs/api/logs.d.ts +6 -0
- package/docs/api/mailboxes.d.ts +6 -0
- package/docs/api/marketingIntelligence.d.ts +40 -0
- package/docs/api/marketingIntelligence.md +20 -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 +72 -2
- package/docs/api/snippet.md +73 -4
- 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 +10 -0
- package/docs/api/suppressions.md +2 -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 +32 -0
- package/docs/api/visitors.md +12 -0
- package/docs/api/voice.d.ts +6 -0
- package/docs/api/webAnalytics.d.ts +288 -0
- package/docs/api/webAnalytics.md +144 -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/api/workflows.md +6 -0
- package/docs/sdk-clients.md +5 -5
- package/package.json +1 -1
|
@@ -1427,7 +1427,7 @@ export interface AppointmentsOperations {
|
|
|
1427
1427
|
};
|
|
1428
1428
|
/**
|
|
1429
1429
|
* PATCH /appointments/bookings/{booking_uid}/location
|
|
1430
|
-
*
|
|
1430
|
+
* Change a booking's location and/or conferencing
|
|
1431
1431
|
* tier: external · scope: meetings:run
|
|
1432
1432
|
*/
|
|
1433
1433
|
update_booking_location_appointments_bookings__booking_uid__location_patch: {
|
|
@@ -2028,10 +2028,16 @@ export interface PaginationMeta {
|
|
|
2028
2028
|
limit: number;
|
|
2029
2029
|
/** 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. */
|
|
2030
2030
|
next_cursor?: string | null;
|
|
2031
|
+
/** 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. */
|
|
2032
|
+
notes?: Array<string> | null;
|
|
2031
2033
|
/** Current page number (1-indexed) */
|
|
2032
2034
|
page: number;
|
|
2033
2035
|
/** Total number of items */
|
|
2034
2036
|
total: number;
|
|
2037
|
+
/** 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. */
|
|
2038
|
+
total_available?: number | null;
|
|
2039
|
+
/** 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. */
|
|
2040
|
+
total_is_lower_bound?: boolean | null;
|
|
2035
2041
|
}
|
|
2036
2042
|
|
|
2037
2043
|
export interface RequestRescheduleRequest {
|
|
@@ -2235,8 +2241,20 @@ export interface UpdateEventTypeRequest {
|
|
|
2235
2241
|
use_common_schedule?: boolean | null;
|
|
2236
2242
|
}
|
|
2237
2243
|
|
|
2244
|
+
/**
|
|
2245
|
+
* Change a booking's location and/or conferencing.
|
|
2246
|
+
*
|
|
2247
|
+
* Send only the field you change: an omitted field is left as is, and ``null``
|
|
2248
|
+
* clears it. ``selected_location`` is a physical, phone or custom location;
|
|
2249
|
+
* ``selected_conferencing`` is a meeting link or a conferencing app (a new
|
|
2250
|
+
* meeting room is created for zoom, roam_auto, ms_teams and google_meet).
|
|
2251
|
+
* ``location`` is deprecated: a plain address, kept for older clients.
|
|
2252
|
+
*/
|
|
2238
2253
|
export interface UpdateLocationRequest {
|
|
2239
|
-
location
|
|
2254
|
+
location?: string | null;
|
|
2255
|
+
notify_attendees?: boolean;
|
|
2256
|
+
selected_conferencing?: LocationItem | null;
|
|
2257
|
+
selected_location?: LocationItem | null;
|
|
2240
2258
|
}
|
|
2241
2259
|
|
|
2242
2260
|
/** A member's SCHEDULING role - not their graph8 organisation role. */
|
package/docs/api/appointments.md
CHANGED
|
@@ -100,7 +100,7 @@ Exact TypeScript types for every operation on this page, and every schema they u
|
|
|
100
100
|
| [`toggleWorkflow`](#op-toggleworkflow) | `POST /api/v1/appointments/workflows/{workflow_id}/toggle` | external | `meetings:run` | Activate or deactivate a workflow |
|
|
101
101
|
| [`unassignManagedMember`](#op-unassignmanagedmember) | `DELETE /api/v1/appointments/event-types/{event_type_id}/members/{user_id}` | destructive | `meetings:delete` | Unassign Managed Member |
|
|
102
102
|
| [`updateAvailability`](#op-updateavailability) | `PATCH /api/v1/appointments/schedules/{schedule_id}/availability` | write | `meetings:write` | Replace availability rules and/or date overrides for a schedule |
|
|
103
|
-
| [`updateBookingLocation`](#op-updatebookinglocation) | `PATCH /api/v1/appointments/bookings/{booking_uid}/location` | external | `meetings:run` |
|
|
103
|
+
| [`updateBookingLocation`](#op-updatebookinglocation) | `PATCH /api/v1/appointments/bookings/{booking_uid}/location` | external | `meetings:run` | Change a booking's location and/or conferencing |
|
|
104
104
|
| [`updateBookingSequence`](#op-updatebookingsequence) | `PATCH /api/v1/appointments/bookings/{booking_uid}/sequence` | external | `meetings:run` | Associate a booking with a sequence (or detach) |
|
|
105
105
|
| [`updateEmbedConfig`](#op-updateembedconfig) | `PATCH /api/v1/appointments/event-types/{event_type_id}/embed` | write | `meetings:write` | Update Embed Config |
|
|
106
106
|
| [`updateEventType`](#op-updateeventtype) | `PATCH /api/v1/appointments/event-types/{event_type_id}` | write | `meetings:write` | Update an event type (partial) |
|
|
@@ -145,7 +145,7 @@ Body fields (`AddGuestsRequest`):
|
|
|
145
145
|
|
|
146
146
|
| Field | Type | Required | Description |
|
|
147
147
|
|---|---|---|---|
|
|
148
|
-
| `body.guests` | `Array<string>` | yes |
|
|
148
|
+
| `body.guests` | `Array<string>` | yes | min items 1, max items 50 |
|
|
149
149
|
|
|
150
150
|
**Returns** `Record<string, unknown>`.
|
|
151
151
|
|
|
@@ -3148,20 +3148,33 @@ const result = await g8.api.appointments.updateAvailability({ path: { schedule_i
|
|
|
3148
3148
|
|
|
3149
3149
|
### `g8.api.appointments.updateBookingLocation(input)`
|
|
3150
3150
|
|
|
3151
|
-
**
|
|
3151
|
+
**Change a booking's location and/or conferencing**
|
|
3152
3152
|
|
|
3153
3153
|
- HTTP: `PATCH /api/v1/appointments/bookings/{booking_uid}/location`
|
|
3154
3154
|
- operationId: `update_booking_location_appointments_bookings__booking_uid__location_patch` (also callable as `g8.api.call("update_booking_location_appointments_bookings__booking_uid__location_patch", input)`)
|
|
3155
3155
|
- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
|
|
3156
3156
|
- API-key scope: `meetings:run`
|
|
3157
3157
|
|
|
3158
|
-
Change
|
|
3158
|
+
Change a booking's physical location and/or its conferencing.
|
|
3159
3159
|
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3160
|
+
Two independent fields; send only the one you change. An omitted field is
|
|
3161
|
+
left as is, and ``null`` clears it:
|
|
3162
|
+
|
|
3163
|
+
* ``selected_location``: a location object, e.g.
|
|
3164
|
+
``{"kind": "in_person_host", "address": "1 Market St"}``,
|
|
3165
|
+
``{"kind": "phone_host", "phone": "+14155550100"}`` or
|
|
3166
|
+
``{"kind": "custom", "display_label": "Lobby"}``.
|
|
3167
|
+
* ``selected_conferencing``: ``{"kind": "link", "link": "https://..."}`` for a
|
|
3168
|
+
meeting URL, or ``{"kind": "conferencing", "provider": "zoom"}`` (also
|
|
3169
|
+
``roam_auto``, ``ms_teams``, ``google_meet``), which creates a NEW meeting room.
|
|
3170
|
+
* ``notify_attendees`` (default true): the host is always emailed.
|
|
3171
|
+
|
|
3172
|
+
The host's calendar event is updated too; ``calendar_synced`` in the response
|
|
3173
|
+
is false when that update failed (the change is saved either way). Errors:
|
|
3174
|
+
404 when the booking is not visible to the caller, 409 when it is cancelled,
|
|
3175
|
+
past, imported or changed meanwhile, 422 for an invalid value or a provider
|
|
3176
|
+
the host has not connected, 429 past the per-booking edit limit, 502 when a
|
|
3177
|
+
new meeting room could not be created (nothing is changed then).
|
|
3165
3178
|
|
|
3166
3179
|
**Input**
|
|
3167
3180
|
|
|
@@ -3174,7 +3187,10 @@ Body fields (`UpdateLocationRequest`):
|
|
|
3174
3187
|
|
|
3175
3188
|
| Field | Type | Required | Description |
|
|
3176
3189
|
|---|---|---|---|
|
|
3177
|
-
| `body.location` | `string` |
|
|
3190
|
+
| `body.location` | `string \| null` | no | |
|
|
3191
|
+
| `body.notify_attendees` | `boolean` | no | default `true` |
|
|
3192
|
+
| `body.selected_conferencing` | `LocationItem \| null` | no | |
|
|
3193
|
+
| `body.selected_location` | `LocationItem \| null` | no | |
|
|
3178
3194
|
|
|
3179
3195
|
**Returns** `Record<string, unknown>`.
|
|
3180
3196
|
|
|
@@ -3182,7 +3198,7 @@ Body fields (`UpdateLocationRequest`):
|
|
|
3182
3198
|
|
|
3183
3199
|
```ts
|
|
3184
3200
|
// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
|
|
3185
|
-
const result = await g8.api.appointments.updateBookingLocation({ path: { booking_uid: "example" }, body: {
|
|
3201
|
+
const result = await g8.api.appointments.updateBookingLocation({ path: { booking_uid: "example" }, body: {} });
|
|
3186
3202
|
```
|
|
3187
3203
|
|
|
3188
3204
|
---
|
package/docs/api/apps.d.ts
CHANGED
|
@@ -713,10 +713,16 @@ export interface PaginationMeta {
|
|
|
713
713
|
limit: number;
|
|
714
714
|
/** 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. */
|
|
715
715
|
next_cursor?: string | null;
|
|
716
|
+
/** 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. */
|
|
717
|
+
notes?: Array<string> | null;
|
|
716
718
|
/** Current page number (1-indexed) */
|
|
717
719
|
page: number;
|
|
718
720
|
/** Total number of items */
|
|
719
721
|
total: number;
|
|
722
|
+
/** 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. */
|
|
723
|
+
total_available?: number | null;
|
|
724
|
+
/** 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. */
|
|
725
|
+
total_is_lower_bound?: boolean | null;
|
|
720
726
|
}
|
|
721
727
|
|
|
722
728
|
/**
|
package/docs/api/apps.md
CHANGED
|
@@ -504,11 +504,13 @@ Can this app be built and run yet, and if not, what is missing (M9 J9).
|
|
|
504
504
|
|
|
505
505
|
ANSWERS FROM THE CONTROL PLANE, AND SAYS SO. It reports what graph8 has
|
|
506
506
|
recorded: a bound source, an assigned hostname, declared secrets, the last
|
|
507
|
-
deployment's state.
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
507
|
+
deployment's state. The serving half -- namespace provisioner, registry
|
|
508
|
+
credentials, and the deployed-image rollout -- now EXISTS as control-plane code
|
|
509
|
+
(#22301), so this no longer blocks on it unconditionally. What it still checks
|
|
510
|
+
is whether that code is CONFIGURED in this environment (`_unset_serving_runtime_vars`):
|
|
511
|
+
reporting `ready: true` with the templates or registry credentials unset would
|
|
512
|
+
be the most expensive kind of wrong, because a builder would push and wait for
|
|
513
|
+
something nothing can serve.
|
|
512
514
|
|
|
513
515
|
`blockers` is the field that matters. An agent driving a build needs to know
|
|
514
516
|
WHY it cannot proceed; a bare `ready: false` sends it guessing, and guessing
|
|
@@ -146,6 +146,8 @@ export interface BatchAssertResponse {
|
|
|
146
146
|
errors?: Array<Record<string, unknown>>;
|
|
147
147
|
total: number;
|
|
148
148
|
updated?: number;
|
|
149
|
+
/** Advisory notes about values saved as sent that look wrong (e.g. an unrecognised seniority or country), prefixed with the row index. Empty when the input is clean. */
|
|
150
|
+
warnings?: Array<string>;
|
|
149
151
|
}
|
|
150
152
|
|
|
151
153
|
export interface BatchCompanyAssertRequest {
|
|
@@ -191,8 +193,12 @@ export interface CompanyAssertRequest {
|
|
|
191
193
|
export interface CompanyAssertResponse {
|
|
192
194
|
/** 'created' or 'updated' */
|
|
193
195
|
action: string;
|
|
196
|
+
/** ID of the company that was created or updated (use it with GET/PATCH /companies/{company_id}). Null when the saved record cannot be identified unambiguously, e.g. when the domain already matched several companies in the list. */
|
|
197
|
+
company_id?: number | null;
|
|
194
198
|
count?: number;
|
|
195
199
|
custom_fields?: CustomFieldWriteReport;
|
|
200
|
+
/** Advisory notes about values saved as sent that look wrong (e.g. an unrecognised country). Empty when the input is clean. */
|
|
201
|
+
warnings?: Array<string>;
|
|
196
202
|
}
|
|
197
203
|
|
|
198
204
|
export interface ContactAssertRequest {
|
|
@@ -225,6 +231,8 @@ export interface ContactAssertResponse {
|
|
|
225
231
|
action: string;
|
|
226
232
|
count?: number;
|
|
227
233
|
custom_fields?: CustomFieldWriteReport;
|
|
234
|
+
/** Advisory notes about values saved as sent that look wrong (e.g. an unrecognised seniority or country). Empty when the input is clean. */
|
|
235
|
+
warnings?: Array<string>;
|
|
228
236
|
}
|
|
229
237
|
|
|
230
238
|
/**
|
|
@@ -279,8 +287,14 @@ export interface PaginationMeta {
|
|
|
279
287
|
limit: number;
|
|
280
288
|
/** 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. */
|
|
281
289
|
next_cursor?: string | null;
|
|
290
|
+
/** 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. */
|
|
291
|
+
notes?: Array<string> | null;
|
|
282
292
|
/** Current page number (1-indexed) */
|
|
283
293
|
page: number;
|
|
284
294
|
/** Total number of items */
|
|
285
295
|
total: number;
|
|
296
|
+
/** 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. */
|
|
297
|
+
total_available?: number | null;
|
|
298
|
+
/** 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. */
|
|
299
|
+
total_is_lower_bound?: boolean | null;
|
|
286
300
|
}
|
package/docs/api/assertUpsert.md
CHANGED
|
@@ -71,6 +71,7 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
71
71
|
| `custom_fields` | `CustomFieldWriteReport` | no | |
|
|
72
72
|
| `errors` | `Array<Record<string, unknown>>` | no | default `[]` |
|
|
73
73
|
| `updated` | `integer` | no | default `0` |
|
|
74
|
+
| `warnings` | `Array<string>` | no | Advisory notes about values saved as sent that look wrong (e.g. an unrecognised seniority or country), prefixed with the row index. Empty when the input is clean. |
|
|
74
75
|
|
|
75
76
|
**Example**
|
|
76
77
|
|
|
@@ -127,8 +128,10 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
127
128
|
| Field | Type | Required | Description |
|
|
128
129
|
|---|---|---|---|
|
|
129
130
|
| `action` | `string` | yes | 'created' or 'updated' |
|
|
131
|
+
| `company_id` | `integer \| null` | no | ID of the company that was created or updated (use it with GET/PATCH /companies/{company_id}). Null when the saved record cannot be identified unambiguously, e.g. when the domain already matched several companies in the list. |
|
|
130
132
|
| `count` | `integer` | no | default `1` |
|
|
131
133
|
| `custom_fields` | `CustomFieldWriteReport` | no | |
|
|
134
|
+
| `warnings` | `Array<string>` | no | Advisory notes about values saved as sent that look wrong (e.g. an unrecognised country). Empty when the input is clean. |
|
|
132
135
|
|
|
133
136
|
**Example**
|
|
134
137
|
|
|
@@ -191,6 +194,7 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
191
194
|
| `action` | `string` | yes | 'created' or 'updated' |
|
|
192
195
|
| `count` | `integer` | no | default `1` |
|
|
193
196
|
| `custom_fields` | `CustomFieldWriteReport` | no | |
|
|
197
|
+
| `warnings` | `Array<string>` | no | Advisory notes about values saved as sent that look wrong (e.g. an unrecognised seniority or country). Empty when the input is clean. |
|
|
194
198
|
|
|
195
199
|
**Example**
|
|
196
200
|
|
|
@@ -240,6 +244,7 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
240
244
|
| `custom_fields` | `CustomFieldWriteReport` | no | |
|
|
241
245
|
| `errors` | `Array<Record<string, unknown>>` | no | default `[]` |
|
|
242
246
|
| `updated` | `integer` | no | default `0` |
|
|
247
|
+
| `warnings` | `Array<string>` | no | Advisory notes about values saved as sent that look wrong (e.g. an unrecognised seniority or country), prefixed with the row index. Empty when the input is clean. |
|
|
243
248
|
|
|
244
249
|
**Example**
|
|
245
250
|
|
|
@@ -198,11 +198,19 @@ export interface AudienceSyncConfigResponse {
|
|
|
198
198
|
id: number;
|
|
199
199
|
is_active?: boolean;
|
|
200
200
|
last_sync_at?: string | null;
|
|
201
|
+
/** Error of the last failed run, if any. */
|
|
202
|
+
last_sync_error?: string | null;
|
|
201
203
|
mode?: string;
|
|
204
|
+
/** When the worker will next try this sync. */
|
|
205
|
+
next_sync_at?: string | null;
|
|
202
206
|
platform: string;
|
|
203
207
|
platform_audience_name?: string | null;
|
|
204
208
|
refresh_cadence_hours?: number;
|
|
205
209
|
status?: string | null;
|
|
210
|
+
/** Human-readable explanation of status_reason. */
|
|
211
|
+
status_detail?: string | null;
|
|
212
|
+
/** Why the sync is not delivering, or null when healthy: keyword_only (no list, keyword-only Google Search; never scheduled), list_missing (every list it uploads from was deleted), lists_partially_missing, paused, failing (last run failed), failing_never_synced (has never succeeded). */
|
|
213
|
+
status_reason?: string | null;
|
|
206
214
|
}
|
|
207
215
|
|
|
208
216
|
export interface AudienceSyncCreateRequest {
|
|
@@ -234,10 +242,16 @@ export interface PaginationMeta {
|
|
|
234
242
|
limit: number;
|
|
235
243
|
/** 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. */
|
|
236
244
|
next_cursor?: string | null;
|
|
245
|
+
/** 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. */
|
|
246
|
+
notes?: Array<string> | null;
|
|
237
247
|
/** Current page number (1-indexed) */
|
|
238
248
|
page: number;
|
|
239
249
|
/** Total number of items */
|
|
240
250
|
total: number;
|
|
251
|
+
/** 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. */
|
|
252
|
+
total_available?: number | null;
|
|
253
|
+
/** 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. */
|
|
254
|
+
total_is_lower_bound?: boolean | null;
|
|
241
255
|
}
|
|
242
256
|
|
|
243
257
|
export interface SyncErrorResponse {
|
|
@@ -79,10 +79,14 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
79
79
|
| `created_at` | `string \| null` | no | |
|
|
80
80
|
| `is_active` | `boolean` | no | default `true` |
|
|
81
81
|
| `last_sync_at` | `string \| null` | no | |
|
|
82
|
+
| `last_sync_error` | `string \| null` | no | Error of the last failed run, if any. |
|
|
82
83
|
| `mode` | `string` | no | default `"mirror"` |
|
|
84
|
+
| `next_sync_at` | `string \| null` | no | When the worker will next try this sync. |
|
|
83
85
|
| `platform_audience_name` | `string \| null` | no | |
|
|
84
86
|
| `refresh_cadence_hours` | `integer` | no | default `24` |
|
|
85
87
|
| `status` | `string \| null` | no | |
|
|
88
|
+
| `status_detail` | `string \| null` | no | Human-readable explanation of status_reason. |
|
|
89
|
+
| `status_reason` | `string \| null` | no | Why the sync is not delivering, or null when healthy: keyword_only (no list, keyword-only Google Search; never scheduled), list_missing (every list it uploads from was deleted), lists_partially_missing, paused, failing (last run failed), failing_never_synced (has never succeeded). |
|
|
86
90
|
|
|
87
91
|
**Example**
|
|
88
92
|
|
|
@@ -160,10 +164,14 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
160
164
|
| `created_at` | `string \| null` | no | |
|
|
161
165
|
| `is_active` | `boolean` | no | default `true` |
|
|
162
166
|
| `last_sync_at` | `string \| null` | no | |
|
|
167
|
+
| `last_sync_error` | `string \| null` | no | Error of the last failed run, if any. |
|
|
163
168
|
| `mode` | `string` | no | default `"mirror"` |
|
|
169
|
+
| `next_sync_at` | `string \| null` | no | When the worker will next try this sync. |
|
|
164
170
|
| `platform_audience_name` | `string \| null` | no | |
|
|
165
171
|
| `refresh_cadence_hours` | `integer` | no | default `24` |
|
|
166
172
|
| `status` | `string \| null` | no | |
|
|
173
|
+
| `status_detail` | `string \| null` | no | Human-readable explanation of status_reason. |
|
|
174
|
+
| `status_reason` | `string \| null` | no | Why the sync is not delivering, or null when healthy: keyword_only (no list, keyword-only Google Search; never scheduled), list_missing (every list it uploads from was deleted), lists_partially_missing, paused, failing (last run failed), failing_never_synced (has never succeeded). |
|
|
167
175
|
|
|
168
176
|
**Example**
|
|
169
177
|
|
|
@@ -203,10 +211,14 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
203
211
|
| `created_at` | `string \| null` | no | |
|
|
204
212
|
| `is_active` | `boolean` | no | default `true` |
|
|
205
213
|
| `last_sync_at` | `string \| null` | no | |
|
|
214
|
+
| `last_sync_error` | `string \| null` | no | Error of the last failed run, if any. |
|
|
206
215
|
| `mode` | `string` | no | default `"mirror"` |
|
|
216
|
+
| `next_sync_at` | `string \| null` | no | When the worker will next try this sync. |
|
|
207
217
|
| `platform_audience_name` | `string \| null` | no | |
|
|
208
218
|
| `refresh_cadence_hours` | `integer` | no | default `24` |
|
|
209
219
|
| `status` | `string \| null` | no | |
|
|
220
|
+
| `status_detail` | `string \| null` | no | Human-readable explanation of status_reason. |
|
|
221
|
+
| `status_reason` | `string \| null` | no | Why the sync is not delivering, or null when healthy: keyword_only (no list, keyword-only Google Search; never scheduled), list_missing (every list it uploads from was deleted), lists_partially_missing, paused, failing (last run failed), failing_never_synced (has never succeeded). |
|
|
210
222
|
|
|
211
223
|
**Example**
|
|
212
224
|
|
|
@@ -382,10 +394,14 @@ Other envelope fields: `pagination` (PaginationMeta).
|
|
|
382
394
|
| `created_at` | `string \| null` | no | |
|
|
383
395
|
| `is_active` | `boolean` | no | default `true` |
|
|
384
396
|
| `last_sync_at` | `string \| null` | no | |
|
|
397
|
+
| `last_sync_error` | `string \| null` | no | Error of the last failed run, if any. |
|
|
385
398
|
| `mode` | `string` | no | default `"mirror"` |
|
|
399
|
+
| `next_sync_at` | `string \| null` | no | When the worker will next try this sync. |
|
|
386
400
|
| `platform_audience_name` | `string \| null` | no | |
|
|
387
401
|
| `refresh_cadence_hours` | `integer` | no | default `24` |
|
|
388
402
|
| `status` | `string \| null` | no | |
|
|
403
|
+
| `status_detail` | `string \| null` | no | Human-readable explanation of status_reason. |
|
|
404
|
+
| `status_reason` | `string \| null` | no | Why the sync is not delivering, or null when healthy: keyword_only (no list, keyword-only Google Search; never scheduled), list_missing (every list it uploads from was deleted), lists_partially_missing, paused, failing (last run failed), failing_never_synced (has never succeeded). |
|
|
389
405
|
|
|
390
406
|
**Example**
|
|
391
407
|
|
package/docs/api/brandKit.d.ts
CHANGED
|
@@ -593,10 +593,16 @@ export interface PaginationMeta {
|
|
|
593
593
|
limit: number;
|
|
594
594
|
/** 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. */
|
|
595
595
|
next_cursor?: string | null;
|
|
596
|
+
/** 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. */
|
|
597
|
+
notes?: Array<string> | null;
|
|
596
598
|
/** Current page number (1-indexed) */
|
|
597
599
|
page: number;
|
|
598
600
|
/** Total number of items */
|
|
599
601
|
total: number;
|
|
602
|
+
/** 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. */
|
|
603
|
+
total_available?: number | null;
|
|
604
|
+
/** 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. */
|
|
605
|
+
total_is_lower_bound?: boolean | null;
|
|
600
606
|
}
|
|
601
607
|
|
|
602
608
|
/**
|
package/docs/api/bugReports.d.ts
CHANGED
|
@@ -174,8 +174,14 @@ export interface PaginationMeta {
|
|
|
174
174
|
limit: number;
|
|
175
175
|
/** 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. */
|
|
176
176
|
next_cursor?: string | null;
|
|
177
|
+
/** 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. */
|
|
178
|
+
notes?: Array<string> | null;
|
|
177
179
|
/** Current page number (1-indexed) */
|
|
178
180
|
page: number;
|
|
179
181
|
/** Total number of items */
|
|
180
182
|
total: number;
|
|
183
|
+
/** 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. */
|
|
184
|
+
total_available?: number | null;
|
|
185
|
+
/** 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. */
|
|
186
|
+
total_is_lower_bound?: boolean | null;
|
|
181
187
|
}
|
package/docs/api/by-path.md
CHANGED
|
@@ -1183,6 +1183,7 @@ Every Developer API route, sorted by path, with the SDK call that reaches it. Th
|
|
|
1183
1183
|
| POST | `/api/v1/enrichment/lookup/company` | [`g8.api.enrichment.lookupCompany`](enrichment.md#op-lookupcompany) or `g8.enrich.company()` | billable |
|
|
1184
1184
|
| POST | `/api/v1/enrichment/lookup/person` | [`g8.api.enrichment.lookupPerson`](enrichment.md#op-lookupperson) or `g8.enrich.person()` | billable |
|
|
1185
1185
|
| POST | `/api/v1/enrichment/person` | [`g8.api.enrichment.lookupPersonAlias`](enrichment.md#op-lookuppersonalias) | billable |
|
|
1186
|
+
| POST | `/api/v1/enrichment/preflight` | [`g8.api.enrichment.preflightEnrichment`](enrichment.md#op-preflightenrichment) | read |
|
|
1186
1187
|
| GET | `/api/v1/enrichment/providers` | [`g8.api.enrichment.listEnrichmentProviders`](enrichment.md#op-listenrichmentproviders) | read |
|
|
1187
1188
|
| GET | `/api/v1/enrichment/record-sync/{entity_type}/fields` | [`g8.api.enrichment.listRecordSyncFields`](enrichment.md#op-listrecordsyncfields) | read |
|
|
1188
1189
|
| GET | `/api/v1/enrichment/record-sync/{entity_type}/history` | [`g8.api.enrichment.listRecordSyncHistory`](enrichment.md#op-listrecordsynchistory) | read |
|
|
@@ -2367,6 +2368,7 @@ Every Developer API route, sorted by path, with the SDK call that reaches it. Th
|
|
|
2367
2368
|
| GET | `/api/v1/roles` | [`g8.api.roles.listRoles`](roles.md#op-listroles) | read |
|
|
2368
2369
|
| POST | `/api/v1/roles` | [`g8.api.roles.createRole`](roles.md#op-createrole) | write |
|
|
2369
2370
|
| GET | `/api/v1/roles/domain-settings` | [`g8.api.roles.getDomainSettings`](roles.md#op-getdomainsettings) | read |
|
|
2371
|
+
| POST | `/api/v1/roles/invite` | [`g8.api.roles.inviteMember`](roles.md#op-invitemember) | external |
|
|
2370
2372
|
| GET | `/api/v1/roles/join-requests` | [`g8.api.roles.listJoinRequests`](roles.md#op-listjoinrequests) | read |
|
|
2371
2373
|
| GET | `/api/v1/roles/join-requests/count` | [`g8.api.roles.getJoinRequestCount`](roles.md#op-getjoinrequestcount) | read |
|
|
2372
2374
|
| POST | `/api/v1/roles/join-requests/{request_id}/reject` | [`g8.api.roles.rejectJoinRequest`](roles.md#op-rejectjoinrequest) | write |
|
|
@@ -2652,6 +2654,7 @@ Every Developer API route, sorted by path, with the SDK call that reaches it. Th
|
|
|
2652
2654
|
| POST | `/api/v1/social/posts/{post_id}/publish` | [`g8.api.socialPublishing.publishSocialPost`](socialPublishing.md#op-publishsocialpost) | external |
|
|
2653
2655
|
| POST | `/api/v1/social/posts/{post_id}/schedule` | [`g8.api.socialPublishing.scheduleSocialPost`](socialPublishing.md#op-schedulesocialpost) | external |
|
|
2654
2656
|
| GET | `/api/v1/social/providers` | [`g8.api.socialPublishing.listSocialProviders`](socialPublishing.md#op-listsocialproviders) | read |
|
|
2657
|
+
| GET | `/api/v1/streams` | [`g8.api.snippet.listOrgStreams`](snippet.md#op-listorgstreams) | read |
|
|
2655
2658
|
| POST | `/api/v1/stripe/api-key` | [`g8.api.quotes.connectStripeApiKey`](quotes.md#op-connectstripeapikey) | external |
|
|
2656
2659
|
| GET | `/api/v1/stripe/companies/{company_id}/invoices` | [`g8.api.quotes.getCompanyStripeInvoices`](quotes.md#op-getcompanystripeinvoices) | read |
|
|
2657
2660
|
| GET | `/api/v1/stripe/companies/{company_id}/revenue-summary` | [`g8.api.quotes.getCompanyRevenueSummary`](quotes.md#op-getcompanyrevenuesummary) | read |
|
|
@@ -110,8 +110,14 @@ export interface PaginationMeta {
|
|
|
110
110
|
limit: number;
|
|
111
111
|
/** 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. */
|
|
112
112
|
next_cursor?: string | null;
|
|
113
|
+
/** 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. */
|
|
114
|
+
notes?: Array<string> | null;
|
|
113
115
|
/** Current page number (1-indexed) */
|
|
114
116
|
page: number;
|
|
115
117
|
/** Total number of items */
|
|
116
118
|
total: number;
|
|
119
|
+
/** 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. */
|
|
120
|
+
total_available?: number | null;
|
|
121
|
+
/** 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. */
|
|
122
|
+
total_is_lower_bound?: boolean | null;
|
|
117
123
|
}
|
|
@@ -145,8 +145,14 @@ export interface PaginationMeta {
|
|
|
145
145
|
limit: number;
|
|
146
146
|
/** 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. */
|
|
147
147
|
next_cursor?: string | null;
|
|
148
|
+
/** 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. */
|
|
149
|
+
notes?: Array<string> | null;
|
|
148
150
|
/** Current page number (1-indexed) */
|
|
149
151
|
page: number;
|
|
150
152
|
/** Total number of items */
|
|
151
153
|
total: number;
|
|
154
|
+
/** 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. */
|
|
155
|
+
total_available?: number | null;
|
|
156
|
+
/** 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. */
|
|
157
|
+
total_is_lower_bound?: boolean | null;
|
|
152
158
|
}
|
package/docs/api/campaigns.d.ts
CHANGED
|
@@ -674,10 +674,16 @@ export interface PaginationMeta {
|
|
|
674
674
|
limit: number;
|
|
675
675
|
/** 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. */
|
|
676
676
|
next_cursor?: string | null;
|
|
677
|
+
/** 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. */
|
|
678
|
+
notes?: Array<string> | null;
|
|
677
679
|
/** Current page number (1-indexed) */
|
|
678
680
|
page: number;
|
|
679
681
|
/** Total number of items */
|
|
680
682
|
total: number;
|
|
683
|
+
/** 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. */
|
|
684
|
+
total_available?: number | null;
|
|
685
|
+
/** 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. */
|
|
686
|
+
total_is_lower_bound?: boolean | null;
|
|
681
687
|
}
|
|
682
688
|
|
|
683
689
|
/**
|
package/docs/api/channels.d.ts
CHANGED
|
@@ -151,10 +151,16 @@ export interface PaginationMeta {
|
|
|
151
151
|
limit: number;
|
|
152
152
|
/** 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. */
|
|
153
153
|
next_cursor?: string | null;
|
|
154
|
+
/** 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. */
|
|
155
|
+
notes?: Array<string> | null;
|
|
154
156
|
/** Current page number (1-indexed) */
|
|
155
157
|
page: number;
|
|
156
158
|
/** Total number of items */
|
|
157
159
|
total: number;
|
|
160
|
+
/** 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. */
|
|
161
|
+
total_available?: number | null;
|
|
162
|
+
/** 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. */
|
|
163
|
+
total_is_lower_bound?: boolean | null;
|
|
158
164
|
}
|
|
159
165
|
|
|
160
166
|
/**
|
|
@@ -164,10 +164,16 @@ export interface PaginationMeta {
|
|
|
164
164
|
limit: number;
|
|
165
165
|
/** 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. */
|
|
166
166
|
next_cursor?: string | null;
|
|
167
|
+
/** 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. */
|
|
168
|
+
notes?: Array<string> | null;
|
|
167
169
|
/** Current page number (1-indexed) */
|
|
168
170
|
page: number;
|
|
169
171
|
/** Total number of items */
|
|
170
172
|
total: number;
|
|
173
|
+
/** 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. */
|
|
174
|
+
total_available?: number | null;
|
|
175
|
+
/** 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. */
|
|
176
|
+
total_is_lower_bound?: boolean | null;
|
|
171
177
|
}
|
|
172
178
|
|
|
173
179
|
export interface developer_api__interfaces__v1__cli_campaigns_router__CampaignCreateRequest {
|
|
@@ -256,10 +256,16 @@ export interface PaginationMeta {
|
|
|
256
256
|
limit: number;
|
|
257
257
|
/** 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. */
|
|
258
258
|
next_cursor?: string | null;
|
|
259
|
+
/** 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. */
|
|
260
|
+
notes?: Array<string> | null;
|
|
259
261
|
/** Current page number (1-indexed) */
|
|
260
262
|
page: number;
|
|
261
263
|
/** Total number of items */
|
|
262
264
|
total: number;
|
|
265
|
+
/** 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. */
|
|
266
|
+
total_available?: number | null;
|
|
267
|
+
/** 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. */
|
|
268
|
+
total_is_lower_bound?: boolean | null;
|
|
263
269
|
}
|
|
264
270
|
|
|
265
271
|
export interface PipelineCreateRequest {
|
package/docs/api/clickHouse.d.ts
CHANGED
|
@@ -108,8 +108,14 @@ export interface PaginationMeta {
|
|
|
108
108
|
limit: number;
|
|
109
109
|
/** 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. */
|
|
110
110
|
next_cursor?: string | null;
|
|
111
|
+
/** 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. */
|
|
112
|
+
notes?: Array<string> | null;
|
|
111
113
|
/** Current page number (1-indexed) */
|
|
112
114
|
page: number;
|
|
113
115
|
/** Total number of items */
|
|
114
116
|
total: number;
|
|
117
|
+
/** 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. */
|
|
118
|
+
total_available?: number | null;
|
|
119
|
+
/** 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. */
|
|
120
|
+
total_is_lower_bound?: boolean | null;
|
|
115
121
|
}
|
package/docs/api/companies.d.ts
CHANGED
|
@@ -633,9 +633,9 @@ export interface CompaniesOperations {
|
|
|
633
633
|
employee_count_min?: number | null;
|
|
634
634
|
/** Maximum employee count */
|
|
635
635
|
employee_count_max?: number | null;
|
|
636
|
-
/** Filter by country (exact match) */
|
|
636
|
+
/** Filter by country (exact match, case-insensitive; surrounding spaces ignored). Common aliases match each other: United States = US = USA; United Kingdom = UK. */
|
|
637
637
|
country?: string | null;
|
|
638
|
-
/** Filter by state (exact match) */
|
|
638
|
+
/** Filter by state (exact match, case-insensitive; surrounding spaces ignored) */
|
|
639
639
|
state?: string | null;
|
|
640
640
|
/** Filter by city (partial match) */
|
|
641
641
|
city?: string | null;
|
|
@@ -1204,6 +1204,8 @@ export interface CompanyCreateResponse {
|
|
|
1204
1204
|
company_id?: number | null;
|
|
1205
1205
|
merged?: boolean;
|
|
1206
1206
|
status: string;
|
|
1207
|
+
/** Advisory notes about values that look wrong (e.g. an employee_count with no number, an unrecognised country, or a linkedin_url that is not a web address and was not saved). Empty when the input is clean. */
|
|
1208
|
+
warnings?: Array<string>;
|
|
1207
1209
|
}
|
|
1208
1210
|
|
|
1209
1211
|
/** Lighter company representation for list endpoints. */
|
|
@@ -1318,7 +1320,7 @@ export type CompanyWorkflowType = "company_intelligence" | "stakeholder_mapping"
|
|
|
1318
1320
|
export interface CreateCompanyColumnRequest {
|
|
1319
1321
|
/** Email of the user creating the column (for audit). */
|
|
1320
1322
|
created_by: string;
|
|
1321
|
-
/** Column data type
|
|
1323
|
+
/** Column data type: 'text', 'int' (whole number), 'numeric' (decimal) or 'boolean' (yes/no). Other values 422. */
|
|
1322
1324
|
data_type?: ColumnType;
|
|
1323
1325
|
/** STRONGLY RECOMMENDED. Optional waterfall enrichment block. When supplied, a companion `enrichment_configs` row is created alongside the column so the UI 'Enrich' button works immediately. Without it the column exists but isn't enrichable until a pipeline is configured via POST /enrichment/waterfall/configs. */
|
|
1324
1326
|
enrichment?: CreateFieldEnrichmentInput | null;
|
|
@@ -1337,15 +1339,21 @@ export interface CreateCompanyColumnRequest {
|
|
|
1337
1339
|
* that is populated when the request included an `enrichment` block.
|
|
1338
1340
|
*/
|
|
1339
1341
|
export interface CreateCompanyColumnResponse {
|
|
1342
|
+
/** True when a column with this name already existed in this scope, so the existing column was returned. A different `data_type` is rejected with 409. */
|
|
1343
|
+
already_existed?: boolean;
|
|
1340
1344
|
data_type?: ColumnType;
|
|
1341
1345
|
/** Populated when the request included an `enrichment` block. Use `enrichment.column_id` for subsequent POST /enrichment/waterfall/enrich calls. */
|
|
1342
1346
|
enrichment?: CreateFieldEnrichmentResponse | null;
|
|
1347
|
+
/** When `already_existed` is true: the existing column's data type. */
|
|
1348
|
+
existing_data_type?: string | null;
|
|
1343
1349
|
id?: number | null;
|
|
1344
1350
|
/** Computed: True when object_id is null/empty (global column). */
|
|
1345
1351
|
is_global?: boolean;
|
|
1346
1352
|
name?: string | null;
|
|
1347
1353
|
object_id?: string | null;
|
|
1348
1354
|
title: string;
|
|
1355
|
+
/** Non-blocking notices (e.g. a same-named org-wide column also shows on this list). */
|
|
1356
|
+
warnings?: Array<string>;
|
|
1349
1357
|
}
|
|
1350
1358
|
|
|
1351
1359
|
/**
|
|
@@ -1526,10 +1534,16 @@ export interface PaginationMeta {
|
|
|
1526
1534
|
limit: number;
|
|
1527
1535
|
/** 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. */
|
|
1528
1536
|
next_cursor?: string | null;
|
|
1537
|
+
/** 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. */
|
|
1538
|
+
notes?: Array<string> | null;
|
|
1529
1539
|
/** Current page number (1-indexed) */
|
|
1530
1540
|
page: number;
|
|
1531
1541
|
/** Total number of items */
|
|
1532
1542
|
total: number;
|
|
1543
|
+
/** 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. */
|
|
1544
|
+
total_available?: number | null;
|
|
1545
|
+
/** 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. */
|
|
1546
|
+
total_is_lower_bound?: boolean | null;
|
|
1533
1547
|
}
|
|
1534
1548
|
|
|
1535
1549
|
/** Attach the output of a skill run to a record as a document. */
|