@smartthings/core-sdk - npm Package Compare versions

Comparing version 8.2.0 to 8.3.0

dist/endpoint/schema.d.ts

@@ -122,3 +122,5 @@ import { Endpoint } from '../endpoint';
     /**
-     * Possible values - __requiresLogin__ or __loggedIn__. These two values determine what fields are returned in this response. If value is "requiresLogin", only "oAuthLink" is returned in the response. If value is "loggedIn", only isaId, partnerName, appName, devices and icons are returned.
+     * Possible values - __requiresLogin__ or __loggedIn__. These two values determine what fields are returned in
+     * this response. If value is "requiresLogin", only "oAuthLink" is returned in the response. If value is
+     * "loggedIn", only isaId, partnerName, appName, devices and icons are returned.
      */
@@ -183,3 +185,3 @@ pageType?: string;
      * An href to the OAuth page for this connector that allows authentication and connection to the SmartThings
-     * patform.
+     * platform.
      */
@@ -208,2 +210,3 @@ oAuthLink?: string;
      * Returns a specific ST Schema connector
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -214,14 +217,22 @@ */
      * Create an ST Schema connector
+     *
      * @param data definition of the connector
+     * @param organizationId The organization to associate the connector with. You must be a member
+     * of the organization. Overrides any organization header included when creating the
+     * `SmartThingsClient`.
      */
-    create(data: SchemaAppRequest): Promise<SchemaCreateResponse>;
+    create(data: SchemaAppRequest, organizationId?: string): Promise<SchemaCreateResponse>;
     /**
      * Update an ST Schema connector
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
      * @param data new definition of the connector
+     * @param organizationId The organization to associate the connector with. You must be a member
+     * of the organization. The organization cannot be changed if the connector's `certificationStatus` is `wwst`.
      */
-    update(id: string, data: SchemaAppRequest): Promise<Status>;
+    update(id: string, data: SchemaAppRequest, organizationId?: string): Promise<Status>;
     /**
      * Re-generate the OAuth clientId and clientSecret for an ST Schema connector. The old clientId and clientSecret
      * will no longer be valid after this operation.
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -232,2 +243,3 @@ */
      * Delete an ST Schema connector
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -238,2 +250,3 @@ */
      * Get the page definition of an ST Schema installed instance in the specified location.
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -245,2 +258,3 @@ * @param locationId UUID of the location in which the connector is or is to be installed.
      * Returns a list of the installed ST Schema connector instances in the specified location
+     *
      * @param locationId UUID of the location
@@ -252,2 +266,3 @@ */
      * devices created by the instance.
+     *
      * @param id UUID of the installed app instance
@@ -259,3 +274,2 @@ */
      * devices created by this instance
-     * @param id
      */
@@ -262,0 +276,0 @@ deleteInstalledApp(id: string): Promise<Status>;

dist/endpoint/schema.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/endpoint/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAkB,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACzE,OAAO,EAAsB,MAAM,EAAE,MAAM,UAAU,CAAA;AAGrD,MAAM,WAAW,SAAU,SAAQ,gBAAgB;IAClD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,cAAc,CAAA;AAC9D,MAAM,WAAW,gBAAgB;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC7B;AAED,MAAM,WAAW,aAAa;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC1B;AAOD,MAAM,WAAW,YAAY;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;CACzC;AAOD,MAAM,WAAW,oBAAoB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;CACtB;AAED,oBAAY,cAAc;IACzB,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;CACrB;AAED,MAAM,WAAW,UAAU;IAC1B;;;OAGG;IACH,QAAQ,EAAE,cAAc,CAAA;CACxB;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACzD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACvD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,qBAAa,cAAe,SAAQ,QAAQ;gBAC/B,MAAM,EAAE,oBAAoB;IAIxC;;OAEG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAQxF;;;OAGG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAI1C;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIpE;;;;OAIG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKxE;;;;OAIG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIjE;;;OAGG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKhD;;;;OAIG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,sBAAsB,CAAC;IAItG;;;OAGG;IACU,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAK9E;;;;OAIG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI/D;;;;OAIG;IACU,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAI5D"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/endpoint/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAkB,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACzE,OAAO,EAAsB,MAAM,EAAE,MAAM,UAAU,CAAA;AAGrD,MAAM,WAAW,SAAU,SAAQ,gBAAgB;IAClD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,cAAc,CAAA;AAC9D,MAAM,WAAW,gBAAgB;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC7B;AAED,MAAM,WAAW,aAAa;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC1B;AAOD,MAAM,WAAW,YAAY;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;CACzC;AAOD,MAAM,WAAW,oBAAoB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;CACtB;AAED,oBAAY,cAAc;IACzB,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;CACrB;AAED,MAAM,WAAW,UAAU;IAC1B;;;OAGG;IACH,QAAQ,EAAE,cAAc,CAAA;CACxB;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACzD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACvD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,qBAAa,cAAe,SAAQ,QAAQ;gBAC/B,MAAM,EAAE,oBAAoB;IAIxC;;OAEG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAQxF;;;;OAIG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAI1C;;;;;;;OAOG;IACI,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAK7F;;;;;;;OAOG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMjG;;;;;OAKG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIjE;;;;OAIG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKhD;;;;;OAKG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,sBAAsB,CAAC;IAItG;;;;OAIG;IACU,aAAa,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAK9E;;;;;OAKG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI/D;;;OAGG;IACU,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAI5D"}

dist/endpoint/schema.js

@@ -40,2 +40,3 @@ "use strict";
      * Returns a specific ST Schema connector
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -48,15 +49,24 @@ */
      * Create an ST Schema connector
+     *
      * @param data definition of the connector
+     * @param organizationId The organization to associate the connector with. You must be a member
+     * of the organization. Overrides any organization header included when creating the
+     * `SmartThingsClient`.
      */
-    create(data) {
-        return this.client.post('apps', data);
+    create(data, organizationId) {
+        const options = organizationId ? { headerOverrides: { 'X-ST-Organization': organizationId } } : undefined;
+        return this.client.post('apps', data, undefined, options);
     }
     /**
      * Update an ST Schema connector
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
      * @param data new definition of the connector
+     * @param organizationId The organization to associate the connector with. You must be a member
+     * of the organization. The organization cannot be changed if the connector's `certificationStatus` is `wwst`.
      */
-    update(id, data) {
+    update(id, data, organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.client.put(`apps/${id}`, data);
+            const options = organizationId ? { headerOverrides: { 'X-ST-Organization': organizationId } } : undefined;
+            yield this.client.put(`apps/${id}`, data, undefined, options);
             return types_1.SuccessStatusValue;
@@ -68,2 +78,3 @@ });
      * will no longer be valid after this operation.
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -76,2 +87,3 @@ */
      * Delete an ST Schema connector
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -87,2 +99,3 @@ */
      * Get the page definition of an ST Schema installed instance in the specified location.
+     *
      * @param id the "endpointApp" UUID of the connector, e.g. "viper_799ff3a0-8249-11e9-9bf1-b5c7d651c2c3"
@@ -96,2 +109,3 @@ * @param locationId UUID of the location in which the connector is or is to be installed.
      * Returns a list of the installed ST Schema connector instances in the specified location
+     *
      * @param locationId UUID of the location
@@ -108,2 +122,3 @@ */
      * devices created by the instance.
+     *
      * @param id UUID of the installed app instance
@@ -117,3 +132,2 @@ */
      * devices created by this instance
-     * @param id
      */
@@ -120,0 +134,0 @@ deleteInstalledApp(id) {

package.json

 {
 	"name": "@smartthings/core-sdk",
-	"version": "8.2.0",
+	"version": "8.3.0",
 	"description": "JavaScript/TypeScript library for using SmartThings APIs",
@@ -5,0 +5,0 @@ "author": "Samsung Electronics Co., LTD.",

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

476869

0.29%

Lines of code

9401

0.3%

Worsened metrics

Number of low supply chain risk alerts

26

4%

No dependency changes