@wix/auto_sdk_connectors_connectors 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.
@@ -0,0 +1,652 @@
1
+ import { GetConnectorRequest as GetConnectorRequest$1, GetConnectorResponse as GetConnectorResponse$1, DeleteConnectorRequest as DeleteConnectorRequest$1, DeleteConnectorResponse as DeleteConnectorResponse$1, QueryConnectorsRequest as QueryConnectorsRequest$1, QueryConnectorsResponse as QueryConnectorsResponse$1, StartConnectRequest as StartConnectRequest$1, StartConnectResponse as StartConnectResponse$1, DispatchRequest as DispatchRequest$1, RawHttpResponse as RawHttpResponse$1, ListMcpToolsRequest as ListMcpToolsRequest$1, ListMcpToolsResponse as ListMcpToolsResponse$1 } from './index.typings.js';
2
+ import '@wix/sdk-types';
3
+
4
+ /**
5
+ * Not a taggable product resource: it carries no OAuth credential of its own (that lives on the
6
+ * shared wix.connectors_access_keys.v1.ConnectorAccessKey), only binding data.
7
+ */
8
+ interface Connector extends ConnectorRegistrationOneOf {
9
+ /** Curated owner: the connector app + CONNECTOR_CONFIG component this connection was created against. */
10
+ predefinedRegistration?: PredefinedRegistration;
11
+ /** Dynamic owner: the provider registration this connection was created against. */
12
+ dynamicRegistration?: DynamicRegistration;
13
+ /**
14
+ * SDL derives this entity's owner from identity.targetAccountId; do not add account_id.
15
+ * @format GUID
16
+ * @readonly
17
+ */
18
+ id?: string | null;
19
+ /**
20
+ * Optimistic-lock revision assigned by SDL.
21
+ * @readonly
22
+ */
23
+ revision?: string | null;
24
+ /**
25
+ * Time at which SDL created the Connector.
26
+ * @readonly
27
+ */
28
+ createdDate?: Date | null;
29
+ /**
30
+ * Time at which SDL last updated the Connector.
31
+ * @readonly
32
+ */
33
+ updatedDate?: Date | null;
34
+ /**
35
+ * Stable identifier of the connector implementation, for example "github".
36
+ * @maxLength 80
37
+ * @immutable
38
+ */
39
+ connectorSlug?: string;
40
+ /** Whether the Connector is account-owned or restricted to the consenting user. */
41
+ exposure?: ExposureWithLiterals;
42
+ /**
43
+ * Best-effort snapshot of the shared access key's credential_state, maintained by consuming
44
+ * AccessKeyBindingPushed off connectors-access-keys-store's own state-change events. NEVER a source
45
+ * of truth and NEVER an authorization input -- under event lag this can read ACTIVE while the key is
46
+ * REVOKED. It exists only to answer "what should be shown to the user"; every credential-usability
47
+ * decision (dispatch, revocation, anything that gates behavior) must keep reading
48
+ * connectors-access-keys-store synchronously. The same rule covers filtering by this field: a query
49
+ * for credential_state == ACTIVE returns what the platform last believed, never a permission to use
50
+ * those bindings. UNKNOWN_CREDENTIAL_STATE means no push has ever arrived for the bound access key --
51
+ * including every row that predates this projection -- and is never a signal of a healthy connection.
52
+ * Server-owned: no create or update path accepts a caller-supplied value for it. When a push carries
53
+ * the source event's own timestamp, that timestamp is tracked on the domain row (not exposed on this
54
+ * contract) and a later push older than the stored value is dropped; a push with no timestamp only
55
+ * ever initializes a row that has never recorded one, never overwrites an already-timestamped
56
+ * snapshot.
57
+ * @readonly
58
+ */
59
+ credentialState?: CredentialStateWithLiterals;
60
+ /**
61
+ * Deprecated: use registration.predefined_registration.app_id. Retained for callers still on the
62
+ * flat field. Empty for a dynamic (registration-owned) connector.
63
+ * @format GUID
64
+ * @immutable
65
+ * @deprecated
66
+ * @replacedBy predefined_registration.app_id
67
+ * @targetRemovalDate 2027-06-30
68
+ */
69
+ appId?: string;
70
+ /**
71
+ * Deprecated: use registration.predefined_registration.component_id.
72
+ * @format GUID
73
+ * @immutable
74
+ * @deprecated
75
+ * @replacedBy predefined_registration.component_id
76
+ * @targetRemovalDate 2027-06-30
77
+ */
78
+ componentId?: string;
79
+ /** Non-secret discriminant of the owner kind, aligned with the oneof above. */
80
+ registrationType?: RegistrationTypeWithLiterals;
81
+ }
82
+ /** @oneof */
83
+ interface ConnectorRegistrationOneOf {
84
+ /** Curated owner: the connector app + CONNECTOR_CONFIG component this connection was created against. */
85
+ predefinedRegistration?: PredefinedRegistration;
86
+ /** Dynamic owner: the provider registration this connection was created against. */
87
+ dynamicRegistration?: DynamicRegistration;
88
+ }
89
+ declare enum Exposure {
90
+ /** The Connector is owned and usable by its account. */
91
+ ACCOUNT = "ACCOUNT",
92
+ /** The Connector is restricted to its consenting user. */
93
+ USER = "USER"
94
+ }
95
+ /** @enumType */
96
+ type ExposureWithLiterals = Exposure | 'ACCOUNT' | 'USER';
97
+ /**
98
+ * Provider-reported granted scopes, preserving the distinction between a provider that never reports
99
+ * scopes and one that explicitly reports an empty set.
100
+ */
101
+ interface GrantedScopes {
102
+ /** Whether the provider has reported a granted-scopes set for this credential. */
103
+ reportingState?: ScopeReportingStateWithLiterals;
104
+ /**
105
+ * The scopes the provider reported. Meaningful only when reporting_state is REPORTED: an empty list
106
+ * there means the provider explicitly reported no granted scopes (known-empty), not that reporting is
107
+ * unknown.
108
+ * @maxSize 40
109
+ * @maxLength 70
110
+ */
111
+ scopes?: string[];
112
+ }
113
+ declare enum ScopeReportingState {
114
+ /** The provider has not reported a granted-scopes set for this credential. */
115
+ NOT_REPORTED = "NOT_REPORTED",
116
+ /** The provider reported a granted-scopes set, which may itself be empty. */
117
+ REPORTED = "REPORTED"
118
+ }
119
+ /** @enumType */
120
+ type ScopeReportingStateWithLiterals = ScopeReportingState | 'NOT_REPORTED' | 'REPORTED';
121
+ /** Reused verbatim from wix.connectors.v1. */
122
+ declare enum CredentialState {
123
+ ACTIVE = "ACTIVE",
124
+ REVOKED = "REVOKED"
125
+ }
126
+ /** @enumType */
127
+ type CredentialStateWithLiterals = CredentialState | 'ACTIVE' | 'REVOKED';
128
+ /** Curated owner: the connector app plus CONNECTOR_CONFIG component a connection was created against. */
129
+ interface PredefinedRegistration {
130
+ /**
131
+ * The connector app that declares the CONNECTOR_CONFIG component.
132
+ * @format GUID
133
+ * @immutable
134
+ */
135
+ appId?: string;
136
+ /**
137
+ * The CONNECTOR_CONFIG component within that app — the stable address for the connector's config.
138
+ * @format GUID
139
+ * @immutable
140
+ */
141
+ componentId?: string;
142
+ }
143
+ /**
144
+ * Dynamic owner: the wix.connectors.registry.v1.mcp_server_registration a connection was created
145
+ * against, for a DCR connector reached by URL. Shared per provider rather than per app/component.
146
+ */
147
+ interface DynamicRegistration {
148
+ /**
149
+ * The provider-registry McpServerRegistration this connection was created against.
150
+ * @format GUID
151
+ * @immutable
152
+ */
153
+ registrationId?: string;
154
+ }
155
+ /** Which kind of owner this connection belongs to. */
156
+ declare enum RegistrationType {
157
+ /** Owned by a connector app/component (curated). */
158
+ PREDEFINED = "PREDEFINED",
159
+ /** Owned by a provider registration (DCR). */
160
+ DYNAMIC = "DYNAMIC"
161
+ }
162
+ /** @enumType */
163
+ type RegistrationTypeWithLiterals = RegistrationType | 'PREDEFINED' | 'DYNAMIC';
164
+ interface CreateConnectorRequest {
165
+ /** Durable OAuth Connector to persist in the target account tenant. */
166
+ connector?: Connector;
167
+ }
168
+ interface CreateConnectorResponse {
169
+ /** The persisted Connector. */
170
+ connector?: Connector;
171
+ }
172
+ interface GetConnectorRequest {
173
+ /**
174
+ * ID of the Connector to retrieve.
175
+ * @format GUID
176
+ */
177
+ connectorId: string;
178
+ }
179
+ interface GetConnectorResponse {
180
+ /** The requested Connector. */
181
+ connector?: Connector;
182
+ }
183
+ interface DeleteConnectorRequest {
184
+ /**
185
+ * ID of the Connector to move to the trash bin.
186
+ * @format GUID
187
+ */
188
+ connectorId: string;
189
+ }
190
+ interface DeleteConnectorResponse {
191
+ }
192
+ interface QueryConnectorsRequest {
193
+ /** Filter, sort, and cursor paging arguments for Connectors in the target account tenant. */
194
+ query?: CursorQuery;
195
+ }
196
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
197
+ /**
198
+ * Cursor paging options.
199
+ *
200
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
201
+ */
202
+ cursorPaging?: CursorPaging;
203
+ /**
204
+ * Filter object.
205
+ *
206
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
207
+ */
208
+ filter?: Record<string, any> | null;
209
+ /**
210
+ * Sort object.
211
+ *
212
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
213
+ * @maxSize 5
214
+ */
215
+ sort?: Sorting[];
216
+ }
217
+ /** @oneof */
218
+ interface CursorQueryPagingMethodOneOf {
219
+ /**
220
+ * Cursor paging options.
221
+ *
222
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
223
+ */
224
+ cursorPaging?: CursorPaging;
225
+ }
226
+ interface Sorting {
227
+ /**
228
+ * Name of the field to sort by.
229
+ * @maxLength 512
230
+ */
231
+ fieldName?: string;
232
+ /** Sort order. */
233
+ order?: SortOrderWithLiterals;
234
+ }
235
+ declare enum SortOrder {
236
+ ASC = "ASC",
237
+ DESC = "DESC"
238
+ }
239
+ /** @enumType */
240
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
241
+ interface CursorPaging {
242
+ /**
243
+ * Maximum number of items to return in the results.
244
+ * @max 100
245
+ */
246
+ limit?: number | null;
247
+ /**
248
+ * Pointer to the next or previous page in the list of results.
249
+ *
250
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
251
+ * Not relevant for the first request.
252
+ * @maxLength 16000
253
+ */
254
+ cursor?: string | null;
255
+ }
256
+ interface QueryConnectorsResponse {
257
+ /** Connectors from the target account tenant. Protected fields require their own permissions. */
258
+ connectors?: Connector[];
259
+ /** Cursor information for the next or previous page. */
260
+ pagingMetadata?: CursorPagingMetadata;
261
+ }
262
+ interface CursorPagingMetadata {
263
+ /** Number of items returned in current page. */
264
+ count?: number | null;
265
+ /** Cursor strings that point to the next page, previous page, or both. */
266
+ cursors?: Cursors;
267
+ /**
268
+ * Whether there are more pages to retrieve following the current page.
269
+ *
270
+ * + `true`: Another page of results can be retrieved.
271
+ * + `false`: This is the last page.
272
+ */
273
+ hasNext?: boolean | null;
274
+ }
275
+ interface Cursors {
276
+ /**
277
+ * Cursor string pointing to the next page in the list of results.
278
+ * @maxLength 16000
279
+ */
280
+ next?: string | null;
281
+ /**
282
+ * Cursor pointing to the previous page in the list of results.
283
+ * @maxLength 16000
284
+ */
285
+ prev?: string | null;
286
+ }
287
+ interface StartConnectRequest extends StartConnectRequestOwnerOneOf {
288
+ /** Curated connect: the connector app + CONNECTOR_CONFIG component. */
289
+ predefinedRegistration?: PredefinedRegistration;
290
+ /**
291
+ * Dynamic (DCR) connect: the provider-registry McpServerRegistration reached by URL; the OAuth
292
+ * config comes from the registration rather than a CONNECTOR_CONFIG component.
293
+ */
294
+ dynamicRegistration?: DynamicRegistration;
295
+ /** Non-secret discriminant of the owner kind, aligned with the oneof above. */
296
+ registrationType?: StartConnectRequestRegistrationTypeWithLiterals;
297
+ /**
298
+ * Deprecated: use owner.predefined_registration.app_id. Retained for callers still on the flat
299
+ * field until they migrate to the owner oneof. Not GUID-typed: that format rejects the empty
300
+ * default a oneof-owner request carries, so this optional field only caps length.
301
+ * @maxLength 80
302
+ * @deprecated
303
+ * @replacedBy predefined_registration.app_id
304
+ * @targetRemovalDate 2027-06-30
305
+ */
306
+ appId?: string;
307
+ /**
308
+ * Deprecated: use owner.predefined_registration.component_id.
309
+ * @maxLength 80
310
+ * @deprecated
311
+ * @replacedBy predefined_registration.component_id
312
+ * @targetRemovalDate 2027-06-30
313
+ */
314
+ componentId?: string;
315
+ /**
316
+ * Requested exposure of the Connector this connect will produce. UNKNOWN_EXPOSURE is treated as
317
+ * ACCOUNT. USER requires an initiating Wix user identity on the call — its id is recorded as the
318
+ * Connector's consenting_user_id and the connection is then visible only to that user.
319
+ */
320
+ exposure?: ExposureWithLiterals;
321
+ /**
322
+ * Optional Wix URL to return the browser to after connect completes. Must pass the Wix-domain
323
+ * allowlist (validated server-side at GenerateAuthorizationUrl). When omitted, the fixed landing
324
+ * page is used. Carried through the handshake; the same URL is used for both success and error
325
+ * landings (with ?error= on failure). Not WEB_URL-typed: that format rejects the empty default, so
326
+ * this optional field only caps length here — the server-side allowlist is the real URL gate.
327
+ * @maxLength 2048
328
+ */
329
+ returnUrl?: string;
330
+ }
331
+ /** @oneof */
332
+ interface StartConnectRequestOwnerOneOf {
333
+ /** Curated connect: the connector app + CONNECTOR_CONFIG component. */
334
+ predefinedRegistration?: PredefinedRegistration;
335
+ /**
336
+ * Dynamic (DCR) connect: the provider-registry McpServerRegistration reached by URL; the OAuth
337
+ * config comes from the registration rather than a CONNECTOR_CONFIG component.
338
+ */
339
+ dynamicRegistration?: DynamicRegistration;
340
+ }
341
+ /** Which kind of owner this connect targets. */
342
+ declare enum StartConnectRequestRegistrationType {
343
+ /** Curated owner (app_id + component_id). */
344
+ PREDEFINED = "PREDEFINED",
345
+ /** Dynamic (DCR) owner (registration_id). */
346
+ DYNAMIC = "DYNAMIC"
347
+ }
348
+ /** @enumType */
349
+ type StartConnectRequestRegistrationTypeWithLiterals = StartConnectRequestRegistrationType | 'PREDEFINED' | 'DYNAMIC';
350
+ interface StartConnectResponse extends StartConnectResponseNextActionOneOf {
351
+ /** Redirect the caller's browser to complete the connect. */
352
+ redirect?: Redirect;
353
+ /** Nothing left to do — the connect is already finished. */
354
+ completed?: Completed;
355
+ /**
356
+ * Deprecated: read `next_action.redirect.url` instead. Still populated whenever the next action IS
357
+ * a redirect, so callers that have not migrated keep working; it is simply unable to express any
358
+ * other outcome, which is why it is being replaced rather than extended.
359
+ * @format WEB_URL
360
+ * @deprecated
361
+ * @replacedBy next_action.redirect.url
362
+ * @targetRemovalDate 2027-06-30
363
+ */
364
+ authorizationUrl?: string;
365
+ }
366
+ /** @oneof */
367
+ interface StartConnectResponseNextActionOneOf {
368
+ /** Redirect the caller's browser to complete the connect. */
369
+ redirect?: Redirect;
370
+ /** Nothing left to do — the connect is already finished. */
371
+ completed?: Completed;
372
+ }
373
+ /** Redirects the caller's browser to a provider authorization URL. */
374
+ interface Redirect {
375
+ /**
376
+ * Provider authorization URL to redirect the user's browser to.
377
+ * @format WEB_URL
378
+ */
379
+ url?: string;
380
+ }
381
+ /**
382
+ * The connect is already finished and the Connector exists; no user interaction happened or is needed.
383
+ * Returned for a provider that requires no authorization at all, where there is no authorization URL
384
+ * to visit and so no callback to return through.
385
+ */
386
+ interface Completed {
387
+ /**
388
+ * Id of the access key the resulting Connector is bound to.
389
+ * @format GUID
390
+ */
391
+ accessKeyId?: string;
392
+ }
393
+ interface DomainEvent extends DomainEventBodyOneOf {
394
+ createdEvent?: EntityCreatedEvent;
395
+ updatedEvent?: EntityUpdatedEvent;
396
+ deletedEvent?: EntityDeletedEvent;
397
+ actionEvent?: ActionEvent;
398
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
399
+ id?: string;
400
+ /**
401
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
402
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
403
+ */
404
+ entityFqdn?: string;
405
+ /**
406
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
407
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
408
+ */
409
+ slug?: string;
410
+ /** ID of the entity associated with the event. */
411
+ entityId?: string;
412
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
413
+ eventTime?: Date | null;
414
+ /**
415
+ * Whether the event was triggered as a result of a privacy regulation application
416
+ * (for example, GDPR).
417
+ */
418
+ triggeredByAnonymizeRequest?: boolean | null;
419
+ /** If present, indicates the action that triggered the event. */
420
+ originatedFrom?: string | null;
421
+ /**
422
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
423
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
424
+ */
425
+ entityEventSequence?: string | null;
426
+ }
427
+ /** @oneof */
428
+ interface DomainEventBodyOneOf {
429
+ createdEvent?: EntityCreatedEvent;
430
+ updatedEvent?: EntityUpdatedEvent;
431
+ deletedEvent?: EntityDeletedEvent;
432
+ actionEvent?: ActionEvent;
433
+ }
434
+ interface EntityCreatedEvent {
435
+ entityAsJson?: string;
436
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
437
+ restoreInfo?: RestoreInfo;
438
+ }
439
+ interface RestoreInfo {
440
+ deletedDate?: Date | null;
441
+ }
442
+ interface EntityUpdatedEvent {
443
+ /**
444
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
445
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
446
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
447
+ */
448
+ currentEntityAsJson?: string;
449
+ }
450
+ interface EntityDeletedEvent {
451
+ /** Entity that was deleted. */
452
+ deletedEntityAsJson?: string | null;
453
+ }
454
+ interface ActionEvent {
455
+ bodyAsJson?: string;
456
+ }
457
+ interface Empty {
458
+ }
459
+ interface MessageEnvelope {
460
+ /**
461
+ * App instance ID.
462
+ * @format GUID
463
+ */
464
+ instanceId?: string | null;
465
+ /**
466
+ * Event type.
467
+ * @maxLength 150
468
+ */
469
+ eventType?: string;
470
+ /** The identification type and identity data. */
471
+ identity?: IdentificationData;
472
+ /** Stringify payload. */
473
+ data?: string;
474
+ /** Details related to the account */
475
+ accountInfo?: AccountInfo;
476
+ }
477
+ interface IdentificationData extends IdentificationDataIdOneOf {
478
+ /**
479
+ * ID of a site visitor that has not logged in to the site.
480
+ * @format GUID
481
+ */
482
+ anonymousVisitorId?: string;
483
+ /**
484
+ * ID of a site visitor that has logged in to the site.
485
+ * @format GUID
486
+ */
487
+ memberId?: string;
488
+ /**
489
+ * ID of a Wix user (site owner, contributor, etc.).
490
+ * @format GUID
491
+ */
492
+ wixUserId?: string;
493
+ /**
494
+ * ID of an app.
495
+ * @format GUID
496
+ */
497
+ appId?: string;
498
+ /** @readonly */
499
+ identityType?: WebhookIdentityTypeWithLiterals;
500
+ }
501
+ /** @oneof */
502
+ interface IdentificationDataIdOneOf {
503
+ /**
504
+ * ID of a site visitor that has not logged in to the site.
505
+ * @format GUID
506
+ */
507
+ anonymousVisitorId?: string;
508
+ /**
509
+ * ID of a site visitor that has logged in to the site.
510
+ * @format GUID
511
+ */
512
+ memberId?: string;
513
+ /**
514
+ * ID of a Wix user (site owner, contributor, etc.).
515
+ * @format GUID
516
+ */
517
+ wixUserId?: string;
518
+ /**
519
+ * ID of an app.
520
+ * @format GUID
521
+ */
522
+ appId?: string;
523
+ }
524
+ declare enum WebhookIdentityType {
525
+ UNKNOWN = "UNKNOWN",
526
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
527
+ MEMBER = "MEMBER",
528
+ WIX_USER = "WIX_USER",
529
+ APP = "APP"
530
+ }
531
+ /** @enumType */
532
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
533
+ interface AccountInfo {
534
+ /**
535
+ * ID of the Wix account associated with the event.
536
+ * @format GUID
537
+ */
538
+ accountId?: string | null;
539
+ /**
540
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
541
+ * @format GUID
542
+ */
543
+ parentAccountId?: string | null;
544
+ /**
545
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
546
+ * @format GUID
547
+ */
548
+ siteId?: string | null;
549
+ }
550
+ interface DispatchRequest {
551
+ /**
552
+ * ID of the Connector to authorize in the caller's target account.
553
+ * @format GUID
554
+ */
555
+ connectorId: string;
556
+ /** Raw provider request. Callers must not include credentials; Wix injects them at dispatch. */
557
+ providerRequest: RawHttpRequest;
558
+ /**
559
+ * Optional caller-supplied key making a retry of this dispatch safe: the same key on the same
560
+ * connector will not produce a second provider attempt through Wix. Scoped to the connector, so
561
+ * callers need only make it unique per connector. Guarantees at-most-once ATTEMPT by Wix — it
562
+ * cannot guarantee the provider applied the effect at most once when an attempt's outcome is
563
+ * unknown (timeout, connection reset). For that, include the provider's own idempotency header in
564
+ * provider_request. A repeated key fails with a duplicate-dispatch error rather than replaying the
565
+ * original response, which Wix does not retain; callers needing it must store it themselves.
566
+ * @maxLength 128
567
+ */
568
+ idempotencyKey?: string;
569
+ }
570
+ interface RawHttpRequest {
571
+ body?: Uint8Array;
572
+ pathParams?: PathParametersEntry[];
573
+ queryParams?: QueryParametersEntry[];
574
+ headers?: HeadersEntry[];
575
+ method?: string;
576
+ rawPath?: string;
577
+ rawQuery?: string;
578
+ }
579
+ interface PathParametersEntry {
580
+ key?: string;
581
+ value?: string;
582
+ }
583
+ interface QueryParametersEntry {
584
+ key?: string;
585
+ value?: string;
586
+ }
587
+ interface HeadersEntry {
588
+ key?: string;
589
+ value?: string;
590
+ }
591
+ interface RawHttpResponse {
592
+ body?: Uint8Array;
593
+ statusCode?: number | null;
594
+ headers?: HeadersEntry[];
595
+ }
596
+ interface ListMcpToolsRequest {
597
+ /**
598
+ * ID of the Connector whose callable MCP tools are requested.
599
+ * @format GUID
600
+ */
601
+ connectorId: string;
602
+ }
603
+ interface ListMcpToolsResponse {
604
+ /**
605
+ * The server's advertised tools filtered by the connector's allowlist. Capped to match mcp_config.allowed_tools' own maximum; the runtime
606
+ * rejects a provider advertisement it cannot fit rather than returning an unbounded payload.
607
+ * @maxSize 200
608
+ */
609
+ tools?: McpTool[];
610
+ }
611
+ /** One MCP tool as advertised by the connector's MCP server. */
612
+ interface McpTool {
613
+ /**
614
+ * Tool name, exactly as the server advertises it.
615
+ * @maxLength 128
616
+ */
617
+ name?: string;
618
+ /**
619
+ * Human- and model-readable description of what the tool does, as provided by the server.
620
+ * @maxLength 10000
621
+ */
622
+ description?: string;
623
+ /** JSON Schema of the tool's arguments, as provided by the server. */
624
+ inputSchema?: Record<string, any> | null;
625
+ }
626
+
627
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
628
+ getUrl: (context: any) => string;
629
+ httpMethod: K;
630
+ path: string;
631
+ pathParams: M;
632
+ __requestType: T;
633
+ __originalRequestType: S;
634
+ __responseType: Q;
635
+ __originalResponseType: R;
636
+ };
637
+ declare function getConnector(): __PublicMethodMetaInfo<'GET', {
638
+ connectorId: string;
639
+ }, GetConnectorRequest$1, GetConnectorRequest, GetConnectorResponse$1, GetConnectorResponse>;
640
+ declare function deleteConnector(): __PublicMethodMetaInfo<'DELETE', {
641
+ connectorId: string;
642
+ }, DeleteConnectorRequest$1, DeleteConnectorRequest, DeleteConnectorResponse$1, DeleteConnectorResponse>;
643
+ declare function queryConnectors(): __PublicMethodMetaInfo<'POST', {}, QueryConnectorsRequest$1, QueryConnectorsRequest, QueryConnectorsResponse$1, QueryConnectorsResponse>;
644
+ declare function startConnect(): __PublicMethodMetaInfo<'POST', {}, StartConnectRequest$1, StartConnectRequest, StartConnectResponse$1, StartConnectResponse>;
645
+ declare function dispatcherDispatch(): __PublicMethodMetaInfo<'POST', {
646
+ connectorId: string;
647
+ }, DispatchRequest$1, DispatchRequest, RawHttpResponse$1, RawHttpResponse>;
648
+ declare function listMcpTools(): __PublicMethodMetaInfo<'GET', {
649
+ connectorId: string;
650
+ }, ListMcpToolsRequest$1, ListMcpToolsRequest, ListMcpToolsResponse$1, ListMcpToolsResponse>;
651
+
652
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type Completed as CompletedOriginal, type Connector as ConnectorOriginal, type ConnectorRegistrationOneOf as ConnectorRegistrationOneOfOriginal, type CreateConnectorRequest as CreateConnectorRequestOriginal, type CreateConnectorResponse as CreateConnectorResponseOriginal, CredentialState as CredentialStateOriginal, type CredentialStateWithLiterals as CredentialStateWithLiteralsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteConnectorRequest as DeleteConnectorRequestOriginal, type DeleteConnectorResponse as DeleteConnectorResponseOriginal, type DispatchRequest as DispatchRequestOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DynamicRegistration as DynamicRegistrationOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Exposure as ExposureOriginal, type ExposureWithLiterals as ExposureWithLiteralsOriginal, type GetConnectorRequest as GetConnectorRequestOriginal, type GetConnectorResponse as GetConnectorResponseOriginal, type GrantedScopes as GrantedScopesOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ListMcpToolsRequest as ListMcpToolsRequestOriginal, type ListMcpToolsResponse as ListMcpToolsResponseOriginal, type McpTool as McpToolOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PathParametersEntry as PathParametersEntryOriginal, type PredefinedRegistration as PredefinedRegistrationOriginal, type QueryConnectorsRequest as QueryConnectorsRequestOriginal, type QueryConnectorsResponse as QueryConnectorsResponseOriginal, type QueryParametersEntry as QueryParametersEntryOriginal, type RawHttpRequest as RawHttpRequestOriginal, type RawHttpResponse as RawHttpResponseOriginal, type Redirect as RedirectOriginal, RegistrationType as RegistrationTypeOriginal, type RegistrationTypeWithLiterals as RegistrationTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, ScopeReportingState as ScopeReportingStateOriginal, type ScopeReportingStateWithLiterals as ScopeReportingStateWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type StartConnectRequest as StartConnectRequestOriginal, type StartConnectRequestOwnerOneOf as StartConnectRequestOwnerOneOfOriginal, StartConnectRequestRegistrationType as StartConnectRequestRegistrationTypeOriginal, type StartConnectRequestRegistrationTypeWithLiterals as StartConnectRequestRegistrationTypeWithLiteralsOriginal, type StartConnectResponseNextActionOneOf as StartConnectResponseNextActionOneOfOriginal, type StartConnectResponse as StartConnectResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, deleteConnector, dispatcherDispatch, getConnector, listMcpTools, queryConnectors, startConnect };