@vidispine/vdt-api 22.3.0-pre.3 → 22.3.0-pre.4

package/dist/index.js

@@ -273,7 +273,7 @@ var _excluded$X = ["entityType", "entityId"],
     _excluded8$m = ["entityType", "entityId", "accessControlListDocument"],
     _excluded9$l = ["entityType", "entityId", "accessControlListDocument"],
     _excluded10$j = ["entityType", "entityId", "headers"],
-    _excluded11$h = ["entityType", "entityId", "headers"],
+    _excluded11$i = ["entityType", "entityId", "headers"],
     _excluded12$g = ["accessControlDocument"],
     _excluded13$f = ["groupName"],
     _excluded14$e = ["groupName"];
@@ -586,7 +586,7 @@ function getEntityAccessGraphDot(_ref11) {
       entityId = _ref11$entityId === void 0 ? isRequired() : _ref11$entityId,
       _ref11$headers = _ref11.headers,
       propHeaders = _ref11$headers === void 0 ? {} : _ref11$headers,
-      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$h);
+      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$i);
 
   var path = "/API/".concat(entityType, "/").concat(entityId, "/access/graph/dot");
 
@@ -1204,7 +1204,7 @@ var _excluded$T = ["itemId"],
     _excluded8$l = ["itemId", "shapeId"],
     _excluded9$k = ["itemId", "shapeId", "componentId"],
     _excluded10$i = ["itemId", "key"],
-    _excluded11$g = ["itemId", "shapeId", "key"],
+    _excluded11$h = ["itemId", "shapeId", "key"],
     _excluded12$f = ["itemId", "shapeId", "componentId", "key"],
     _excluded13$e = ["itemId", "key", "value", "headers"],
     _excluded14$d = ["itemId", "shapeId", "key", "value", "headers"],
@@ -1508,7 +1508,7 @@ function getShapeBulkyMetadata(_ref11) {
       shapeId = _ref11$shapeId === void 0 ? isRequired() : _ref11$shapeId,
       _ref11$key = _ref11.key,
       key = _ref11$key === void 0 ? isRequired() : _ref11$key,
-      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$g);
+      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$h);
 
   var path = "/API/item/".concat(itemId, "/shape/").concat(shapeId, "/metadata/bulky/").concat(key);
   return vFetch(_objectSpread$W({
@@ -2767,7 +2767,7 @@ var _excluded$S = ["entity", "entityId", "metadataDocument"],
     _excluded8$k = ["entity", "entityId", "metadataChangeSetDocument"],
     _excluded9$j = ["entity", "entityId"],
     _excluded10$h = ["entity", "entityId", "changesetId"],
-    _excluded11$f = ["entity", "entityId", "changesetId"],
+    _excluded11$g = ["entity", "entityId", "changesetId"],
     _excluded12$e = ["entity", "entityId", "uuid", "metadataEntryDocument"],
     _excluded13$d = ["entity", "entityId", "metadataEntryListDocument"],
     _excluded14$c = ["entity", "entityId", "headers"],
@@ -2780,7 +2780,7 @@ var _excluded$S = ["entity", "entityId", "metadataDocument"],
     _excluded21$5 = ["entityType", "entityId", "subpath"],
     _excluded22$5 = ["simpleMetadataDocument", "entityType", "entityId"],
     _excluded23$5 = ["simpleMetadataDocument", "entityType", "entityId", "subpath"],
-    _excluded24$3 = ["entityType", "entityId"],
+    _excluded24$4 = ["entityType", "entityId"],
     _excluded25$3 = ["entityType", "entityId", "key", "headers"],
     _excluded26$3 = ["entityType", "entityId", "key", "headers"],
     _excluded27$3 = ["entityType", "entityId", "key", "value", "headers"];
@@ -3096,7 +3096,7 @@ function removeEntityMetadataChange(_ref11) {
       entityId = _ref11$entityId === void 0 ? isRequired() : _ref11$entityId,
       _ref11$changesetId = _ref11.changesetId,
       changesetId = _ref11$changesetId === void 0 ? isRequired() : _ref11$changesetId,
-      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$f);
+      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$g);
 
   var path = "/API/".concat(entity, "/").concat(entityId, "/metadata/changes/").concat(changesetId);
   return vFetch(_objectSpread$U({
@@ -3487,7 +3487,7 @@ function removeSimpleMetadata() {
       entityType = _ref25$entityType === void 0 ? isRequired() : _ref25$entityType,
       _ref25$entityId = _ref25.entityId,
       entityId = _ref25$entityId === void 0 ? isRequired() : _ref25$entityId,
-      props = _objectWithoutProperties__default["default"](_ref25, _excluded24$3);
+      props = _objectWithoutProperties__default["default"](_ref25, _excluded24$4);
 
   var path = "/API/".concat(entityType, "/").concat(entityId, "/metadata");
   return vFetch(_objectSpread$U({
@@ -3807,7 +3807,7 @@ var _excluded$Q = ["collectionId"],
     _excluded8$j = ["collectionDocument", "queryParams"],
     _excluded9$i = ["collectionId"],
     _excluded10$g = ["queryParams"],
-    _excluded11$e = ["collectionId"],
+    _excluded11$f = ["collectionId"],
     _excluded12$d = ["collectionId", "entityId"],
     _excluded13$c = ["collectionId", "entityId"],
     _excluded14$b = ["collectionId", "collectionDocument"],
@@ -3819,7 +3819,8 @@ var _excluded$Q = ["collectionId"],
     _excluded20$4 = ["collectionId"],
     _excluded21$4 = ["collectionId"],
     _excluded22$4 = ["collectionId"],
-    _excluded23$4 = ["collectionId"];
+    _excluded23$4 = ["collectionId"],
+    _excluded24$3 = ["collectionId", "queryParams"];
 
 function ownKeys$S(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -4121,7 +4122,7 @@ function removeCollectionList(_ref12) {
 function renameCollection(_ref13) {
   var _ref13$collectionId = _ref13.collectionId,
       collectionId = _ref13$collectionId === void 0 ? isRequired() : _ref13$collectionId,
-      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$e);
+      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$f);
 
   var path = "/API/collection/".concat(collectionId, "/rename");
   return vFetch(_objectSpread$S({
@@ -4406,6 +4407,31 @@ function removeCollectionMetadataLock(_ref25) {
     entityId: collectionId
   }, props));
 }
+/**
+ * {@link https://apidoc.vidispine.com/latest/ref/item/export.html?#start-an-export-job-for-a-collection-or-a-library APIdoc}
+ *
+ * @function collection.exportCollection
+ * @param {Object} obj
+ * @param {string} obj.collectionId
+ * @param {string} obj.queryParams
+ * @returns {Promise<Object>}
+ */
+
+
+function exportCollection(_ref26) {
+  var _ref26$collectionId = _ref26.collectionId,
+      collectionId = _ref26$collectionId === void 0 ? isRequired() : _ref26$collectionId,
+      _ref26$queryParams = _ref26.queryParams,
+      queryParams = _ref26$queryParams === void 0 ? isRequired() : _ref26$queryParams,
+      props = _objectWithoutProperties__default["default"](_ref26, _excluded24$3);
+
+  var path = "/API/collection/".concat(collectionId, "/export");
+  return vFetch(_objectSpread$S({
+    path: path,
+    method: 'POST',
+    queryParams: queryParams
+  }, props));
+}
 
 var collection = {
   listCollection: listCollection,
@@ -4432,7 +4458,8 @@ var collection = {
   createCollectionMetadataLock: createCollectionMetadataLock,
   getCollectionMetadataLock: getCollectionMetadataLock,
   updateCollectionMetadataLock: updateCollectionMetadataLock,
-  removeCollectionMetadataLock: removeCollectionMetadataLock
+  removeCollectionMetadataLock: removeCollectionMetadataLock,
+  exportCollection: exportCollection
 };
 
 var _excluded$P = ["itemId", "shapeId"],
@@ -4445,7 +4472,7 @@ var _excluded$P = ["itemId", "shapeId"],
     _excluded8$i = ["itemId", "shapeId", "componentId", "targetItemId", "targetShapeId", "targetComponentId"],
     _excluded9$h = ["itemId", "shapeId", "componentId", "targetItemId", "targetShapeId"],
     _excluded10$f = ["itemId", "shapeId", "componentId", "fileId"],
-    _excluded11$d = ["itemId", "shapeId", "componentId", "fileId"],
+    _excluded11$e = ["itemId", "shapeId", "componentId", "fileId"],
     _excluded12$c = ["itemId", "shapeId", "componentId", "analyzeJobDocument"];
 
 function ownKeys$R(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -4796,7 +4823,7 @@ function removeComponentFile(_ref11) {
       componentId = _ref11$componentId === void 0 ? isRequired() : _ref11$componentId,
       _ref11$fileId = _ref11.fileId,
       fileId = _ref11$fileId === void 0 ? isRequired() : _ref11$fileId,
-      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$d);
+      props = _objectWithoutProperties__default["default"](_ref11, _excluded11$e);
 
   var path = "/API/item/".concat(itemId, "/shape/").concat(shapeId, "/component/").concat(componentId, "/file/").concat(fileId);
   return vFetch(_objectSpread$R({
@@ -4862,7 +4889,7 @@ var _excluded$O = ["configurationPropertyDocument"],
     _excluded8$h = ["metricsConfigurationDocument"],
     _excluded9$g = ["pathAliasConfigurationDocument"],
     _excluded10$e = ["logReportConfigurationDocument"],
-    _excluded11$c = ["databasePurgingConfigurationDocument"],
+    _excluded11$d = ["databasePurgingConfigurationDocument"],
     _excluded12$b = ["corsConfigurationDocument"],
     _excluded13$b = ["oAuth2ConfigurationDocument"],
     _excluded14$a = ["jobPriorityConfigurationDocument"],
@@ -5351,7 +5378,7 @@ function getDatabasePurgingConfiguration() {
 function updateDatabasePurgingConfiguration(_ref22) {
   var _ref22$databasePurgin = _ref22.databasePurgingConfigurationDocument,
       databasePurgingConfigurationDocument = _ref22$databasePurgin === void 0 ? isRequired() : _ref22$databasePurgin,
-      props = _objectWithoutProperties__default["default"](_ref22, _excluded11$c);
+      props = _objectWithoutProperties__default["default"](_ref22, _excluded11$d);
 
   var path = '/API/configuration/purging';
   return vFetch(_objectSpread$Q({
@@ -6847,7 +6874,7 @@ var _excluded$G = ["groupName"],
     _excluded8$f = ["metadataFieldGroupSearchDocument"],
     _excluded9$f = ["groupName"],
     _excluded10$d = ["groupName"],
-    _excluded11$b = ["groupName", "metadataFieldAccessControlDocument"],
+    _excluded11$c = ["groupName", "metadataFieldAccessControlDocument"],
     _excluded12$a = ["groupName", "accessId"],
     _excluded13$a = ["groupName"];
 
@@ -7138,7 +7165,7 @@ function createFieldGroupAccess(_ref12) {
       groupName = _ref12$groupName === void 0 ? isRequired() : _ref12$groupName,
       _ref12$metadataFieldA = _ref12.metadataFieldAccessControlDocument,
       metadataFieldAccessControlDocument = _ref12$metadataFieldA === void 0 ? isRequired() : _ref12$metadataFieldA,
-      props = _objectWithoutProperties__default["default"](_ref12, _excluded11$b);
+      props = _objectWithoutProperties__default["default"](_ref12, _excluded11$c);
 
   var path = "/API/metadata-field/field-group/".concat(groupName, "/access");
   return vFetch(_objectSpread$H({
@@ -7247,7 +7274,7 @@ var _excluded$F = ["storageId"],
     _excluded8$e = ["fileId", "metadataDocument"],
     _excluded9$e = ["storageId", "metadataDocument"],
     _excluded10$c = ["storageId", "metadataDocument"],
-    _excluded11$a = ["fileId", "targetStorageId"],
+    _excluded11$b = ["fileId", "targetStorageId"],
     _excluded12$9 = ["fileId"],
     _excluded13$9 = ["storageId", "fileDocument"],
     _excluded14$9 = ["fileId"],
@@ -7595,7 +7622,7 @@ function createFileMove(_ref13) {
       fileId = _ref13$fileId === void 0 ? isRequired() : _ref13$fileId,
       _ref13$targetStorageI = _ref13.targetStorageId,
       targetStorageId = _ref13$targetStorageI === void 0 ? isRequired() : _ref13$targetStorageI,
-      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$a);
+      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$b);
 
   var path = "/API/storage/file/".concat(fileId, "/storage/").concat(targetStorageId, "/");
   return vFetch(_objectSpread$G({
@@ -8033,7 +8060,7 @@ var _excluded$D = ["groupName"],
     _excluded8$d = ["groupName", "headers"],
     _excluded9$d = ["groupName", "headers"],
     _excluded10$b = ["groupName", "childGroupName"],
-    _excluded11$9 = ["groupName", "childGroupName"],
+    _excluded11$a = ["groupName", "childGroupName"],
     _excluded12$8 = ["groupName", "headers"],
     _excluded13$8 = ["groupName", "userName"],
     _excluded14$8 = ["groupName", "userName"];
@@ -8374,7 +8401,7 @@ function removeGroupChildren(_ref13) {
       groupName = _ref13$groupName === void 0 ? isRequired() : _ref13$groupName,
       _ref13$childGroupName = _ref13.childGroupName,
       childGroupName = _ref13$childGroupName === void 0 ? isRequired() : _ref13$childGroupName,
-      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$9);
+      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$a);
 
   var path = "/API/group/".concat(groupName, "/group/").concat(childGroupName);
   return vFetch(_objectSpread$E({
@@ -8494,7 +8521,7 @@ var _excluded$C = ["metadataDocument"],
     _excluded8$c = ["itemId", "component", "file", "headers"],
     _excluded9$c = ["itemId", "component", "file", "headers"],
     _excluded10$a = ["itemId", "placeholderImportRequestDocument"],
-    _excluded11$8 = ["itemId"],
+    _excluded11$9 = ["itemId"],
     _excluded12$7 = ["itemId", "component", "fileId"],
     _excluded13$7 = ["itemId"],
     _excluded14$7 = ["itemId", "file", "headers"];
@@ -8821,7 +8848,7 @@ function createImportItem(_ref11) {
 function createImportItemPasskey(_ref12) {
   var _ref12$itemId = _ref12.itemId,
       itemId = _ref12$itemId === void 0 ? isRequired() : _ref12$itemId,
-      props = _objectWithoutProperties__default["default"](_ref12, _excluded11$8);
+      props = _objectWithoutProperties__default["default"](_ref12, _excluded11$9);
 
   var path = "/API/import/placeholder/".concat(itemId, "/raw-passkey/");
   return vFetch(_objectSpread$D({
@@ -9139,7 +9166,7 @@ var _excluded$A = ["itemId"],
     _excluded8$b = ["itemId"],
     _excluded9$b = ["itemId"],
     _excluded10$9 = ["itemId"],
-    _excluded11$7 = ["itemId"],
+    _excluded11$8 = ["itemId"],
     _excluded12$6 = ["itemId", "relationItemId"],
     _excluded13$6 = ["itemRelationListDocument"],
     _excluded14$6 = ["itemId", "relationItemId"],
@@ -9464,7 +9491,7 @@ function createExportImp(_ref12) {
 function listItemRelation(_ref13) {
   var _ref13$itemId = _ref13.itemId,
       itemId = _ref13$itemId === void 0 ? isRequired() : _ref13$itemId,
-      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$7);
+      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$8);
 
   var path = "/API/item/".concat(itemId, "/relation");
   return vFetch(_objectSpread$B({
@@ -10771,7 +10798,8 @@ var _excluded$w = ["itemListDocument"],
     _excluded7$a = ["libraryId", "metadataDocument"],
     _excluded8$9 = ["libraryId"],
     _excluded9$9 = ["libraryId", "librarySettingsDocument"],
-    _excluded10$7 = ["libraryId"];
+    _excluded10$7 = ["libraryId"],
+    _excluded11$7 = ["libraryId", "queryParams"];
 
 function ownKeys$x(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
@@ -11063,6 +11091,31 @@ function getLibraryBatch(_ref12) {
     method: 'POST'
   }, props));
 }
+/**
+ * {@link https://apidoc.vidispine.com/latest/ref/item/export.html?#start-an-export-job-for-a-collection-or-a-library APIdoc}
+ *
+ * @function library.exportCollection
+ * @param {Object} obj
+ * @param {string} obj.libraryId
+ * @param {string} obj.queryParams
+ * @returns {Promise<Object>}
+ */
+
+
+function exportLibrary(_ref13) {
+  var _ref13$libraryId = _ref13.libraryId,
+      libraryId = _ref13$libraryId === void 0 ? isRequired() : _ref13$libraryId,
+      _ref13$queryParams = _ref13.queryParams,
+      queryParams = _ref13$queryParams === void 0 ? isRequired() : _ref13$queryParams,
+      props = _objectWithoutProperties__default["default"](_ref13, _excluded11$7);
+
+  var path = "/API/library/".concat(libraryId, "/export");
+  return vFetch(_objectSpread$x({
+    path: path,
+    method: 'POST',
+    queryParams: queryParams
+  }, props));
+}
 
 var library = {
   listLibrary: listLibrary,
@@ -11076,7 +11129,8 @@ var library = {
   updateLibraryItemMetadata: updateLibraryItemMetadata,
   getLibrarySettings: getLibrarySettings,
   updateLibrarySettings: updateLibrarySettings,
-  getLibraryBatch: getLibraryBatch
+  getLibraryBatch: getLibraryBatch,
+  exportLibrary: exportLibrary
 };
 
 var _excluded$v = ["file", "headers"];