balena-sdk 15.57.2 → 15.58.0

package/CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 15.57.2 - 2021-11-16
+## 15.58.0 - 2021-11-16
+
+* models/release: Add note() method [Thodoris Greasidis]
+* typings: Add the release.invalidation_reason property [Thodoris Greasidis]
+* typings: Add the release.note property [Thodoris Greasidis]
+
+## 15.57.2 - 2021-11-15
 
 * tests/logs: Increase the wait time for retrieving the subscribed logs [Thodoris Greasidis]
 * tests/logs: Refactor to async-await [Thodoris Greasidis]

package/DOCUMENTATION.md

@@ -326,6 +326,7 @@ const sdk = fromSharedOptions();
             * [.getLatestByApplication(nameOrSlugOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
             * [.createFromUrl(nameOrSlugOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
             * [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
+            * [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
         * [.service](#balena.models.service) : <code>object</code>
             * [.var](#balena.models.service.var) : <code>object</code>
                 * [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
@@ -701,6 +702,7 @@ balena.models.device.get(123).catch(function (error) {
         * [.getLatestByApplication(nameOrSlugOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
         * [.createFromUrl(nameOrSlugOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
         * [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
+        * [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
     * [.service](#balena.models.service) : <code>object</code>
         * [.var](#balena.models.service.var) : <code>object</code>
             * [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
@@ -6509,6 +6511,7 @@ balena.models.config.getDeviceOptions('raspberry-pi', function(error, options) {
     * [.getLatestByApplication(nameOrSlugOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
     * [.createFromUrl(nameOrSlugOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
     * [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
+    * [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
 
 <a name="balena.models.release.tags"></a>
 
@@ -6864,6 +6867,26 @@ balena.models.release.finalize('7cf02a6').then(function() {
 	console.log('finalized!');
 });
 ```
+<a name="balena.models.release.note"></a>
+
+##### release.note(commitOrId, note) ⇒ <code>Promise</code>
+**Kind**: static method of [<code>release</code>](#balena.models.release)  
+**Summary**: Add a note to a release  
+**Access**: public  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| commitOrId | <code>String</code> \| <code>Number</code> | release commit (string) or id (number) |
+| note | <code>String</code> \| <code>Null</code> | the note |
+
+**Example**  
+```js
+balena.models.release.note('7cf02a6', 'My useful note');
+```
+**Example**  
+```js
+balena.models.release.note(123, 'My useful note');
+```
 <a name="balena.models.service"></a>
 
 #### models.service : <code>object</code>

package/es2015/balena-browser.js

@@ -10695,6 +10695,36 @@ const getReleaseModel = function (deps, opts) {
             });
         });
     }
+    /**
+     * @summary Add a note to a release
+     * @name note
+     * @public
+     * @function
+     * @memberof balena.models.release
+     *
+     * @param {String|Number} commitOrId - release commit (string) or id (number)
+     * @param {String|Null} note - the note
+     *
+     * @returns {Promise}
+     *
+     * @example
+     * balena.models.release.note('7cf02a6', 'My useful note');
+     *
+     * @example
+     * balena.models.release.note(123, 'My useful note');
+     */
+    function note(commitOrId, noteOrNull) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const { id } = yield get(commitOrId, { $select: 'id' });
+            yield pine.patch({
+                resource: 'release',
+                id,
+                body: {
+                    note: noteOrNull,
+                },
+            });
+        });
+    }
     /**
      * @namespace balena.models.release.tags
      * @memberof balena.models.release
@@ -10868,6 +10898,7 @@ const getReleaseModel = function (deps, opts) {
         getWithImageDetails,
         createFromUrl,
         finalize,
+        note,
         tags,
     };
 };
@@ -12045,7 +12076,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // being embedded in the dist of the consumer project
 // which we want to avoid, both b/c of the dist size increase &
 // the security concerns of including the versions of the dependencies
-const sdkVersion = '15.57.2';
+const sdkVersion = '15.58.0';
 exports.default = sdkVersion;
 
 },{}],47:[function(require,module,exports){