@golemio/parkings 1.1.1-dev.553095105 → 1.1.1-dev.564542852

package/docs/openapi.yaml

@@ -0,0 +1,675 @@
+# prettier-ignore
+
+openapi: 3.0.3
+info:
+    title: 🅿️ Parking
+    description: >-
+        <p>💡 Parkings, parking zones, tarifs, measurements.</p>
+    version: 1.0.0
+    contact:
+        name: Golemio Prague Data Plaform
+        email: golemio@operatorict.cz
+        url: https://golemio.cz
+servers:
+    - url: https://rabin.golemio.cz/v2
+      description: Test (development) server
+    - url: https://api.golemio.cz/v2
+      description: Main (production) server
+tags:
+    - name: 🅿️ Parking
+      description: >-
+          <p>💡 Parkings, parking zones, tarifs, measurements.</p>
+paths:
+    /parking:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET All Parking Spaces
+            parameters:
+                - name: latlng
+                  in: query
+                  description: Sorting by location (Latitude and Longitude separated by comma,
+                      latitude first).
+                  schema:
+                      type: string
+                      example: 50.124935,14.457204
+                - name: range
+                  in: query
+                  description: Filter by distance from latlng in meters (range query). Depends
+                      on the latlng parameter.
+                  schema:
+                      type: number
+                      example: 5000
+                - name: source
+                  in: query
+                  description: Filter by data provider.
+                  schema:
+                      type: string
+                      example: korid
+                - name: sourceId
+                  in: query
+                  description: Filter by parking group id. Unique per data provider.
+                  schema:
+                      type: string
+                      example: 1
+                - name: category
+                  in: query
+                  description: Filter by parking type. Use with square brackets `category[]`
+                  style: form
+                  explode: false
+                  schema:
+                      type: array
+                      items:
+                          type: object
+                      example: park_and_ride
+                - name: limit
+                  in: query
+                  description: Limits number of retrieved items.
+                  schema:
+                      type: number
+                      example: 10
+                - name: offset
+                  in: query
+                  description: Number of the first items that are skipped.
+                  schema:
+                      type: number
+                      example: 0
+
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: object
+                                properties:
+                                    features:
+                                        type: array
+                                        items:
+                                            $ref: '#/components/schemas/ParkingSpaceFeature'
+                                    type:
+                                        type: string
+                                        example: FeatureCollection
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+
+                404:
+                    description: Not found
+    /parking/{id}:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET Parking Space
+            parameters:
+                - name: id
+                  in: path
+                  description: Id of parking location.
+                  required: true
+                  schema:
+                      type: string
+                      example: 6
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                $ref: '#/components/schemas/ParkingSpaceFeature'
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+
+                404:
+                    description: Not found
+    /parking/detail:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET All Detailed Parking Spaces
+            parameters:
+                -   name: latlng
+                    in: query
+                    description: Sorting by location (Latitude and Longitude separated by comma,
+                        latitude first).
+                    schema:
+                        type: string
+                        example: 50.124935,14.457204
+                -   name: range
+                    in: query
+                    description: Filter by distance from latlng in meters (range query). Depends
+                        on the latlng parameter.
+                    schema:
+                        type: number
+                        example: 5000
+                -   name: source
+                    in: query
+                    description: Filter by data provider.
+                    schema:
+                        type: string
+                        example: TSK
+                -   name: sourceId
+                    in: query
+                    description: Filter by parking group id. Unique per data provider.
+                    schema:
+                        type: string
+                        example: 1
+                -   name: category
+                    in: query
+                    description: Filter by parking type. Use with square brackets `category[]`
+                    style: form
+                    explode: false
+                    schema:
+                        type: array
+                        items:
+                            type: object
+                        example: park_and_ride
+                -   name: limit
+                    in: query
+                    description: Limits number of retrieved items.
+                    schema:
+                        type: number
+                        example: 10
+                -   name: offset
+                    in: query
+                    description: Number of the first items that are skipped.
+                    schema:
+                        type: number
+                        example: 0
+
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: object
+                                properties:
+                                    features:
+                                        type: array
+                                        items:
+                                            $ref: '#/components/schemas/ParkingSpaceFeature'
+                                    type:
+                                        type: string
+                                        example: FeatureCollection
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+
+                404:
+                    description: Not found
+    /parking/detail/{id}:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET Detailed Parking Space
+            parameters:
+                -   name: id
+                    in: path
+                    description: Id of parking location.
+                    required: true
+                    schema:
+                        type: string
+                        example: 6
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                $ref: '#/components/schemas/ParkingSpaceFeature'
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+
+                404:
+                    description: Not found
+    /parking/measurements:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET All Parking Spaces Measurements
+            parameters:
+                - name: source
+                  in: query
+                  description: Filter by data provider.
+                  schema:
+                      type: string
+                      example: korid
+                - name: sourceId
+                  in: query
+                  description: Filter by parking group id. Unique per data provider.
+                  schema:
+                      type: string
+                      example: 1
+                - name: latest
+                  in: query
+                  description: Show only the latest measurement.
+                  schema:
+                    type: boolean
+                    example: true
+                    default: false
+                - name: from
+                  in: query
+                  description: Date in ISO8601, limits data measured from this datetime.
+                  schema:
+                      type: string
+                      example: "2021-02-26T12:01:00.000Z"
+                - name: to
+                  in: query
+                  description: Date in ISO8601, limits data measured up until this datetime.
+                  schema:
+                      type: string
+                      example: "2021-02-26T12:03:00.000Z"
+                - name: page
+                  in: query
+                  description: Number of result page.
+                  schema:
+                      type: number
+                      example: 1
+                - name: pageSize
+                  in: query
+                  description: Result page size.
+                  schema:
+                      type: number
+                      example: 10000
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: '#/components/schemas/ParkingMeasurement'
+                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: '{"pageSize":{"location":"query","param":"pageSize","value":"-2","msg":"pageSize should be a positive int and should not exceed 10,000"}}'
+    /parking/tariffs/:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET All Parking Spaces Tariffs
+            parameters:
+                - name: x-access-token
+                  in: header
+                  description: e.g. YOUR_ACCESS_TOKEN
+                  schema:
+                      type: string
+                      example: YOUR_ACCESS_TOKEN
+                - name: source
+                  in: query
+                  description: Filter by data provider.
+                  schema:
+                      type: string
+                      example: korid
+                  required: false
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: '#/components/schemas/ParkingSpaceTariff'
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+
+                404:
+                    description: Not found
+    /parking/tariffs/{tariffId}:
+        get:
+            tags:
+                - 🅿️ Parking
+            summary: GET Parking Space Tariff
+            parameters:
+                - name: tariffId
+                  in: path
+                  description: Id of parking tariff.
+                  required: true
+                  schema:
+                      type: string
+                      example: b184865e-5a5e-5465-abc1-4fab6bc56a77
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                $ref: '#/components/schemas/ParkingSpaceTariff'
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+                404:
+                    description: Not found
+components:
+    responses:
+        UnauthorizedError:
+            description: API key is missing or invalid
+            headers:
+                x-access-token:
+                    schema:
+                        type: string
+    schemas:
+        ParkingSpaceFeature:
+            type: object
+            properties:
+                geometry:
+                    type: object
+                    description: GeoJSon geometry
+                    properties:
+
+                        coordinates:
+                            oneOf:
+                                - type: array
+                                  items:
+                                      type: number
+                                  example: [14.441252, 50.109318]
+                                - type: array
+                                  items:
+                                      type: array
+                                      items:
+                                          type: number
+                                      example: [14.441252, 50.109318]
+                        type:
+                            type: string
+                            enum:
+                                - Point
+                                - Polygon
+                properties:
+                    type: object
+                    properties:
+                        id:
+                            type: string
+                            example: 1768
+                        source:
+                            type: string
+                            example: TSK
+                        source_id:
+                            type: string
+                            example: 534002
+                        data_provider:
+                            type: string
+                            nullable: true
+                            example: www.tsk-praha.cz
+                        name:
+                            type: string
+                            example: Holešovice
+                        category:
+                            type: string
+                            nullable: true
+                            example: park_and_ride
+                        date_modified:
+                            type: string
+                            example: '2020-05-18T07:38:37.000Z'
+                        address_formatted:
+                            type: string
+                            nullable: true
+                            example: 'Vrbenského, 17000 Praha Holešovice, Česko'
+                        address:
+                            type: object
+                            nullable: true
+                            properties:
+                                address_country:
+                                    type: string
+                                    example: Česko
+                                address_formatted:
+                                    type: string
+                                    example: Vrbenského, 17000 Praha Holešovice, Česko
+                                address_locality:
+                                    type: string
+                                    example: Praha
+                                address_region:
+                                    type: string
+                                    example: Holešovice
+                                postal_code:
+                                    type: string
+                                    example: 17000
+                                street_address:
+                                    type: string
+                                    example: Vrbenského
+                        area_served:
+                            type: string
+                            nullable: true
+                        web_app_payment_url:
+                            type: string
+                            nullable: true
+                            example: 'https://ke-utc.appspot.com/static/select_offstreet.html?shortname=139'
+                        android_app_payment_url:
+                            type: string
+                            nullable: true
+                        ios_app_payment_url:
+                            type: string
+                            nullable: true
+                        total_spot_number:
+                            type: number
+                            example: 74
+                        tariff_id:
+                            type: string
+                            nullable: true
+                            example: 20
+                        valid_from:
+                            type: string
+                            nullable: true
+                            example: '2020-05-31T00:00:00.000Z'
+                        valid_to:
+                            type: string
+                            nullable: true
+                            example: '2022-05-31T00:00:00.000Z'
+                        parking_type:
+                            type: string
+                            enum:
+                                - park_and_ride
+                                - park_paid_private
+                                - on_street
+                                - other
+                                - park_sharing
+                                - disabled_parking
+                        zone_type:
+                            type: string
+                            nullable: true
+                            enum:
+                                - zone_residential
+                                - zone_mixed
+                                - zone_visitors
+                                - zone_other
+                                - zone_free
+                        centroid:
+                            type: object
+                            properties:
+                                type:
+                                    type: string
+                                    example: Point
+                                coordinates:
+                                    type: array
+                                    items:
+                                        type: number
+                                        example: [14.441252, 50.109318]
+                        available_spots_last_updated:
+                            type: number
+                            nullable: true
+                            example: '2021-03-01T00:19:47+01:00'
+                        available_spots_number:
+                            type: number
+                            nullable: true
+                            example: 17
+                    required:
+                        - id
+                        - source
+                        - source_id
+                        - name
+                        - date_modified
+                        - parking_type
+                        - centroid
+                        - available_spots_last_updated
+                        - available_spots_number
+                type:
+                    type: string
+                    example: Feature
+        ParkingMeasurement:
+            title: Parking Measurement
+            type: object
+            properties:
+                source:
+                    type: string
+                    example: korid
+                source_id:
+                    type: string
+                    example: 1
+                available_spot_number:
+                    type: number
+                    example: 2
+                closed_spot_number:
+                    type: number
+                    example: 0
+                occupied_spot_number:
+                    type: number
+                    example: 12
+                total_spot_number:
+                    type: number
+                    example: 14
+                date_modified:
+                    type: string
+                    example: "2021-02-28T23:19:47.384Z"
+            required:
+                - source
+                - source_id
+                - available_spot_number
+                - closed_spot_number
+                - occupied_spot_number
+                - total_spot_number
+                - date_modified
+        ParkingSpaceTariff:
+            title: Parking Space Tariff
+            required:
+                - tariff_id
+                - source
+                - last_updated
+                - payment_mode
+                - free_of_charge
+                - charge_band_name
+                - charge_currency
+            type: object
+            properties:
+                tariff_id:
+                    type: string
+                    example: b184865e-5a5e-5465-abc1-4fab6bc56a77
+                source:
+                    type: string
+                    example: korid
+                last_updated:
+                    type: string
+                    example: "2020-10-12T15:19:21+02:00"
+                payment_mode:
+                    type: string
+                    example: "\"\""
+                payment_additional_description:
+                    type: string
+                    nullable: true
+                    example: Parkování Liberec
+                free_of_charge:
+                    type: boolean
+                    example: false
+                url_link_address:
+                    type: string
+                    nullable: true
+                    example: https://parking.liberec.cz/
+                charge_band_name:
+                    type: string
+                    example: E
+                payment_methods:
+                    type: array
+                    items:
+                        type: string
+                        enum:
+                            - card_online
+                            - card_offline
+                            - cash
+                            - coins_only
+                            - mobile_app
+                            - litacka
+                            - sms_payment
+                            - apple_pay
+                            - google_pay
+                            - unknown
+
+                charge_currency:
+                    type: string
+                    example: CZK
+                allowed_vehicle_type:
+                    type: string
+                    nullable: true
+                    example: carSharing, taxi
+                allowed_fuel_type:
+                    type: string
+                    nullable: true
+                    example: electricity, petrol, lpg
+                charges:
+                    type: array
+                    items:
+                        $ref: '#/components/schemas/ParkingSpaceTariffCharge'
+                reservation_url:
+                    type: string
+                    nullable: true
+        ParkingSpaceTariffCharge:
+            title: Parking Space Tariff Charge
+            required:
+                - charge
+                - charge_order_index
+            type: object
+            properties:
+                charge:
+                    type: number
+                    example: 20
+                charge_type:
+                    type: string
+                    nullable: true
+                    enum:
+                        - minimum
+                        - maximum
+                        - additional_interval_price
+                        - season_ticket
+                        - temporary_price
+                        - first_interval_price
+                        - free_parking
+                        - flat
+                        - unknown
+                        - other
+                charge_order_index:
+                    type: number
+                    example: 0
+                charge_interval:
+                    type: number
+                    nullable: true
+                    example: 1800
+                max_iterations_of_charge:
+                    type: number
+                    nullable: true
+                    example: 1
+                min_iterations_of_charge:
+                    type: number
+                    nullable: true
+                    example: 1
+                start_time_of_period:
+                    type: string
+                    nullable: true
+                    example: Mon-Fri 09:00
+                end_time_of_period:
+                    type: string
+                    nullable: true
+                    example: Mon-Sun 14:30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@golemio/parkings",
-  "version": "1.1.1-dev.553095105",
+  "version": "1.1.1-dev.564542852",
   "description": "Golemio Parkings Module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,10 +27,10 @@
   "devDependencies": {
     "@commitlint/cli": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
-    "@golemio/core": "1.2.10-dev.544242823",
-    "@golemio/city-districts": "1.0.5-dev.551054240",
+    "@golemio/core": "1.2.13",
+    "@golemio/city-districts": "1.0.5",
     "@golemio/eslint-config": "^1.1.0",
-    "@golemio/schema-definitions": "2.0.37-dev.549508871",
+    "@golemio/schema-definitions": "2.0.37",
     "@ovos-media/ts-transform-paths": "^1.7.18-1",
     "@types/chai": "4.2.3",
     "@types/chai-as-promised": "7.1.2",

package/dist/output-gateway/models/ParkingsMeasurementsActualModel.d.ts

@@ -1,7 +0,0 @@
-import { SequelizeModel } from "@golemio/core/dist/output-gateway";
-import { IGetMeasurementsFilterParams, IParkingsMeasurement } from "./ParkingsMeasurementsModel";
-export declare class ParkingsMeasurementsActualModel extends SequelizeModel {
-    constructor();
-    GetAll: (options?: IGetMeasurementsFilterParams) => Promise<IParkingsMeasurement[]>;
-    GetOne: () => Promise<void>;
-}