@wix/auto_sdk_data_external-database-connections 1.0.11 → 1.0.12

package/build/{es/src/data-v1-external-database-connection-external-database-connections.types.d.ts → data-v1-external-database-connection-external-database-connections.universal-DDx0w2iE.d.mts}

@@ -1,5 +1,5 @@
 /** An external database connection defines a connection between an external database and a Wix site. */
-export interface ExternalDatabaseConnection {
+interface ExternalDatabaseConnection {
     /**
      * Name of the external database connection.
      *
@@ -37,7 +37,7 @@ export interface ExternalDatabaseConnection {
      */
     capabilities?: Capabilities;
 }
-export declare enum CauseOfFailure {
+declare enum CauseOfFailure {
     /** No connection failure. */
     NONE = "NONE",
     /** General communication failure. */
@@ -50,8 +50,8 @@ export declare enum CauseOfFailure {
     DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
 }
 /** @enumType */
-export type CauseOfFailureWithLiterals = CauseOfFailure | 'NONE' | 'COMMUNICATION_FAILURE' | 'DESTINATION_HOST_UNREACHABLE' | 'UNAUTHORIZED' | 'DESTINATION_ENDPOINT_NOT_DEFINED';
-export declare enum CollectionsFound {
+type CauseOfFailureWithLiterals = CauseOfFailure | 'NONE' | 'COMMUNICATION_FAILURE' | 'DESTINATION_HOST_UNREACHABLE' | 'UNAUTHORIZED' | 'DESTINATION_ENDPOINT_NOT_DEFINED';
+declare enum CollectionsFound {
     /** Attempt to connect to the external database failed, so status is unknown. */
     UNKNOWN = "UNKNOWN",
     /** External database has collections. */
@@ -60,8 +60,8 @@ export declare enum CollectionsFound {
     NO = "NO"
 }
 /** @enumType */
-export type CollectionsFoundWithLiterals = CollectionsFound | 'UNKNOWN' | 'YES' | 'NO';
-export declare enum FieldType {
+type CollectionsFoundWithLiterals = CollectionsFound | 'UNKNOWN' | 'YES' | 'NO';
+declare enum FieldType {
     UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
     TEXT = "TEXT",
     NUMBER = "NUMBER",
@@ -103,8 +103,8 @@ export declare enum FieldType {
     LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
 }
 /** @enumType */
-export type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
-export interface ConnectionStatus {
+type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
+interface ConnectionStatus {
     /** Whether the connection was established successfully. */
     successful?: boolean;
     /** Whether and why the connection attempt failed. */
@@ -115,15 +115,13 @@ export interface ConnectionStatus {
      */
     hasCollections?: CollectionsFoundWithLiterals;
 }
-export declare enum ProtocolVersion {
+declare enum ProtocolVersion {
     UNKNOWN_PROTOCOL_VERSION = "UNKNOWN_PROTOCOL_VERSION",
     V1 = "V1",
     V2 = "V2",
     V3 = "V3"
 }
-/** @enumType */
-export type ProtocolVersionWithLiterals = ProtocolVersion | 'UNKNOWN_PROTOCOL_VERSION' | 'V1' | 'V2' | 'V3';
-export interface Capabilities {
+interface Capabilities {
     /** Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. */
     collectionModificationsSupported?: boolean;
     /**
@@ -132,34 +130,34 @@ export interface Capabilities {
      */
     fieldTypes?: FieldTypeWithLiterals[];
 }
-export interface GetExternalDatabaseConnectionRequest {
+interface GetExternalDatabaseConnectionRequest {
     /**
      * Name of the external database connection to retrieve.
      * @maxLength 255
      */
     name: string;
 }
-export interface GetExternalDatabaseConnectionResponse {
+interface GetExternalDatabaseConnectionResponse {
     /** Details of the retrieved external database connection. */
     externalDatabaseConnection?: ExternalDatabaseConnection;
 }
-export interface ListExternalDatabaseConnectionsRequest {
+interface ListExternalDatabaseConnectionsRequest {
     /** Paging metadata. */
     paging?: Paging;
 }
-export interface Paging {
+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 {
+interface ListExternalDatabaseConnectionsResponse {
     /** List of external database connections. */
     externalDatabaseConnections?: ExternalDatabaseConnection[];
     /** Paging metadata. */
     pagingMetadata?: PagingMetadata;
 }
-export interface PagingMetadata {
+interface PagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -169,13 +167,13 @@ export interface PagingMetadata {
     /** Flag that indicates the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
-export interface CreateExternalDatabaseConnectionRequest {
+interface CreateExternalDatabaseConnectionRequest {
     /** External database connection details. */
     externalDatabaseConnection: ExternalDatabaseConnection;
     /** Connection type. The connection type specifies the type of adaptor by which the external collection is integrated with the site. */
     connectionType: ConnectionTypeWithLiterals;
 }
-export declare enum ConnectionType {
+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). */
@@ -184,35 +182,35 @@ export declare enum ConnectionType {
     WIX_SERVICE_PLUGIN = "WIX_SERVICE_PLUGIN"
 }
 /** @enumType */
-export type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'STANDALONE' | 'WIX_SERVICE_PLUGIN';
-export interface CreateExternalDatabaseConnectionResponse {
+type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'STANDALONE' | 'WIX_SERVICE_PLUGIN';
+interface CreateExternalDatabaseConnectionResponse {
     /** Details of the created external database connection. */
     externalDatabaseConnection?: ExternalDatabaseConnection;
 }
-export interface UpdateExternalDatabaseConnectionRequest {
+interface UpdateExternalDatabaseConnectionRequest {
     /** Updated external database connection. The existing connection is replaced with this version. */
     externalDatabaseConnection: ExternalDatabaseConnection;
 }
-export interface UpdateExternalDatabaseConnectionResponse {
+interface UpdateExternalDatabaseConnectionResponse {
     /** Details of the updated external database connection. */
     externalDatabaseConnection?: ExternalDatabaseConnection;
 }
-export interface DeleteExternalDatabaseConnectionRequest {
+interface DeleteExternalDatabaseConnectionRequest {
     /**
      * Name of the external database connection to delete.
      * @maxLength 255
      */
     name: string;
 }
-export interface DeleteExternalDatabaseConnectionResponse {
+interface DeleteExternalDatabaseConnectionResponse {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+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;
+    _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`.
@@ -241,36 +239,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+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;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -286,7 +282,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -311,7 +307,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -333,7 +329,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -341,4 +337,39 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface ListExternalDatabaseConnectionsOptions {
+    /** Paging metadata. */
+    paging?: Paging;
+}
+interface UpdateExternalDatabaseConnection {
+    /**
+     * Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`.
+     * @format WEB_URL
+     */
+    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
+     * @maxLength 128
+     */
+    publicKey?: string | null;
+    /**
+     * Capabilities of the external database.
+     * @readonly
+     */
+    capabilities?: Capabilities;
+}
+
+export { type ActionEvent as A, type ConnectionTypeWithLiterals as C, type DeleteExternalDatabaseConnectionRequest as D, type ExternalDatabaseConnection as E, FieldType as F, type GetExternalDatabaseConnectionRequest as G, type IdentificationData as I, type ListExternalDatabaseConnectionsOptions as L, type MessageEnvelope as M, ProtocolVersion as P, type RestoreInfo as R, type UpdateExternalDatabaseConnection as U, WebhookIdentityType as W, type ListExternalDatabaseConnectionsResponse as a, CauseOfFailure as b, CollectionsFound as c, ConnectionType as d, type ConnectionStatus as e, type Capabilities as f, type GetExternalDatabaseConnectionResponse as g, type ListExternalDatabaseConnectionsRequest as h, type Paging as i, type PagingMetadata as j, type CreateExternalDatabaseConnectionRequest as k, type CreateExternalDatabaseConnectionResponse as l, type UpdateExternalDatabaseConnectionRequest as m, type UpdateExternalDatabaseConnectionResponse as n, type DeleteExternalDatabaseConnectionResponse as o, type DomainEvent as p, type DomainEventBodyOneOf as q, type EntityCreatedEvent as r, type EntityUpdatedEvent as s, type EntityDeletedEvent as t, type IdentificationDataIdOneOf as u };

package/build/{cjs/src/data-v1-external-database-connection-external-database-connections.types.d.ts → data-v1-external-database-connection-external-database-connections.universal-DDx0w2iE.d.ts}

@@ -1,5 +1,5 @@
 /** An external database connection defines a connection between an external database and a Wix site. */
-export interface ExternalDatabaseConnection {
+interface ExternalDatabaseConnection {
     /**
      * Name of the external database connection.
      *
@@ -37,7 +37,7 @@ export interface ExternalDatabaseConnection {
      */
     capabilities?: Capabilities;
 }
-export declare enum CauseOfFailure {
+declare enum CauseOfFailure {
     /** No connection failure. */
     NONE = "NONE",
     /** General communication failure. */
@@ -50,8 +50,8 @@ export declare enum CauseOfFailure {
     DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
 }
 /** @enumType */
-export type CauseOfFailureWithLiterals = CauseOfFailure | 'NONE' | 'COMMUNICATION_FAILURE' | 'DESTINATION_HOST_UNREACHABLE' | 'UNAUTHORIZED' | 'DESTINATION_ENDPOINT_NOT_DEFINED';
-export declare enum CollectionsFound {
+type CauseOfFailureWithLiterals = CauseOfFailure | 'NONE' | 'COMMUNICATION_FAILURE' | 'DESTINATION_HOST_UNREACHABLE' | 'UNAUTHORIZED' | 'DESTINATION_ENDPOINT_NOT_DEFINED';
+declare enum CollectionsFound {
     /** Attempt to connect to the external database failed, so status is unknown. */
     UNKNOWN = "UNKNOWN",
     /** External database has collections. */
@@ -60,8 +60,8 @@ export declare enum CollectionsFound {
     NO = "NO"
 }
 /** @enumType */
-export type CollectionsFoundWithLiterals = CollectionsFound | 'UNKNOWN' | 'YES' | 'NO';
-export declare enum FieldType {
+type CollectionsFoundWithLiterals = CollectionsFound | 'UNKNOWN' | 'YES' | 'NO';
+declare enum FieldType {
     UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
     TEXT = "TEXT",
     NUMBER = "NUMBER",
@@ -103,8 +103,8 @@ export declare enum FieldType {
     LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
 }
 /** @enumType */
-export type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
-export interface ConnectionStatus {
+type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
+interface ConnectionStatus {
     /** Whether the connection was established successfully. */
     successful?: boolean;
     /** Whether and why the connection attempt failed. */
@@ -115,15 +115,13 @@ export interface ConnectionStatus {
      */
     hasCollections?: CollectionsFoundWithLiterals;
 }
-export declare enum ProtocolVersion {
+declare enum ProtocolVersion {
     UNKNOWN_PROTOCOL_VERSION = "UNKNOWN_PROTOCOL_VERSION",
     V1 = "V1",
     V2 = "V2",
     V3 = "V3"
 }
-/** @enumType */
-export type ProtocolVersionWithLiterals = ProtocolVersion | 'UNKNOWN_PROTOCOL_VERSION' | 'V1' | 'V2' | 'V3';
-export interface Capabilities {
+interface Capabilities {
     /** Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. */
     collectionModificationsSupported?: boolean;
     /**
@@ -132,34 +130,34 @@ export interface Capabilities {
      */
     fieldTypes?: FieldTypeWithLiterals[];
 }
-export interface GetExternalDatabaseConnectionRequest {
+interface GetExternalDatabaseConnectionRequest {
     /**
      * Name of the external database connection to retrieve.
      * @maxLength 255
      */
     name: string;
 }
-export interface GetExternalDatabaseConnectionResponse {
+interface GetExternalDatabaseConnectionResponse {
     /** Details of the retrieved external database connection. */
     externalDatabaseConnection?: ExternalDatabaseConnection;
 }
-export interface ListExternalDatabaseConnectionsRequest {
+interface ListExternalDatabaseConnectionsRequest {
     /** Paging metadata. */
     paging?: Paging;
 }
-export interface Paging {
+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 {
+interface ListExternalDatabaseConnectionsResponse {
     /** List of external database connections. */
     externalDatabaseConnections?: ExternalDatabaseConnection[];
     /** Paging metadata. */
     pagingMetadata?: PagingMetadata;
 }
-export interface PagingMetadata {
+interface PagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -169,13 +167,13 @@ export interface PagingMetadata {
     /** Flag that indicates the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
-export interface CreateExternalDatabaseConnectionRequest {
+interface CreateExternalDatabaseConnectionRequest {
     /** External database connection details. */
     externalDatabaseConnection: ExternalDatabaseConnection;
     /** Connection type. The connection type specifies the type of adaptor by which the external collection is integrated with the site. */
     connectionType: ConnectionTypeWithLiterals;
 }
-export declare enum ConnectionType {
+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). */
@@ -184,35 +182,35 @@ export declare enum ConnectionType {
     WIX_SERVICE_PLUGIN = "WIX_SERVICE_PLUGIN"
 }
 /** @enumType */
-export type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'STANDALONE' | 'WIX_SERVICE_PLUGIN';
-export interface CreateExternalDatabaseConnectionResponse {
+type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'STANDALONE' | 'WIX_SERVICE_PLUGIN';
+interface CreateExternalDatabaseConnectionResponse {
     /** Details of the created external database connection. */
     externalDatabaseConnection?: ExternalDatabaseConnection;
 }
-export interface UpdateExternalDatabaseConnectionRequest {
+interface UpdateExternalDatabaseConnectionRequest {
     /** Updated external database connection. The existing connection is replaced with this version. */
     externalDatabaseConnection: ExternalDatabaseConnection;
 }
-export interface UpdateExternalDatabaseConnectionResponse {
+interface UpdateExternalDatabaseConnectionResponse {
     /** Details of the updated external database connection. */
     externalDatabaseConnection?: ExternalDatabaseConnection;
 }
-export interface DeleteExternalDatabaseConnectionRequest {
+interface DeleteExternalDatabaseConnectionRequest {
     /**
      * Name of the external database connection to delete.
      * @maxLength 255
      */
     name: string;
 }
-export interface DeleteExternalDatabaseConnectionResponse {
+interface DeleteExternalDatabaseConnectionResponse {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+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;
+    _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`.
@@ -241,36 +239,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+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;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -286,7 +282,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -311,7 +307,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -333,7 +329,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -341,4 +337,39 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface ListExternalDatabaseConnectionsOptions {
+    /** Paging metadata. */
+    paging?: Paging;
+}
+interface UpdateExternalDatabaseConnection {
+    /**
+     * Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`.
+     * @format WEB_URL
+     */
+    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
+     * @maxLength 128
+     */
+    publicKey?: string | null;
+    /**
+     * Capabilities of the external database.
+     * @readonly
+     */
+    capabilities?: Capabilities;
+}
+
+export { type ActionEvent as A, type ConnectionTypeWithLiterals as C, type DeleteExternalDatabaseConnectionRequest as D, type ExternalDatabaseConnection as E, FieldType as F, type GetExternalDatabaseConnectionRequest as G, type IdentificationData as I, type ListExternalDatabaseConnectionsOptions as L, type MessageEnvelope as M, ProtocolVersion as P, type RestoreInfo as R, type UpdateExternalDatabaseConnection as U, WebhookIdentityType as W, type ListExternalDatabaseConnectionsResponse as a, CauseOfFailure as b, CollectionsFound as c, ConnectionType as d, type ConnectionStatus as e, type Capabilities as f, type GetExternalDatabaseConnectionResponse as g, type ListExternalDatabaseConnectionsRequest as h, type Paging as i, type PagingMetadata as j, type CreateExternalDatabaseConnectionRequest as k, type CreateExternalDatabaseConnectionResponse as l, type UpdateExternalDatabaseConnectionRequest as m, type UpdateExternalDatabaseConnectionResponse as n, type DeleteExternalDatabaseConnectionResponse as o, type DomainEvent as p, type DomainEventBodyOneOf as q, type EntityCreatedEvent as r, type EntityUpdatedEvent as s, type EntityDeletedEvent as t, type IdentificationDataIdOneOf as u };

package/build/index.d.mts

@@ -0,0 +1,66 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { E as ExternalDatabaseConnection, L as ListExternalDatabaseConnectionsOptions, a as ListExternalDatabaseConnectionsResponse, C as ConnectionTypeWithLiterals, U as UpdateExternalDatabaseConnection } from './data-v1-external-database-connection-external-database-connections.universal-DDx0w2iE.mjs';
+export { A as ActionEvent, f as Capabilities, b as CauseOfFailure, c as CollectionsFound, e as ConnectionStatus, d as ConnectionType, k as CreateExternalDatabaseConnectionRequest, l as CreateExternalDatabaseConnectionResponse, D as DeleteExternalDatabaseConnectionRequest, o as DeleteExternalDatabaseConnectionResponse, p as DomainEvent, q as DomainEventBodyOneOf, r as EntityCreatedEvent, t as EntityDeletedEvent, s as EntityUpdatedEvent, F as FieldType, G as GetExternalDatabaseConnectionRequest, g as GetExternalDatabaseConnectionResponse, I as IdentificationData, u as IdentificationDataIdOneOf, h as ListExternalDatabaseConnectionsRequest, M as MessageEnvelope, i as Paging, j as PagingMetadata, P as ProtocolVersion, R as RestoreInfo, m as UpdateExternalDatabaseConnectionRequest, n as UpdateExternalDatabaseConnectionResponse, W as WebhookIdentityType } from './data-v1-external-database-connection-external-database-connections.universal-DDx0w2iE.mjs';
+
+declare function getExternalDatabaseConnection$1(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>;
+}
+declare function listExternalDatabaseConnections$1(httpClient: HttpClient): ListExternalDatabaseConnectionsSignature;
+interface ListExternalDatabaseConnectionsSignature {
+    /**
+     * Lists all of the site's external database connections of all adaptor types.
+     */
+    (options?: ListExternalDatabaseConnectionsOptions | undefined): Promise<ListExternalDatabaseConnectionsResponse>;
+}
+declare function createExternalDatabaseConnection$1(httpClient: HttpClient): CreateExternalDatabaseConnectionSignature;
+interface CreateExternalDatabaseConnectionSignature {
+    /**
+     * Creates a new external database connection.
+     *
+     * Before you can establish a connection between a site and an external database, you must prepare an external database adaptor.
+     * @param - External database connection details.
+     * @param - Connection type. The connection type specifies the type of adaptor by which the external collection is integrated with the site.
+     * @param - Options for creating an external database connection.
+     * @returns Details of the created external database connection.
+     */
+    (externalDatabaseConnection: ExternalDatabaseConnection, connectionType: ConnectionTypeWithLiterals): Promise<ExternalDatabaseConnection>;
+}
+declare function updateExternalDatabaseConnection$1(httpClient: HttpClient): UpdateExternalDatabaseConnectionSignature;
+interface UpdateExternalDatabaseConnectionSignature {
+    /**
+     * Updates an external database connection.
+     *
+     * > **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>;
+}
+declare function deleteExternalDatabaseConnection$1(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, create a new external database connection.
+     * @param - Name of the external database connection to delete.
+     */
+    (name: string): Promise<void>;
+}
+
+declare const getExternalDatabaseConnection: MaybeContext<BuildRESTFunction<typeof getExternalDatabaseConnection$1> & typeof getExternalDatabaseConnection$1>;
+declare const listExternalDatabaseConnections: MaybeContext<BuildRESTFunction<typeof listExternalDatabaseConnections$1> & typeof listExternalDatabaseConnections$1>;
+declare const createExternalDatabaseConnection: MaybeContext<BuildRESTFunction<typeof createExternalDatabaseConnection$1> & typeof createExternalDatabaseConnection$1>;
+declare const updateExternalDatabaseConnection: MaybeContext<BuildRESTFunction<typeof updateExternalDatabaseConnection$1> & typeof updateExternalDatabaseConnection$1>;
+declare const deleteExternalDatabaseConnection: MaybeContext<BuildRESTFunction<typeof deleteExternalDatabaseConnection$1> & typeof deleteExternalDatabaseConnection$1>;
+
+export { ExternalDatabaseConnection, ListExternalDatabaseConnectionsOptions, ListExternalDatabaseConnectionsResponse, UpdateExternalDatabaseConnection, createExternalDatabaseConnection, deleteExternalDatabaseConnection, getExternalDatabaseConnection, listExternalDatabaseConnections, updateExternalDatabaseConnection };