contentful-management 9.1.2 → 9.2.0

package/dist/contentful-management.browser.js

@@ -8218,7 +8218,7 @@ var queryForRelease = function queryForRelease(http, params) {
 /*!********************************************!*\
   !*** ./adapters/REST/endpoints/release.ts ***!
   \********************************************/
-/*! exports provided: get, query, create, update, del, publish, unpublish, validate */
+/*! exports provided: get, query, create, update, del, publish, unpublish, validate, archive, unarchive */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
@@ -8231,6 +8231,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "publish", function() { return publish; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "unpublish", function() { return unpublish; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "validate", function() { return validate; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "archive", function() { return archive; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "unarchive", function() { return unarchive; });
 /* harmony import */ var _raw__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./raw */ "./adapters/REST/endpoints/raw.ts");
 function ownKeys(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; }
 
@@ -8238,7 +8240,6 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
 
 var get = function get(http, params) {
   return _raw__WEBPACK_IMPORTED_MODULE_0__["get"](http, "/spaces/".concat(params.spaceId, "/environments/").concat(params.environmentId, "/releases/").concat(params.releaseId));
@@ -8278,6 +8279,20 @@ var unpublish = function unpublish(http, params, headers) {
 var validate = function validate(http, params, payload) {
   return _raw__WEBPACK_IMPORTED_MODULE_0__["post"](http, "/spaces/".concat(params.spaceId, "/environments/").concat(params.environmentId, "/releases/").concat(params.releaseId, "/validate"), payload);
 };
+var archive = function archive(http, params) {
+  return _raw__WEBPACK_IMPORTED_MODULE_0__["put"](http, "/spaces/".concat(params.spaceId, "/environments/").concat(params.environmentId, "/releases/").concat(params.releaseId, "/archived"), null, {
+    headers: {
+      'X-Contentful-Version': params.version
+    }
+  });
+};
+var unarchive = function unarchive(http, params) {
+  return _raw__WEBPACK_IMPORTED_MODULE_0__["del"](http, "/spaces/".concat(params.spaceId, "/environments/").concat(params.environmentId, "/releases/").concat(params.releaseId, "/archived"), {
+    headers: {
+      'X-Contentful-Version': params.version
+    }
+  });
+};
 
 /***/ }),
 
@@ -10167,7 +10182,7 @@ function createClient(params) {
   var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
   var userAgent = Object(contentful_sdk_core__WEBPACK_IMPORTED_MODULE_0__["getUserAgentHeader"])( // @ts-expect-error
-  "".concat(sdkMain, "/").concat("9.1.2"), params.application, params.integration, params.feature);
+  "".concat(sdkMain, "/").concat("9.2.0"), params.application, params.integration, params.feature);
   var adapter = Object(_create_adapter__WEBPACK_IMPORTED_MODULE_1__["createAdapter"])(params); // Parameters<?> and ReturnType<?> only return the types of the last overload
   // https://github.com/microsoft/TypeScript/issues/26591
   // @ts-expect-error
@@ -13499,6 +13514,80 @@ function createEnvironmentApi(makeRequest) {
       });
     },
 
+    /**
+     * Archives a Release and prevents new operations (publishing, unpublishing adding new entities etc).
+     * @param options.releaseId the ID of the release
+     * @param options.version the version of the release that is to be archived
+     * @returns Promise containing a wrapped Release, that has helper methods within.
+     *
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.archiveRelease({ releaseId: '<release_id>', version: 1 }))
+     * .catch(console.error)
+     * ```
+     */
+    archiveRelease: function archiveRelease(_ref6) {
+      var releaseId = _ref6.releaseId,
+          version = _ref6.version;
+      var raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Release',
+        action: 'archive',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          releaseId: releaseId,
+          version: version
+        }
+      }).then(function (data) {
+        return Object(_entities_release__WEBPACK_IMPORTED_MODULE_3__["wrapRelease"])(makeRequest, data);
+      });
+    },
+
+    /**
+     * Unarchives a previously archived Release - this enables the release to be published, unpublished etc.
+     * @param options.releaseId the ID of the release
+     * @param options.version the version of the release that is to be unarchived
+     * @returns Promise containing a wrapped Release, that has helper methods within.
+     *
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.unarchiveRelease({ releaseId: '<release_id>', version: 1 }))
+     * .catch(console.error)
+     * ```
+     */
+    unarchiveRelease: function unarchiveRelease(_ref7) {
+      var releaseId = _ref7.releaseId,
+          version = _ref7.version;
+      var raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Release',
+        action: 'unarchive',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          releaseId: releaseId,
+          version: version
+        }
+      }).then(function (data) {
+        return Object(_entities_release__WEBPACK_IMPORTED_MODULE_3__["wrapRelease"])(makeRequest, data);
+      });
+    },
+
     /**
      * Retrieves a ReleaseAction by ID
      * @param params.releaseId The ID of a Release
@@ -13518,9 +13607,9 @@ function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getReleaseAction: function getReleaseAction(_ref6) {
-      var actionId = _ref6.actionId,
-          releaseId = _ref6.releaseId;
+    getReleaseAction: function getReleaseAction(_ref8) {
+      var actionId = _ref8.actionId,
+          releaseId = _ref8.releaseId;
       var raw = this.toPlainObject();
       return makeRequest({
         entityType: 'ReleaseAction',
@@ -13556,9 +13645,9 @@ function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getReleaseActions: function getReleaseActions(_ref7) {
-      var releaseId = _ref7.releaseId,
-          query = _ref7.query;
+    getReleaseActions: function getReleaseActions(_ref9) {
+      var releaseId = _ref9.releaseId,
+          query = _ref9.query;
       var raw = this.toPlainObject();
       return makeRequest({
         entityType: 'ReleaseAction',
@@ -18341,7 +18430,7 @@ function createReleaseApi(makeRequest) {
   };
 
   return {
-    update: function update(payload) {
+    archive: function archive() {
       var _this = this;
 
       return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
@@ -18353,9 +18442,8 @@ function createReleaseApi(makeRequest) {
                 params = getParams(_this);
                 return _context.abrupt("return", makeRequest({
                   entityType: 'Release',
-                  action: 'update',
-                  params: params,
-                  payload: payload
+                  action: 'archive',
+                  params: params
                 }).then(function (release) {
                   return wrapRelease(makeRequest, release);
                 }));
@@ -18368,7 +18456,7 @@ function createReleaseApi(makeRequest) {
         }, _callee);
       }))();
     },
-    delete: function _delete() {
+    unarchive: function unarchive() {
       var _this2 = this;
 
       return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
@@ -18378,14 +18466,15 @@ function createReleaseApi(makeRequest) {
             switch (_context2.prev = _context2.next) {
               case 0:
                 params = getParams(_this2);
-                _context2.next = 3;
-                return makeRequest({
+                return _context2.abrupt("return", makeRequest({
                   entityType: 'Release',
-                  action: 'delete',
+                  action: 'unarchive',
                   params: params
-                });
+                }).then(function (release) {
+                  return wrapRelease(makeRequest, release);
+                }));
 
-              case 3:
+              case 2:
               case "end":
                 return _context2.stop();
             }
@@ -18393,7 +18482,7 @@ function createReleaseApi(makeRequest) {
         }, _callee2);
       }))();
     },
-    publish: function publish(options) {
+    update: function update(payload) {
       var _this3 = this;
 
       return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
@@ -18405,12 +18494,11 @@ function createReleaseApi(makeRequest) {
                 params = getParams(_this3);
                 return _context3.abrupt("return", makeRequest({
                   entityType: 'Release',
-                  action: 'publish',
-                  params: params
-                }).then(function (data) {
-                  return Object(_release_action__WEBPACK_IMPORTED_MODULE_4__["wrapReleaseAction"])(makeRequest, data);
-                }).then(function (action) {
-                  return action.waitProcessing(options);
+                  action: 'update',
+                  params: params,
+                  payload: payload
+                }).then(function (release) {
+                  return wrapRelease(makeRequest, release);
                 }));
 
               case 2:
@@ -18421,7 +18509,7 @@ function createReleaseApi(makeRequest) {
         }, _callee3);
       }))();
     },
-    unpublish: function unpublish(options) {
+    delete: function _delete() {
       var _this4 = this;
 
       return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4() {
@@ -18431,17 +18519,14 @@ function createReleaseApi(makeRequest) {
             switch (_context4.prev = _context4.next) {
               case 0:
                 params = getParams(_this4);
-                return _context4.abrupt("return", makeRequest({
+                _context4.next = 3;
+                return makeRequest({
                   entityType: 'Release',
-                  action: 'unpublish',
+                  action: 'delete',
                   params: params
-                }).then(function (data) {
-                  return Object(_release_action__WEBPACK_IMPORTED_MODULE_4__["wrapReleaseAction"])(makeRequest, data);
-                }).then(function (action) {
-                  return action.waitProcessing(options);
-                }));
+                });
 
-              case 2:
+              case 3:
               case "end":
                 return _context4.stop();
             }
@@ -18449,7 +18534,7 @@ function createReleaseApi(makeRequest) {
         }, _callee4);
       }))();
     },
-    validate: function validate(options) {
+    publish: function publish(options) {
       var _this5 = this;
 
       return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
@@ -18460,6 +18545,62 @@ function createReleaseApi(makeRequest) {
               case 0:
                 params = getParams(_this5);
                 return _context5.abrupt("return", makeRequest({
+                  entityType: 'Release',
+                  action: 'publish',
+                  params: params
+                }).then(function (data) {
+                  return Object(_release_action__WEBPACK_IMPORTED_MODULE_4__["wrapReleaseAction"])(makeRequest, data);
+                }).then(function (action) {
+                  return action.waitProcessing(options);
+                }));
+
+              case 2:
+              case "end":
+                return _context5.stop();
+            }
+          }
+        }, _callee5);
+      }))();
+    },
+    unpublish: function unpublish(options) {
+      var _this6 = this;
+
+      return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee6() {
+        var params;
+        return regeneratorRuntime.wrap(function _callee6$(_context6) {
+          while (1) {
+            switch (_context6.prev = _context6.next) {
+              case 0:
+                params = getParams(_this6);
+                return _context6.abrupt("return", makeRequest({
+                  entityType: 'Release',
+                  action: 'unpublish',
+                  params: params
+                }).then(function (data) {
+                  return Object(_release_action__WEBPACK_IMPORTED_MODULE_4__["wrapReleaseAction"])(makeRequest, data);
+                }).then(function (action) {
+                  return action.waitProcessing(options);
+                }));
+
+              case 2:
+              case "end":
+                return _context6.stop();
+            }
+          }
+        }, _callee6);
+      }))();
+    },
+    validate: function validate(options) {
+      var _this7 = this;
+
+      return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee7() {
+        var params;
+        return regeneratorRuntime.wrap(function _callee7$(_context7) {
+          while (1) {
+            switch (_context7.prev = _context7.next) {
+              case 0:
+                params = getParams(_this7);
+                return _context7.abrupt("return", makeRequest({
                   entityType: 'Release',
                   action: 'validate',
                   params: params,
@@ -18472,10 +18613,10 @@ function createReleaseApi(makeRequest) {
 
               case 2:
               case "end":
-                return _context5.stop();
+                return _context7.stop();
             }
           }
-        }, _callee5);
+        }, _callee7);
       }))();
     }
   };
@@ -20438,12 +20579,14 @@ var createPlainClient = function createPlainClient(makeRequest, defaults, alphaF
       getManyForOrganization: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Usage', 'getManyForOrganization')
     },
     release: {
+      archive: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'archive'),
       get: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'get'),
       query: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'query'),
       create: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'create'),
       update: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'update'),
       delete: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'delete'),
       publish: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'publish'),
+      unarchive: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'unarchive'),
       unpublish: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'unpublish'),
       validate: Object(_wrappers_wrap__WEBPACK_IMPORTED_MODULE_2__["wrap"])(wrapParams, 'Release', 'validate')
     },