@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
|
@@ -87,10 +87,10 @@ const _listIndexesResponse = {};
|
|
|
87
87
|
* Creates an index for a data collection.
|
|
88
88
|
*
|
|
89
89
|
* The index can't be used immediately, as the process of generating the index takes time.
|
|
90
|
-
* You can check whether your index is ready using
|
|
90
|
+
* You can check whether your index is ready using [`listIndexes()`](https://dev.wix.com/api/sdk/data/indexes/listindexes).
|
|
91
91
|
*
|
|
92
92
|
* Note that when an index fails to create, the failed index still occupies a slot.
|
|
93
|
-
* To remove the failed index and free up the slot for a new index, use
|
|
93
|
+
* To remove the failed index and free up the slot for a new index, use [`dropIndex()`](https://dev.wix.com/api/sdk/data/indexes/dropindex).
|
|
94
94
|
* @public
|
|
95
95
|
* @documentationMaturity preview
|
|
96
96
|
* @requiredField options
|
|
@@ -98,6 +98,7 @@ const _listIndexesResponse = {};
|
|
|
98
98
|
* @requiredField options.index.fields
|
|
99
99
|
* @requiredField options.index.fields.path
|
|
100
100
|
* @requiredField options.index.name
|
|
101
|
+
* @param options - Options for creating an index.
|
|
101
102
|
*/
|
|
102
103
|
function createIndex(options) {
|
|
103
104
|
var _a, _b, _c;
|
|
@@ -150,11 +151,12 @@ exports.createIndex = createIndex;
|
|
|
150
151
|
* Removes an index from a data collection.
|
|
151
152
|
*
|
|
152
153
|
* The process of dropping an index from a collection takes time.
|
|
153
|
-
* You can check whether your index has been dropped by
|
|
154
|
+
* You can check whether your index has been dropped by calling [`listIndexes()`](https://dev.wix.com/api/sdk/data/indexes/listindexes)
|
|
154
155
|
* @public
|
|
155
156
|
* @documentationMaturity preview
|
|
156
157
|
* @requiredField options
|
|
157
158
|
* @requiredField options.indexName
|
|
159
|
+
* @param options - Options for dropping an index.
|
|
158
160
|
*/
|
|
159
161
|
function dropIndex(options) {
|
|
160
162
|
var _a, _b, _c;
|
|
@@ -213,6 +215,7 @@ exports.dropIndex = dropIndex;
|
|
|
213
215
|
* While it is still in the process of being removed, its status is `DROPPING`.
|
|
214
216
|
* @public
|
|
215
217
|
* @documentationMaturity preview
|
|
218
|
+
* @param options - Options for retrieving a list of indexes.
|
|
216
219
|
*/
|
|
217
220
|
function listIndexes(options) {
|
|
218
221
|
var _a, _b, _c;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-index.universal.js","sourceRoot":"","sources":["../../../src/data-v2-index.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,+EAAiE;AAEjE,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;AA2C5B;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAaD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,GAAN,cAAM,KAAN,cAAM,QAejB;AA0BD,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;
|
|
1
|
+
{"version":3,"file":"data-v2-index.universal.js","sourceRoot":"","sources":["../../../src/data-v2-index.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,+EAAiE;AAEjE,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;AA2C5B;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAaD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,GAAN,cAAM,KAAN,cAAM,QAejB;AA0BD,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA6BD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEhC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,WAAW,CAC/B,OAA2B;;;QAE3B,MAAM,qBAAqB,GAAG;YAC5B,KAAK,EAAE,YAAY;YACnB,gBAAgB,EAAE,uBAAuB;SAC1C,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,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,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,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAE9D,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,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;AAvDD,kCAuDC;AASD;;;;;;;;;;GAUG;AACH,SAAsB,SAAS,CAAC,OAAyB;;;QACvD,MAAM,qBAAqB,GAAG;YAC5B,SAAS,EAAE,gBAAgB;YAC3B,gBAAgB,EAAE,uBAAuB;SAC1C,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,iBAAiB;YAC7B,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,kBAAkB;YAC9B,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,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE5D,KAAK,CAAC,qCAAqC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjE,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;AArDD,8BAqDC;AASD;;;;;;;;;;;GAWG;AACH,SAAsB,WAAW,CAC/B,OAA4B;;;QAE5B,MAAM,qBAAqB,GAAG,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,CAAC;QAC5E,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,mBAAmB;YAC/B,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,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC7B,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,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAE9D,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,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;AApDD,kCAoDC"}
|
|
@@ -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>;
|
|
@@ -277,7 +277,7 @@ export function getExternalDatabaseConnection(payload) {
|
|
|
277
277
|
__getExternalDatabaseConnection.fromReq = fromReq;
|
|
278
278
|
return __getExternalDatabaseConnection;
|
|
279
279
|
}
|
|
280
|
-
/** Retrieves a list of all external database collections associated with the site. */
|
|
280
|
+
/** Retrieves a list of all external database collections associated with the site or project. */
|
|
281
281
|
export function listExternalDatabaseConnections(payload) {
|
|
282
282
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_listExternalDatabaseConnectionsRequest, {});
|
|
283
283
|
const { fromJSON: fromRes } = serializer(_listExternalDatabaseConnectionsResponse, {});
|
|
@@ -303,7 +303,7 @@ export function listExternalDatabaseConnections(payload) {
|
|
|
303
303
|
/**
|
|
304
304
|
* Creates a new external database connection.
|
|
305
305
|
*
|
|
306
|
-
* The
|
|
306
|
+
* The `options.externalDatabaseConnection` parameter must include a name, base URL, and configuration details for the external database.
|
|
307
307
|
* If any of these are missing, the external database connection isn't created.
|
|
308
308
|
*/
|
|
309
309
|
export function createExternalDatabaseConnection(payload) {
|
|
@@ -331,7 +331,7 @@ export function createExternalDatabaseConnection(payload) {
|
|
|
331
331
|
/**
|
|
332
332
|
* Updates an external database connection.
|
|
333
333
|
*
|
|
334
|
-
* An external database collection name must be
|
|
334
|
+
* An external database collection name must be provided in `name`.
|
|
335
335
|
* If an existing external database connection is found with the same name, that connection's details are updated.
|
|
336
336
|
* If no external database connection has that name, the request fails.
|
|
337
337
|
*
|
|
@@ -362,7 +362,7 @@ export function updateExternalDatabaseConnection(payload) {
|
|
|
362
362
|
/**
|
|
363
363
|
* Deletes an external database connection.
|
|
364
364
|
*
|
|
365
|
-
* > **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/
|
|
365
|
+
* > **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).
|
|
366
366
|
*/
|
|
367
367
|
export function deleteExternalDatabaseConnection(payload) {
|
|
368
368
|
const { toJSON: toReq, fromJSON: fromReq } = 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,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;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,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,6BAA6B,CAC3C,OAA6C;IAE7C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,qCAAqC,EACrC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,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,iBAAiB,CAAC,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;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,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;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,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,6BAA6B,CAC3C,OAA6C;IAE7C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,qCAAqC,EACrC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,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,iBAAiB,CAAC,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;AAED,iGAAiG;AACjG,MAAM,UAAU,+BAA+B,CAC7C,OAA+C;IAE/C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,uCAAuC,EACvC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,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,iBAAiB,CAAC,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;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAAgD;IAEhD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wCAAwC,EACxC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,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;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAAgD;IAEhD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wCAAwC,EACxC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,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;AAED;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAAgD;IAEhD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wCAAwC,EACxC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,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,iBAAiB,CAAC,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"}
|
|
@@ -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 +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,OAAO,EACL,6BAA6B,IAAI,sCAAsC,EACvE,+BAA+B,IAAI,wCAAwC,EAC3E,gCAAgC,IAAI,yCAAyC,EAC7E,gCAAgC,IAAI,yCAAyC,EAC7E,gCAAgC,IAAI,yCAAyC,GAG9E,MAAM,kDAAkD,CAAC;AAE1D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,sCAAsC,CACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,UAAsB;IACpE,OAAO,GAAG,EAAE,CACV,wCAAwC;IACtC,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,OAAiD,EAAE,EAAE,CAC3D,yCAAyC,CACvC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,OAAiD,EAAE,EAAE,CACzE,yCAAyC,CACvC,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,yCAAyC,CACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC"}
|
|
1
|
+
{"version":3,"file":"data-v1-external-database-connection.public.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,6BAA6B,IAAI,sCAAsC,EACvE,+BAA+B,IAAI,wCAAwC,EAC3E,gCAAgC,IAAI,yCAAyC,EAC7E,gCAAgC,IAAI,yCAAyC,EAC7E,gCAAgC,IAAI,yCAAyC,GAG9E,MAAM,kDAAkD,CAAC;AAE1D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,sCAAsC,CACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,UAAsB;IACpE,OAAO,GAAG,EAAE,CACV,wCAAwC;IACtC,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,OAAiD,EAAE,EAAE,CAC3D,yCAAyC,CACvC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,OAAiD,EAAE,EAAE,CACzE,yCAAyC,CACvC,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,yCAAyC,CACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC"}
|
|
@@ -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,2 +1,12 @@
|
|
|
1
|
-
export
|
|
1
|
+
export var CauseOfFailure;
|
|
2
|
+
(function (CauseOfFailure) {
|
|
3
|
+
/** No connection failure. */
|
|
4
|
+
CauseOfFailure["NONE"] = "NONE";
|
|
5
|
+
/** General communication failure. */
|
|
6
|
+
CauseOfFailure["COMMUNICATION_FAILURE"] = "COMMUNICATION_FAILURE";
|
|
7
|
+
/** External database host is unreachable. */
|
|
8
|
+
CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
|
|
9
|
+
/** Unauthorized to access external database. */
|
|
10
|
+
CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
|
|
11
|
+
})(CauseOfFailure || (CauseOfFailure = {}));
|
|
2
12
|
//# 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,MAAM,CAAN,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,KAAd,cAAc,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
|
|
@@ -24,6 +24,17 @@ export const __debug = {
|
|
|
24
24
|
};
|
|
25
25
|
const _toVeloEntity = '$';
|
|
26
26
|
const _fromVeloEntity = '$';
|
|
27
|
+
export var CauseOfFailure;
|
|
28
|
+
(function (CauseOfFailure) {
|
|
29
|
+
/** No connection failure. */
|
|
30
|
+
CauseOfFailure["NONE"] = "NONE";
|
|
31
|
+
/** General communication failure. */
|
|
32
|
+
CauseOfFailure["COMMUNICATION_FAILURE"] = "COMMUNICATION_FAILURE";
|
|
33
|
+
/** External database host is unreachable. */
|
|
34
|
+
CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
|
|
35
|
+
/** Unauthorized to access external database. */
|
|
36
|
+
CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
|
|
37
|
+
})(CauseOfFailure || (CauseOfFailure = {}));
|
|
27
38
|
const _createExternalDatabaseConnectionRequest = {};
|
|
28
39
|
const _createExternalDatabaseConnectionResponse = {};
|
|
29
40
|
const _deleteExternalDatabaseConnectionRequest = {};
|
|
@@ -85,7 +96,7 @@ export function getExternalDatabaseConnection(name) {
|
|
|
85
96
|
});
|
|
86
97
|
}
|
|
87
98
|
/**
|
|
88
|
-
* Retrieves a list of all external database collections associated with the site.
|
|
99
|
+
* Retrieves a list of all external database collections associated with the site or project.
|
|
89
100
|
* @public
|
|
90
101
|
* @documentationMaturity preview
|
|
91
102
|
*/
|
|
@@ -133,13 +144,14 @@ export function listExternalDatabaseConnections() {
|
|
|
133
144
|
/**
|
|
134
145
|
* Creates a new external database connection.
|
|
135
146
|
*
|
|
136
|
-
* The
|
|
147
|
+
* The `options.externalDatabaseConnection` parameter must include a name, base URL, and configuration details for the external database.
|
|
137
148
|
* If any of these are missing, the external database connection isn't created.
|
|
138
149
|
* @public
|
|
139
150
|
* @documentationMaturity preview
|
|
140
151
|
* @requiredField options.externalDatabaseConnection.configuration
|
|
141
152
|
* @requiredField options.externalDatabaseConnection.endpoint
|
|
142
153
|
* @requiredField options.externalDatabaseConnection.name
|
|
154
|
+
* @param options - Options for creating an external database connection.
|
|
143
155
|
*/
|
|
144
156
|
export function createExternalDatabaseConnection(options) {
|
|
145
157
|
var _a, _b, _c;
|
|
@@ -189,7 +201,7 @@ export function createExternalDatabaseConnection(options) {
|
|
|
189
201
|
/**
|
|
190
202
|
* Updates an external database connection.
|
|
191
203
|
*
|
|
192
|
-
* An external database collection name must be
|
|
204
|
+
* An external database collection name must be provided in `name`.
|
|
193
205
|
* If an existing external database connection is found with the same name, that connection's details are updated.
|
|
194
206
|
* If no external database connection has that name, the request fails.
|
|
195
207
|
*
|
|
@@ -202,6 +214,7 @@ export function createExternalDatabaseConnection(options) {
|
|
|
202
214
|
* @requiredField name
|
|
203
215
|
* @requiredField options.externalDatabaseConnection.configuration
|
|
204
216
|
* @requiredField options.externalDatabaseConnection.endpoint
|
|
217
|
+
* @param options - Options for updating an external database connection.
|
|
205
218
|
*/
|
|
206
219
|
export function updateExternalDatabaseConnection(name, options) {
|
|
207
220
|
var _a, _b, _c;
|
|
@@ -255,7 +268,7 @@ export function updateExternalDatabaseConnection(name, options) {
|
|
|
255
268
|
/**
|
|
256
269
|
* Deletes an external database connection.
|
|
257
270
|
*
|
|
258
|
-
* > **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/
|
|
271
|
+
* > **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).
|
|
259
272
|
* @param name - Name of the external database connection to delete.
|
|
260
273
|
* @public
|
|
261
274
|
* @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,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,6CAA6C,MAAM,6CAA6C,CAAC;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;AAED,MAAM,CAAC,MAAM,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,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,6CAA6C,MAAM,6CAA6C,CAAC;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;AAED,MAAM,CAAC,MAAM,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,MAAM,CAAN,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,KAAd,cAAc,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,MAAM,UAAgB,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,UAAU,CAAC;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,UAAU,CAAC;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,cAAc,CAAC,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;AAED;;;;GAIG;AACH,MAAM,UAAgB,+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,UAAU,CAAC;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,UAAU,CAAC;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,cAAc,CAAC,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;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAgB,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,UAAU,CAAC;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,UAAU,CAAC;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,cAAc,CAAC,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;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAgB,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,UAAU,CAAC;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,UAAU,CAAC;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,cAAc,CAAC,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;AAqBD;;;;;;;;GAQG;AACH,MAAM,UAAgB,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,UAAU,CAAC;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,UAAU,CAAC;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,cAAc,CAAC,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"}
|
|
@@ -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>;
|
|
@@ -342,7 +342,7 @@ export function getDataCollection(payload) {
|
|
|
342
342
|
return __getDataCollection;
|
|
343
343
|
}
|
|
344
344
|
/**
|
|
345
|
-
* Retrieves a list of all data collections associated with the site.
|
|
345
|
+
* Retrieves a list of all data collections associated with the site or project.
|
|
346
346
|
*
|
|
347
347
|
* By default, the list is ordered by ID in ascending order.
|
|
348
348
|
*/
|
|
@@ -375,14 +375,14 @@ export function listDataCollections(payload) {
|
|
|
375
375
|
/**
|
|
376
376
|
* Updates a data collection.
|
|
377
377
|
*
|
|
378
|
-
* A collection ID, revision number, permissions, and at least 1 field must be provided within
|
|
378
|
+
* A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
|
|
379
379
|
* If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
|
|
380
380
|
* Otherwise, the request fails.
|
|
381
381
|
*
|
|
382
|
-
* When a collection is updated, its `
|
|
382
|
+
* When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
|
|
383
383
|
*
|
|
384
384
|
* > **Note:**
|
|
385
|
-
* > After a collection is updated, it only contains the properties included in the
|
|
385
|
+
* > 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
|
|
386
386
|
* > aren't included in the updated collection details, their values are lost.
|
|
387
387
|
*/
|
|
388
388
|
export 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 {
|