feat: update query params for Events API and Route API (#46)

blues · Aug 26, 2024 · 8a51291 · 8a51291
2 parents ddf1f7e + 58330ff
commit 8a51291
Show file tree

Hide file tree

Showing 105 changed files with 489 additions and 380 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.21",
+  "projectVersion": "1.0.22",
   "sourceFolder": "src",
   "usePromises": true
 }
diff --git a/openapi.yaml b/openapi.yaml
@@ -1167,6 +1167,13 @@ paths:
         - $ref: "#/components/parameters/endDateParam"
         - $ref: "#/components/parameters/systemFilesOnlyParam"
         - $ref: "#/components/parameters/filesQueryParam"
+        - $ref: "#/components/parameters/formatParam"
+        - $ref: "#/components/parameters/serialNumberFilterParam"
+        - $ref: "#/components/parameters/fleetUIDFilterQueryParam"
+        - $ref: "#/components/parameters/sessionUIDFilterParam"
+        - $ref: "#/components/parameters/eventUIDFilterQueryParam"
+        - $ref: "#/components/parameters/selectFieldsParam"
+
         - name: deviceUIDs
           description: Deprecated.
           in: query
@@ -1253,6 +1260,12 @@ paths:
         - $ref: "#/components/parameters/endDateParam"
         - $ref: "#/components/parameters/systemFilesOnlyParam"
         - $ref: "#/components/parameters/filesQueryParam"
+        - $ref: "#/components/parameters/formatParam"
+        - $ref: "#/components/parameters/serialNumberFilterParam"
+        - $ref: "#/components/parameters/fleetUIDFilterQueryParam"
+        - $ref: "#/components/parameters/sessionUIDFilterParam"
+        - $ref: "#/components/parameters/eventUIDFilterQueryParam"
+        - $ref: "#/components/parameters/selectFieldsParam"
         - name: deviceUIDs
           description: Deprecated.
           in: query
@@ -2223,6 +2236,7 @@ components:
       schema:
         type: integer
         minimum: 1
+        maximum: 10000
         default: 50
 
     pageNumParam:
@@ -2240,7 +2254,11 @@ components:
       in: query
       required: false
       schema:
-        type: string
+        type: array
+        items:
+          type: string
+      style: form
+      explode: true
 
     deviceUIDsParamQuery:
       name: deviceUIDs
@@ -2345,6 +2363,72 @@ components:
         type: string
       example: _health.qo, data.qo
 
+    formatParam:
+      name: format
+      in: query
+      required: false
+      schema:
+        type: string
+        enum: [json, csv]
+        default: json
+      description: Response format (JSON or CSV)
+
+    serialNumberFilterParam:
+      name: serialNumber
+      in: query
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: true
+      description: Filter by Serial Number
+
+    fleetUIDFilterQueryParam:
+      name: fleetUID
+      in: query
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: true
+      description: Filter by Fleet UID
+
+    sessionUIDFilterParam:
+      name: sessionUID
+      in: query
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: true
+      description: Filter by Session UID
+
+    eventUIDFilterQueryParam:
+      name: eventUID
+      in: query
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: true
+      description: Filter by Event UID
+
+    selectFieldsParam:
+      name: selectFields
+      in: query
+      required: false
+      schema:
+        type: string
+      description: Comma-separated list of fields to select from JSON payload (e.g., "field1,field2.subfield,field3"), this will reflect the columns in the CSV output.
+
     filenameQueryParam:
       name: filename
       in: query
@@ -2419,6 +2503,11 @@ components:
 
     EventsResponse:
       description: The response body from a GET events request.
+      headers:
+        X-Has-More:
+          description: True if there are more events
+          schema:
+            type: boolean
       content:
         application/json:
           schema:
@@ -2431,6 +2520,9 @@ components:
               has_more:
                 type: boolean
                 description: True if there are more events
+              through:
+                type: string
+                description: The UID of the last event returned
             required:
               - events
               - has_more
@@ -2469,6 +2561,15 @@ components:
                 tri_timezone: America/New_York
                 tri_points: 6
             has_more: true
+        text/csv:
+          schema:
+            type: string
+            format: binary
+          example: |
+            eventUID,deviceUID,when,best_location_type,best_lat,best_lon,body.temperature,body.humidity
+            e123456-7890-abcd-ef01-234567890abc,dev:000000000000001,1625097600,gps,37.7749,-122.4194,22.5,45.2
+            f234567-8901-bcde-fg12-345678901bcd,dev:000000000000002,1625097660,triangulated,40.7128,-74.0060,24.3,48.7
+            g345678-9012-cdef-gh23-456789012cde,dev:000000000000003,1625097720,tower,51.5074,-0.1278,20.1,52.9
 
     EventsByCursorResponse:
       description: The response body from a GET events by cursor request.

diff --git a/src/.openapi-generator/FILES b/src/.openapi-generator/FILES
@@ -1,6 +1,5 @@
 .babelrc
 .gitignore
-.openapi-generator-ignore
 .travis.yml
 README.md
 docs/Alert.md
@@ -198,98 +197,3 @@ src/model/TowerLocation.js
 src/model/Twilio.js
 src/model/UpdateFleetRequest.js
 src/model/UserDbRoute.js
-test/api/AlertApi.spec.js
-test/api/AuthorizationApi.spec.js
-test/api/BillingAccountApi.spec.js
-test/api/DeviceApi.spec.js
-test/api/EventApi.spec.js
-test/api/MonitorApi.spec.js
-test/api/ProjectApi.spec.js
-test/api/RouteApi.spec.js
-test/model/Alert.spec.js
-test/model/AlertDataInner.spec.js
-test/model/AlertNotificationsInner.spec.js
-test/model/Aws.spec.js
-test/model/Azure.spec.js
-test/model/BillingAccount.spec.js
-test/model/BillingAccountRole.spec.js
-test/model/Body.spec.js
-test/model/CloneProjectRequest.spec.js
-test/model/Contact.spec.js
-test/model/CreateFleetRequest.spec.js
-test/model/CreateMonitor.spec.js
-test/model/CreateProductRequest.spec.js
-test/model/CreateProjectRequest.spec.js
-test/model/DFUEnv.spec.js
-test/model/DFUState.spec.js
-test/model/DeleteDeviceFleetsRequest.spec.js
-test/model/Device.spec.js
-test/model/DeviceSession.spec.js
-test/model/DeviceTowerInfo.spec.js
-test/model/DeviceUsage.spec.js
-test/model/EmailNotification.spec.js
-test/model/EnvironmentVariables.spec.js
-test/model/Error.spec.js
-test/model/Event.spec.js
-test/model/FirmwareInfo.spec.js
-test/model/FirmwareStatus.spec.js
-test/model/Fleet.spec.js
-test/model/GetAlerts200Response.spec.js
-test/model/GetBillingAccounts200Response.spec.js
-test/model/GetDeviceEnvironmentVariables200Response.spec.js
-test/model/GetDeviceHealthLog200Response.spec.js
-test/model/GetDeviceHealthLog200ResponseHealthLogInner.spec.js
-test/model/GetDeviceLatest200Response.spec.js
-test/model/GetDevicePublicKey200Response.spec.js
-test/model/GetDeviceSessions200Response.spec.js
-test/model/GetProjectDevicePublicKeys200Response.spec.js
-test/model/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.spec.js
-test/model/GetProjectDevices200Response.spec.js
-test/model/GetProjectEvents200Response.spec.js
-test/model/GetProjectEventsByCursor200Response.spec.js
-test/model/GetProjectFleets200Response.spec.js
-test/model/GetProjectMembers200Response.spec.js
-test/model/GetProjectProducts200Response.spec.js
-test/model/GetProjects200Response.spec.js
-test/model/GetRouteLogsByRoute200ResponseInner.spec.js
-test/model/Google.spec.js
-test/model/HandleNoteChanges200Response.spec.js
-test/model/HandleNoteGet200Response.spec.js
-test/model/HandleNoteSignal200Response.spec.js
-test/model/HandleNotefileChanges200Response.spec.js
-test/model/HandleNotefileChangesPending200Response.spec.js
-test/model/HandleNotefileDeleteRequest.spec.js
-test/model/Http.spec.js
-test/model/HttpFilter.spec.js
-test/model/HttpTransform.spec.js
-test/model/Location.spec.js
-test/model/Login200Response.spec.js
-test/model/LoginRequest.spec.js
-test/model/Monitor.spec.js
-test/model/MonitorAlertRoutesInner.spec.js
-test/model/Mqtt.spec.js
-test/model/Note.spec.js
-test/model/OTAStatus.spec.js
-test/model/OTAStatusList.spec.js
-test/model/OTAUpdateRequest.spec.js
-test/model/OTAUpdateStatus.spec.js
-test/model/PostProvisionProjectDeviceRequest.spec.js
-test/model/Product.spec.js
-test/model/Project.spec.js
-test/model/ProjectMember.spec.js
-test/model/Proxy.spec.js
-test/model/PutDeviceFleetsRequest.spec.js
-test/model/Radresponder.spec.js
-test/model/Role.spec.js
-test/model/Route.spec.js
-test/model/RouteSchema.spec.js
-test/model/Slack.spec.js
-test/model/SlackBearerNotification.spec.js
-test/model/SlackWebHookNotification.spec.js
-test/model/Snowflake.spec.js
-test/model/SnowflakeTransform.spec.js
-test/model/Thingworx.spec.js
-test/model/TowerLocation.spec.js
-test/model/Twilio.spec.js
-test/model/UpdateFleetRequest.spec.js
-test/model/UserDbRoute.spec.js
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.21
+- Package version: 1.0.22
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
   For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)