@wix/auto_sdk_data_external-database-connections 1.0.0

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

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.ConnectionType = exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = void 0;
+var CauseOfFailure;
+(function (CauseOfFailure) {
+    /** No connection failure. */
+    CauseOfFailure["NONE"] = "NONE";
+    /** General communication failure. */
+    CauseOfFailure["COMMUNICATION_FAILURE"] = "COMMUNICATION_FAILURE";
+    /** External database host is unreachable. */
+    CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
+    /** Unauthorized to access the external database. */
+    CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
+    /** `endpoint` is not set. */
+    CauseOfFailure["DESTINATION_ENDPOINT_NOT_DEFINED"] = "DESTINATION_ENDPOINT_NOT_DEFINED";
+})(CauseOfFailure || (exports.CauseOfFailure = CauseOfFailure = {}));
+var CollectionsFound;
+(function (CollectionsFound) {
+    /** Attempt to connect to the external database failed, so status is unknown. */
+    CollectionsFound["UNKNOWN"] = "UNKNOWN";
+    /** External database has collections. */
+    CollectionsFound["YES"] = "YES";
+    /** External database does not have any collections. */
+    CollectionsFound["NO"] = "NO";
+})(CollectionsFound || (exports.CollectionsFound = CollectionsFound = {}));
+var FieldType;
+(function (FieldType) {
+    FieldType["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
+    FieldType["TEXT"] = "TEXT";
+    FieldType["NUMBER"] = "NUMBER";
+    FieldType["DATE"] = "DATE";
+    FieldType["DATETIME"] = "DATETIME";
+    FieldType["IMAGE"] = "IMAGE";
+    FieldType["BOOLEAN"] = "BOOLEAN";
+    FieldType["DOCUMENT"] = "DOCUMENT";
+    FieldType["URL"] = "URL";
+    FieldType["RICH_TEXT"] = "RICH_TEXT";
+    FieldType["VIDEO"] = "VIDEO";
+    FieldType["ANY"] = "ANY";
+    FieldType["ARRAY_STRING"] = "ARRAY_STRING";
+    FieldType["ARRAY_DOCUMENT"] = "ARRAY_DOCUMENT";
+    FieldType["AUDIO"] = "AUDIO";
+    FieldType["TIME"] = "TIME";
+    FieldType["LANGUAGE"] = "LANGUAGE";
+    FieldType["RICH_CONTENT"] = "RICH_CONTENT";
+    FieldType["MEDIA_GALLERY"] = "MEDIA_GALLERY";
+    FieldType["ADDRESS"] = "ADDRESS";
+    FieldType["PAGE_LINK"] = "PAGE_LINK";
+    FieldType["REFERENCE"] = "REFERENCE";
+    FieldType["MULTI_REFERENCE"] = "MULTI_REFERENCE";
+    FieldType["OBJECT"] = "OBJECT";
+    FieldType["ARRAY"] = "ARRAY";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_TIME"] = "LEGACY_TIME";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_BOOK"] = "LEGACY_BOOK";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_EXTERNAL_URL"] = "LEGACY_EXTERNAL_URL";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_BROKEN_REFERENCE"] = "LEGACY_BROKEN_REFERENCE";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_IMAGE"] = "LEGACY_IMAGE";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_COLOR"] = "LEGACY_COLOR";
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    FieldType["LEGACY_EXTERNAL_VIDEO"] = "LEGACY_EXTERNAL_VIDEO";
+})(FieldType || (exports.FieldType = FieldType = {}));
+var ProtocolVersion;
+(function (ProtocolVersion) {
+    ProtocolVersion["UNKNOWN_PROTOCOL_VERSION"] = "UNKNOWN_PROTOCOL_VERSION";
+    ProtocolVersion["V1"] = "V1";
+    ProtocolVersion["V2"] = "V2";
+    ProtocolVersion["V3"] = "V3";
+})(ProtocolVersion || (exports.ProtocolVersion = ProtocolVersion = {}));
+var ConnectionType;
+(function (ConnectionType) {
+    /** Unknown connection type. */
+    ConnectionType["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). */
+    ConnectionType["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). */
+    ConnectionType["WIX_SERVICE_PLUGIN"] = "WIX_SERVICE_PLUGIN";
+})(ConnectionType || (exports.ConnectionType = ConnectionType = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=data-v1-external-database-connection-external-database-connections.types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data-v1-external-database-connection-external-database-connections.types.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection-external-database-connections.types.ts"],"names":[],"mappings":";;;AAiCA,IAAY,cAWX;AAXD,WAAY,cAAc;IACxB,6BAA6B;IAC7B,+BAAa,CAAA;IACb,qCAAqC;IACrC,iEAA+C,CAAA;IAC/C,6CAA6C;IAC7C,+EAA6D,CAAA;IAC7D,oDAAoD;IACpD,+CAA6B,CAAA;IAC7B,6BAA6B;IAC7B,uFAAqE,CAAA;AACvE,CAAC,EAXW,cAAc,8BAAd,cAAc,QAWzB;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,gFAAgF;IAChF,uCAAmB,CAAA;IACnB,yCAAyC;IACzC,+BAAW,CAAA;IACX,uDAAuD;IACvD,6BAAS,CAAA;AACX,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAED,IAAY,SAwCX;AAxCD,WAAY,SAAS;IACnB,sDAAyC,CAAA;IACzC,0BAAa,CAAA;IACb,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,wBAAW,CAAA;IACX,oCAAuB,CAAA;IACvB,4BAAe,CAAA;IACf,wBAAW,CAAA;IACX,0CAA6B,CAAA;IAC7B,8CAAiC,CAAA;IACjC,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,0CAA6B,CAAA;IAC7B,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gDAAmC,CAAA;IACnC,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,wFAAwF;IACxF,wCAA2B,CAAA;IAC3B,wFAAwF;IACxF,wCAA2B,CAAA;IAC3B,wFAAwF;IACxF,wDAA2C,CAAA;IAC3C,wFAAwF;IACxF,gEAAmD,CAAA;IACnD,wFAAwF;IACxF,0CAA6B,CAAA;IAC7B,wFAAwF;IACxF,0CAA6B,CAAA;IAC7B,wFAAwF;IACxF,4DAA+C,CAAA;AACjD,CAAC,EAxCW,SAAS,yBAAT,SAAS,QAwCpB;AAcD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;AACX,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AA4DD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,+BAA+B;IAC/B,qEAAmD,CAAA;IACnD,qOAAqO;IACrO,2CAAyB,CAAA;IACzB,wMAAwM;IACxM,2DAAyC,CAAA;AAC3C,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AA2ID,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

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

@@ -0,0 +1,448 @@
+/** 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 {
+    entity?: string;
+}
+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.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: 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[];
+}
+export 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;
+}
+/**
+ * Retrieves the specified external database connection.
+ * @param name - Name of the external database connection to retrieve.
+ * @public
+ * @requiredField name
+ * @permissionId WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION
+ * @permissionScope Manage External Database Connections
+ * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
+ * @permissionScope Manage All Data Resources
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
+ * @applicableIdentity APP
+ * @returns Details of the retrieved external database connection.
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.GetExternalDatabaseConnection
+ */
+export declare function getExternalDatabaseConnection(name: string): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
+/**
+ * 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).
+ * @public
+ * @permissionId WIX_DATA.LIST_EXTERNAL_DATABASE_CONNECTIONS
+ * @permissionScope Manage External Database Connections
+ * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
+ * @permissionScope Manage All Data Resources
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.ListExternalDatabaseConnections
+ */
+export declare function listExternalDatabaseConnections(options?: ListExternalDatabaseConnectionsOptions): Promise<ListExternalDatabaseConnectionsResponse & ListExternalDatabaseConnectionsResponseNonNullableFields>;
+export interface ListExternalDatabaseConnectionsOptions {
+    /** Paging metadata. */
+    paging?: Paging;
+}
+/**
+ * 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 externalDatabaseConnection - External database connection details.
+ * @param connectionType - 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).
+ * @public
+ * @requiredField connectionType
+ * @requiredField externalDatabaseConnection
+ * @requiredField externalDatabaseConnection.name
+ * @param options - Options for creating an external database connection.
+ * @permissionId WIX_DATA.CREATE_EXTERNAL_DATABASE_CONNECTION
+ * @permissionScope Manage External Database Connections
+ * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
+ * @permissionScope Manage All Data Resources
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
+ * @applicableIdentity APP
+ * @returns Details of the created external database connection.
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.CreateExternalDatabaseConnection
+ */
+export declare function createExternalDatabaseConnection(externalDatabaseConnection: ExternalDatabaseConnection, connectionType: ConnectionType): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
+/**
+ * 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 - 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`.
+ * @public
+ * @requiredField externalDatabaseConnection
+ * @requiredField name
+ * @param options - Options for updating an external database connection.
+ * @param externalDatabaseConnection - Updated external database connection details. The existing connection is replaced with this version.
+ * @permissionId WIX_DATA.UPDATE_EXTERNAL_DATABASE_CONNECTION
+ * @permissionScope Manage External Database Connections
+ * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
+ * @permissionScope Manage All Data Resources
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
+ * @applicableIdentity APP
+ * @returns Details of the updated external database connection.
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.UpdateExternalDatabaseConnection
+ */
+export declare function updateExternalDatabaseConnection(name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
+export interface UpdateExternalDatabaseConnection {
+    /** 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;
+}
+/**
+ * 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 - Name of the external database connection to delete.
+ * @public
+ * @requiredField name
+ * @permissionId WIX_DATA.DELETE_EXTERNAL_DATABASE_CONNECTION
+ * @permissionScope Manage External Database Connections
+ * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
+ * @permissionScope Manage All Data Resources
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.DeleteExternalDatabaseConnection
+ */
+export declare function deleteExternalDatabaseConnection(name: string): Promise<void>;
+export {};