@wix/auto_sdk_connectors_connectors 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,862 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * Not a taggable product resource: it carries no OAuth credential of its own (that lives on the
+ * shared wix.connectors_access_keys.v1.ConnectorAccessKey), only binding data.
+ */
+interface Connector extends ConnectorRegistrationOneOf {
+    /** Curated owner: the connector app + CONNECTOR_CONFIG component this connection was created against. */
+    predefinedRegistration?: PredefinedRegistration;
+    /** Dynamic owner: the provider registration this connection was created against. */
+    dynamicRegistration?: DynamicRegistration;
+    /**
+     * SDL derives this entity's owner from identity.targetAccountId; do not add account_id.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Optimistic-lock revision assigned by SDL.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Time at which SDL created the Connector.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Time at which SDL last updated the Connector.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Stable identifier of the connector implementation, for example "github".
+     * @maxLength 80
+     * @immutable
+     */
+    connectorSlug?: string;
+    /** Whether the Connector is account-owned or restricted to the consenting user. */
+    exposure?: ExposureWithLiterals;
+    /**
+     * Best-effort snapshot of the shared access key's credential_state, maintained by consuming
+     * AccessKeyBindingPushed off connectors-access-keys-store's own state-change events. NEVER a source
+     * of truth and NEVER an authorization input -- under event lag this can read ACTIVE while the key is
+     * REVOKED. It exists only to answer "what should be shown to the user"; every credential-usability
+     * decision (dispatch, revocation, anything that gates behavior) must keep reading
+     * connectors-access-keys-store synchronously. The same rule covers filtering by this field: a query
+     * for credential_state == ACTIVE returns what the platform last believed, never a permission to use
+     * those bindings. UNKNOWN_CREDENTIAL_STATE means no push has ever arrived for the bound access key --
+     * including every row that predates this projection -- and is never a signal of a healthy connection.
+     * Server-owned: no create or update path accepts a caller-supplied value for it. When a push carries
+     * the source event's own timestamp, that timestamp is tracked on the domain row (not exposed on this
+     * contract) and a later push older than the stored value is dropped; a push with no timestamp only
+     * ever initializes a row that has never recorded one, never overwrites an already-timestamped
+     * snapshot.
+     * @readonly
+     */
+    credentialState?: CredentialStateWithLiterals;
+    /**
+     * Deprecated: use registration.predefined_registration.app_id. Retained for callers still on the
+     * flat field. Empty for a dynamic (registration-owned) connector.
+     * @format GUID
+     * @immutable
+     * @deprecated
+     * @replacedBy predefined_registration.app_id
+     * @targetRemovalDate 2027-06-30
+     */
+    appId?: string;
+    /**
+     * Deprecated: use registration.predefined_registration.component_id.
+     * @format GUID
+     * @immutable
+     * @deprecated
+     * @replacedBy predefined_registration.component_id
+     * @targetRemovalDate 2027-06-30
+     */
+    componentId?: string;
+    /** Non-secret discriminant of the owner kind, aligned with the oneof above. */
+    registrationType?: RegistrationTypeWithLiterals;
+}
+/** @oneof */
+interface ConnectorRegistrationOneOf {
+    /** Curated owner: the connector app + CONNECTOR_CONFIG component this connection was created against. */
+    predefinedRegistration?: PredefinedRegistration;
+    /** Dynamic owner: the provider registration this connection was created against. */
+    dynamicRegistration?: DynamicRegistration;
+}
+declare enum Exposure {
+    /** The Connector is owned and usable by its account. */
+    ACCOUNT = "ACCOUNT",
+    /** The Connector is restricted to its consenting user. */
+    USER = "USER"
+}
+/** @enumType */
+type ExposureWithLiterals = Exposure | 'ACCOUNT' | 'USER';
+/**
+ * Provider-reported granted scopes, preserving the distinction between a provider that never reports
+ * scopes and one that explicitly reports an empty set.
+ */
+interface GrantedScopes {
+    /** Whether the provider has reported a granted-scopes set for this credential. */
+    reportingState?: ScopeReportingStateWithLiterals;
+    /**
+     * The scopes the provider reported. Meaningful only when reporting_state is REPORTED: an empty list
+     * there means the provider explicitly reported no granted scopes (known-empty), not that reporting is
+     * unknown.
+     * @maxSize 40
+     * @maxLength 70
+     */
+    scopes?: string[];
+}
+declare enum ScopeReportingState {
+    /** The provider has not reported a granted-scopes set for this credential. */
+    NOT_REPORTED = "NOT_REPORTED",
+    /** The provider reported a granted-scopes set, which may itself be empty. */
+    REPORTED = "REPORTED"
+}
+/** @enumType */
+type ScopeReportingStateWithLiterals = ScopeReportingState | 'NOT_REPORTED' | 'REPORTED';
+/** Reused verbatim from wix.connectors.v1. */
+declare enum CredentialState {
+    ACTIVE = "ACTIVE",
+    REVOKED = "REVOKED"
+}
+/** @enumType */
+type CredentialStateWithLiterals = CredentialState | 'ACTIVE' | 'REVOKED';
+/** Curated owner: the connector app plus CONNECTOR_CONFIG component a connection was created against. */
+interface PredefinedRegistration {
+    /**
+     * The connector app that declares the CONNECTOR_CONFIG component.
+     * @format GUID
+     * @immutable
+     */
+    appId?: string;
+    /**
+     * The CONNECTOR_CONFIG component within that app — the stable address for the connector's config.
+     * @format GUID
+     * @immutable
+     */
+    componentId?: string;
+}
+/**
+ * Dynamic owner: the wix.connectors.registry.v1.mcp_server_registration a connection was created
+ * against, for a DCR connector reached by URL. Shared per provider rather than per app/component.
+ */
+interface DynamicRegistration {
+    /**
+     * The provider-registry McpServerRegistration this connection was created against.
+     * @format GUID
+     * @immutable
+     */
+    registrationId?: string;
+}
+/** Which kind of owner this connection belongs to. */
+declare enum RegistrationType {
+    /** Owned by a connector app/component (curated). */
+    PREDEFINED = "PREDEFINED",
+    /** Owned by a provider registration (DCR). */
+    DYNAMIC = "DYNAMIC"
+}
+/** @enumType */
+type RegistrationTypeWithLiterals = RegistrationType | 'PREDEFINED' | 'DYNAMIC';
+interface CreateConnectorRequest {
+    /** Durable OAuth Connector to persist in the target account tenant. */
+    connector?: Connector;
+}
+interface CreateConnectorResponse {
+    /** The persisted Connector. */
+    connector?: Connector;
+}
+interface GetConnectorRequest {
+    /**
+     * ID of the Connector to retrieve.
+     * @format GUID
+     */
+    connectorId: string;
+}
+interface GetConnectorResponse {
+    /** The requested Connector. */
+    connector?: Connector;
+}
+interface DeleteConnectorRequest {
+    /**
+     * ID of the Connector to move to the trash bin.
+     * @format GUID
+     */
+    connectorId: string;
+}
+interface DeleteConnectorResponse {
+}
+interface QueryConnectorsRequest {
+    /** Filter, sort, and cursor paging arguments for Connectors in the target account tenant. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryConnectorsResponse {
+    /** Connectors from the target account tenant. Protected fields require their own permissions. */
+    connectors?: Connector[];
+    /** Cursor information for the next or previous page. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface StartConnectRequest extends StartConnectRequestOwnerOneOf {
+    /** Curated connect: the connector app + CONNECTOR_CONFIG component. */
+    predefinedRegistration?: PredefinedRegistration;
+    /**
+     * Dynamic (DCR) connect: the provider-registry McpServerRegistration reached by URL; the OAuth
+     * config comes from the registration rather than a CONNECTOR_CONFIG component.
+     */
+    dynamicRegistration?: DynamicRegistration;
+    /** Non-secret discriminant of the owner kind, aligned with the oneof above. */
+    registrationType?: StartConnectRequestRegistrationTypeWithLiterals;
+    /**
+     * Deprecated: use owner.predefined_registration.app_id. Retained for callers still on the flat
+     * field until they migrate to the owner oneof. Not GUID-typed: that format rejects the empty
+     * default a oneof-owner request carries, so this optional field only caps length.
+     * @maxLength 80
+     * @deprecated
+     * @replacedBy predefined_registration.app_id
+     * @targetRemovalDate 2027-06-30
+     */
+    appId?: string;
+    /**
+     * Deprecated: use owner.predefined_registration.component_id.
+     * @maxLength 80
+     * @deprecated
+     * @replacedBy predefined_registration.component_id
+     * @targetRemovalDate 2027-06-30
+     */
+    componentId?: string;
+    /**
+     * Requested exposure of the Connector this connect will produce. UNKNOWN_EXPOSURE is treated as
+     * ACCOUNT. USER requires an initiating Wix user identity on the call — its id is recorded as the
+     * Connector's consenting_user_id and the connection is then visible only to that user.
+     */
+    exposure?: ExposureWithLiterals;
+    /**
+     * Optional Wix URL to return the browser to after connect completes. Must pass the Wix-domain
+     * allowlist (validated server-side at GenerateAuthorizationUrl). When omitted, the fixed landing
+     * page is used. Carried through the handshake; the same URL is used for both success and error
+     * landings (with ?error= on failure). Not WEB_URL-typed: that format rejects the empty default, so
+     * this optional field only caps length here — the server-side allowlist is the real URL gate.
+     * @maxLength 2048
+     */
+    returnUrl?: string;
+}
+/** @oneof */
+interface StartConnectRequestOwnerOneOf {
+    /** Curated connect: the connector app + CONNECTOR_CONFIG component. */
+    predefinedRegistration?: PredefinedRegistration;
+    /**
+     * Dynamic (DCR) connect: the provider-registry McpServerRegistration reached by URL; the OAuth
+     * config comes from the registration rather than a CONNECTOR_CONFIG component.
+     */
+    dynamicRegistration?: DynamicRegistration;
+}
+/** Which kind of owner this connect targets. */
+declare enum StartConnectRequestRegistrationType {
+    /** Curated owner (app_id + component_id). */
+    PREDEFINED = "PREDEFINED",
+    /** Dynamic (DCR) owner (registration_id). */
+    DYNAMIC = "DYNAMIC"
+}
+/** @enumType */
+type StartConnectRequestRegistrationTypeWithLiterals = StartConnectRequestRegistrationType | 'PREDEFINED' | 'DYNAMIC';
+interface StartConnectResponse extends StartConnectResponseNextActionOneOf {
+    /** Redirect the caller's browser to complete the connect. */
+    redirect?: Redirect;
+    /** Nothing left to do — the connect is already finished. */
+    completed?: Completed;
+    /**
+     * Deprecated: read `next_action.redirect.url` instead. Still populated whenever the next action IS
+     * a redirect, so callers that have not migrated keep working; it is simply unable to express any
+     * other outcome, which is why it is being replaced rather than extended.
+     * @format WEB_URL
+     * @deprecated
+     * @replacedBy next_action.redirect.url
+     * @targetRemovalDate 2027-06-30
+     */
+    authorizationUrl?: string;
+}
+/** @oneof */
+interface StartConnectResponseNextActionOneOf {
+    /** Redirect the caller's browser to complete the connect. */
+    redirect?: Redirect;
+    /** Nothing left to do — the connect is already finished. */
+    completed?: Completed;
+}
+/** Redirects the caller's browser to a provider authorization URL. */
+interface Redirect {
+    /**
+     * Provider authorization URL to redirect the user's browser to.
+     * @format WEB_URL
+     */
+    url?: string;
+}
+/**
+ * The connect is already finished and the Connector exists; no user interaction happened or is needed.
+ * Returned for a provider that requires no authorization at all, where there is no authorization URL
+ * to visit and so no callback to return through.
+ */
+interface Completed {
+    /**
+     * Id of the access key the resulting Connector is bound to.
+     * @format GUID
+     */
+    accessKeyId?: string;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * 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.
+     * 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.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface DispatchRequest {
+    /**
+     * ID of the Connector to authorize in the caller's target account.
+     * @format GUID
+     */
+    connectorId: string;
+    /** Raw provider request. Callers must not include credentials; Wix injects them at dispatch. */
+    providerRequest: RawHttpRequest;
+    /**
+     * Optional caller-supplied key making a retry of this dispatch safe: the same key on the same
+     * connector will not produce a second provider attempt through Wix. Scoped to the connector, so
+     * callers need only make it unique per connector. Guarantees at-most-once ATTEMPT by Wix — it
+     * cannot guarantee the provider applied the effect at most once when an attempt's outcome is
+     * unknown (timeout, connection reset). For that, include the provider's own idempotency header in
+     * provider_request. A repeated key fails with a duplicate-dispatch error rather than replaying the
+     * original response, which Wix does not retain; callers needing it must store it themselves.
+     * @maxLength 128
+     */
+    idempotencyKey?: string;
+}
+interface RawHttpRequest {
+    body?: Uint8Array;
+    pathParams?: PathParametersEntry[];
+    queryParams?: QueryParametersEntry[];
+    headers?: HeadersEntry[];
+    method?: string;
+    rawPath?: string;
+    rawQuery?: string;
+}
+interface PathParametersEntry {
+    key?: string;
+    value?: string;
+}
+interface QueryParametersEntry {
+    key?: string;
+    value?: string;
+}
+interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+interface ListMcpToolsRequest {
+    /**
+     * ID of the Connector whose callable MCP tools are requested.
+     * @format GUID
+     */
+    connectorId: string;
+}
+interface ListMcpToolsResponse {
+    /**
+     * The server's advertised tools filtered by the connector's allowlist. Capped to match mcp_config.allowed_tools' own maximum; the runtime
+     * rejects a provider advertisement it cannot fit rather than returning an unbounded payload.
+     * @maxSize 200
+     */
+    tools?: McpTool[];
+}
+/** One MCP tool as advertised by the connector's MCP server. */
+interface McpTool {
+    /**
+     * Tool name, exactly as the server advertises it.
+     * @maxLength 128
+     */
+    name?: string;
+    /**
+     * Human- and model-readable description of what the tool does, as provided by the server.
+     * @maxLength 10000
+     */
+    description?: string;
+    /** JSON Schema of the tool's arguments, as provided by the server. */
+    inputSchema?: Record<string, any> | null;
+}
+/**
+ * Lists Connectors only in the caller's target account tenant. USER Connectors are included
+ * only for their consenting user; ACCOUNT Connectors are included for authorized account callers.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId connectors:v1:connector:query_connectors
+ * @fqn wix.connectors.v1.ConnectorsService.QueryConnectors
+ */
+declare function queryConnectors(): ConnectorsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ConnectorsQueryResult extends QueryCursorResult {
+    items: Connector[];
+    query: ConnectorsQueryBuilder;
+    next: () => Promise<ConnectorsQueryResult>;
+    prev: () => Promise<ConnectorsQueryResult>;
+}
+interface ConnectorsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'exposure' | 'credentialState' | 'appId' | 'componentId' | 'registrationType', value: any) => ConnectorsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'exposure' | 'credentialState' | 'appId' | 'componentId' | 'registrationType', value: any) => ConnectorsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'appId' | 'componentId', value: any) => ConnectorsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'appId' | 'componentId', value: any) => ConnectorsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'appId' | 'componentId', value: any) => ConnectorsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'appId' | 'componentId', value: any) => ConnectorsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'appId' | 'componentId', value: string) => ConnectorsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'exposure' | 'credentialState' | 'appId' | 'componentId' | 'registrationType', value: any) => ConnectorsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'exposure' | 'credentialState' | 'appId' | 'componentId' | 'registrationType', value: boolean) => ConnectorsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'exposure' | 'credentialState' | 'appId' | 'componentId' | 'registrationType'>) => ConnectorsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'predefinedRegistration.appId' | 'predefinedRegistration.componentId' | 'dynamicRegistration.registrationId' | '_id' | 'connectorSlug' | 'exposure' | 'credentialState' | 'appId' | 'componentId' | 'registrationType'>) => ConnectorsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ConnectorsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ConnectorsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ConnectorsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.connectors.v1.ConnectorsService.QueryConnectors
+ * @requiredField query
+ */
+declare function typedQueryConnectors(query: ConnectorQuery): Promise<NonNullablePaths<QueryConnectorsResponse, `connectors` | `connectors.${number}.predefinedRegistration.appId` | `connectors.${number}.predefinedRegistration.componentId` | `connectors.${number}.dynamicRegistration.registrationId` | `connectors.${number}.connectorSlug` | `connectors.${number}.exposure` | `connectors.${number}.credentialState` | `connectors.${number}.appId` | `connectors.${number}.componentId` | `connectors.${number}.registrationType`, 5>>;
+interface ConnectorQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: [
+                '_id',
+                'appId',
+                'componentId',
+                'connectorSlug',
+                'credentialState',
+                'dynamicRegistration.registrationId',
+                'exposure',
+                'predefinedRegistration.appId',
+                'predefinedRegistration.componentId',
+                'registrationType'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Connector, ConnectorQuerySpec>;
+type ConnectorQuery = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: _wix_sdk_types.QueryHelpers<Connector, ConnectorQuerySpec, ConnectorQuery>;
+};
+/**
+ * Starts an OAuth connect for a connector component, under the caller's identity.targetAccountId.
+ * Asks oauth-handler to generate the provider authorization URL: it mints an unguessable, one-time
+ * state, caches the trusted completion context (PKCE verifier when configured) in WixCache with a
+ * short TTL, and returns the URL to redirect the user's browser to. Does not create a Connector —
+ * a Connector exists only after the OAuth callback completes. Does not install an app or call
+ * any app-installation API.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId connectors:v1:connector:start_connect
+ * @fqn wix.connectors.v1.ConnectorsService.StartConnect
+ */
+declare function startConnect(options?: StartConnectOptions): Promise<NonNullablePaths<StartConnectResponse, `redirect.url` | `completed.accessKeyId` | `authorizationUrl`, 3>>;
+interface StartConnectOptions extends StartConnectOptionsOwnerOneOf {
+    /** Curated connect: the connector app + CONNECTOR_CONFIG component. */
+    predefinedRegistration?: PredefinedRegistration;
+    /**
+     * Dynamic (DCR) connect: the provider-registry McpServerRegistration reached by URL; the OAuth
+     * config comes from the registration rather than a CONNECTOR_CONFIG component.
+     */
+    dynamicRegistration?: DynamicRegistration;
+    /** Non-secret discriminant of the owner kind, aligned with the oneof above. */
+    registrationType?: StartConnectRequestRegistrationTypeWithLiterals;
+    /**
+     * Deprecated: use owner.predefined_registration.app_id. Retained for callers still on the flat
+     * field until they migrate to the owner oneof. Not GUID-typed: that format rejects the empty
+     * default a oneof-owner request carries, so this optional field only caps length.
+     * @maxLength 80
+     * @deprecated
+     * @replacedBy predefined_registration.app_id
+     * @targetRemovalDate 2027-06-30
+     */
+    appId?: string;
+    /**
+     * Deprecated: use owner.predefined_registration.component_id.
+     * @maxLength 80
+     * @deprecated
+     * @replacedBy predefined_registration.component_id
+     * @targetRemovalDate 2027-06-30
+     */
+    componentId?: string;
+    /**
+     * Requested exposure of the Connector this connect will produce. UNKNOWN_EXPOSURE is treated as
+     * ACCOUNT. USER requires an initiating Wix user identity on the call — its id is recorded as the
+     * Connector's consenting_user_id and the connection is then visible only to that user.
+     */
+    exposure?: ExposureWithLiterals;
+    /**
+     * Optional Wix URL to return the browser to after connect completes. Must pass the Wix-domain
+     * allowlist (validated server-side at GenerateAuthorizationUrl). When omitted, the fixed landing
+     * page is used. Carried through the handshake; the same URL is used for both success and error
+     * landings (with ?error= on failure). Not WEB_URL-typed: that format rejects the empty default, so
+     * this optional field only caps length here — the server-side allowlist is the real URL gate.
+     * @maxLength 2048
+     */
+    returnUrl?: string;
+}
+/** @oneof */
+interface StartConnectOptionsOwnerOneOf {
+    /** Curated connect: the connector app + CONNECTOR_CONFIG component. */
+    predefinedRegistration?: PredefinedRegistration;
+    /**
+     * Dynamic (DCR) connect: the provider-registry McpServerRegistration reached by URL; the OAuth
+     * config comes from the registration rather than a CONNECTOR_CONFIG component.
+     */
+    dynamicRegistration?: DynamicRegistration;
+}
+interface DispatcherDispatchOptions {
+    /**
+     * Optional caller-supplied key making a retry of this dispatch safe: the same key on the same
+     * connector will not produce a second provider attempt through Wix. Scoped to the connector, so
+     * callers need only make it unique per connector. Guarantees at-most-once ATTEMPT by Wix — it
+     * cannot guarantee the provider applied the effect at most once when an attempt's outcome is
+     * unknown (timeout, connection reset). For that, include the provider's own idempotency header in
+     * provider_request. A repeated key fails with a duplicate-dispatch error rather than replaying the
+     * original response, which Wix does not retain; callers needing it must store it themselves.
+     * @maxLength 128
+     */
+    idempotencyKey?: string;
+}
+
+export { type AccountInfo, type ActionEvent, type CommonQueryWithEntityContext, type Completed, type Connector, type ConnectorQuery, type ConnectorQuerySpec, type ConnectorRegistrationOneOf, type ConnectorsQueryBuilder, type ConnectorsQueryResult, type CreateConnectorRequest, type CreateConnectorResponse, CredentialState, type CredentialStateWithLiterals, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteConnectorRequest, type DeleteConnectorResponse, type DispatchRequest, type DispatcherDispatchOptions, type DomainEvent, type DomainEventBodyOneOf, type DynamicRegistration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Exposure, type ExposureWithLiterals, type GetConnectorRequest, type GetConnectorResponse, type GrantedScopes, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ListMcpToolsRequest, type ListMcpToolsResponse, type McpTool, type MessageEnvelope, type PathParametersEntry, type PredefinedRegistration, type QueryConnectorsRequest, type QueryConnectorsResponse, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, type Redirect, RegistrationType, type RegistrationTypeWithLiterals, type RestoreInfo, ScopeReportingState, type ScopeReportingStateWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type StartConnectOptions, type StartConnectOptionsOwnerOneOf, type StartConnectRequest, type StartConnectRequestOwnerOneOf, StartConnectRequestRegistrationType, type StartConnectRequestRegistrationTypeWithLiterals, type StartConnectResponse, type StartConnectResponseNextActionOneOf, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, queryConnectors, startConnect, typedQueryConnectors, utils };