@wix/auto_sdk_data_collections 1.0.0

package/build/internal/cjs/src/data-v2-data-collection-collections.http.js

@@ -0,0 +1,704 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteDataCollectionField = exports.updateDataCollectionField = exports.createDataCollectionField = exports.restoreDataCollection = exports.deleteDataCollection = exports.updateDataCollection = exports.listDataCollections = exports.getDataCollection = exports.createDataCollection = void 0;
+const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
+const float_1 = require("@wix/sdk-runtime/transformations/float");
+const float_2 = require("@wix/sdk-runtime/transformations/float");
+const timestamp_1 = require("@wix/sdk-runtime/transformations/timestamp");
+const timestamp_2 = require("@wix/sdk-runtime/transformations/timestamp");
+const transform_paths_1 = require("@wix/sdk-runtime/transformations/transform-paths");
+const rest_modules_2 = require("@wix/sdk-runtime/rest-modules");
+function resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl(opts) {
+    const domainToMappings = {
+        'api._api_base_domain_': [
+            {
+                srcPath: '/cloud-data',
+                destPath: '',
+            },
+        ],
+        'code._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data/v1/data-settings',
+                destPath: '/v1/data-settings',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/connector',
+                destPath: '/v1/connector',
+            },
+            {
+                srcPath: '/_api/data/v1/data-settings',
+                destPath: '/v1/data-settings',
+            },
+            {
+                srcPath: '/_api/data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/data/v1/connector',
+                destPath: '/v1/connector',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/wix-data',
+                destPath: '/v1/wix-data',
+            },
+        ],
+        'cloud-data.wix-code.com': [
+            {
+                srcPath: '',
+                destPath: '',
+            },
+        ],
+        _: [
+            {
+                srcPath: '/_api/cloud-data',
+                destPath: '',
+            },
+        ],
+        'www._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data',
+                destPath: '',
+            },
+            {
+                srcPath: '/_api/data',
+                destPath: '',
+            },
+            {
+                srcPath: '/_api/cloud-data',
+                destPath: '',
+            },
+        ],
+        'dev._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data',
+                destPath: '',
+            },
+        ],
+        'bo._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data/v1',
+                destPath: '/v1',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2',
+                destPath: '/v2',
+            },
+        ],
+        'wixbo.ai': [
+            {
+                srcPath: '/_api/cloud-data/v1',
+                destPath: '/v1',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2',
+                destPath: '/v2',
+            },
+        ],
+        'wix-bo.com': [
+            {
+                srcPath: '/_api/cloud-data/v1',
+                destPath: '/v1',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2',
+                destPath: '/v2',
+            },
+        ],
+        'manage._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data',
+                destPath: '',
+            },
+            {
+                srcPath: '/_api/data',
+                destPath: '',
+            },
+            {
+                srcPath: '/_api/cloud-data',
+                destPath: '',
+            },
+        ],
+        'editor._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/cloud-data/dbs/tasks',
+                destPath: '/dbs/tasks',
+            },
+            {
+                srcPath: '/_api/data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/data/dbs/tasks',
+                destPath: '/dbs/tasks',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/wix-data',
+                destPath: '/v1/wix-data',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/data-settings',
+                destPath: '/v1/data-settings',
+            },
+            {
+                srcPath: '/_api/data/v2/indexes',
+                destPath: '/v2/indexes',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/external-database-connections',
+                destPath: '/v1/external-database-connections',
+            },
+            {
+                srcPath: '/_api/data/v1/data-collection-sharing',
+                destPath: '/v1/data-collection-sharing',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/collections',
+                destPath: '/v2/collections',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/bulk',
+                destPath: '/v2/bulk',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/items',
+                destPath: '/v2/items',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/dbs/tasks',
+                destPath: '/v2/dbs/tasks',
+            },
+        ],
+        'blocks._base_domain_': [
+            {
+                srcPath: '/_api/cloud-data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/cloud-data/dbs/tasks',
+                destPath: '/dbs/tasks',
+            },
+            {
+                srcPath: '/_api/data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/data/dbs/tasks',
+                destPath: '/dbs/tasks',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/wix-data',
+                destPath: '/v1/wix-data',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/data-settings',
+                destPath: '/v1/data-settings',
+            },
+            {
+                srcPath: '/_api/data/v2/indexes',
+                destPath: '/v2/indexes',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/external-database-connections',
+                destPath: '/v1/external-database-connections',
+            },
+            {
+                srcPath: '/_api/data/v1/data-collection-sharing',
+                destPath: '/v1/data-collection-sharing',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/collections',
+                destPath: '/v2/collections',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/bulk',
+                destPath: '/v2/bulk',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/items',
+                destPath: '/v2/items',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/dbs/tasks',
+                destPath: '/v2/dbs/tasks',
+            },
+        ],
+        'create.editorx': [
+            {
+                srcPath: '/_api/cloud-data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/cloud-data/dbs/tasks',
+                destPath: '/dbs/tasks',
+            },
+            {
+                srcPath: '/_api/data/v1/schemas',
+                destPath: '/v1/schemas',
+            },
+            {
+                srcPath: '/_api/data/dbs/tasks',
+                destPath: '/dbs/tasks',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/wix-data',
+                destPath: '/v1/wix-data',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/data-settings',
+                destPath: '/v1/data-settings',
+            },
+            {
+                srcPath: '/_api/data/v2/indexes',
+                destPath: '/v2/indexes',
+            },
+            {
+                srcPath: '/_api/cloud-data/v1/external-database-connections',
+                destPath: '/v1/external-database-connections',
+            },
+            {
+                srcPath: '/_api/data/v1/data-collection-sharing',
+                destPath: '/v1/data-collection-sharing',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/collections',
+                destPath: '/v2/collections',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/bulk',
+                destPath: '/v2/bulk',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/items',
+                destPath: '/v2/items',
+            },
+            {
+                srcPath: '/_api/cloud-data/v2/dbs/tasks',
+                destPath: '/v2/dbs/tasks',
+            },
+        ],
+        'www.wixapis.com': [
+            {
+                srcPath: '/wix-data/v1/collections',
+                destPath: '/v1/wix-data/collections',
+            },
+            {
+                srcPath: '/wix-data/v1/external-database-connections',
+                destPath: '/v1/external-database-connections',
+            },
+            {
+                srcPath: '/wix-data/v2/indexes',
+                destPath: '/v2/indexes',
+            },
+            {
+                srcPath: '/wix-data/v1/items',
+                destPath: '/v1/items',
+            },
+            {
+                srcPath: '/wix-data/v1/bulk',
+                destPath: '/v1/bulk',
+            },
+            {
+                srcPath: '/wix-data/v1/external-databases',
+                destPath: '/v1/external-databases',
+            },
+            {
+                srcPath: '/wix-data/v2',
+                destPath: '/v2',
+            },
+        ],
+        'www.wixgateway.com': [
+            {
+                srcPath: '/wix-data/v1/items',
+                destPath: '/v1/items',
+            },
+            {
+                srcPath: '/wix-data/v1/bulk',
+                destPath: '/v1/bulk',
+            },
+        ],
+        '*.dev.wix-code.com': [
+            {
+                srcPath: '/_api/cloud-data/v2',
+                destPath: '/v2',
+            },
+        ],
+    };
+    return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+const PACKAGE_NAME = '@wix/auto_sdk_data_collections';
+/**
+ * Creates a new data collection.
+ *
+ * The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
+ */
+function createDataCollection(payload) {
+    function __createDataCollection({ host }) {
+        const serializedData = (0, transform_paths_1.transformPaths)(payload, [
+            {
+                transformFn: timestamp_1.transformSDKTimestampToRESTTimestamp,
+                paths: [
+                    { path: 'collection.createdDate' },
+                    { path: 'collection.updatedDate' },
+                ],
+            },
+            {
+                transformFn: float_1.transformSDKFloatToRESTFloat,
+                paths: [
+                    { path: 'collection.fields.numberRange.min' },
+                    { path: 'collection.fields.numberRange.max' },
+                ],
+            },
+        ]);
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'POST',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({ protoPath: '/v2/collections', data: serializedData, host }),
+            data: serializedData,
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'collection.createdDate' },
+                        { path: 'collection.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'collection.fields.numberRange.min' },
+                        { path: 'collection.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __createDataCollection;
+}
+exports.createDataCollection = createDataCollection;
+/** Retrieves a data collection by ID. */
+function getDataCollection(payload) {
+    function __getDataCollection({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'GET',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({ protoPath: '/v2/collections/{dataCollectionId}', data: payload, host }),
+            params: (0, rest_modules_1.toURLSearchParams)(payload),
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'collection.createdDate' },
+                        { path: 'collection.updatedDate' },
+                        { path: 'referencedCollections.createdDate' },
+                        { path: 'referencedCollections.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'collection.fields.numberRange.min' },
+                        { path: 'collection.fields.numberRange.max' },
+                        { path: 'referencedCollections.fields.numberRange.min' },
+                        { path: 'referencedCollections.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __getDataCollection;
+}
+exports.getDataCollection = getDataCollection;
+/**
+ * Retrieves a list of all data collections associated with the site or project.
+ *
+ * By default, the list is ordered by ID in ascending order.
+ */
+function listDataCollections(payload) {
+    function __listDataCollections({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'GET',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.ListDataCollections',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({ protoPath: '/v2/collections', data: payload, host }),
+            params: (0, rest_modules_1.toURLSearchParams)(payload),
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'collections.createdDate' },
+                        { path: 'collections.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'collections.fields.numberRange.min' },
+                        { path: 'collections.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __listDataCollections;
+}
+exports.listDataCollections = listDataCollections;
+/**
+ * Updates a data collection.
+ *
+ * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
+ * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
+ * Otherwise, the request fails.
+ *
+ * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
+ *
+ * > **Note:**
+ * > After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties
+ * > aren't included in the updated collection details, their values are lost.
+ */
+function updateDataCollection(payload) {
+    function __updateDataCollection({ host }) {
+        const serializedData = (0, transform_paths_1.transformPaths)(payload, [
+            {
+                transformFn: timestamp_1.transformSDKTimestampToRESTTimestamp,
+                paths: [
+                    { path: 'collection.createdDate' },
+                    { path: 'collection.updatedDate' },
+                ],
+            },
+            {
+                transformFn: float_1.transformSDKFloatToRESTFloat,
+                paths: [
+                    { path: 'collection.fields.numberRange.min' },
+                    { path: 'collection.fields.numberRange.max' },
+                ],
+            },
+        ]);
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'PUT',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollection',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({ protoPath: '/v2/collections', data: serializedData, host }),
+            data: serializedData,
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'collection.createdDate' },
+                        { path: 'collection.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'collection.fields.numberRange.min' },
+                        { path: 'collection.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __updateDataCollection;
+}
+exports.updateDataCollection = updateDataCollection;
+/**
+ * Deletes a data collection.
+ *
+ * > **Note:**
+ * > Once a collection is deleted, it can only be restored for limited amount of time.
+ */
+function deleteDataCollection(payload) {
+    function __deleteDataCollection({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'DELETE',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollection',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({ protoPath: '/v2/collections/{dataCollectionId}', data: payload, host }),
+            params: (0, rest_modules_1.toURLSearchParams)(payload),
+        };
+        return metadata;
+    }
+    return __deleteDataCollection;
+}
+exports.deleteDataCollection = deleteDataCollection;
+/**
+ * Restores recently deleted collection.
+ *
+ * Fails with `WDE0025` if collection was deleted too long ago or has never existed.
+ */
+function restoreDataCollection(payload) {
+    function __restoreDataCollection({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'POST',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.RestoreDataCollection',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({
+                protoPath: '/v2/collections/restore/{dataCollectionId}',
+                data: payload,
+                host,
+            }),
+            data: payload,
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'dataCollection.createdDate' },
+                        { path: 'dataCollection.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'dataCollection.fields.numberRange.min' },
+                        { path: 'dataCollection.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __restoreDataCollection;
+}
+exports.restoreDataCollection = restoreDataCollection;
+/** Adds new field to data collection schema */
+function createDataCollectionField(payload) {
+    function __createDataCollectionField({ host }) {
+        const serializedData = (0, transform_paths_1.transformPaths)(payload, [
+            {
+                transformFn: float_1.transformSDKFloatToRESTFloat,
+                paths: [
+                    { path: 'field.numberRange.min' },
+                    { path: 'field.numberRange.max' },
+                ],
+            },
+        ]);
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'POST',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollectionField',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({
+                protoPath: '/v2/collections/create-field',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'dataCollection.createdDate' },
+                        { path: 'dataCollection.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'dataCollection.fields.numberRange.min' },
+                        { path: 'dataCollection.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __createDataCollectionField;
+}
+exports.createDataCollectionField = createDataCollectionField;
+/** Updates data collection field */
+function updateDataCollectionField(payload) {
+    function __updateDataCollectionField({ host }) {
+        const serializedData = (0, transform_paths_1.transformPaths)(payload, [
+            {
+                transformFn: float_1.transformSDKFloatToRESTFloat,
+                paths: [
+                    { path: 'field.numberRange.min' },
+                    { path: 'field.numberRange.max' },
+                ],
+            },
+        ]);
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'POST',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollectionField',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({
+                protoPath: '/v2/collections/update-field',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'dataCollection.createdDate' },
+                        { path: 'dataCollection.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'dataCollection.fields.numberRange.min' },
+                        { path: 'dataCollection.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __updateDataCollectionField;
+}
+exports.updateDataCollectionField = updateDataCollectionField;
+/** Deletes data collection field */
+function deleteDataCollectionField(payload) {
+    function __deleteDataCollectionField({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.data.v2.data_collection',
+            method: 'POST',
+            methodFqn: 'com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionField',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl({ protoPath: '/v2/collections/delete-field', data: payload, host }),
+            data: payload,
+            transformResponse: (payload) => (0, transform_paths_1.transformPaths)(payload, [
+                {
+                    transformFn: timestamp_2.transformRESTTimestampToSDKTimestamp,
+                    paths: [
+                        { path: 'dataCollection.createdDate' },
+                        { path: 'dataCollection.updatedDate' },
+                    ],
+                },
+                {
+                    transformFn: float_2.transformRESTFloatToSDKFloat,
+                    paths: [
+                        { path: 'dataCollection.fields.numberRange.min' },
+                        { path: 'dataCollection.fields.numberRange.max' },
+                    ],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __deleteDataCollectionField;
+}
+exports.deleteDataCollectionField = deleteDataCollectionField;
+//# sourceMappingURL=data-v2-data-collection-collections.http.js.map