dctrackclient - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

package.json

 {
   "name": "dctrackclient",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Sunbird dcTrack API client in JavaScript",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -9,3 +9,3 @@ # dcTrackClient [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nicfv/dcTrackClient/publish.yml?logo=github)](https://github.com/nicfv/dcTrackClient) [![PyPI](https://img.shields.io/pypi/v/dcTrackClient)](https://pypi.org/project/dcTrackClient/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/dcTrackClient?logo=pypi)](https://pypi.org/project/dcTrackClient/) [![npm](https://img.shields.io/npm/v/dctrackclient)](https://www.npmjs.com/package/dctrackclient) [![npm](https://img.shields.io/npm/dt/dctrackclient?logo=npm)](https://www.npmjs.com/package/dctrackclient)
 ```shell
-pip install dcTrackClient==1.3.0
+pip install dcTrackClient==1.3.1
 ```
@@ -15,3 +15,3 @@
 ```shell
-npm i dctrackclient@1.3.0
+npm i dctrackclient@1.3.1
 ```
@@ -551,30 +551,30 @@
 
-## getBreakers(panelItemID)
+## getBreakers(panelItemId)
 > Get a list of all Breakers for a given Panel Item. Returns JSON entity containing an array of all the Breakers for the specified Panel Item.
 ```
-GET api/v2/dcimoperations/items/{panelItemID}/breakers
+GET api/v2/dcimoperations/items/{panelItemId}/breakers
 ```
 |Parameter|Type|
 |---|---|
-|panelItemID|number|
+|panelItemId|number|
 
-## getBreaker(panelItemID, breakerPortId)
+## getBreaker(panelItemId, breakerPortId)
 > Get a list of all Breakers for a given Panel Item. Returns JSON entity containing information for a single Panel Item Breaker.
 ```
-GET api/v2/dcimoperations/items/{panelItemID}/breakers/{breakerPortId}
+GET api/v2/dcimoperations/items/{panelItemId}/breakers/{breakerPortId}
 ```
 |Parameter|Type|
 |---|---|
-|panelItemID|number|
+|panelItemId|number|
 |breakerPortId|number|
 
-## updateBreaker(panelItemD, beakerPortID, payload)
+## updateBreaker(panelItemId, beakerPortId, payload)
 > Update a single Breaker for a given Panel Item. Returns JSON entity containing information for the updated Panel Item Breaker. Note: This API performs as a true PUT and not a PATCH. Unlike with a PATCH, you must specify all attributes even if you want to change only one. Attributes that are not included in the Request will be considered as removed.
 ```
-PUT api/v2/dcimoperations/items/{panelItemD}/breakers/{beakerPortID} payload
+PUT api/v2/dcimoperations/items/{panelItemId}/breakers/{beakerPortId} payload
 ```
 |Parameter|Type|
 |---|---|
-|panelItemD|string|
-|beakerPortID|number|
+|panelItemId|number|
+|beakerPortId|number|
 |payload|object|
@@ -592,20 +592,20 @@
 
-## deleteBreaker(panelItemID, breakerPortId)
+## deleteBreaker(panelItemId, breakerPortId)
 > Delete a Breaker for a given Panel Item. Returns empty JSON.
 ```
-DELETE api/v2/dcimoperations/items/{panelItemID}/breakers/{breakerPortId}
+DELETE api/v2/dcimoperations/items/{panelItemId}/breakers/{breakerPortId}
 ```
 |Parameter|Type|
 |---|---|
-|panelItemID|number|
+|panelItemId|number|
 |breakerPortId|number|
 
-## createBreakersBulk(panelItemID, payload)
+## createBreakersBulk(panelItemId, payload)
 > Add/Update/Delete Breakers for a given Panel Item.
 ```
-POST api/v2/dcimoperations/items/{panelItemID}/breakers/bulk payload
+POST api/v2/dcimoperations/items/{panelItemId}/breakers/bulk payload
 ```
 |Parameter|Type|
 |---|---|
-|panelItemID|number|
+|panelItemId|number|
 |payload|object|
@@ -612,0 +612,0 @@

src/index.js

@@ -5,3 +5,3 @@ import fetch from 'node-fetch';
 /**
- * Sunbird dcTrack API client version 1.3.0 in JavaScript
+ * Sunbird dcTrack API client version 1.3.1 in JavaScript
  */
@@ -355,6 +355,6 @@ export class Client {
  * Get a list of all Breakers for a given Panel Item. Returns JSON entity containing an array of all the Breakers for the specified Panel Item.
- * @param {number} panelItemID
+ * @param {number} panelItemId
  */
-Client.prototype.getBreakers = function (panelItemID) {
-    return this.request('GET', '/api/v2/dcimoperations/items/' + panelItemID + '/breakers?');
+Client.prototype.getBreakers = function (panelItemId) {
+    return this.request('GET', '/api/v2/dcimoperations/items/' + panelItemId + '/breakers?');
 }
@@ -364,7 +364,7 @@
  * Get a list of all Breakers for a given Panel Item. Returns JSON entity containing information for a single Panel Item Breaker.
- * @param {number} panelItemID
+ * @param {number} panelItemId
  * @param {number} breakerPortId
  */
-Client.prototype.getBreaker = function (panelItemID, breakerPortId) {
-    return this.request('GET', '/api/v2/dcimoperations/items/' + panelItemID + '/breakers/' + breakerPortId + '?');
+Client.prototype.getBreaker = function (panelItemId, breakerPortId) {
+    return this.request('GET', '/api/v2/dcimoperations/items/' + panelItemId + '/breakers/' + breakerPortId + '?');
 }
@@ -374,8 +374,8 @@
  * Update a single Breaker for a given Panel Item. Returns JSON entity containing information for the updated Panel Item Breaker. Note: This API performs as a true PUT and not a PATCH. Unlike with a PATCH, you must specify all attributes even if you want to change only one. Attributes that are not included in the Request will be considered as removed.
- * @param {string} panelItemD
- * @param {number} beakerPortID
+ * @param {number} panelItemId
+ * @param {number} beakerPortId
  * @param {object} payload
  */
-Client.prototype.updateBreaker = function (panelItemD, beakerPortID, payload) {
-    return this.request('PUT', '/api/v2/dcimoperations/items/' + panelItemD + '/breakers/' + beakerPortID + '?', payload);
+Client.prototype.updateBreaker = function (panelItemId, beakerPortId, payload) {
+    return this.request('PUT', '/api/v2/dcimoperations/items/' + panelItemId + '/breakers/' + beakerPortId + '?', payload);
 }
@@ -394,7 +394,7 @@
  * Delete a Breaker for a given Panel Item. Returns empty JSON.
- * @param {number} panelItemID
+ * @param {number} panelItemId
  * @param {number} breakerPortId
  */
-Client.prototype.deleteBreaker = function (panelItemID, breakerPortId) {
-    return this.request('DELETE', '/api/v2/dcimoperations/items/' + panelItemID + '/breakers/' + breakerPortId + '?');
+Client.prototype.deleteBreaker = function (panelItemId, breakerPortId) {
+    return this.request('DELETE', '/api/v2/dcimoperations/items/' + panelItemId + '/breakers/' + breakerPortId + '?');
 }
@@ -404,7 +404,7 @@
  * Add/Update/Delete Breakers for a given Panel Item.
- * @param {number} panelItemID
+ * @param {number} panelItemId
  * @param {object} payload
  */
-Client.prototype.createBreakersBulk = function (panelItemID, payload) {
-    return this.request('POST', '/api/v2/dcimoperations/items/' + panelItemID + '/breakers/bulk?', payload);
+Client.prototype.createBreakersBulk = function (panelItemId, payload) {
+    return this.request('POST', '/api/v2/dcimoperations/items/' + panelItemId + '/breakers/bulk?', payload);
 }
@@ -411,0 +411,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

102409

increased by0.01%

No dependency changes