feat: new device API params (#47)

blues · Sep 12, 2024 · 12b2363 · 12b2363
2 parents 8a51291 + ee63700
commit 12b2363
Show file tree

Hide file tree

Showing 102 changed files with 411 additions and 200 deletions.
diff --git a/config.json b/config.json
@@ -3,7 +3,7 @@
   "licenseName": "MIT",
   "moduleName": "NotehubJs",
   "npmRepository": "https://registry.npmjs.org",
-  "projectVersion": "1.0.22",
+  "projectVersion": "1.0.23",
   "sourceFolder": "src",
   "usePromises": true
 }
diff --git a/openapi.yaml b/openapi.yaml
@@ -730,6 +730,15 @@ paths:
         - $ref: "#/components/parameters/projectUIDParam"
         - $ref: "#/components/parameters/pageSizeParam"
         - $ref: "#/components/parameters/pageNumParam"
+        - $ref: "#/components/parameters/deviceUIDParamQuery"
+        - $ref: "#/components/parameters/tagParam"
+        - $ref: "#/components/parameters/serialNumberParam"
+        - $ref: "#/components/parameters/fleetUIDQueryParam"
+        - $ref: "#/components/parameters/notecardFirmwareParam"
+        - $ref: "#/components/parameters/locationParam"
+        - $ref: "#/components/parameters/hostFirmwareParam"
+        - $ref: "#/components/parameters/productUIDQueryParam"
+        - $ref: "#/components/parameters/skuParam"
       responses:
         "200":
           description: Successful operation
@@ -799,6 +808,14 @@ paths:
         - $ref: "#/components/parameters/fleetUIDParam"
         - $ref: "#/components/parameters/pageSizeParam"
         - $ref: "#/components/parameters/pageNumParam"
+        - $ref: "#/components/parameters/deviceUIDParamQuery"
+        - $ref: "#/components/parameters/tagParam"
+        - $ref: "#/components/parameters/serialNumberParam"
+        - $ref: "#/components/parameters/notecardFirmwareParam"
+        - $ref: "#/components/parameters/locationParam"
+        - $ref: "#/components/parameters/hostFirmwareParam"
+        - $ref: "#/components/parameters/productUIDQueryParam"
+        - $ref: "#/components/parameters/skuParam"
       responses:
         "200":
           description: Successful operation
@@ -2476,8 +2493,12 @@ components:
       name: productUID
       in: query
       required: false
+      style: form
+      explode: true
       schema:
-        type: string
+        type: array
+        items:
+          type: string
 
     productQueryParam:
       name: product
@@ -2490,8 +2511,86 @@ components:
       name: monitorUID
       in: query
       required: false
+      style: form
+      explode: true
       schema:
-        type: string
+        type: array
+        items:
+          type: string
+
+    tagParam:
+      name: tag
+      in: query
+      description: Tag filter
+      required: false
+      style: form
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
+
+    serialNumberParam:
+      name: serialNumber
+      in: query
+      description: Serial number filter
+      required: false
+      style: form
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
+
+    notecardFirmwareParam:
+      name: notecardFirmware
+      in: query
+      description: Firmware version filter
+      required: false
+      style: form
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
+
+    locationParam:
+      name: location
+      in: query
+      description: Location filter
+      required: false
+      style: form
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
+
+    hostFirmwareParam:
+      name: hostFirmware
+      in: query
+      description: Host firmware filter
+      required: false
+      style: form
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
+
+    skuParam:
+      name: sku
+      in: query
+      description: SKU filter
+      required: false
+      style: form
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
+
+
 
   responses:
     ErrorResponse:

diff --git a/src/README.md b/src/README.md
@@ -6,7 +6,7 @@ The OpenAPI definition for the Notehub.io API.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.1.0
-- Package version: 1.0.22
+- Package version: 1.0.23
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
   For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)
 
@@ -112,7 +112,7 @@ var projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // {String}
 var opts = {
   'pageSize': 50, // {Number}
   'pageNum': 1, // {Number}
-  'monitorUID': "monitorUID_example" // {String}
+  'monitorUID': ["null"] // {[String]}
 };
 api.getAlerts(projectUID, opts).then(function(data) {
   console.log('API called successfully. Returned data: ' + JSON.stringify(data));

diff --git a/src/docs/AlertApi.md b/src/docs/AlertApi.md
@@ -26,7 +26,7 @@ let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String |
 let opts = {
   'pageSize': 50, // Number |
   'pageNum': 1, // Number |
-  'monitorUID': "monitorUID_example" // String |
+  'monitorUID': ["null"] // [String] |
 };
 apiInstance.getAlerts(projectUID, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + JSON.stringify(data));
@@ -38,12 +38,12 @@ apiInstance.getAlerts(projectUID, opts).then((data) => {
 
 ### Parameters
 
-| Name           | Type       | Description | Notes                      |
-| -------------- | ---------- | ----------- | -------------------------- |
-| **projectUID** | **String** |             |
-| **pageSize**   | **Number** |             | [optional] [default to 50] |
-| **pageNum**    | **Number** |             | [optional] [default to 1]  |
-| **monitorUID** | **String** |             | [optional]                 |
+| Name           | Type                      | Description | Notes                      |
+| -------------- | ------------------------- | ----------- | -------------------------- |
+| **projectUID** | **String**                |             |
+| **pageSize**   | **Number**                |             | [optional] [default to 50] |
+| **pageNum**    | **Number**                |             | [optional] [default to 1]  |
+| **monitorUID** | [**[String]**](String.md) |             | [optional]                 |
 
 ### Return type
 

diff --git a/src/docs/DeviceApi.md b/src/docs/DeviceApi.md
@@ -711,7 +711,16 @@ let apiInstance = new NotehubJs.DeviceApi();
 let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String |
 let opts = {
   'pageSize': 50, // Number |
-  'pageNum': 1 // Number |
+  'pageNum': 1, // Number |
+  'deviceUID': ["null"], // [String] | A Device UID.
+  'tag': ["null"], // [String] | Tag filter
+  'serialNumber': ["null"], // [String] | Serial number filter
+  'fleetUID': "fleetUID_example", // String |
+  'notecardFirmware': ["null"], // [String] | Firmware version filter
+  'location': ["null"], // [String] | Location filter
+  'hostFirmware': ["null"], // [String] | Host firmware filter
+  'productUID': ["null"], // [String] |
+  'sku': ["null"] // [String] | SKU filter
 };
 apiInstance.getProjectDevices(projectUID, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + JSON.stringify(data));
@@ -723,11 +732,20 @@ apiInstance.getProjectDevices(projectUID, opts).then((data) => {
 
 ### Parameters
 
-| Name           | Type       | Description | Notes                      |
-| -------------- | ---------- | ----------- | -------------------------- |
-| **projectUID** | **String** |             |
-| **pageSize**   | **Number** |             | [optional] [default to 50] |
-| **pageNum**    | **Number** |             | [optional] [default to 1]  |
+| Name                 | Type                      | Description             | Notes                      |
+| -------------------- | ------------------------- | ----------------------- | -------------------------- |
+| **projectUID**       | **String**                |                         |
+| **pageSize**         | **Number**                |                         | [optional] [default to 50] |
+| **pageNum**          | **Number**                |                         | [optional] [default to 1]  |
+| **deviceUID**        | [**[String]**](String.md) | A Device UID.           | [optional]                 |
+| **tag**              | [**[String]**](String.md) | Tag filter              | [optional]                 |
+| **serialNumber**     | [**[String]**](String.md) | Serial number filter    | [optional]                 |
+| **fleetUID**         | **String**                |                         | [optional]                 |
+| **notecardFirmware** | [**[String]**](String.md) | Firmware version filter | [optional]                 |
+| **location**         | [**[String]**](String.md) | Location filter         | [optional]                 |
+| **hostFirmware**     | [**[String]**](String.md) | Host firmware filter    | [optional]                 |
+| **productUID**       | [**[String]**](String.md) |                         | [optional]                 |
+| **sku**              | [**[String]**](String.md) | SKU filter              | [optional]                 |
 
 ### Return type
 
@@ -762,7 +780,15 @@ let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String |
 let fleetUID = "fleetUID_example"; // String |
 let opts = {
   'pageSize': 50, // Number |
-  'pageNum': 1 // Number |
+  'pageNum': 1, // Number |
+  'deviceUID': ["null"], // [String] | A Device UID.
+  'tag': ["null"], // [String] | Tag filter
+  'serialNumber': ["null"], // [String] | Serial number filter
+  'notecardFirmware': ["null"], // [String] | Firmware version filter
+  'location': ["null"], // [String] | Location filter
+  'hostFirmware': ["null"], // [String] | Host firmware filter
+  'productUID': ["null"], // [String] |
+  'sku': ["null"] // [String] | SKU filter
 };
 apiInstance.getProjectFleetDevices(projectUID, fleetUID, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + JSON.stringify(data));
@@ -774,12 +800,20 @@ apiInstance.getProjectFleetDevices(projectUID, fleetUID, opts).then((data) => {
 
 ### Parameters
 
-| Name           | Type       | Description | Notes                      |
-| -------------- | ---------- | ----------- | -------------------------- |
-| **projectUID** | **String** |             |
-| **fleetUID**   | **String** |             |
-| **pageSize**   | **Number** |             | [optional] [default to 50] |
-| **pageNum**    | **Number** |             | [optional] [default to 1]  |
+| Name                 | Type                      | Description             | Notes                      |
+| -------------------- | ------------------------- | ----------------------- | -------------------------- |
+| **projectUID**       | **String**                |                         |
+| **fleetUID**         | **String**                |                         |
+| **pageSize**         | **Number**                |                         | [optional] [default to 50] |
+| **pageNum**          | **Number**                |                         | [optional] [default to 1]  |
+| **deviceUID**        | [**[String]**](String.md) | A Device UID.           | [optional]                 |
+| **tag**              | [**[String]**](String.md) | Tag filter              | [optional]                 |
+| **serialNumber**     | [**[String]**](String.md) | Serial number filter    | [optional]                 |
+| **notecardFirmware** | [**[String]**](String.md) | Firmware version filter | [optional]                 |
+| **location**         | [**[String]**](String.md) | Location filter         | [optional]                 |
+| **hostFirmware**     | [**[String]**](String.md) | Host firmware filter    | [optional]                 |
+| **productUID**       | [**[String]**](String.md) |                         | [optional]                 |
+| **sku**              | [**[String]**](String.md) | SKU filter              | [optional]                 |
 
 ### Return type