@golemio/parkings 1.7.10 → 1.7.11-dev.1187905601

package/docs/openapi-output.yaml

@@ -221,15 +221,15 @@ paths:
                 - name: minutesBefore
                   in: query
                   schema:
-                    type: integer                
-                    example: 10                
+                    type: integer
+                    example: 10
                   description: 'Filter by time conditions based on last data update. By maximal minutes before last update.'
                 - name: updatedSince
                   in: query
                   schema:
                     type: string
                     example: '2022-07-25T00:00:00.000Z'
-                  description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutsBefore.'
+                  description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutesBefore.'
             responses:
                 200:
                     description: OK
@@ -330,15 +330,15 @@ paths:
                 - name: minutesBefore
                   in: query
                   schema:
-                    type: integer                
-                    example: 10                
+                    type: integer
+                    example: 10
                   description: 'Filter by time conditions based on last data update. By maximal minutes before last update.'
                 - name: updatedSince
                   in: query
                   schema:
                     type: string
                     example: '2022-07-25T00:00:00.000Z'
-                  description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutsBefore.'
+                  description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutesBefore.'
                 -   name: zoneType
                     in: query
                     description: Filter by parking zone. Use with square brackets `zoneType[]`,
@@ -457,15 +457,15 @@ paths:
                 - name: minutesBefore
                   in: query
                   schema:
-                    type: integer                
-                    example: 10                
+                    type: integer
+                    example: 10
                   description: 'Filter by time conditions based on last data update. By maximal minutes before last update.'
                 - name: updatedSince
                   in: query
                   schema:
                     type: string
                     example: '2022-07-25T00:00:00.000Z'
-                  description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutsBefore.'
+                  description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutesBefore.'
             responses:
                 200:
                     description: OK
@@ -577,7 +577,7 @@ paths:
               schema:
                 type: string
               example: '50.123,14.243,50.017,14.573'
-              description: 'Filter by bounding box in format "topLeft.lat,topLeft.lon,bottomRight.lat,bottomRight.lon", polygons that fit only partialy to selected bounding box are included'
+              description: 'Filter by bounding box in format "topLeft.lat,topLeft.lon,bottomRight.lat,bottomRight.lon", polygons that fit only partially to selected bounding box are included'
             - name: validFrom
               in: query
               schema:
@@ -602,20 +602,20 @@ paths:
                     - designated
                     - truck
                     - motorcycle
-                    - RV               
+                    - RV
               description: 'Experimental: Filter by access combinations to specific spaces in parking. Return only strictly matched parking by access to parking spaces'
             - name: minutesBefore
               in: query
               schema:
-                type: integer                
-                example: 10                
+                type: integer
+                example: 10
               description: 'Filter by time conditions based on last data update. By maximal minutes before last update.'
             - name: updatedSince
               in: query
               schema:
                 type: string
                 example: '2022-07-25T00:00:00.000Z'
-              description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutsBefore.'
+              description: 'Filter by time conditions based on last data update. Date has to be in ISO8601 format. Cannot be used together with minutesBefore.'
             - name: limit
               in: query
               schema:
@@ -657,9 +657,8 @@ paths:
               required: true
               schema:
                 type: string
-                format: uuid
-              example: 'c66bb668-eab6-49da-bc84-002263e1dce0'
-              description: 'The UUID identifier of the parking location to retrieve'
+              example: 'tsk2-P1-0586'
+              description: 'The identifier of the parking location to retrieve'
           responses:
             '200':
               description: 'Successful response'
@@ -667,12 +666,117 @@ paths:
                 application/json:
                   schema:
                     $ref: '#/components/schemas/Parking'
+    /v3/parking/{id}/average-occupancy:
+        get:
+            tags:
+                - 🅿️ Parking (v3)
+            summary: 'Get detailed information about the average occupancy by ID'
+            parameters:
+                - name: id
+                  in: path
+                  required: true
+                  schema:
+                      type: string
+                  example: 'tsk2-P1-0586'
+                  description: 'The identifier of the parking space to retrieve'
+            responses:
+                200:
+                    description: 'Successful response'
+                    content:
+                        application/json:
+                            schema:
+                                $ref: '#/components/schemas/AverageOccupancyWeek'
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+                404:
+                    description: Not found
+                400:
+                    description: Bad request
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: object
+                                properties:
+                                    error_message:
+                                        type: string
+                                        example: Bad request
+                                    error_status:
+                                        type: number
+                                        example: 400
+                                    error_info:
+                                        type: string
+                                        example: '{"limit":{"location":"query","param":"limit","value":"-2","msg":"Invalid value"}}'
+    /v3/parking-measurements:
+        get:
+            tags:
+                - 🅿️ Parking (v3)
+            summary: 'Get a list of the latest (max 1h old) parking measurements with filtering options'
+            parameters:
+                - name: primarySource
+                  in: query
+                  schema:
+                      type: array
+                      items:
+                          type: string
+                          enum:
+                              - tsk_v2
+                  description: 'Filter by primary source. Use with square brackets `primarySource[]`'
+                - name: primarySourceId
+                  in: query
+                  schema:
+                      type: array
+                      items:
+                          type: string
+                          example: 'c66bb668-eab6-49da-bc84-002263e1dce0'
+                  description: 'Filter by primary source ID. Use with square brackets `primarySourceId[]`'
+                - name: limit
+                  in: query
+                  schema:
+                      type: integer
+                      default: 1000
+                      maximum: 10000
+                      minimum: 0
+                  description: 'Number of results to return'
+                - name: offset
+                  in: query
+                  schema:
+                      type: integer
+                      default: 0
+                      minimum: 0
+                  description: 'Number of results to skip for pagination'
+            responses:
+                200:
+                    description: 'Successful response'
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: '#/components/schemas/ParkingOccupancyMeasurement'
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+                400:
+                    description: Bad request
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: object
+                                properties:
+                                    error_message:
+                                        type: string
+                                        example: Bad request
+                                    error_status:
+                                        type: number
+                                        example: 400
+                                    error_info:
+                                        type: string
+                                        example: '{"limit":{"location":"query","param":"limit","value":"-2","msg":"Invalid value"}}'
     /v3/parking-tariffs:
         get:
           tags:
             - 🅿️ Parking (v3)
           summary: 'Get a list of tariffs with filtering options'
-          parameters: 
+          parameters:
             - name: primarySource
               in: query
               schema:
@@ -689,21 +793,21 @@ paths:
               schema:
                 type: string
               example: '6c08e2f9-a884-4dce-81e3-00e3391f811a'
-              description: 'Filter by primary source ID of ChargeBand in Tariff (result show all tariffs that contains atleast one ChargeBand with the selected primary sources id and inside only ChargeBand objects that fit into that filter)'
+              description: 'Filter by primary source ID of ChargeBand in Tariff (result show all tariffs that contains at least one ChargeBand with the selected primary sources id and inside only ChargeBand objects that fit into that filter)'
             - name: validFrom
               in: query
               schema:
                 type: string
                 format: date-time
               example: '2022-08-01T00:00:00.000Z'
-              description: 'Filter by valid from date of ChargeBand in Tariff (result show all tariffs that contains atleast one valid ChargeBand and inside only ChargeBand objects that fit into that filter)'
+              description: 'Filter by valid from date of ChargeBand in Tariff (result show all tariffs that contains at least one valid ChargeBand and inside only ChargeBand objects that fit into that filter)'
             - name: validTo
               in: query
               schema:
                 type: string
                 format: date-time
               example: '2023-12-31T00:00:00.000Z'
-              description: 'Filter by valid to date of ChargeBand in Tariff (result show all tariffs that contains atleast one valid ChargeBand and inside only ChargeBand objects that fit into that filter)'
+              description: 'Filter by valid to date of ChargeBand in Tariff (result show all tariffs that contains at least one valid ChargeBand and inside only ChargeBand objects that fit into that filter)'
             - name: limit
               in: query
               schema:
@@ -787,7 +891,7 @@ paths:
               schema:
                 type: string
               example: '50.123,14.243,50.017,14.573'
-              description: 'Filter by bounding box in format "topLeft.lat,topLeft.lon,bottomRight.lat,bottomRight.lon", polygons that fit only partialy to selected bounding box are included' 
+              description: 'Filter by bounding box in format "topLeft.lat,topLeft.lon,bottomRight.lat,bottomRight.lon", polygons that fit only partially to selected bounding box are included'
             - name: codeMask
               in: query
               schema:
@@ -1064,7 +1168,7 @@ components:
                 10:
                     type: number
                     example: 51
-                51:
+                11:
                     type: number
                     example: 51
                 12:
@@ -1103,6 +1207,25 @@ components:
                 23:
                     type: number
                     example: 16
+        AverageOccupancyWeek:
+            type: object
+            nullable: true
+            properties:
+                0:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                1:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                2:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                3:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                4:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                5:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                6:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+            description: "The day of the week (0 - 6; Sunday is 0)"
         ParkingLotHistory:
             type: object
             properties:
@@ -1550,7 +1673,7 @@ components:
               type: object
               properties:
                 id:
-                  type: string                  
+                  type: string
                   description: 'The identifier for the parking location.'
                 primary_source:
                   type: string
@@ -1595,7 +1718,7 @@ components:
                   description: 'Whether the parking location has security.'
                   example: null
                 dimensions:
-                  $ref: '#/components/schemas/ParkingDimension'                  
+                  $ref: '#/components/schemas/ParkingDimension'
                 covered:
                   type: boolean
                   nullable: true
@@ -1633,6 +1756,12 @@ components:
                   type: string
                   format: uuid
                   description: 'UUID of related parking tariff.'
+                has_measurement_info:
+                  type: boolean
+                  description: 'True if occupancy measurements are available'
+                has_occupancy_info:
+                    type: boolean
+                    description: 'True if average occupancy info calculated from measurements is available'
               required:
                 - id
                 - primary_source
@@ -1709,7 +1838,7 @@ components:
               type: object
               properties:
                 id:
-                  type: string                  
+                  type: string
                   description: 'The identifier for the parking space.'
                 capacity:
                   type: integer
@@ -1786,11 +1915,47 @@ components:
                 - rv
           additionalProperties:
             type: boolean
+        ParkingOccupancyMeasurement:
+          type: object
+          title: Parking Occupancy
+          properties:
+              parking_id:
+                  type: string
+                  nullable: false
+              primary_source:
+                  type: string
+                  enum:
+                      - tsk_v2
+                  description: 'The primary source of the parking location. Assigned by us.'
+              primary_source_id:
+                  type: string
+                  nullable: true
+                  description: 'The ID defined by the primary source. As in the source data.'
+              has_free_spots:
+                  type: boolean
+                  nullable: false
+              total_spot_number:
+                  type: number
+                  nullable: true
+              free_spot_number:
+                  type: number
+                  nullable: true
+              closed_spot_number:
+                  type: number
+                  nullable: true
+              occupied_spot_number:
+                  type: number
+                  nullable: true
+              last_updated:
+                  type: string
+                  nullable: false
+                  format: date-time
+                  description: 'The date and time when the info about the occupancy measurement was last updated.'
         ParkingAddress:
           type: object
           title: Parking Address
           properties:
-            address_formated:
+            address_formatted:
               type: string
               nullable: true
               description: 'Formatted address of the parking location.'

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/parkings",
-    "version": "1.7.10",
+    "version": "1.7.11-dev.1187905601",
     "description": "Golemio Parkings Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -79,4 +79,4 @@
         "@turf/turf": "^6.5.0",
         "uuid-by-string": "^3.0.2"
     }
-}
+}