@wix/auto_sdk_data_external-database-connections 1.0.16 → 1.0.17

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 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.js';
-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.js';
+import { ExternalDatabaseConnection, ListExternalDatabaseConnectionsOptions, ListExternalDatabaseConnectionsResponse, ConnectionTypeWithLiterals, UpdateExternalDatabaseConnection } from './index.typings.js';
+export { ActionEvent, Capabilities, CauseOfFailure, CollectionsFound, ConnectionStatus, ConnectionType, CreateExternalDatabaseConnectionRequest, CreateExternalDatabaseConnectionResponse, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FieldType, GetExternalDatabaseConnectionRequest, GetExternalDatabaseConnectionResponse, IdentificationData, IdentificationDataIdOneOf, ListExternalDatabaseConnectionsRequest, MessageEnvelope, Paging, PagingMetadata, ProtocolVersion, RestoreInfo, UpdateExternalDatabaseConnectionRequest, UpdateExternalDatabaseConnectionResponse, WebhookIdentityType } from './index.typings.js';
 
 declare function getExternalDatabaseConnection$1(httpClient: HttpClient): GetExternalDatabaseConnectionSignature;
 interface GetExternalDatabaseConnectionSignature {

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

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /** An external database connection defines a connection between an external database and a Wix site. */
 interface ExternalDatabaseConnection {
     /**
@@ -121,6 +123,8 @@ declare enum ProtocolVersion {
     V2 = "V2",
     V3 = "V3"
 }
+/** @enumType */
+type ProtocolVersionWithLiterals = ProtocolVersion | 'UNKNOWN_PROTOCOL_VERSION' | 'V1' | 'V2' | 'V3';
 interface Capabilities {
     /** Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. */
     collectionModificationsSupported?: boolean;
@@ -338,10 +342,67 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type ExternalDatabaseConnectionNonNullablePaths = `name` | `connectionStatus.successful` | `connectionStatus.causeOfFailure` | `connectionStatus.hasCollections` | `capabilities.collectionModificationsSupported` | `capabilities.fieldTypes`;
+/**
+ * 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
+ * @applicableIdentity APP
+ * @returns Details of the retrieved external database connection.
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.GetExternalDatabaseConnection
+ */
+declare function getExternalDatabaseConnection(name: string): Promise<NonNullablePaths<ExternalDatabaseConnection, ExternalDatabaseConnectionNonNullablePaths>>;
+/**
+ * Lists all of the site's external database connections of all adaptor types.
+ * @public
+ * @permissionId WIX_DATA.LIST_EXTERNAL_DATABASE_CONNECTIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.ListExternalDatabaseConnections
+ */
+declare function listExternalDatabaseConnections(options?: ListExternalDatabaseConnectionsOptions): Promise<NonNullablePaths<ListExternalDatabaseConnectionsResponse, {
+    [P in ExternalDatabaseConnectionNonNullablePaths]: `externalDatabaseConnections.${number}.${P}`;
+}[ExternalDatabaseConnectionNonNullablePaths]>>;
 interface ListExternalDatabaseConnectionsOptions {
     /** Paging metadata. */
     paging?: Paging;
 }
+/**
+ * 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 externalDatabaseConnection - External database connection details.
+ * @param connectionType - Connection type. The connection type specifies the type of adaptor by which the external collection is integrated with the site.
+ * @public
+ * @requiredField connectionType
+ * @requiredField externalDatabaseConnection
+ * @requiredField externalDatabaseConnection.name
+ * @param options - Options for creating an external database connection.
+ * @permissionId WIX_DATA.CREATE_EXTERNAL_DATABASE_CONNECTION
+ * @applicableIdentity APP
+ * @returns Details of the created external database connection.
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.CreateExternalDatabaseConnection
+ */
+declare function createExternalDatabaseConnection(externalDatabaseConnection: NonNullablePaths<ExternalDatabaseConnection, `name`>, connectionType: ConnectionTypeWithLiterals): Promise<NonNullablePaths<ExternalDatabaseConnection, ExternalDatabaseConnectionNonNullablePaths>>;
+/**
+ * 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 - 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
+ * @applicableIdentity APP
+ * @returns Details of the updated external database connection.
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.UpdateExternalDatabaseConnection
+ */
+declare function updateExternalDatabaseConnection(name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection): Promise<NonNullablePaths<ExternalDatabaseConnection, ExternalDatabaseConnectionNonNullablePaths>>;
 interface UpdateExternalDatabaseConnection {
     /**
      * Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`.
@@ -371,5 +432,17 @@ interface UpdateExternalDatabaseConnection {
      */
     capabilities?: Capabilities;
 }
+/**
+ * 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 - Name of the external database connection to delete.
+ * @public
+ * @requiredField name
+ * @permissionId WIX_DATA.DELETE_EXTERNAL_DATABASE_CONNECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.DeleteExternalDatabaseConnection
+ */
+declare function deleteExternalDatabaseConnection(name: string): Promise<void>;
 
-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 };
+export { type ActionEvent, type Capabilities, CauseOfFailure, type CauseOfFailureWithLiterals, CollectionsFound, type CollectionsFoundWithLiterals, type ConnectionStatus, ConnectionType, type ConnectionTypeWithLiterals, type CreateExternalDatabaseConnectionRequest, type CreateExternalDatabaseConnectionResponse, type DeleteExternalDatabaseConnectionRequest, type DeleteExternalDatabaseConnectionResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExternalDatabaseConnection, FieldType, type FieldTypeWithLiterals, type GetExternalDatabaseConnectionRequest, type GetExternalDatabaseConnectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListExternalDatabaseConnectionsOptions, type ListExternalDatabaseConnectionsRequest, type ListExternalDatabaseConnectionsResponse, type MessageEnvelope, type Paging, type PagingMetadata, ProtocolVersion, type ProtocolVersionWithLiterals, type RestoreInfo, type UpdateExternalDatabaseConnection, type UpdateExternalDatabaseConnectionRequest, type UpdateExternalDatabaseConnectionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createExternalDatabaseConnection, deleteExternalDatabaseConnection, getExternalDatabaseConnection, listExternalDatabaseConnections, updateExternalDatabaseConnection };