@wix/auto_sdk_data_external-database-connections 1.0.0

package/build/cjs/src/data-v1-external-database-connection-external-database-connections.meta.js

@@ -0,0 +1,127 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = void 0;
+const ambassadorWixDataV1ExternalDatabaseConnection = __importStar(require("./data-v1-external-database-connection-external-database-connections.http.js"));
+function getExternalDatabaseConnection() {
+    const payload = { name: ':name' };
+    const getRequestOptions = ambassadorWixDataV1ExternalDatabaseConnection.getExternalDatabaseConnection(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v1/external-database-connections/{name}',
+        pathParams: { name: 'name' },
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.getExternalDatabaseConnection = getExternalDatabaseConnection;
+function listExternalDatabaseConnections() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDataV1ExternalDatabaseConnection.listExternalDatabaseConnections(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v1/external-database-connections',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.listExternalDatabaseConnections = listExternalDatabaseConnections;
+function createExternalDatabaseConnection() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDataV1ExternalDatabaseConnection.createExternalDatabaseConnection(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'POST',
+        path: '/v1/external-database-connections',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.createExternalDatabaseConnection = createExternalDatabaseConnection;
+function updateExternalDatabaseConnection() {
+    const payload = {
+        externalDatabaseConnection: { name: ':externalDatabaseConnectionName' },
+    };
+    const getRequestOptions = ambassadorWixDataV1ExternalDatabaseConnection.updateExternalDatabaseConnection(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'PUT',
+        path: '/v1/external-database-connections/{externalDatabaseConnection.name}',
+        pathParams: {
+            externalDatabaseConnectionName: 'externalDatabaseConnectionName',
+        },
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.updateExternalDatabaseConnection = updateExternalDatabaseConnection;
+function deleteExternalDatabaseConnection() {
+    const payload = { name: ':name' };
+    const getRequestOptions = ambassadorWixDataV1ExternalDatabaseConnection.deleteExternalDatabaseConnection(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'DELETE',
+        path: '/v1/external-database-connections/{name}',
+        pathParams: { name: 'name' },
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.deleteExternalDatabaseConnection = deleteExternalDatabaseConnection;
+//# sourceMappingURL=data-v1-external-database-connection-external-database-connections.meta.js.map

package/build/cjs/src/data-v1-external-database-connection-external-database-connections.meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-v1-external-database-connection-external-database-connections.meta.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection-external-database-connections.meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4JAA8I;AAsB9I,SAAgB,6BAA6B;IAU3C,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAS,CAAC;IAEzC,MAAM,iBAAiB,GACrB,6CAA6C,CAAC,6BAA6B,CACzE,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,0CAA0C;QAChD,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QAC5B,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAhCD,sEAgCC;AAED,SAAgB,+BAA+B;IAU7C,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,6CAA6C,CAAC,+BAA+B,CAC3E,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,mCAAmC;QACzC,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAhCD,0EAgCC;AAED,SAAgB,gCAAgC;IAU9C,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,6CAA6C,CAAC,gCAAgC,CAC5E,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,mCAAmC;QACzC,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAhCD,4EAgCC;AAED,SAAgB,gCAAgC;IAU9C,MAAM,OAAO,GAAG;QACd,0BAA0B,EAAE,EAAE,IAAI,EAAE,iCAAiC,EAAE;KACjE,CAAC;IAET,MAAM,iBAAiB,GACrB,6CAA6C,CAAC,gCAAgC,CAC5E,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,qEAAqE;QAC3E,UAAU,EAAE;YACV,8BAA8B,EAAE,gCAAgC;SACjE;QACD,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AApCD,4EAoCC;AAED,SAAgB,gCAAgC;IAQ9C,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAS,CAAC;IAEzC,MAAM,iBAAiB,GACrB,6CAA6C,CAAC,gCAAgC,CAC5E,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,QAAQ;QACpB,IAAI,EAAE,0CAA0C;QAChD,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QAC5B,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA9BD,4EA8BC"}

package/build/cjs/src/data-v1-external-database-connection-external-database-connections.public.d.ts

@@ -0,0 +1,69 @@
+import { HttpClient } from '@wix/sdk-types';
+import { ConnectionType, ExternalDatabaseConnection, ExternalDatabaseConnectionNonNullableFields, ListExternalDatabaseConnectionsOptions, ListExternalDatabaseConnectionsResponse, ListExternalDatabaseConnectionsResponseNonNullableFields, UpdateExternalDatabaseConnection } from './data-v1-external-database-connection-external-database-connections.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getExternalDatabaseConnection(httpClient: HttpClient): GetExternalDatabaseConnectionSignature;
+interface GetExternalDatabaseConnectionSignature {
+    /**
+     * Retrieves the specified external database connection.
+     * @param - Name of the external database connection to retrieve.
+     * @returns Details of the retrieved external database connection.
+     */
+    (name: string): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
+}
+export declare function listExternalDatabaseConnections(httpClient: HttpClient): ListExternalDatabaseConnectionsSignature;
+interface ListExternalDatabaseConnectionsSignature {
+    /**
+     * Lists the site's external database connections.
+     *
+     * > **Note**: The method lists both [adaptor types](https://dev.wix.com/docs/rest/business-solutions/cms/external-database-connection/introduction#about-external-database-adaptors).
+     */
+    (options?: ListExternalDatabaseConnectionsOptions | undefined): Promise<ListExternalDatabaseConnectionsResponse & ListExternalDatabaseConnectionsResponseNonNullableFields>;
+}
+export declare function createExternalDatabaseConnection(httpClient: HttpClient): CreateExternalDatabaseConnectionSignature;
+interface CreateExternalDatabaseConnectionSignature {
+    /**
+     * Creates a new external database connection.
+     *
+     * The `externalDatabaseConnection` parameter must include a `name`, `endpoint`, and `configuration` details for the external database.
+     * If any of these are missing, the external database connection isn't created.
+     * @param - External database connection details.
+     * @param - Connection type. The connection type determines the type of adaptor by which the external collection is integrated with the site.
+     *
+     * Learn more about [external database adaptors](https://dev.wix.com/docs/rest/business-solutions/cms/external-database-connection/introduction#about-external-database-adaptors).
+     * @param - Options for creating an external database connection.
+     * @returns Details of the created external database connection.
+     */
+    (externalDatabaseConnection: ExternalDatabaseConnection, connectionType: ConnectionType): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
+}
+export declare function updateExternalDatabaseConnection(httpClient: HttpClient): UpdateExternalDatabaseConnectionSignature;
+interface UpdateExternalDatabaseConnectionSignature {
+    /**
+     * Updates an external database connection.
+     *
+     * An external database collection name must be provided in `name`.
+     * If an existing external database connection is found with the same name, that connection's details are updated.
+     * If no external database connection has that name, the request fails.
+     *
+     * > **Note:** After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.
+     * @param - Name of the external database connection.
+     *
+     * An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`.
+     * @param - Options for updating an external database connection.
+     * @param - Updated external database connection details. The existing connection is replaced with this version.
+     * @returns Details of the updated external database connection.
+     */
+    (name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
+}
+export declare function deleteExternalDatabaseConnection(httpClient: HttpClient): DeleteExternalDatabaseConnectionSignature;
+interface DeleteExternalDatabaseConnectionSignature {
+    /**
+     * Deletes an external database connection.
+     *
+     * > **Note:** Once an external database connection is deleted, it can't be restored. To reconnect the database you need to create a new external database connection.
+     * @param - Name of the external database connection to delete.
+     */
+    (name: string): Promise<void>;
+}
+export { ActionEvent, Capabilities, CauseOfFailure, CollectionsFound, ConnectionStatus, ConnectionType, CreateExternalDatabaseConnectionRequest, CreateExternalDatabaseConnectionResponse, CreateExternalDatabaseConnectionResponseNonNullableFields, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExternalDatabaseConnection, ExternalDatabaseConnectionNonNullableFields, FieldType, GetExternalDatabaseConnectionRequest, GetExternalDatabaseConnectionResponse, GetExternalDatabaseConnectionResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, ListExternalDatabaseConnectionsOptions, ListExternalDatabaseConnectionsRequest, ListExternalDatabaseConnectionsResponse, ListExternalDatabaseConnectionsResponseNonNullableFields, MessageEnvelope, Paging, PagingMetadata, ProtocolVersion, RestoreInfo, UpdateExternalDatabaseConnection, UpdateExternalDatabaseConnectionRequest, UpdateExternalDatabaseConnectionResponse, UpdateExternalDatabaseConnectionResponseNonNullableFields, WebhookIdentityType, } from './data-v1-external-database-connection-external-database-connections.universal.js';

package/build/cjs/src/data-v1-external-database-connection-external-database-connections.public.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.ProtocolVersion = exports.FieldType = exports.ConnectionType = exports.CollectionsFound = exports.CauseOfFailure = exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.__metadata = void 0;
+const data_v1_external_database_connection_external_database_connections_universal_js_1 = require("./data-v1-external-database-connection-external-database-connections.universal.js");
+exports.__metadata = { PACKAGE_NAME: '@wix/data' };
+function getExternalDatabaseConnection(httpClient) {
+    return (name) => (0, data_v1_external_database_connection_external_database_connections_universal_js_1.getExternalDatabaseConnection)(name, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getExternalDatabaseConnection = getExternalDatabaseConnection;
+function listExternalDatabaseConnections(httpClient) {
+    return (options) => (0, data_v1_external_database_connection_external_database_connections_universal_js_1.listExternalDatabaseConnections)(options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.listExternalDatabaseConnections = listExternalDatabaseConnections;
+function createExternalDatabaseConnection(httpClient) {
+    return (externalDatabaseConnection, connectionType) => (0, data_v1_external_database_connection_external_database_connections_universal_js_1.createExternalDatabaseConnection)(externalDatabaseConnection, connectionType, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.createExternalDatabaseConnection = createExternalDatabaseConnection;
+function updateExternalDatabaseConnection(httpClient) {
+    return (name, externalDatabaseConnection) => (0, data_v1_external_database_connection_external_database_connections_universal_js_1.updateExternalDatabaseConnection)(name, externalDatabaseConnection, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.updateExternalDatabaseConnection = updateExternalDatabaseConnection;
+function deleteExternalDatabaseConnection(httpClient) {
+    return (name) => (0, data_v1_external_database_connection_external_database_connections_universal_js_1.deleteExternalDatabaseConnection)(name, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.deleteExternalDatabaseConnection = deleteExternalDatabaseConnection;
+var data_v1_external_database_connection_external_database_connections_universal_js_2 = require("./data-v1-external-database-connection-external-database-connections.universal.js");
+Object.defineProperty(exports, "CauseOfFailure", { enumerable: true, get: function () { return data_v1_external_database_connection_external_database_connections_universal_js_2.CauseOfFailure; } });
+Object.defineProperty(exports, "CollectionsFound", { enumerable: true, get: function () { return data_v1_external_database_connection_external_database_connections_universal_js_2.CollectionsFound; } });
+Object.defineProperty(exports, "ConnectionType", { enumerable: true, get: function () { return data_v1_external_database_connection_external_database_connections_universal_js_2.ConnectionType; } });
+Object.defineProperty(exports, "FieldType", { enumerable: true, get: function () { return data_v1_external_database_connection_external_database_connections_universal_js_2.FieldType; } });
+Object.defineProperty(exports, "ProtocolVersion", { enumerable: true, get: function () { return data_v1_external_database_connection_external_database_connections_universal_js_2.ProtocolVersion; } });
+Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return data_v1_external_database_connection_external_database_connections_universal_js_2.WebhookIdentityType; } });
+//# sourceMappingURL=data-v1-external-database-connection-external-database-connections.public.js.map

package/build/cjs/src/data-v1-external-database-connection-external-database-connections.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-v1-external-database-connection-external-database-connections.public.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection-external-database-connections.public.ts"],"names":[],"mappings":";;;AACA,uLAa2F;AAE9E,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,6BAA6B,CAC3C,UAAsB;IAEtB,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,+GAAsC,EACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,sEASC;AAaD,SAAgB,+BAA+B,CAC7C,UAAsB;IAEtB,OAAO,CAAC,OAAgD,EAAE,EAAE,CAC1D,IAAA,iHAAwC,EACtC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0EASC;AAcD,SAAgB,gCAAgC,CAC9C,UAAsB;IAEtB,OAAO,CACL,0BAAsD,EACtD,cAA8B,EAC9B,EAAE,CACF,IAAA,kHAAyC,EACvC,0BAA0B,EAC1B,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,4EAaC;AAuBD,SAAgB,gCAAgC,CAC9C,UAAsB;IAEtB,OAAO,CACL,IAAY,EACZ,0BAA4D,EAC5D,EAAE,CACF,IAAA,kHAAyC,EACvC,IAAI,EACJ,0BAA0B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,4EAaC;AA0BD,SAAgB,gCAAgC,CAC9C,UAAsB;IAEtB,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,kHAAyC,EACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,4EASC;AAYD,qLAuC2F;AApCzF,iLAAA,cAAc,OAAA;AACd,mLAAA,gBAAgB,OAAA;AAEhB,iLAAA,cAAc,OAAA;AAad,4KAAA,SAAS,OAAA;AAaT,kLAAA,eAAe,OAAA;AAMf,sLAAA,mBAAmB,OAAA"}

package/build/cjs/src/data-v1-external-database-connection-external-database-connections.types.d.ts

@@ -0,0 +1,326 @@
+/** An external database connection defines a connection between an external database and a Wix site. */
+export interface ExternalDatabaseConnection {
+    /**
+     * Name of the external database connection.
+     *
+     * An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`.
+     */
+    name?: string;
+    /** Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`. */
+    endpoint?: string | null;
+    /**
+     * Settings specified to the external database connection as part of each request.
+     *
+     * These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API.
+     */
+    configuration?: Record<string, any> | null;
+    /**
+     * Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
+     * @readonly
+     */
+    connectionStatus?: ConnectionStatus;
+    /**
+     * Public key used to validate requests to the external database.
+     * @readonly
+     */
+    publicKey?: string | null;
+    /**
+     * Capabilities of the external database.
+     * @readonly
+     */
+    capabilities?: Capabilities;
+}
+export declare enum CauseOfFailure {
+    /** No connection failure. */
+    NONE = "NONE",
+    /** General communication failure. */
+    COMMUNICATION_FAILURE = "COMMUNICATION_FAILURE",
+    /** External database host is unreachable. */
+    DESTINATION_HOST_UNREACHABLE = "DESTINATION_HOST_UNREACHABLE",
+    /** Unauthorized to access the external database. */
+    UNAUTHORIZED = "UNAUTHORIZED",
+    /** `endpoint` is not set. */
+    DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
+}
+export declare enum CollectionsFound {
+    /** Attempt to connect to the external database failed, so status is unknown. */
+    UNKNOWN = "UNKNOWN",
+    /** External database has collections. */
+    YES = "YES",
+    /** External database does not have any collections. */
+    NO = "NO"
+}
+export declare enum FieldType {
+    UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
+    TEXT = "TEXT",
+    NUMBER = "NUMBER",
+    DATE = "DATE",
+    DATETIME = "DATETIME",
+    IMAGE = "IMAGE",
+    BOOLEAN = "BOOLEAN",
+    DOCUMENT = "DOCUMENT",
+    URL = "URL",
+    RICH_TEXT = "RICH_TEXT",
+    VIDEO = "VIDEO",
+    ANY = "ANY",
+    ARRAY_STRING = "ARRAY_STRING",
+    ARRAY_DOCUMENT = "ARRAY_DOCUMENT",
+    AUDIO = "AUDIO",
+    TIME = "TIME",
+    LANGUAGE = "LANGUAGE",
+    RICH_CONTENT = "RICH_CONTENT",
+    MEDIA_GALLERY = "MEDIA_GALLERY",
+    ADDRESS = "ADDRESS",
+    PAGE_LINK = "PAGE_LINK",
+    REFERENCE = "REFERENCE",
+    MULTI_REFERENCE = "MULTI_REFERENCE",
+    OBJECT = "OBJECT",
+    ARRAY = "ARRAY",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_TIME = "LEGACY_TIME",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_BOOK = "LEGACY_BOOK",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_EXTERNAL_URL = "LEGACY_EXTERNAL_URL",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_BROKEN_REFERENCE = "LEGACY_BROKEN_REFERENCE",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_IMAGE = "LEGACY_IMAGE",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_COLOR = "LEGACY_COLOR",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
+}
+export interface ConnectionStatus {
+    /** Whether the connection was established successfully. */
+    successful?: boolean;
+    /** Whether and why the connection attempt failed. */
+    causeOfFailure?: CauseOfFailure;
+    /**
+     * Whether the external database has collections.
+     * @readonly
+     */
+    hasCollections?: CollectionsFound;
+}
+export declare enum ProtocolVersion {
+    UNKNOWN_PROTOCOL_VERSION = "UNKNOWN_PROTOCOL_VERSION",
+    V1 = "V1",
+    V2 = "V2",
+    V3 = "V3"
+}
+export interface Capabilities {
+    /** Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. */
+    collectionModificationsSupported?: boolean;
+    /** Field types the external database supports. Applies only when `collectionModificationsSupported` is set to `true`. */
+    fieldTypes?: FieldType[];
+}
+export interface GetExternalDatabaseConnectionRequest {
+    /** Name of the external database connection to retrieve. */
+    name: string;
+}
+export interface GetExternalDatabaseConnectionResponse {
+    /** Details of the retrieved external database connection. */
+    externalDatabaseConnection?: ExternalDatabaseConnection;
+}
+export interface ListExternalDatabaseConnectionsRequest {
+    /** Paging metadata. */
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListExternalDatabaseConnectionsResponse {
+    /** List of external database connections. */
+    externalDatabaseConnections?: ExternalDatabaseConnection[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadata;
+}
+export interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+export interface CreateExternalDatabaseConnectionRequest {
+    /** External database connection details. */
+    externalDatabaseConnection: ExternalDatabaseConnection;
+    /**
+     * Connection type. The connection type determines the type of adaptor by which the external collection is integrated with the site.
+     *
+     * Learn more about [external database adaptors](https://dev.wix.com/docs/rest/business-solutions/cms/external-database-connection/introduction#about-external-database-adaptors).
+     */
+    connectionType: ConnectionType;
+}
+export declare enum ConnectionType {
+    /** Unknown connection type. */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    /** External database connection based on the legacy [external database collection service plugin](https://dev.wix.com/docs/velo/api-reference/wix-data-v2/service-plugins-spis/external-database-collection-legacy/introduction). */
+    STANDALONE = "STANDALONE",
+    /** External database connection based on the [external database service plugin](https://dev.wix.com/docs/rest/business-solutions/cms/service-plugins/external-database-service-plugin/introduction). */
+    WIX_SERVICE_PLUGIN = "WIX_SERVICE_PLUGIN"
+}
+export interface CreateExternalDatabaseConnectionResponse {
+    /** Details of the created external database connection. */
+    externalDatabaseConnection?: ExternalDatabaseConnection;
+}
+export interface UpdateExternalDatabaseConnectionRequest {
+    /** Updated external database connection. The existing connection is replaced with this version. */
+    externalDatabaseConnection: ExternalDatabaseConnection;
+}
+export interface UpdateExternalDatabaseConnectionResponse {
+    /** Details of the updated external database connection. */
+    externalDatabaseConnection?: ExternalDatabaseConnection;
+}
+export interface DeleteExternalDatabaseConnectionRequest {
+    /** Name of the external database connection to delete. */
+    name: string;
+}
+export interface DeleteExternalDatabaseConnectionResponse {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface ConnectionStatusNonNullableFields {
+    successful: boolean;
+    causeOfFailure: CauseOfFailure;
+    hasCollections: CollectionsFound;
+}
+interface CapabilitiesNonNullableFields {
+    collectionModificationsSupported: boolean;
+    fieldTypes: FieldType[];
+}
+interface ExternalDatabaseConnectionNonNullableFields {
+    name: string;
+    connectionStatus?: ConnectionStatusNonNullableFields;
+    protocolVersion: ProtocolVersion;
+    capabilities?: CapabilitiesNonNullableFields;
+}
+export interface GetExternalDatabaseConnectionResponseNonNullableFields {
+    externalDatabaseConnection?: ExternalDatabaseConnectionNonNullableFields;
+}
+export interface ListExternalDatabaseConnectionsResponseNonNullableFields {
+    externalDatabaseConnections: ExternalDatabaseConnectionNonNullableFields[];
+}
+export interface CreateExternalDatabaseConnectionResponseNonNullableFields {
+    externalDatabaseConnection?: ExternalDatabaseConnectionNonNullableFields;
+}
+export interface UpdateExternalDatabaseConnectionResponseNonNullableFields {
+    externalDatabaseConnection?: ExternalDatabaseConnectionNonNullableFields;
+}
+export {};