@wix/data 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/data-v1-external-database-connection.http.d.ts +4 -4
- package/build/cjs/src/data-v1-external-database-connection.http.js +4 -4
- package/build/cjs/src/data-v1-external-database-connection.http.js.map +1 -1
- package/build/cjs/src/data-v1-external-database-connection.public.d.ts +2 -1
- package/build/cjs/src/data-v1-external-database-connection.public.js +3 -1
- package/build/cjs/src/data-v1-external-database-connection.public.js.map +1 -1
- package/build/cjs/src/data-v1-external-database-connection.types.d.ts +29 -2
- package/build/cjs/src/data-v1-external-database-connection.types.js +12 -0
- package/build/cjs/src/data-v1-external-database-connection.types.js.map +1 -1
- package/build/cjs/src/data-v1-external-database-connection.universal.d.ts +41 -6
- package/build/cjs/src/data-v1-external-database-connection.universal.js +18 -5
- package/build/cjs/src/data-v1-external-database-connection.universal.js.map +1 -1
- package/build/cjs/src/data-v2-data-collection.http.d.ts +4 -4
- package/build/cjs/src/data-v2-data-collection.http.js +4 -4
- package/build/cjs/src/data-v2-data-collection.types.d.ts +1 -1
- package/build/cjs/src/data-v2-data-collection.universal.d.ts +9 -5
- package/build/cjs/src/data-v2-data-collection.universal.js +8 -4
- package/build/cjs/src/data-v2-data-collection.universal.js.map +1 -1
- package/build/cjs/src/data-v2-data-item.http.d.ts +44 -22
- package/build/cjs/src/data-v2-data-item.http.js +44 -22
- package/build/cjs/src/data-v2-data-item.http.js.map +1 -1
- package/build/cjs/src/data-v2-data-item.universal.d.ts +77 -37
- package/build/cjs/src/data-v2-data-item.universal.js +62 -21
- package/build/cjs/src/data-v2-data-item.universal.js.map +1 -1
- package/build/cjs/src/data-v2-index.http.d.ts +3 -3
- package/build/cjs/src/data-v2-index.http.js +3 -3
- package/build/cjs/src/data-v2-index.universal.d.ts +15 -9
- package/build/cjs/src/data-v2-index.universal.js +6 -3
- package/build/cjs/src/data-v2-index.universal.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.http.d.ts +4 -4
- package/build/es/src/data-v1-external-database-connection.http.js +4 -4
- package/build/es/src/data-v1-external-database-connection.http.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.public.d.ts +2 -1
- package/build/es/src/data-v1-external-database-connection.public.js +1 -0
- package/build/es/src/data-v1-external-database-connection.public.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.types.d.ts +29 -2
- package/build/es/src/data-v1-external-database-connection.types.js +11 -1
- package/build/es/src/data-v1-external-database-connection.types.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.universal.d.ts +41 -6
- package/build/es/src/data-v1-external-database-connection.universal.js +17 -4
- package/build/es/src/data-v1-external-database-connection.universal.js.map +1 -1
- package/build/es/src/data-v2-data-collection.http.d.ts +4 -4
- package/build/es/src/data-v2-data-collection.http.js +4 -4
- package/build/es/src/data-v2-data-collection.types.d.ts +1 -1
- package/build/es/src/data-v2-data-collection.universal.d.ts +9 -5
- package/build/es/src/data-v2-data-collection.universal.js +8 -4
- package/build/es/src/data-v2-data-collection.universal.js.map +1 -1
- package/build/es/src/data-v2-data-item.http.d.ts +44 -22
- package/build/es/src/data-v2-data-item.http.js +44 -22
- package/build/es/src/data-v2-data-item.http.js.map +1 -1
- package/build/es/src/data-v2-data-item.universal.d.ts +77 -37
- package/build/es/src/data-v2-data-item.universal.js +62 -21
- package/build/es/src/data-v2-data-item.universal.js.map +1 -1
- package/build/es/src/data-v2-index.http.d.ts +3 -3
- package/build/es/src/data-v2-index.http.js +3 -3
- package/build/es/src/data-v2-index.universal.d.ts +15 -9
- package/build/es/src/data-v2-index.universal.js +6 -3
- package/build/es/src/data-v2-index.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -2,19 +2,19 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
|
2
2
|
import { CreateExternalDatabaseConnectionRequest, CreateExternalDatabaseConnectionResponse, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionResponse, GetExternalDatabaseConnectionRequest, GetExternalDatabaseConnectionResponse, ListExternalDatabaseConnectionsRequest, ListExternalDatabaseConnectionsResponse, UpdateExternalDatabaseConnectionRequest, UpdateExternalDatabaseConnectionResponse } from './data-v1-external-database-connection.types';
|
|
3
3
|
/** Retrieves an external database connection by name. */
|
|
4
4
|
export declare function getExternalDatabaseConnection(payload: GetExternalDatabaseConnectionRequest): RequestOptionsFactory<GetExternalDatabaseConnectionResponse>;
|
|
5
|
-
/** Retrieves a list of all external database collections associated with the site. */
|
|
5
|
+
/** Retrieves a list of all external database collections associated with the site or project. */
|
|
6
6
|
export declare function listExternalDatabaseConnections(payload: ListExternalDatabaseConnectionsRequest): RequestOptionsFactory<ListExternalDatabaseConnectionsResponse>;
|
|
7
7
|
/**
|
|
8
8
|
* Creates a new external database connection.
|
|
9
9
|
*
|
|
10
|
-
* The
|
|
10
|
+
* The `options.externalDatabaseConnection` parameter must include a name, base URL, and configuration details for the external database.
|
|
11
11
|
* If any of these are missing, the external database connection isn't created.
|
|
12
12
|
*/
|
|
13
13
|
export declare function createExternalDatabaseConnection(payload: CreateExternalDatabaseConnectionRequest): RequestOptionsFactory<CreateExternalDatabaseConnectionResponse>;
|
|
14
14
|
/**
|
|
15
15
|
* Updates an external database connection.
|
|
16
16
|
*
|
|
17
|
-
* An external database collection name must be
|
|
17
|
+
* An external database collection name must be provided in `name`.
|
|
18
18
|
* If an existing external database connection is found with the same name, that connection's details are updated.
|
|
19
19
|
* If no external database connection has that name, the request fails.
|
|
20
20
|
*
|
|
@@ -24,6 +24,6 @@ export declare function updateExternalDatabaseConnection(payload: UpdateExternal
|
|
|
24
24
|
/**
|
|
25
25
|
* Deletes an external database connection.
|
|
26
26
|
*
|
|
27
|
-
* > **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](https://dev.wix.com/api/
|
|
27
|
+
* > **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](https://dev.wix.com/api/sdk/data/externaldatabaseconnections/deleteexternaldatabaseconnection).
|
|
28
28
|
*/
|
|
29
29
|
export declare function deleteExternalDatabaseConnection(payload: DeleteExternalDatabaseConnectionRequest): RequestOptionsFactory<DeleteExternalDatabaseConnectionResponse>;
|
|
@@ -281,7 +281,7 @@ function getExternalDatabaseConnection(payload) {
|
|
|
281
281
|
return __getExternalDatabaseConnection;
|
|
282
282
|
}
|
|
283
283
|
exports.getExternalDatabaseConnection = getExternalDatabaseConnection;
|
|
284
|
-
/** Retrieves a list of all external database collections associated with the site. */
|
|
284
|
+
/** Retrieves a list of all external database collections associated with the site or project. */
|
|
285
285
|
function listExternalDatabaseConnections(payload) {
|
|
286
286
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listExternalDatabaseConnectionsRequest, {});
|
|
287
287
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_listExternalDatabaseConnectionsResponse, {});
|
|
@@ -308,7 +308,7 @@ exports.listExternalDatabaseConnections = listExternalDatabaseConnections;
|
|
|
308
308
|
/**
|
|
309
309
|
* Creates a new external database connection.
|
|
310
310
|
*
|
|
311
|
-
* The
|
|
311
|
+
* The `options.externalDatabaseConnection` parameter must include a name, base URL, and configuration details for the external database.
|
|
312
312
|
* If any of these are missing, the external database connection isn't created.
|
|
313
313
|
*/
|
|
314
314
|
function createExternalDatabaseConnection(payload) {
|
|
@@ -337,7 +337,7 @@ exports.createExternalDatabaseConnection = createExternalDatabaseConnection;
|
|
|
337
337
|
/**
|
|
338
338
|
* Updates an external database connection.
|
|
339
339
|
*
|
|
340
|
-
* An external database collection name must be
|
|
340
|
+
* An external database collection name must be provided in `name`.
|
|
341
341
|
* If an existing external database connection is found with the same name, that connection's details are updated.
|
|
342
342
|
* If no external database connection has that name, the request fails.
|
|
343
343
|
*
|
|
@@ -369,7 +369,7 @@ exports.updateExternalDatabaseConnection = updateExternalDatabaseConnection;
|
|
|
369
369
|
/**
|
|
370
370
|
* Deletes an external database connection.
|
|
371
371
|
*
|
|
372
|
-
* > **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](https://dev.wix.com/api/
|
|
372
|
+
* > **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](https://dev.wix.com/api/sdk/data/externaldatabaseconnections/deleteexternaldatabaseconnection).
|
|
373
373
|
*/
|
|
374
374
|
function deleteExternalDatabaseConnection(payload) {
|
|
375
375
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteExternalDatabaseConnectionRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v1-external-database-connection.http.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAgBhD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AACrD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AACrD,MAAM,qCAAqC,GAAG,EAAE,CAAC;AACjD,MAAM,sCAAsC,GAAG,EAAE,CAAC;AAClD,MAAM,uCAAuC,GAAG,EAAE,CAAC;AACnD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AAErD,SAAS,kFAAkF,CACzF,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,eAAe;aAC1B;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,eAAe;aAC1B;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,yBAAyB,EAAE;YACzB;gBACE,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,mDAAmD;gBAC5D,QAAQ,EAAE,mCAAmC;aAC9C;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,mDAAmD;gBAC5D,QAAQ,EAAE,mCAAmC;aAC9C;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,mDAAmD;gBAC5D,QAAQ,EAAE,mCAAmC;aAC9C;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,0BAA0B;aACrC;YACD;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,mCAAmC;aAC9C;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,WAAW;aACtB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,UAAU;aACrB;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,wBAAwB;aACnC;YACD;gBACE,OAAO,EAAE,cAAc;gBACvB,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,WAAW;aACtB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,UAAU;aACrB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,yDAAyD;AACzD,SAAgB,6BAA6B,CAC3C,OAA6C;IAE7C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qCAAqC,EACrC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,sCAAsC,EACtC,EAAE,CACH,CAAC;IAEF,SAAS,+BAA+B,CAAC,EAAE,IAAI,EAAO;QACpD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,0CAA0C;YACtD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,8GAA8G;YAChH,GAAG,EAAE,kFAAkF,CACrF;gBACE,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+BAA+B,CAAC,OAAO,GAAG,OAAO,CAAC;IAElD,OAAO,+BAA+B,CAAC;AACzC,CAAC;AApCD,sEAoCC;AAED,
|
|
1
|
+
{"version":3,"file":"data-v1-external-database-connection.http.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAgBhD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AACrD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AACrD,MAAM,qCAAqC,GAAG,EAAE,CAAC;AACjD,MAAM,sCAAsC,GAAG,EAAE,CAAC;AAClD,MAAM,uCAAuC,GAAG,EAAE,CAAC;AACnD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AAErD,SAAS,kFAAkF,CACzF,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,eAAe;aAC1B;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,eAAe;aAC1B;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,yBAAyB,EAAE;YACzB;gBACE,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,mDAAmD;gBAC5D,QAAQ,EAAE,mCAAmC;aAC9C;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,mDAAmD;gBAC5D,QAAQ,EAAE,mCAAmC;aAC9C;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,YAAY;aACvB;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,mDAAmD;gBAC5D,QAAQ,EAAE,mCAAmC;aAC9C;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,0BAA0B;aACrC;YACD;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,mCAAmC;aAC9C;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,aAAa;aACxB;YACD;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,WAAW;aACtB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,UAAU;aACrB;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,wBAAwB;aACnC;YACD;gBACE,OAAO,EAAE,cAAc;gBACvB,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,WAAW;aACtB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,UAAU;aACrB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,yDAAyD;AACzD,SAAgB,6BAA6B,CAC3C,OAA6C;IAE7C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qCAAqC,EACrC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,sCAAsC,EACtC,EAAE,CACH,CAAC;IAEF,SAAS,+BAA+B,CAAC,EAAE,IAAI,EAAO;QACpD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,0CAA0C;YACtD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,8GAA8G;YAChH,GAAG,EAAE,kFAAkF,CACrF;gBACE,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+BAA+B,CAAC,OAAO,GAAG,OAAO,CAAC;IAElD,OAAO,+BAA+B,CAAC;AACzC,CAAC;AApCD,sEAoCC;AAED,iGAAiG;AACjG,SAAgB,+BAA+B,CAC7C,OAA+C;IAE/C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,uCAAuC,EACvC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,wCAAwC,EACxC,EAAE,CACH,CAAC;IAEF,SAAS,iCAAiC,CAAC,EAAE,IAAI,EAAO;QACtD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,0CAA0C;YACtD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,gHAAgH;YAClH,GAAG,EAAE,kFAAkF,CACrF;gBACE,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,iCAAiC,CAAC,OAAO,GAAG,OAAO,CAAC;IAEpD,OAAO,iCAAiC,CAAC;AAC3C,CAAC;AApCD,0EAoCC;AAED;;;;;GAKG;AACH,SAAgB,gCAAgC,CAC9C,OAAgD;IAEhD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wCAAwC,EACxC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,yCAAyC,EACzC,EAAE,CACH,CAAC;IAEF,SAAS,kCAAkC,CAAC,EAAE,IAAI,EAAO;QACvD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,0CAA0C;YACtD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iHAAiH;YACnH,GAAG,EAAE,kFAAkF,CACrF;gBACE,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kCAAkC,CAAC,OAAO,GAAG,OAAO,CAAC;IAErD,OAAO,kCAAkC,CAAC;AAC5C,CAAC;AApCD,4EAoCC;AAED;;;;;;;;GAQG;AACH,SAAgB,gCAAgC,CAC9C,OAAgD;IAEhD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wCAAwC,EACxC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,yCAAyC,EACzC,EAAE,CACH,CAAC;IAEF,SAAS,kCAAkC,CAAC,EAAE,IAAI,EAAO;QACvD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,0CAA0C;YACtD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,iHAAiH;YACnH,GAAG,EAAE,kFAAkF,CACrF;gBACE,SAAS,EACP,qEAAqE;gBACvE,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kCAAkC,CAAC,OAAO,GAAG,OAAO,CAAC;IAErD,OAAO,kCAAkC,CAAC;AAC5C,CAAC;AArCD,4EAqCC;AAED;;;;GAIG;AACH,SAAgB,gCAAgC,CAC9C,OAAgD;IAEhD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wCAAwC,EACxC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,yCAAyC,EACzC,EAAE,CACH,CAAC;IAEF,SAAS,kCAAkC,CAAC,EAAE,IAAI,EAAO;QACvD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,0CAA0C;YACtD,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,iHAAiH;YACnH,GAAG,EAAE,kFAAkF,CACrF;gBACE,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kCAAkC,CAAC,OAAO,GAAG,OAAO,CAAC;IAErD,OAAO,kCAAkC,CAAC;AAC5C,CAAC;AApCD,4EAoCC"}
|
|
@@ -8,4 +8,5 @@ export declare function listExternalDatabaseConnections(httpClient: HttpClient):
|
|
|
8
8
|
export declare function createExternalDatabaseConnection(httpClient: HttpClient): (options?: CreateExternalDatabaseConnectionOptions | undefined) => Promise<import("./data-v1-external-database-connection.universal").CreateExternalDatabaseConnectionResponse>;
|
|
9
9
|
export declare function updateExternalDatabaseConnection(httpClient: HttpClient): (name: string, options?: UpdateExternalDatabaseConnectionOptions | undefined) => Promise<import("./data-v1-external-database-connection.universal").UpdateExternalDatabaseConnectionResponse>;
|
|
10
10
|
export declare function deleteExternalDatabaseConnection(httpClient: HttpClient): (name: string) => Promise<void>;
|
|
11
|
-
export {
|
|
11
|
+
export { CauseOfFailure } from './data-v1-external-database-connection.universal';
|
|
12
|
+
export { ExternalDatabaseConnection, ConnectionStatus, GetExternalDatabaseConnectionRequest, GetExternalDatabaseConnectionResponse, ListExternalDatabaseConnectionsRequest, ListExternalDatabaseConnectionsResponse, CreateExternalDatabaseConnectionRequest, CreateExternalDatabaseConnectionResponse, UpdateExternalDatabaseConnectionRequest, UpdateExternalDatabaseConnectionResponse, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionResponse, CreateExternalDatabaseConnectionOptions, UpdateExternalDatabaseConnectionOptions, } from './data-v1-external-database-connection.universal';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.__metadata = void 0;
|
|
3
|
+
exports.CauseOfFailure = exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.__metadata = void 0;
|
|
4
4
|
const data_v1_external_database_connection_universal_1 = require("./data-v1-external-database-connection.universal");
|
|
5
5
|
exports.__metadata = { PACKAGE_NAME: '@wix/data' };
|
|
6
6
|
function getExternalDatabaseConnection(httpClient) {
|
|
@@ -33,4 +33,6 @@ function deleteExternalDatabaseConnection(httpClient) {
|
|
|
33
33
|
{ httpClient });
|
|
34
34
|
}
|
|
35
35
|
exports.deleteExternalDatabaseConnection = deleteExternalDatabaseConnection;
|
|
36
|
+
var data_v1_external_database_connection_universal_2 = require("./data-v1-external-database-connection.universal");
|
|
37
|
+
Object.defineProperty(exports, "CauseOfFailure", { enumerable: true, get: function () { return data_v1_external_database_connection_universal_2.CauseOfFailure; } });
|
|
36
38
|
//# sourceMappingURL=data-v1-external-database-connection.public.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v1-external-database-connection.public.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.public.ts"],"names":[],"mappings":";;;AACA,qHAQ0D;AAE7C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,8EAAsC,EACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sEAOC;AAED,SAAgB,+BAA+B,CAAC,UAAsB;IACpE,OAAO,GAAG,EAAE,CACV,IAAA,gFAAwC;IACtC,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,0EAMC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,OAAiD,EAAE,EAAE,CAC3D,IAAA,iFAAyC,EACvC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,OAAiD,EAAE,EAAE,CACzE,IAAA,iFAAyC,EACvC,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,4EAQC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,iFAAyC,EACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC"}
|
|
1
|
+
{"version":3,"file":"data-v1-external-database-connection.public.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.public.ts"],"names":[],"mappings":";;;AACA,qHAQ0D;AAE7C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,8EAAsC,EACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sEAOC;AAED,SAAgB,+BAA+B,CAAC,UAAsB;IACpE,OAAO,GAAG,EAAE,CACV,IAAA,gFAAwC;IACtC,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,0EAMC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,OAAiD,EAAE,EAAE,CAC3D,IAAA,iFAAyC,EACvC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,OAAiD,EAAE,EAAE,CACzE,IAAA,iFAAyC,EACvC,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,4EAQC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,iFAAyC,EACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC;AAED,mHAAkF;AAAzE,gJAAA,cAAc,OAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** An external database connection defines a connection between an external database and a Wix site. */
|
|
1
|
+
/** An external database connection defines a connection between an external database and a Wix site or project. */
|
|
2
2
|
export interface ExternalDatabaseConnection {
|
|
3
3
|
/**
|
|
4
4
|
* Name of the external database connection.
|
|
@@ -14,6 +14,33 @@ export interface ExternalDatabaseConnection {
|
|
|
14
14
|
* Their content and structure depend on the specific requirements of the external database's API.
|
|
15
15
|
*/
|
|
16
16
|
configuration?: Record<string, any> | null;
|
|
17
|
+
/**
|
|
18
|
+
* Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
connectionStatus?: ConnectionStatus;
|
|
22
|
+
}
|
|
23
|
+
export declare enum CauseOfFailure {
|
|
24
|
+
/** No connection failure. */
|
|
25
|
+
NONE = "NONE",
|
|
26
|
+
/** General communication failure. */
|
|
27
|
+
COMMUNICATION_FAILURE = "COMMUNICATION_FAILURE",
|
|
28
|
+
/** External database host is unreachable. */
|
|
29
|
+
DESTINATION_HOST_UNREACHABLE = "DESTINATION_HOST_UNREACHABLE",
|
|
30
|
+
/** Unauthorized to access external database. */
|
|
31
|
+
UNAUTHORIZED = "UNAUTHORIZED"
|
|
32
|
+
}
|
|
33
|
+
export interface ConnectionStatus {
|
|
34
|
+
/** Whether the connection was established successfully. */
|
|
35
|
+
successful?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Reason for the failure, if a connection isn't established successfully.
|
|
38
|
+
* + `NONE`: No connection failure.
|
|
39
|
+
* + `COMMUNICATION_FAILURE`: General communication failure.
|
|
40
|
+
* + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
|
|
41
|
+
* + `UNAUTHORIZED`: Unauthorized to access external database.
|
|
42
|
+
*/
|
|
43
|
+
causeOfFailure?: CauseOfFailure;
|
|
17
44
|
}
|
|
18
45
|
export interface GetExternalDatabaseConnectionRequest {
|
|
19
46
|
/** Name of the external database connection to retrieve. */
|
|
@@ -38,7 +65,7 @@ export interface CreateExternalDatabaseConnectionResponse {
|
|
|
38
65
|
externalDatabaseConnection?: ExternalDatabaseConnection;
|
|
39
66
|
}
|
|
40
67
|
export interface UpdateExternalDatabaseConnectionRequest {
|
|
41
|
-
/** Updated external database connection details. The existing
|
|
68
|
+
/** Updated external database connection details. The existing connection is replaced with this version. */
|
|
42
69
|
externalDatabaseConnection?: ExternalDatabaseConnection;
|
|
43
70
|
}
|
|
44
71
|
export interface UpdateExternalDatabaseConnectionResponse {
|
|
@@ -1,3 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CauseOfFailure = void 0;
|
|
4
|
+
var CauseOfFailure;
|
|
5
|
+
(function (CauseOfFailure) {
|
|
6
|
+
/** No connection failure. */
|
|
7
|
+
CauseOfFailure["NONE"] = "NONE";
|
|
8
|
+
/** General communication failure. */
|
|
9
|
+
CauseOfFailure["COMMUNICATION_FAILURE"] = "COMMUNICATION_FAILURE";
|
|
10
|
+
/** External database host is unreachable. */
|
|
11
|
+
CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
|
|
12
|
+
/** Unauthorized to access external database. */
|
|
13
|
+
CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
|
|
14
|
+
})(CauseOfFailure = exports.CauseOfFailure || (exports.CauseOfFailure = {}));
|
|
3
15
|
//# sourceMappingURL=data-v1-external-database-connection.types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v1-external-database-connection.types.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.types.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"data-v1-external-database-connection.types.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.types.ts"],"names":[],"mappings":";;;AAuBA,IAAY,cASX;AATD,WAAY,cAAc;IACxB,6BAA6B;IAC7B,+BAAa,CAAA;IACb,qCAAqC;IACrC,iEAA+C,CAAA;IAC/C,6CAA6C;IAC7C,+EAA6D,CAAA;IAC7D,gDAAgD;IAChD,+CAA6B,CAAA;AAC/B,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB"}
|
|
@@ -4,7 +4,7 @@ export declare const __debug: {
|
|
|
4
4
|
off: () => boolean;
|
|
5
5
|
};
|
|
6
6
|
};
|
|
7
|
-
/** An external database connection defines a connection between an external database and a Wix site. */
|
|
7
|
+
/** An external database connection defines a connection between an external database and a Wix site or project. */
|
|
8
8
|
export interface ExternalDatabaseConnection {
|
|
9
9
|
/**
|
|
10
10
|
* Name of the external database connection.
|
|
@@ -20,6 +20,33 @@ export interface ExternalDatabaseConnection {
|
|
|
20
20
|
* Their content and structure depend on the specific requirements of the external database's API.
|
|
21
21
|
*/
|
|
22
22
|
configuration?: Record<string, any> | null;
|
|
23
|
+
/**
|
|
24
|
+
* Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
|
|
25
|
+
* @readonly
|
|
26
|
+
*/
|
|
27
|
+
connectionStatus?: ConnectionStatus;
|
|
28
|
+
}
|
|
29
|
+
export declare enum CauseOfFailure {
|
|
30
|
+
/** No connection failure. */
|
|
31
|
+
NONE = "NONE",
|
|
32
|
+
/** General communication failure. */
|
|
33
|
+
COMMUNICATION_FAILURE = "COMMUNICATION_FAILURE",
|
|
34
|
+
/** External database host is unreachable. */
|
|
35
|
+
DESTINATION_HOST_UNREACHABLE = "DESTINATION_HOST_UNREACHABLE",
|
|
36
|
+
/** Unauthorized to access external database. */
|
|
37
|
+
UNAUTHORIZED = "UNAUTHORIZED"
|
|
38
|
+
}
|
|
39
|
+
export interface ConnectionStatus {
|
|
40
|
+
/** Whether the connection was established successfully. */
|
|
41
|
+
successful?: boolean;
|
|
42
|
+
/**
|
|
43
|
+
* Reason for the failure, if a connection isn't established successfully.
|
|
44
|
+
* + `NONE`: No connection failure.
|
|
45
|
+
* + `COMMUNICATION_FAILURE`: General communication failure.
|
|
46
|
+
* + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
|
|
47
|
+
* + `UNAUTHORIZED`: Unauthorized to access external database.
|
|
48
|
+
*/
|
|
49
|
+
causeOfFailure?: CauseOfFailure;
|
|
23
50
|
}
|
|
24
51
|
export interface GetExternalDatabaseConnectionRequest {
|
|
25
52
|
/** Name of the external database connection to retrieve. */
|
|
@@ -44,7 +71,7 @@ export interface CreateExternalDatabaseConnectionResponse {
|
|
|
44
71
|
externalDatabaseConnection?: ExternalDatabaseConnection;
|
|
45
72
|
}
|
|
46
73
|
export interface UpdateExternalDatabaseConnectionRequest {
|
|
47
|
-
/** Updated external database connection details. The existing
|
|
74
|
+
/** Updated external database connection details. The existing connection is replaced with this version. */
|
|
48
75
|
externalDatabaseConnection?: ExternalDatabaseConnection;
|
|
49
76
|
}
|
|
50
77
|
export interface UpdateExternalDatabaseConnectionResponse {
|
|
@@ -66,7 +93,7 @@ export interface DeleteExternalDatabaseConnectionResponse {
|
|
|
66
93
|
*/
|
|
67
94
|
export declare function getExternalDatabaseConnection(name: string): Promise<GetExternalDatabaseConnectionResponse>;
|
|
68
95
|
/**
|
|
69
|
-
* Retrieves a list of all external database collections associated with the site.
|
|
96
|
+
* Retrieves a list of all external database collections associated with the site or project.
|
|
70
97
|
* @public
|
|
71
98
|
* @documentationMaturity preview
|
|
72
99
|
*/
|
|
@@ -74,13 +101,14 @@ export declare function listExternalDatabaseConnections(): Promise<ListExternalD
|
|
|
74
101
|
/**
|
|
75
102
|
* Creates a new external database connection.
|
|
76
103
|
*
|
|
77
|
-
* The
|
|
104
|
+
* The `options.externalDatabaseConnection` parameter must include a name, base URL, and configuration details for the external database.
|
|
78
105
|
* If any of these are missing, the external database connection isn't created.
|
|
79
106
|
* @public
|
|
80
107
|
* @documentationMaturity preview
|
|
81
108
|
* @requiredField options.externalDatabaseConnection.configuration
|
|
82
109
|
* @requiredField options.externalDatabaseConnection.endpoint
|
|
83
110
|
* @requiredField options.externalDatabaseConnection.name
|
|
111
|
+
* @param options - Options for creating an external database connection.
|
|
84
112
|
*/
|
|
85
113
|
export declare function createExternalDatabaseConnection(options?: CreateExternalDatabaseConnectionOptions): Promise<CreateExternalDatabaseConnectionResponse>;
|
|
86
114
|
export interface CreateExternalDatabaseConnectionOptions {
|
|
@@ -90,7 +118,7 @@ export interface CreateExternalDatabaseConnectionOptions {
|
|
|
90
118
|
/**
|
|
91
119
|
* Updates an external database connection.
|
|
92
120
|
*
|
|
93
|
-
* An external database collection name must be
|
|
121
|
+
* An external database collection name must be provided in `name`.
|
|
94
122
|
* If an existing external database connection is found with the same name, that connection's details are updated.
|
|
95
123
|
* If no external database connection has that name, the request fails.
|
|
96
124
|
*
|
|
@@ -103,9 +131,11 @@ export interface CreateExternalDatabaseConnectionOptions {
|
|
|
103
131
|
* @requiredField name
|
|
104
132
|
* @requiredField options.externalDatabaseConnection.configuration
|
|
105
133
|
* @requiredField options.externalDatabaseConnection.endpoint
|
|
134
|
+
* @param options - Options for updating an external database connection.
|
|
106
135
|
*/
|
|
107
136
|
export declare function updateExternalDatabaseConnection(name: string, options?: UpdateExternalDatabaseConnectionOptions): Promise<UpdateExternalDatabaseConnectionResponse>;
|
|
108
137
|
export interface UpdateExternalDatabaseConnectionOptions {
|
|
138
|
+
/** Updated external database connection details. The existing connection is replaced with this version. */
|
|
109
139
|
externalDatabaseConnection: {
|
|
110
140
|
/** Base URL for provisioning and managing data in the external database. For example: `https://example.com/my-external-database`. */
|
|
111
141
|
endpoint?: string;
|
|
@@ -115,12 +145,17 @@ export interface UpdateExternalDatabaseConnectionOptions {
|
|
|
115
145
|
* Their content and structure depend on the specific requirements of the external database's API.
|
|
116
146
|
*/
|
|
117
147
|
configuration?: Record<string, any> | null;
|
|
148
|
+
/**
|
|
149
|
+
* Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
|
|
150
|
+
* @readonly
|
|
151
|
+
*/
|
|
152
|
+
connectionStatus?: ConnectionStatus;
|
|
118
153
|
};
|
|
119
154
|
}
|
|
120
155
|
/**
|
|
121
156
|
* Deletes an external database connection.
|
|
122
157
|
*
|
|
123
|
-
* > **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](https://dev.wix.com/api/
|
|
158
|
+
* > **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](https://dev.wix.com/api/sdk/data/externaldatabaseconnections/deleteexternaldatabaseconnection).
|
|
124
159
|
* @param name - Name of the external database connection to delete.
|
|
125
160
|
* @public
|
|
126
161
|
* @documentationMaturity preview
|
|
@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
28
28
|
});
|
|
29
29
|
};
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
-
exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.__debug = void 0;
|
|
31
|
+
exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.CauseOfFailure = exports.__debug = void 0;
|
|
32
32
|
const velo_1 = require("@wix/metro-runtime/velo");
|
|
33
33
|
const ambassadorWixDataV1ExternalDatabaseConnection = __importStar(require("./data-v1-external-database-connection.http"));
|
|
34
34
|
let __verbose = false;
|
|
@@ -46,6 +46,17 @@ exports.__debug = {
|
|
|
46
46
|
};
|
|
47
47
|
const _toVeloEntity = '$';
|
|
48
48
|
const _fromVeloEntity = '$';
|
|
49
|
+
var CauseOfFailure;
|
|
50
|
+
(function (CauseOfFailure) {
|
|
51
|
+
/** No connection failure. */
|
|
52
|
+
CauseOfFailure["NONE"] = "NONE";
|
|
53
|
+
/** General communication failure. */
|
|
54
|
+
CauseOfFailure["COMMUNICATION_FAILURE"] = "COMMUNICATION_FAILURE";
|
|
55
|
+
/** External database host is unreachable. */
|
|
56
|
+
CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
|
|
57
|
+
/** Unauthorized to access external database. */
|
|
58
|
+
CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
|
|
59
|
+
})(CauseOfFailure = exports.CauseOfFailure || (exports.CauseOfFailure = {}));
|
|
49
60
|
const _createExternalDatabaseConnectionRequest = {};
|
|
50
61
|
const _createExternalDatabaseConnectionResponse = {};
|
|
51
62
|
const _deleteExternalDatabaseConnectionRequest = {};
|
|
@@ -108,7 +119,7 @@ function getExternalDatabaseConnection(name) {
|
|
|
108
119
|
}
|
|
109
120
|
exports.getExternalDatabaseConnection = getExternalDatabaseConnection;
|
|
110
121
|
/**
|
|
111
|
-
* Retrieves a list of all external database collections associated with the site.
|
|
122
|
+
* Retrieves a list of all external database collections associated with the site or project.
|
|
112
123
|
* @public
|
|
113
124
|
* @documentationMaturity preview
|
|
114
125
|
*/
|
|
@@ -157,13 +168,14 @@ exports.listExternalDatabaseConnections = listExternalDatabaseConnections;
|
|
|
157
168
|
/**
|
|
158
169
|
* Creates a new external database connection.
|
|
159
170
|
*
|
|
160
|
-
* The
|
|
171
|
+
* The `options.externalDatabaseConnection` parameter must include a name, base URL, and configuration details for the external database.
|
|
161
172
|
* If any of these are missing, the external database connection isn't created.
|
|
162
173
|
* @public
|
|
163
174
|
* @documentationMaturity preview
|
|
164
175
|
* @requiredField options.externalDatabaseConnection.configuration
|
|
165
176
|
* @requiredField options.externalDatabaseConnection.endpoint
|
|
166
177
|
* @requiredField options.externalDatabaseConnection.name
|
|
178
|
+
* @param options - Options for creating an external database connection.
|
|
167
179
|
*/
|
|
168
180
|
function createExternalDatabaseConnection(options) {
|
|
169
181
|
var _a, _b, _c;
|
|
@@ -214,7 +226,7 @@ exports.createExternalDatabaseConnection = createExternalDatabaseConnection;
|
|
|
214
226
|
/**
|
|
215
227
|
* Updates an external database connection.
|
|
216
228
|
*
|
|
217
|
-
* An external database collection name must be
|
|
229
|
+
* An external database collection name must be provided in `name`.
|
|
218
230
|
* If an existing external database connection is found with the same name, that connection's details are updated.
|
|
219
231
|
* If no external database connection has that name, the request fails.
|
|
220
232
|
*
|
|
@@ -227,6 +239,7 @@ exports.createExternalDatabaseConnection = createExternalDatabaseConnection;
|
|
|
227
239
|
* @requiredField name
|
|
228
240
|
* @requiredField options.externalDatabaseConnection.configuration
|
|
229
241
|
* @requiredField options.externalDatabaseConnection.endpoint
|
|
242
|
+
* @param options - Options for updating an external database connection.
|
|
230
243
|
*/
|
|
231
244
|
function updateExternalDatabaseConnection(name, options) {
|
|
232
245
|
var _a, _b, _c;
|
|
@@ -281,7 +294,7 @@ exports.updateExternalDatabaseConnection = updateExternalDatabaseConnection;
|
|
|
281
294
|
/**
|
|
282
295
|
* Deletes an external database connection.
|
|
283
296
|
*
|
|
284
|
-
* > **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](https://dev.wix.com/api/
|
|
297
|
+
* > **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](https://dev.wix.com/api/sdk/data/externaldatabaseconnections/deleteexternaldatabaseconnection).
|
|
285
298
|
* @param name - Name of the external database connection to delete.
|
|
286
299
|
* @public
|
|
287
300
|
* @documentationMaturity preview
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v1-external-database-connection.universal.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,2HAA6G;AAE7G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"data-v1-external-database-connection.universal.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,2HAA6G;AAE7G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAyB5B,IAAY,cASX;AATD,WAAY,cAAc;IACxB,6BAA6B;IAC7B,+BAAa,CAAA;IACb,qCAAqC;IACrC,iEAA+C,CAAA;IAC/C,6CAA6C;IAC7C,+EAA6D,CAAA;IAC7D,gDAAgD;IAChD,+CAA6B,CAAA;AAC/B,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AA2DD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AACrD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AACrD,MAAM,qCAAqC,GAAG,EAAE,CAAC;AACjD,MAAM,sCAAsC,GAAG,EAAE,CAAC;AAClD,MAAM,uCAAuC,GAAG,EAAE,CAAC;AACnD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,wCAAwC,GAAG,EAAE,CAAC;AACpD,MAAM,yCAAyC,GAAG,EAAE,CAAC;AAErD;;;;;;GAMG;AACH,SAAsB,6BAA6B,CACjD,IAAY;;;QAEZ,MAAM,qBAAqB,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC/C,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,qCAAqC;YACjD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,sCAAsC;YAClD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;gBAC1C,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5C,MAAM,OAAO,GACX,6CAA6C,CAAC,6BAA6B,CACzE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,yDAAyD,SAAS,CAChE,OAAO,CACR,EAAE,CACJ,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,MAAM;aACP,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA3DD,sEA2DC;AAED;;;;GAIG;AACH,SAAsB,+BAA+B;;;QACnD,MAAM,qBAAqB,GAAG,EAAE,CAAC;QACjC,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,uCAAuC;YACnD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,wCAAwC;YACpD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;gBACjD,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,OAAO,GACX,6CAA6C,CAAC,+BAA+B,CAC3E,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,2DAA2D,SAAS,CAClE,OAAO,CACR,EAAE,CACJ,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;YACxE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAvDD,0EAuDC;AAED;;;;;;;;;;;GAWG;AACH,SAAsB,gCAAgC,CACpD,OAAiD;;;QAEjD,MAAM,qBAAqB,GAAG;YAC5B,0BAA0B,EAAE,iCAAiC;SAC9D,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,wCAAwC;YACpD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;gBAC1C,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,yCAAyC;YACrD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;gBAC1C,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GACX,6CAA6C,CAAC,gCAAgC,CAC5E,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,4DAA4D,SAAS,CACnE,OAAO,CACR,EAAE,CACJ,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA7DD,4EA6DC;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAsB,gCAAgC,CACpD,IAAY,EACZ,OAAiD;;;QAEjD,MAAM,qBAAqB,GAAG;YAC5B,0BAA0B,EAAE;gBAC1B,GAAG,EAAE,iCAAiC;gBACtC,IAAI,EAAE,MAAM;aACb;SACF,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,wCAAwC;YACpD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;gBAC1C,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,yCAAyC;YACrD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;gBAC1C,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAErD,MAAM,OAAO,GACX,6CAA6C,CAAC,gCAAgC,CAC5E,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,4DAA4D,SAAS,CACnE,OAAO,CACR,EAAE,CACJ,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,MAAM;gBACN,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAlED,4EAkEC;AAqBD;;;;;;;;GAQG;AACH,SAAsB,gCAAgC,CACpD,IAAY;;;QAEZ,MAAM,qBAAqB,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC/C,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,wCAAwC;YACpD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,yCAAyC;YACrD,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5C,MAAM,OAAO,GACX,6CAA6C,CAAC,gCAAgC,CAC5E,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,4DAA4D,SAAS,CACnE,OAAO,CACR,EAAE,CACJ,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,MAAM;aACP,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA3DD,4EA2DC"}
|
|
@@ -9,7 +9,7 @@ export declare function createDataCollection(payload: CreateDataCollectionReques
|
|
|
9
9
|
/** Retrieves a data collection by ID. */
|
|
10
10
|
export declare function getDataCollection(payload: GetDataCollectionRequest): RequestOptionsFactory<GetDataCollectionResponse>;
|
|
11
11
|
/**
|
|
12
|
-
* Retrieves a list of all data collections associated with the site.
|
|
12
|
+
* Retrieves a list of all data collections associated with the site or project.
|
|
13
13
|
*
|
|
14
14
|
* By default, the list is ordered by ID in ascending order.
|
|
15
15
|
*/
|
|
@@ -17,14 +17,14 @@ export declare function listDataCollections(payload: ListDataCollectionsRequest)
|
|
|
17
17
|
/**
|
|
18
18
|
* Updates a data collection.
|
|
19
19
|
*
|
|
20
|
-
* A collection ID, revision number, permissions, and at least 1 field must be provided within
|
|
20
|
+
* A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
|
|
21
21
|
* If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
|
|
22
22
|
* Otherwise, the request fails.
|
|
23
23
|
*
|
|
24
|
-
* When a collection is updated, its `
|
|
24
|
+
* When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
|
|
25
25
|
*
|
|
26
26
|
* > **Note:**
|
|
27
|
-
* > After a collection is updated, it only contains the properties included in the
|
|
27
|
+
* > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
|
|
28
28
|
* > aren't included in the updated collection details, their values are lost.
|
|
29
29
|
*/
|
|
30
30
|
export declare function updateDataCollection(payload: UpdateDataCollectionRequest): RequestOptionsFactory<UpdateDataCollectionResponse>;
|
|
@@ -347,7 +347,7 @@ function getDataCollection(payload) {
|
|
|
347
347
|
}
|
|
348
348
|
exports.getDataCollection = getDataCollection;
|
|
349
349
|
/**
|
|
350
|
-
* Retrieves a list of all data collections associated with the site.
|
|
350
|
+
* Retrieves a list of all data collections associated with the site or project.
|
|
351
351
|
*
|
|
352
352
|
* By default, the list is ordered by ID in ascending order.
|
|
353
353
|
*/
|
|
@@ -381,14 +381,14 @@ exports.listDataCollections = listDataCollections;
|
|
|
381
381
|
/**
|
|
382
382
|
* Updates a data collection.
|
|
383
383
|
*
|
|
384
|
-
* A collection ID, revision number, permissions, and at least 1 field must be provided within
|
|
384
|
+
* A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
|
|
385
385
|
* If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
|
|
386
386
|
* Otherwise, the request fails.
|
|
387
387
|
*
|
|
388
|
-
* When a collection is updated, its `
|
|
388
|
+
* When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
|
|
389
389
|
*
|
|
390
390
|
* > **Note:**
|
|
391
|
-
* > After a collection is updated, it only contains the properties included in the
|
|
391
|
+
* > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
|
|
392
392
|
* > aren't included in the updated collection details, their values are lost.
|
|
393
393
|
*/
|
|
394
394
|
function updateDataCollection(payload) {
|
|
@@ -456,7 +456,7 @@ export interface UrlizedPluginOptions {
|
|
|
456
456
|
format?: Format;
|
|
457
457
|
}
|
|
458
458
|
export interface GridapplessPluginOptions {
|
|
459
|
-
/**
|
|
459
|
+
/** Whether the tenant was migrated to Gridappless. */
|
|
460
460
|
migrated?: boolean;
|
|
461
461
|
}
|
|
462
462
|
export declare enum PagingMode {
|
|
@@ -462,7 +462,7 @@ export interface UrlizedPluginOptions {
|
|
|
462
462
|
format?: Format;
|
|
463
463
|
}
|
|
464
464
|
export interface GridapplessPluginOptions {
|
|
465
|
-
/**
|
|
465
|
+
/** Whether the tenant was migrated to Gridappless. */
|
|
466
466
|
migrated?: boolean;
|
|
467
467
|
}
|
|
468
468
|
export declare enum PagingMode {
|
|
@@ -651,6 +651,7 @@ export interface DeleteDataCollectionResponse {
|
|
|
651
651
|
* @requiredField options.collection._id
|
|
652
652
|
* @requiredField options.collection.fields
|
|
653
653
|
* @requiredField options.collection.permissions
|
|
654
|
+
* @param options - Options for creating a data collection.
|
|
654
655
|
*/
|
|
655
656
|
export declare function createDataCollection(options?: CreateDataCollectionOptions): Promise<CreateDataCollectionResponse>;
|
|
656
657
|
export interface CreateDataCollectionOptions {
|
|
@@ -664,6 +665,7 @@ export interface CreateDataCollectionOptions {
|
|
|
664
665
|
* @documentationMaturity preview
|
|
665
666
|
* @requiredField GetDataCollectionRequest
|
|
666
667
|
* @requiredField dataCollectionId
|
|
668
|
+
* @param options - Options for retrieving a data collection.
|
|
667
669
|
*/
|
|
668
670
|
export declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<GetDataCollectionResponse>;
|
|
669
671
|
export interface GetDataCollectionOptions {
|
|
@@ -675,11 +677,12 @@ export interface GetDataCollectionOptions {
|
|
|
675
677
|
includeReferencedCollections?: boolean;
|
|
676
678
|
}
|
|
677
679
|
/**
|
|
678
|
-
* Retrieves a list of all data collections associated with the site.
|
|
680
|
+
* Retrieves a list of all data collections associated with the site or project.
|
|
679
681
|
*
|
|
680
682
|
* By default, the list is ordered by ID in ascending order.
|
|
681
683
|
* @public
|
|
682
684
|
* @documentationMaturity preview
|
|
685
|
+
* @param options - Options for retrieving a list of data collections.
|
|
683
686
|
*/
|
|
684
687
|
export declare function listDataCollections(options?: ListDataCollectionsOptions): Promise<ListDataCollectionsResponse>;
|
|
685
688
|
export interface ListDataCollectionsOptions extends ListDataCollectionsRequestPagingMethodOneOf {
|
|
@@ -697,14 +700,14 @@ export interface ListDataCollectionsOptions extends ListDataCollectionsRequestPa
|
|
|
697
700
|
/**
|
|
698
701
|
* Updates a data collection.
|
|
699
702
|
*
|
|
700
|
-
* A collection ID, revision number, permissions, and at least 1 field must be provided within
|
|
703
|
+
* A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
|
|
701
704
|
* If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
|
|
702
705
|
* Otherwise, the request fails.
|
|
703
706
|
*
|
|
704
|
-
* When a collection is updated, its `
|
|
707
|
+
* When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
|
|
705
708
|
*
|
|
706
709
|
* > **Note:**
|
|
707
|
-
* > After a collection is updated, it only contains the properties included in the
|
|
710
|
+
* > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
|
|
708
711
|
* > aren't included in the updated collection details, their values are lost.
|
|
709
712
|
* @public
|
|
710
713
|
* @documentationMaturity preview
|
|
@@ -712,6 +715,7 @@ export interface ListDataCollectionsOptions extends ListDataCollectionsRequestPa
|
|
|
712
715
|
* @requiredField options.collection.fields
|
|
713
716
|
* @requiredField options.collection.permissions
|
|
714
717
|
* @requiredField options.collection.revision
|
|
718
|
+
* @param options - Options for updating a data collection.
|
|
715
719
|
*/
|
|
716
720
|
export declare function updateDataCollection(options?: UpdateDataCollectionOptions): Promise<UpdateDataCollectionResponse>;
|
|
717
721
|
export interface UpdateDataCollectionOptions {
|