@specstream/sdk 0.0.0-stage → 1.0.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 SpecStream SAS
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,71 @@
1
- # Temporary Holding Version
1
+ # @specstream/sdk
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ TypeScript client for [SpecStream](https://specstream.ai), the live web data engine for teams and agents. Describe the list you need in plain words; SpecStream reads the web where those things live, hands back only the matches, each with the page it came from, and you pay only for the matches.
4
+
5
+ The client has no runtime dependencies and needs Node 22 or newer. It uses the same account, permissions, projects and balance as the workspace.
6
+
7
+ ```sh
8
+ npm install @specstream/sdk
9
+ ```
10
+
11
+ Create an API key under **Agents & API** in your SpecStream workspace and keep it in the environment: `SPECSTREAM_API_KEY`.
12
+
13
+ ## Read a request, get the price
14
+
15
+ ```ts
16
+ import { Client } from "@specstream/sdk";
17
+
18
+ const client = new Client({ apiKey: process.env.SPECSTREAM_API_KEY! });
19
+
20
+ const read = await client.compile(
21
+ "Open-source document-signing tools I can self-host. Include the license and latest release.",
22
+ );
23
+ const offer = await client.quoteCapacityWork({
24
+ ast_hash: String(read.ast_hash),
25
+ operation: "find",
26
+ requested_units: 25,
27
+ });
28
+ console.log(offer.maximum_cents, offer.expires_at);
29
+ ```
30
+
31
+ Nothing has run yet. Show a person the quote: what will be found, the facts that come back, the most the work can cost, and when the price expires. A price lasts 30 minutes.
32
+
33
+ ## Approve it, then read the results
34
+
35
+ After a person approves, send the approved maximum in cents and a request key you saved first:
36
+
37
+ ```ts
38
+ const run = await client.authorizeCapacityWork({
39
+ quote_id: offer.quote_id,
40
+ quote_hash: offer.quote_hash,
41
+ confirm_max_cents: approvedMaximumCents,
42
+ idempotency_key: savedRequestKey,
43
+ });
44
+
45
+ if (!run.find_id) throw new Error("The work was not started; retry with the same key");
46
+ const page = await client.rows(run.find_id);
47
+ for (const row of page.rows) console.log(row);
48
+ ```
49
+
50
+ If the response is lost, `getCapacityRequest(savedRequestKey)` returns the same work. Keep the original key when you retry, and you will not pay twice. `authorizeCapacityWork` throws before any network call unless the quote, its signature, a whole-number maximum and the key are all present. `getFind` reports progress, and `rows` pages with `next_cursor`. Reading, exporting and sharing results you own cost nothing.
51
+
52
+ ## More
53
+
54
+ - `quoteCapacityWork` also prices `extend`, `add_facts` and `refresh` (a recheck, at half price) on a finished run.
55
+ - `specOptions(kind)` lists the facts you can ask for per kind of thing. `editSpec` changes a request without rereading it.
56
+ - `createCapacitySchedule` keeps a request current inside per-run and per-period limits.
57
+ - `export` and `downloadExport` give CSV, XLSX, JSON or HTML.
58
+ - Errors are `SpecstreamError` with `status`, `code` and `details`.
59
+
60
+ ## Pricing
61
+
62
+ New accounts start with $10 of work for 30 days, no card. A delivered result costs 10 cents, 30 cents or $1 depending on how many facts it carries. No result, no charge. See [pricing](https://specstream.ai/pricing).
63
+
64
+ ## Links
65
+
66
+ - [SDK docs](https://specstream.ai/docs/sdk) and [API docs](https://specstream.ai/docs/api)
67
+ - [Source and issues](https://github.com/Specstreamai/specstream-tools)
68
+ - [Python client](https://pypi.org/project/specstream-client/)
69
+ - Support: support@specstream.ai
70
+
71
+ MIT license.
@@ -0,0 +1,2 @@
1
+ /** Explicit review is required even when JavaScript bypasses static types. */
2
+ export declare function requireWorkAuthorization(value: unknown): void;
@@ -0,0 +1,25 @@
1
+ /** Explicit review is required even when JavaScript bypasses static types. */
2
+ export function requireWorkAuthorization(value) {
3
+ const required = ["quote_id", "quote_hash", "idempotency_key", "confirm_max_cents"];
4
+ if (!value || typeof value !== "object" || Array.isArray(value)) {
5
+ throw new Error("Provide the exact signed-work authorization");
6
+ }
7
+ const body = value;
8
+ const allowed = new Set([...required, "authority_id"]);
9
+ if (!required.every(key => Object.hasOwn(body, key)) || Object.keys(body).some(key => !allowed.has(key))) {
10
+ throw new Error("Provide the exact quote identity, signature, maximum cents and request key");
11
+ }
12
+ if (typeof body.quote_id !== "string" || !body.quote_id ||
13
+ typeof body.quote_hash !== "string" || !/^[0-9a-f]{64}$/.test(body.quote_hash)) {
14
+ throw new Error("The reviewed quote identity and signature are required");
15
+ }
16
+ if (typeof body.idempotency_key !== "string" || body.idempotency_key.length < 8 || body.idempotency_key.length > 128) {
17
+ throw new Error("Use a stable request key containing 8 to 128 characters");
18
+ }
19
+ if (typeof body.confirm_max_cents !== "number" || !Number.isSafeInteger(body.confirm_max_cents) || body.confirm_max_cents < 0) {
20
+ throw new Error("The approved maximum must be an explicit nonnegative integer in cents");
21
+ }
22
+ if (body.authority_id !== undefined && body.authority_id !== null && typeof body.authority_id !== "string") {
23
+ throw new Error("Authority must be an explicit existing identifier");
24
+ }
25
+ }
@@ -0,0 +1,304 @@
1
+ /** OpenAPI-aligned SPECSTREAM SDK: compile, quote capacity work, explicitly authorize, receive a Delivery. */
2
+ import type { Schemas } from "./work-types.js";
3
+ export type { Schemas } from "./work-types.js";
4
+ export declare const FAMILIES: readonly ["local_business", "creator", "organization", "storefront_product", "app_listing", "job_posting", "scholarly_work", "tender", "grant", "software_repository", "software_package", "dataset", "clinical_trial", "regulatory_document", "vulnerability", "book", "podcast", "web_page", "knowledge_entity", "person"];
5
+ export type EntityType = (typeof FAMILIES)[number];
6
+ export declare const DEFAULT_BASE_URL = "https://api.specstream.ai";
7
+ export declare class SpecstreamError extends Error {
8
+ readonly status: number | null;
9
+ readonly body: unknown;
10
+ readonly code: string | null;
11
+ readonly details: Record<string, unknown>;
12
+ constructor(message: string, status?: number | null, body?: unknown);
13
+ }
14
+ export declare function assertFamily(entityType: string): EntityType;
15
+ export type FetchFn = (input: string, init?: RequestInit) => Promise<Response>;
16
+ export type ClientOptions = {
17
+ apiKey: string;
18
+ baseUrl?: string;
19
+ fetch?: FetchFn;
20
+ exportOrigin?: string;
21
+ timeoutMs?: number;
22
+ };
23
+ export type JsonMap = Record<string, unknown>;
24
+ export declare class Client {
25
+ readonly apiKey: string;
26
+ readonly baseUrl: string;
27
+ private readonly fetchFn;
28
+ private readonly exportOrigin?;
29
+ private readonly timeoutMs;
30
+ constructor(options: ClientOptions);
31
+ families(): readonly EntityType[];
32
+ compile(q: string, locale?: string): Promise<JsonMap>;
33
+ editSpec(ast: JsonMap, operations?: JsonMap[]): Promise<JsonMap>;
34
+ specOptions(target: string): Promise<JsonMap>;
35
+ getFind(findId: string): Promise<JsonMap>;
36
+ revisit(findId: string, after?: string, limit?: number): Promise<JsonMap>;
37
+ rows(findId: string, cursor?: string | null, limit?: number): Promise<Schemas["FindRowsPage"]>;
38
+ export(findId: string, format?: string): Promise<JsonMap>;
39
+ /** Fetch a fresh one-use export. Account credentials never accompany its capability. */
40
+ downloadExport(findId: string, format?: "xlsx" | "csv" | "json" | "html", maxBytes?: number): Promise<Uint8Array>;
41
+ getVocabulary(): Promise<Schemas["VocabularyData"]>;
42
+ workspaceListAuditEvents(query?: {
43
+ "project_id"?: string;
44
+ "actor_account_id"?: string;
45
+ "cursor"?: string;
46
+ "kind"?: "Sign-in" | "Access" | "Spending" | "Exports" | "Automation" | "Lists";
47
+ "limit"?: number;
48
+ }): Promise<Schemas["WorkspaceAuditPage"]>;
49
+ understandLive(request: Schemas["LiveUnderstandingRequest"]): Promise<Schemas["LiveUnderstandingResult"]>;
50
+ workspaceSearch(query: {
51
+ "q": string;
52
+ "limit"?: number;
53
+ "cursor"?: string;
54
+ }): Promise<Schemas["WorkspaceSearchPage"]>;
55
+ workspaceListNotifications(query?: {
56
+ "tab"?: "all" | "unread" | "archived";
57
+ "limit"?: number;
58
+ "cursor"?: string;
59
+ }): Promise<Schemas["WorkspaceNotificationPage"]>;
60
+ workspaceUpdateNotification(identifier: string, request: Schemas["NotificationPatch"]): Promise<Schemas["WorkspaceNotification"]>;
61
+ workspaceReadNotifications(request: Schemas["NotificationRead"]): Promise<Schemas["WorkspaceNotifications"]>;
62
+ getMe(): Promise<Schemas["MeData"]>;
63
+ getAccount(): Promise<Schemas["AccountData"]>;
64
+ listAccountKeys(): Promise<{
65
+ "keys": Array<Schemas["KeyListItem"]>;
66
+ }>;
67
+ createAccountKey(request: Schemas["KeyCreateRequest"]): Promise<Schemas["KeyCreateData"]>;
68
+ updateAccountSpend(request: Schemas["AccountSpendRequest"]): Promise<Schemas["AccountSpendData"]>;
69
+ revokeAccountKey(keyId: string): Promise<{
70
+ "revoked": true;
71
+ }>;
72
+ getFindCommerce(findId: string): Promise<Schemas["CommerceData"]>;
73
+ reconcileFindCommerce(findId: string): Promise<Schemas["CommerceData"]>;
74
+ cancelFind(findId: string): Promise<Schemas["CancelData"]>;
75
+ shareFind(findId: string, request: Schemas["ShareCreateRequest"]): Promise<Schemas["ShareData"]>;
76
+ revokeShare(shareId: string, request?: Schemas["ShareRevokeRequest"]): Promise<{
77
+ "share_id": string;
78
+ "revoked": true;
79
+ }>;
80
+ createSpec(request: Schemas["SpecCreateRequest"]): Promise<Schemas["SavedSpec"]>;
81
+ listSpecs(query?: {
82
+ "limit"?: number;
83
+ "cursor"?: string;
84
+ "project_id"?: string;
85
+ "archived"?: boolean;
86
+ }): Promise<Schemas["SpecPage"]>;
87
+ getSpec(specId: string): Promise<Schemas["SavedSpec"]>;
88
+ reviseSpec(specId: string, request: Schemas["SpecRevisionRequest"]): Promise<Schemas["SavedSpec"]>;
89
+ listSpecRevisions(specId: string, query?: {
90
+ "limit"?: number;
91
+ "cursor"?: string;
92
+ }): Promise<Schemas["RevisionPage"]>;
93
+ getSpecRevision(specId: string, revisionId: string): Promise<Schemas["SpecRevision"]>;
94
+ archiveSpec(specId: string, request: Schemas["SpecArchiveRequest"]): Promise<Schemas["SavedSpec"]>;
95
+ listSpecFinds(specId: string, query?: {
96
+ "limit"?: number;
97
+ "cursor"?: string;
98
+ }): Promise<Schemas["LineagePage"]>;
99
+ getFindLineage(findId: string): Promise<Schemas["FindLineage"]>;
100
+ getDelivery(findId: string): Promise<Schemas["DeliveryProjection"]>;
101
+ getFindDecisions(findId: string, query?: {
102
+ "limit"?: number;
103
+ "cursor"?: string;
104
+ }): Promise<Schemas["DecisionPage"]>;
105
+ createProject(request: Schemas["ProjectCreateRequest"]): Promise<Schemas["Project"]>;
106
+ listProjects(query?: {
107
+ "limit"?: number;
108
+ "cursor"?: string;
109
+ }): Promise<Schemas["ProjectPage"]>;
110
+ getProject(projectId: string): Promise<Schemas["Project"]>;
111
+ updateProject(projectId: string, request: Schemas["ProjectPatchRequest"]): Promise<Schemas["Project"]>;
112
+ putProjectMember(projectId: string, request: Schemas["ProjectMemberRequest"]): Promise<Schemas["ProjectMember"]>;
113
+ listProjectMembers(projectId: string, query?: {
114
+ "limit"?: number;
115
+ "cursor"?: string;
116
+ }): Promise<Schemas["MemberPage"]>;
117
+ revokeProjectMember(projectId: string, accountId: string): Promise<Schemas["MemberRevokeData"]>;
118
+ listCustomerWebhooks(): Promise<Schemas["CustomerWebhookListData"]>;
119
+ createCustomerWebhook(request: Schemas["CustomerWebhookRequest"]): Promise<Schemas["CustomerWebhookData"]>;
120
+ revokeCustomerWebhook(hookId: string): Promise<{
121
+ "revoked": boolean;
122
+ }>;
123
+ getCapacityCatalog(): Promise<{
124
+ [key: string]: unknown;
125
+ }>;
126
+ getCapacityBalance(query?: {
127
+ "project_id"?: string;
128
+ }): Promise<Schemas["CapacityBalanceData"]>;
129
+ getCapacityEntitlements(query?: {
130
+ "project_id"?: string;
131
+ }): Promise<Schemas["CapacityEntitlementsData"]>;
132
+ getCapacityReferral(): Promise<Schemas["CapacityReferralData"]>;
133
+ captureCapacityReferral(request: Schemas["CapacityReferralVisitRequest"]): Promise<Schemas["CapacityReferralVisitData"]>;
134
+ getCapacityHistory(): Promise<Schemas["CapacityHistoryData"]>;
135
+ claimFreeCapacity(): Promise<Schemas["CapacityBalanceData"]>;
136
+ setCapacityBudget(request: Schemas["CapacityBalanceLimitRequest"]): Promise<{
137
+ [key: string]: unknown;
138
+ }>;
139
+ quoteCapacityWork(request: Schemas["CapacityQuoteRequest"]): Promise<Schemas["CapacityQuoteData"]>;
140
+ getCapacityQuote(quoteId: string): Promise<Schemas["CapacityQuoteData"]>;
141
+ authorizeCapacityWork(request: Schemas["CapacityAuthorizeRequest"]): Promise<Schemas["CapacityExecutionData"]>;
142
+ getCapacityRequest(requestKey: string, query?: {
143
+ "project_id"?: string;
144
+ }): Promise<{
145
+ [key: string]: unknown;
146
+ }>;
147
+ getCapacityExecution(findId: string): Promise<Schemas["CommerceData"]>;
148
+ createCapacityFunding(request: Schemas["CapacityFundingRequest"]): Promise<Schemas["CapacityFundingData"]>;
149
+ getCapacityFunding(fundingId: string): Promise<Schemas["CapacityFundingData"]>;
150
+ cancelCapacityFunding(fundingId: string): Promise<Schemas["CapacityFundingData"]>;
151
+ getCapacityMembership(): Promise<Schemas["CapacityMembershipStatusData"]>;
152
+ changeCapacityMembership(request: Schemas["CapacityMembershipRequest"]): Promise<{
153
+ [key: string]: unknown;
154
+ }>;
155
+ createCapacityAuthority(request: Schemas["CapacityAuthorityRequest"]): Promise<{
156
+ [key: string]: unknown;
157
+ }>;
158
+ revokeCapacityAuthority(authorityId: string): Promise<{
159
+ [key: string]: unknown;
160
+ }>;
161
+ createCapacitySchedule(request: Schemas["CapacityScheduleRequest"]): Promise<{
162
+ [key: string]: unknown;
163
+ }>;
164
+ listCapacitySchedules(query?: {
165
+ "project_id"?: string;
166
+ "after"?: string;
167
+ "limit"?: number;
168
+ }): Promise<{
169
+ [key: string]: unknown;
170
+ }>;
171
+ updateCapacitySchedule(scheduleId: string, request: Schemas["CapacitySchedulePatch"]): Promise<{
172
+ [key: string]: unknown;
173
+ }>;
174
+ listCapacityOccurrences(scheduleId: string, query?: {
175
+ "before"?: string;
176
+ "limit"?: number;
177
+ }): Promise<{
178
+ [key: string]: unknown;
179
+ }>;
180
+ runCapacityScheduleNow(scheduleId: string): Promise<{
181
+ [key: string]: unknown;
182
+ }>;
183
+ createCapacityRefundClaim(request: Schemas["CapacityRefundRequest"]): Promise<{
184
+ [key: string]: unknown;
185
+ }>;
186
+ listCapacityRefundClaims(): Promise<Schemas["CapacityRefundClaimsData"]>;
187
+ getCapacityRefundClaim(claimId: string): Promise<{
188
+ [key: string]: unknown;
189
+ }>;
190
+ requestCapacityCustomPlan(request: Schemas["CapacityCustomRequest"]): Promise<{
191
+ [key: string]: unknown;
192
+ }>;
193
+ getCapacityStoreConfig(): Promise<{
194
+ [key: string]: unknown;
195
+ }>;
196
+ verifyCapacityStorePurchase(request: Schemas["StorePurchaseRequest"]): Promise<{
197
+ [key: string]: unknown;
198
+ }>;
199
+ restoreCapacityStorePurchases(request: Schemas["StoreRestoreRequest"]): Promise<{
200
+ [key: string]: unknown;
201
+ }>;
202
+ transferCapacityStoreToCard(request: Schemas["StoreCardTransferRequest"]): Promise<{
203
+ [key: string]: unknown;
204
+ }>;
205
+ createSpecLink(specId: string, request: Schemas["SpecLinkRequest"]): Promise<Schemas["SpecLinkData"]>;
206
+ getSharedSpec(token: string): Promise<Schemas["SharedSpec"]>;
207
+ revokeSpecLink(specId: string, linkId: string): Promise<Schemas["SpecLinkRevoked"]>;
208
+ workspaceSetScheduleDelivery(scheduleId: string, request: Schemas["ScheduleDeliveryInput"]): Promise<Schemas["ScheduleDeliveryData"]>;
209
+ workspaceListCollections(query?: {
210
+ "project_id"?: string;
211
+ "after"?: string;
212
+ "limit"?: number;
213
+ "sort"?: "id" | "recent";
214
+ }): Promise<Schemas["WorkspaceCollectionPage"]>;
215
+ workspaceReadCollection(collectionId: string): Promise<Schemas["WorkspaceCollection"]>;
216
+ workspaceCombineCollections(request: Schemas["CombineCollectionsInput"]): Promise<Schemas["WorkspaceCollection"]>;
217
+ workspaceCopyCollection(collectionId: string, request: Schemas["CopyCollectionInput"]): Promise<Schemas["WorkspaceCollection"]>;
218
+ workspaceFilterCollection(collectionId: string, request: Schemas["CollectionFilter"]): Promise<Schemas["WorkspaceCollection"]>;
219
+ workspaceListViews(collectionId: string): Promise<Schemas["WorkspaceViewList"]>;
220
+ workspaceSaveView(collectionId: string, request: Schemas["WorkspaceViewSave"]): Promise<Schemas["WorkspaceViewList"]>;
221
+ workspaceListStars(): Promise<Schemas["WorkspaceStarList"]>;
222
+ workspaceStarItem(request: Schemas["WorkspaceStarWrite"]): Promise<Schemas["WorkspaceStarList"]>;
223
+ workspaceListNotes(query?: {
224
+ "project_id"?: string;
225
+ "collection_id"?: string;
226
+ "record_id"?: string;
227
+ }): Promise<Schemas["WorkspaceNotes"]>;
228
+ workspaceAddNote(request: Schemas["WorkspaceNoteAdd"]): Promise<Schemas["WorkspaceNotes"]>;
229
+ workspaceResolveNote(noteId: string, request: Schemas["WorkspaceNoteResolve"]): Promise<Schemas["WorkspaceNotes"]>;
230
+ workspaceEditNote(noteId: string, request: Schemas["WorkspaceNoteEdit"]): Promise<Schemas["WorkspaceNotes"]>;
231
+ workspaceDeleteNote(noteId: string, request: Schemas["WorkspaceNoteDelete"]): Promise<Schemas["WorkspaceNotes"]>;
232
+ workspaceRegisterWebPushSubscription(request: Schemas["WebPushSubscriptionInput"]): Promise<Schemas["PushDevice"]>;
233
+ workspacePushCapabilities(): Promise<Schemas["PushCapabilities"]>;
234
+ workspaceListPushDevices(): Promise<Schemas["PushDevicePage"]>;
235
+ workspaceRegisterPushDevice(request: Schemas["PushDeviceInput"]): Promise<Schemas["PushDevice"]>;
236
+ workspaceRevokePushDevice(deviceId: string): Promise<Schemas["PushDeviceRevoked"]>;
237
+ workspaceListYourFields(collectionId: string): Promise<Schemas["YourFields"]>;
238
+ workspaceSaveYourFields(collectionId: string, request: Schemas["YourFieldsSave"]): Promise<Schemas["YourFields"]>;
239
+ workspaceSetYourFieldValue(collectionId: string, request: Schemas["YourFieldValue"]): Promise<Schemas["YourFields"]>;
240
+ beginConnectionAuthorization(provider: string): Promise<Schemas["ConnectedToolData"]>;
241
+ disconnectConnection(connectionId: string): Promise<Schemas["ConnectedToolData"]>;
242
+ listCloudImports(): Promise<Schemas["ConnectedToolData"]>;
243
+ listConnectedTools(): Promise<Schemas["ConnectedToolData"]>;
244
+ listConnections(): Promise<Schemas["ConnectedToolData"]>;
245
+ listConnectionDestinations(connectionId: string, query?: {
246
+ "base_id"?: string;
247
+ "cursor"?: string;
248
+ }): Promise<Schemas["ConnectedToolData"]>;
249
+ getConnectionColumns(connectionId: string, request: Schemas["DestinationRequest"]): Promise<Schemas["ConnectedToolData"]>;
250
+ saveConnectionDestination(connectionId: string, request: Schemas["DestinationRequest"]): Promise<Schemas["ConnectedToolData"]>;
251
+ sendToDestination(connectionId: string, request: Schemas["SendToDestinationInput"]): Promise<Schemas["ConnectedToolData"]>;
252
+ reconcileDestinationExport(connectionId: string, exportId: string): Promise<Schemas["ConnectedToolData"]>;
253
+ listDestinationExports(): Promise<Schemas["ConnectedToolData"]>;
254
+ createDestinationSync(request: Schemas["DestinationSyncInput"]): Promise<Schemas["ConnectedToolData"]>;
255
+ updateDestinationSync(syncId: string, request: Schemas["DestinationSyncUpdate"]): Promise<Schemas["ConnectedToolData"]>;
256
+ listDestinationSyncs(): Promise<Schemas["ConnectedToolData"]>;
257
+ previewCloudList(request: Schemas["CloudImportPreview"]): Promise<Schemas["ConnectedToolData"]>;
258
+ importCloudList(request: Schemas["CloudImportInput"]): Promise<Schemas["ConnectedToolData"]>;
259
+ updateCloudImport(importId: string, request: Schemas["CloudImportUpdate"]): Promise<Schemas["ConnectedToolData"]>;
260
+ workspaceInviteMember(request: Schemas["InvitationInput"]): Promise<Schemas["InvitationData"]>;
261
+ importFileCommand(request: Schemas["FileImportCommand"]): Promise<Schemas["WorkspaceImportData"]>;
262
+ workspaceActivity(query?: {
263
+ "project_id"?: string;
264
+ "cursor"?: string;
265
+ "limit"?: number;
266
+ }): Promise<Schemas["ActivityPage"]>;
267
+ workspaceRelationships(collectionId: string, query?: {
268
+ "field_id"?: string;
269
+ }): Promise<Schemas["RelationshipData"]>;
270
+ workspaceSaveRelationships(collectionId: string, request: Schemas["RelationshipSelection"]): Promise<Schemas["RelationshipData"]>;
271
+ workspaceReportResult(collectionId: string, request: Schemas["ResultReportInput"]): Promise<Schemas["ResultReportData"]>;
272
+ listRequestTemplates(query?: {
273
+ "record_type"?: string;
274
+ }): Promise<Schemas["RequestTemplateList"]>;
275
+ workspaceCollectionChanges(collectionId: string): Promise<Schemas["WorkspaceCollectionChanges"]>;
276
+ workspaceListPasskeys(): Promise<Schemas["PasskeyList"]>;
277
+ workspaceRegisterPasskeyOptions(): Promise<Schemas["SecurityChallenge"]>;
278
+ workspaceRegisterPasskey(request: Schemas["PasskeyRegistration"]): Promise<Schemas["PasskeyData"]>;
279
+ workspaceNamePasskey(credentialId: string, request: Schemas["PasskeyLabel"]): Promise<Schemas["PasskeyData"]>;
280
+ workspaceDeletePasskey(credentialId: string): Promise<Schemas["SecuritySuccess"]>;
281
+ workspacePasskeySignInOptions(): Promise<Schemas["SecurityChallenge"]>;
282
+ workspacePasskeySignIn(request: Schemas["PasskeyComplete"]): Promise<Schemas["SecuritySuccess"]>;
283
+ workspaceListSSODomains(): Promise<Schemas["SSODomains"]>;
284
+ workspaceAddSSODomain(request: Schemas["SSODomainInput"]): Promise<Schemas["SSODomain"]>;
285
+ workspaceVerifySSODomain(domainId: string): Promise<Schemas["SSODomain"]>;
286
+ workspaceConfigureSSO(domainId: string, request: Schemas["SSOConfigInput"]): Promise<Schemas["SSODomain"]>;
287
+ workspaceSetSSOPolicy(domainId: string, request: Schemas["SSOPolicyInput"]): Promise<Schemas["SSODomain"]>;
288
+ workspaceStartSSO(request: Schemas["SSOStartInput"]): Promise<Schemas["SSOStartData"]>;
289
+ workspaceRotateSCIMToken(domainId: string): Promise<Schemas["SCIMCredential"]>;
290
+ workspaceRevokeSCIMToken(domainId: string): Promise<Schemas["SecuritySuccess"]>;
291
+ workspaceReadSCIMMappings(domainId: string): Promise<Schemas["SCIMProvisioning"]>;
292
+ workspaceSetSCIMMappings(domainId: string, request: Schemas["SCIMMappings"]): Promise<Schemas["SCIMMappings"]>;
293
+ workspaceReadPhoto(): Promise<Schemas["AccountPhotoData"]>;
294
+ workspaceDeletePhoto(): Promise<Schemas["AccountPhotoData"]>;
295
+ workspaceStartNativeProvider(request: Schemas["NativeAuthStart"]): Promise<Schemas["NativeAuthStartData"]>;
296
+ workspaceRedeemNativeProvider(request: Schemas["NativeAuthRedeem"]): Promise<Schemas["NativeAuthRedeemData"]>;
297
+ workspacePlacementAllowance(): Promise<Schemas["PlacementMonthlyData"]>;
298
+ workspaceQuotePlacement(importId: string): Promise<Schemas["PlacementQuoteData"]>;
299
+ workspaceStartPlacement(importId: string, request: Schemas["PlacementStartInput"]): Promise<Schemas["PlacementStatusData"]>;
300
+ workspacePlacementStatus(importId: string, placementId: string): Promise<Schemas["PlacementStatusData"]>;
301
+ private headers;
302
+ private request;
303
+ }
304
+ export default Client;