@wix/data 1.0.89 → 1.0.91

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

@@ -1,433 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/** An external database connection defines a connection between an external database and a Wix site or project. */
-export interface ExternalDatabaseConnection {
-    /**
-     * Name of the external database connection.
-     * An external database connection may connect to one or more external data collections or tables.
-     * These are represented as `connectionName/dataCollectionId`.
-     */
-    name?: string;
-    /** Base URL for provisioning and managing data in the external database. For example: `https://example.com/my-external-database`. */
-    endpoint?: string | null;
-    /**
-     * Settings passed to the external database connection as part of each request.
-     * These settings can relate to authentication, tenancy, or provide any other information needed 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;
-    /**
-     * The external database's capabilities.
-     * @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 {
-    UNKNOWN = "UNKNOWN",
-    YES = "YES",
-    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;
-    /**
-     * If and why a connection attempt failed.
-     * + `NONE`: No connection failure.
-     * + `COMMUNICATION_FAILURE`: General communication failure.
-     * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
-     * + `UNAUTHORIZED`: Unauthorized to access external database.
-     * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
-     */
-    causeOfFailure?: CauseOfFailure;
-    /**
-     * Whether the external database has existing collections. Possible values are:
-     * + `UNKNOWN`: The attempt to connect to the external database failed, so status is unknown.
-     * + `NO`: External database does not have any existing collections.
-     * + `YES`: External database has existing 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.
-     * This field only applies when `collectionModificationsSupported` is `true`.
-     */
-    fieldTypes?: FieldType[];
-}
-export interface GetExternalDatabaseConnectionRequest {
-    /** Name of the external database connection to retrieve. */
-    name: string;
-}
-export interface GetExternalDatabaseConnectionResponse {
-    /** Details of the external database connection requested. */
-    externalDatabaseConnection?: ExternalDatabaseConnection;
-}
-export interface ListExternalDatabaseConnectionsRequest {
-    /** Paging */
-    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. */
-    connectionType: ConnectionType;
-}
-export declare enum ConnectionType {
-    /** Unknown connection type. */
-    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
-    /**
-     * Connection to database adapter that implements legacy External Database Collections SPI (protocol version 1 or 2)
-     * https://www.wix.com/velo/reference/spis/external-database-collections/introduction
-     */
-    STANDALONE = "STANDALONE",
-    /**
-     * Connection to database adapter that implements External Database SPI (protocol version 3)
-     * https://dev.wix.com/docs/rest/internal-only/wix-data/external-database-spi/introduction
-     * https://dev.wix.com/docs/rest/articles/getting-started/service-provider-interface
-     */
-    WIX_SPI = "WIX_SPI"
-}
-export interface CreateExternalDatabaseConnectionResponse {
-    /** Details of external database connection created. */
-    externalDatabaseConnection?: ExternalDatabaseConnection;
-}
-export interface UpdateExternalDatabaseConnectionRequest {
-    /** Updated external database connection details. The existing connection is replaced with this version. */
-    externalDatabaseConnection: ExternalDatabaseConnection;
-}
-export interface UpdateExternalDatabaseConnectionResponse {
-    /** Updated external database connection details. */
-    externalDatabaseConnection?: ExternalDatabaseConnection;
-}
-export interface DeleteExternalDatabaseConnectionRequest {
-    /** Name of the external database connection to delete. */
-    name: string;
-}
-export interface DeleteExternalDatabaseConnectionResponse {
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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. */
-    eventTime?: Date;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface GetExternalDatabaseConnectionResponseNonNullableFields {
-    externalDatabaseConnection?: {
-        name: string;
-        connectionStatus?: {
-            successful: boolean;
-            causeOfFailure: CauseOfFailure;
-            hasCollections: CollectionsFound;
-        };
-        capabilities?: {
-            collectionModificationsSupported: boolean;
-            fieldTypes: FieldType[];
-        };
-    };
-}
-export interface ListExternalDatabaseConnectionsResponseNonNullableFields {
-    externalDatabaseConnections: {
-        name: string;
-        connectionStatus?: {
-            successful: boolean;
-            causeOfFailure: CauseOfFailure;
-            hasCollections: CollectionsFound;
-        };
-        capabilities?: {
-            collectionModificationsSupported: boolean;
-            fieldTypes: FieldType[];
-        };
-    }[];
-}
-export interface CreateExternalDatabaseConnectionResponseNonNullableFields {
-    externalDatabaseConnection?: {
-        name: string;
-        connectionStatus?: {
-            successful: boolean;
-            causeOfFailure: CauseOfFailure;
-            hasCollections: CollectionsFound;
-        };
-        capabilities?: {
-            collectionModificationsSupported: boolean;
-            fieldTypes: FieldType[];
-        };
-    };
-}
-export interface UpdateExternalDatabaseConnectionResponseNonNullableFields {
-    externalDatabaseConnection?: {
-        name: string;
-        connectionStatus?: {
-            successful: boolean;
-            causeOfFailure: CauseOfFailure;
-            hasCollections: CollectionsFound;
-        };
-        capabilities?: {
-            collectionModificationsSupported: boolean;
-            fieldTypes: FieldType[];
-        };
-    };
-}
-export declare const onExternalDatabaseConnectionCreated: EventDefinition<DomainCreatedEvent<ExternalDatabaseConnection>, "wix.data.v1.external_database_connection_created">;
-export declare const onExternalDatabaseConnectionUpdated: EventDefinition<DomainUpdatedEvent<ExternalDatabaseConnection>, "wix.data.v1.external_database_connection_updated">;
-export declare const onExternalDatabaseConnectionDeleted: EventDefinition<DomainDeletedEvent<ExternalDatabaseConnection>, "wix.data.v1.external_database_connection_deleted">;
-/**
- * Retrieves an external database connection by name.
- * @param name - Name of the external database connection to retrieve.
- * @public
- * @documentationMaturity preview
- * @requiredField name
- * @permissionScope Manage External Database Connections
- * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
- * @applicableIdentity APP
- * @returns Details of the external database connection requested.
- */
-export declare function getExternalDatabaseConnection(name: string): Promise<ExternalDatabaseConnection & NonNullable<GetExternalDatabaseConnectionResponseNonNullableFields>['externalDatabaseConnection']>;
-/**
- * Retrieves a list of all external database collections associated with the site or project.
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage External Database Connections
- * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
- * @applicableIdentity APP
- */
-export declare function listExternalDatabaseConnections(options?: ListExternalDatabaseConnectionsOptions): Promise<ListExternalDatabaseConnectionsResponse & ListExternalDatabaseConnectionsResponseNonNullableFields>;
-export interface ListExternalDatabaseConnectionsOptions {
-    /** Paging */
-    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.
- * @public
- * @documentationMaturity preview
- * @requiredField externalDatabaseConnection
- * @requiredField externalDatabaseConnection.name
- * @requiredField options
- * @requiredField options.connectionType
- * @param options - Options for creating an external database connection.
- * @permissionScope Manage External Database Connections
- * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
- * @applicableIdentity APP
- * @returns Details of external database connection created.
- */
-export declare function createExternalDatabaseConnection(externalDatabaseConnection: ExternalDatabaseConnection, options: CreateExternalDatabaseConnectionOptions): Promise<ExternalDatabaseConnection & NonNullable<CreateExternalDatabaseConnectionResponseNonNullableFields>['externalDatabaseConnection']>;
-export interface CreateExternalDatabaseConnectionOptions {
-    /** Connection type. */
-    connectionType: ConnectionType;
-}
-/**
- * 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 may connect to one or more external data collections or tables.
- * These are represented as `connectionName/dataCollectionId`.
- * @public
- * @documentationMaturity preview
- * @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.
- * @permissionScope Manage External Database Connections
- * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
- * @applicableIdentity APP
- * @returns Updated external database connection details.
- */
-export declare function updateExternalDatabaseConnection(name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection): Promise<ExternalDatabaseConnection & NonNullable<UpdateExternalDatabaseConnectionResponseNonNullableFields>['externalDatabaseConnection']>;
-export interface UpdateExternalDatabaseConnection {
-    /** Base URL for provisioning and managing data in the external database. For example: `https://example.com/my-external-database`. */
-    endpoint?: string | null;
-    /**
-     * Settings passed to the external database connection as part of each request.
-     * These settings can relate to authentication, tenancy, or provide any other information needed 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;
-    /**
-     * The external database's capabilities.
-     * @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
- * @documentationMaturity preview
- * @requiredField name
- * @permissionScope Manage External Database Connections
- * @permissionScopeId SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE
- * @applicableIdentity APP
- */
-export declare function deleteExternalDatabaseConnection(name: string): Promise<void>;