openapi: 3.0.3
info:
  title: Trax Public Open API
  version: 1.0.0
  description: >-
    Public Open API for Trax fleet-telematics data. Responses use snake_case keys and a standard `{
    data, meta }` envelope; errors use `{ error: { code, message, request_id } }`. All endpoints are
    OAuth 2.0 (client-credentials) protected and tenant-scoped from the token's `company_id`. Every
    entity supports read (list/query/get) access; a defined subset — products, zones, groups, forms,
    maintenance requests, repair orders, devices, drivers, and dispatch jobs — also support
    create/update and entity-specific writes (e.g. deactivate, cancel, dispatch a form to drivers),
    each gated by its own `:write` scope.


    **Authentication** — you need an OAuth **client_id** and **client_secret** (issued per tenant).
    Exchange them for a short-lived bearer token, then send `Authorization: Bearer <access_token>`
    on every call. There is no tenant to pick — the token is already scoped to the client's
    `company_id`.


    ```bash

    # 1. Fetch a token (client-credentials grant)

    curl -sS -X POST 'https://service-prod.zendu.one/Public/OAuth/Token' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d grant_type=client_credentials \
      -d client_id=YOUR_CLIENT_ID \
      -d client_secret=YOUR_CLIENT_SECRET
    # → { "access_token": "eyJ...", "token_type": "Bearer", "expires_in": 3600, "scope":
    "devices:read ..." }


    # 2. Call the API with the token

    curl -sS 'https://trax-public-api.zendu.one/v1/devices' -H 'Authorization: Bearer eyJ...'

    ```


    The optional space-separated `scope` parameter on the token request narrows the token (omit it
    to receive every scope granted to the client; asking for a scope the client lacks returns `400
    invalid_scope`). Tokens expire after `expires_in` seconds (1 hour) — cache and reuse until then,
    then request a new one. Both form-urlencoded and JSON request bodies are accepted at the token
    endpoint.


    **Filtering**: per-field filtering is done via `POST /v1/<entity>/query`, not GET query params.
    Send a JSON body `{ "filters": { <field>: <value or operator object> }, "fields": [...],
    "include": [...], "limit": 100, "cursor": "...", "from": "...", "to": "..." }`. Each entry in
    `filters` is either a bare value (implicit `eq`, or a bare array for implicit `in`) or an
    explicit operator object, e.g. `{ "year": { "gte": 2020, "lte": 2023 } }`. Supported operators:
    `eq` (equality / any-of), `in` (explicit any-of, array value), `contains` (case-insensitive
    substring), `starts_with` (case-insensitive prefix), `gte` / `lte` (comparison), and `between`
    (inclusive range, a two-element `[min, max]` array). Which operators a given field accepts
    depends on its type (string fields typically add `contains`/`starts_with`; numeric and date
    fields add `gte`/`lte`/`between`) — see each entity's `<Entity>Filter` schema for the exact set
    per field. Multiple `filters` fields combine with AND. `GET /v1/<entity>` still supports a
    handful of named filters that predate this system (e.g. `device_id`, `status`) — those behave
    like the bare equality form and remain query params.
servers:
  - url: https://trax-public-api.zendu.one/v1
    description: Production
  - url: https://trax-public-api-dev.zendu.one/v1
    description: Dev
tags:
  - name: Devices
  - name: Drivers
  - name: Trips
  - name: Safety events
  - name: Rules
  - name: Zones
  - name: Groups
  - name: Faults
  - name: Fault codes
  - name: Maintenance
  - name: Diagnostics
  - name: Locations
  - name: Forms
  - name: Products
  - name: Jobs
  - name: Tracker types
  - name: Custom maps
  - name: Comments
  - name: Users
  - name: Coaching sessions
  - name: Company
    description: The authenticated token's own tenant/company record.
  - name: Summaries
    description: >-
      Aggregated driver/vehicle rollups over a date range (default: yesterday; max 31 days).
      Individual fetch by id — no listing.
  - name: Files
  - name: Media
  - name: Geocoding
  - name: TTS
security:
  - oauth2: []
paths:
  /devices:
    get:
      operationId: listDevices
      summary: List devices
      description: >-
        Vehicles and trackers (identity, status, group membership); live position via the status
        sub-resource.

        **Example**


        ```bash

        # requires scope: devices:read

        curl -sS 'https://trax-public-api.zendu.one/v1/devices' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `last_connected_at:asc`, `last_connected_at:desc`,
            `activation_date:asc`, `activation_date:desc`. Default `last_connected_at:desc`.
          schema:
            type: string
            enum:
              - last_connected_at:asc
              - last_connected_at:desc
              - activation_date:asc
              - activation_date:desc
            default: last_connected_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: type
          in: query
          required: false
          description: Filter by type. Discover valid values via `GET /v1/devices`.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
            enum:
              - Active
              - Suspended
              - Terminated
        - name: name
          in: query
          required: false
          description: Filter by name. Discover valid values via `GET /v1/devices`.
          schema:
            type: string
        - name: serial
          in: query
          required: false
          description: Filter by serial.
          schema:
            type: string
        - name: group_id
          in: query
          required: false
          description: Filter by group_id.
          schema:
            type: string
        - name: tag
          in: query
          required: false
          description: Filter by tag.
          schema:
            type: string
      responses:
        '200':
          description: A page of devices.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createDevice
      summary: Create a device
      description: >-
        Vehicles and trackers (identity, status, group membership); live position via the status
        sub-resource.

        **Example**


        ```bash

        # requires scope: devices:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/devices' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "serial": "string",
          "type": "string",
          "group_ids": [],
          "vin": "string",
          "license_plate": "string",
          "manufacturer": "string",
          "model": "string",
          "year": 0,
          "parent_id": "string",
          "asset_tag": "string",
          "phone": "string",
          "beacon_type": "string",
          "color": "string",
          "skill_tags": [],
          "asset_type": "string",
          "image_url": "string",
          "asset_status": "string",
          "hos_enabled": true,
          "license_state": "string",
          "license_country": "string",
          "registration_expires_at": "string"
        }'

        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                serial:
                  type: string
                  description: >-
                    Device hardware serial (ESN/IMEI). Optional, but must be unique within the
                    company when supplied. Create-only (frozen after creation).
                type:
                  type: string
                  description: >-
                    Tracker type. Optional and create-only; currently only `CustomTracker` is
                    accepted (any other value is rejected), and it defaults to `CustomTracker` when
                    omitted.
                group_ids:
                  type: array
                  items:
                    type: string
                vin:
                  type: string
                license_plate:
                  type: string
                manufacturer:
                  type: string
                model:
                  type: string
                year:
                  type: number
                parent_id:
                  type: string
                asset_tag:
                  type: string
                phone:
                  type: string
                beacon_type:
                  type: string
                color:
                  type: string
                skill_tags:
                  type: array
                  items:
                    type: string
                asset_type:
                  type: string
                image_url:
                  type: string
                asset_status:
                  type: string
                hos_enabled:
                  type: boolean
                license_state:
                  type: string
                license_country:
                  type: string
                registration_expires_at:
                  type: string
                  format: date-time
              required:
                - name
      responses:
        '201':
          description: The created device.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Device'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /devices/query:
    post:
      operationId: queryDevice
      summary: Query devices with structured filters
      description: >-
        Vehicles and trackers (identity, status, group membership); live position via the status
        sub-resource. Structured alternative to `GET /devices` for expressing per-field filters (see
        "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: devices:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/devices/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/DeviceFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of devices.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /devices/{id}:
    get:
      operationId: getDevice
      summary: Get a device by id
      description: >-
        Vehicles and trackers (identity, status, group membership); live position via the status
        sub-resource.

        **Example**


        ```bash

        # requires scope: devices:read

        curl -sS 'https://trax-public-api.zendu.one/v1/devices/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The device.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Device'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateDevice
      summary: Update a device
      description: >-
        Vehicles and trackers (identity, status, group membership); live position via the status
        sub-resource.

        **Example**


        ```bash

        # requires scope: devices:write

        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/devices/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "group_ids": [],
          "vin": "string",
          "license_plate": "string",
          "manufacturer": "string",
          "model": "string",
          "year": 0,
          "parent_id": "string",
          "asset_tag": "string",
          "phone": "string",
          "beacon_type": "string",
          "color": "string",
          "skill_tags": [],
          "asset_type": "string",
          "image_url": "string",
          "asset_status": "string",
          "hos_enabled": true,
          "license_state": "string",
          "license_country": "string",
          "registration_expires_at": "string"
        }'

        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                group_ids:
                  type: array
                  items:
                    type: string
                vin:
                  type: string
                license_plate:
                  type: string
                manufacturer:
                  type: string
                model:
                  type: string
                year:
                  type: number
                parent_id:
                  type: string
                asset_tag:
                  type: string
                phone:
                  type: string
                beacon_type:
                  type: string
                color:
                  type: string
                skill_tags:
                  type: array
                  items:
                    type: string
                asset_type:
                  type: string
                image_url:
                  type: string
                asset_status:
                  type: string
                hos_enabled:
                  type: boolean
                license_state:
                  type: string
                license_country:
                  type: string
                registration_expires_at:
                  type: string
                  format: date-time
      responses:
        '200':
          description: The updated device.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Device'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /drivers:
    get:
      operationId: listDrivers
      summary: List drivers
      description: |-
        Drivers (from the users collection); credentials and security state are never exposed.
        **Example**

        ```bash
        # requires scope: drivers:read
        curl -sS 'https://trax-public-api.zendu.one/v1/drivers' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `created_at:asc`, `created_at:desc`, `last_login:asc`,
            `last_login:desc`.
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
              - last_login:asc
              - last_login:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: username
          in: query
          required: false
          description: Filter by username.
          schema:
            type: string
        - name: group_id
          in: query
          required: false
          description: Filter by group_id.
          schema:
            type: string
      responses:
        '200':
          description: A page of drivers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Driver'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createDriver
      summary: Create a driver
      description: |-
        Drivers (from the users collection); credentials and security state are never exposed.
        **Example**

        ```bash
        # requires scope: drivers:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/drivers' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "first_name": "string",
          "last_name": "string",
          "username": "string",
          "group_ids": [],
          "email": "string",
          "phone": "string",
          "units": "string",
          "language": "string",
          "user_type": "string",
          "working_hours": {},
          "license_number": "string",
          "license_state": "string",
          "license_country": "string",
          "password": "string",
          "time_zone": "string",
          "photo_url": "string",
          "region_ids": [],
          "business_group_ids": [],
          "people_group_ids": [],
          "employee_id": "string",
          "can_assign_job_itself": true,
          "default_view": "string",
          "fetch_location_from_mobile": true,
          "feature_preview": true,
          "supervisor_ids": [],
          "driver_app_data": {},
          "map_provider": "string",
          "custom_fields": {},
          "driver_identification": "string",
          "show_self_data": true,
          "comments": "string",
          "live_notification_settings": {},
          "hos_enabled": true,
          "hos_exempted": true,
          "rule_set": "string",
          "us_hos_cycle": "string",
          "home_terminal_name": "string",
          "home_terminal_address": {},
          "exemption_annotation": "string",
          "yard_move_allowed": true,
          "personal_conveyance_allowed": true,
          "pinned_add_in_ids": []
        }'
        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                first_name:
                  type: string
                last_name:
                  type: string
                username:
                  type: string
                  description: >-
                    Login username. Required on create; create-only (a username change is a
                    separate, deferred operation). A `password` is auto-generated when omitted.
                group_ids:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: >-
                    Group ids the driver belongs to. Required on create — at least one group must be
                    supplied.
                email:
                  type: string
                phone:
                  type: string
                units:
                  type: string
                language:
                  type: string
                user_type:
                  type: string
                working_hours:
                  type: object
                  description: >-
                    Per-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: {
                    from, to } }, … }).
                  example:
                    Mon:
                      active: true
                      hours:
                        from: '09:00'
                        to: '17:00'
                license_number:
                  type: string
                license_state:
                  type: string
                license_country:
                  type: string
                password:
                  type: string
                  format: password
                  description: >-
                    Initial password; hashed server-side, never returned. Optional — auto-generated
                    when omitted.
                time_zone:
                  type: string
                photo_url:
                  type: string
                region_ids:
                  type: array
                  items:
                    type: string
                business_group_ids:
                  type: array
                  items:
                    type: string
                people_group_ids:
                  type: array
                  items:
                    type: string
                employee_id:
                  type: string
                can_assign_job_itself:
                  type: boolean
                default_view:
                  type: string
                fetch_location_from_mobile:
                  type: boolean
                feature_preview:
                  type: boolean
                supervisor_ids:
                  type: array
                  items:
                    type: string
                driver_app_data:
                  type: object
                  nullable: true
                  description: Driver app data — check-in/out, breaks, work-time tracking, forwarded as-is.
                map_provider:
                  type: string
                custom_fields:
                  type: object
                  description: Tenant-defined custom field values, keyed by field name, forwarded as-is.
                driver_identification:
                  type: string
                show_self_data:
                  type: boolean
                comments:
                  type: string
                live_notification_settings:
                  type: object
                  nullable: true
                  description: Live-notification preferences, forwarded as-is.
                hos_enabled:
                  type: boolean
                hos_exempted:
                  type: boolean
                rule_set:
                  type: string
                us_hos_cycle:
                  type: string
                home_terminal_name:
                  type: string
                home_terminal_address:
                  type: object
                  nullable: true
                  description: >-
                    Home-terminal location ({ Location: { latitude, longitude }, LocationName }),
                    forwarded as-is.
                  example:
                    Location:
                      latitude: 43.6532
                      longitude: -79.3832
                    LocationName: Main Depot
                exemption_annotation:
                  type: string
                yard_move_allowed:
                  type: boolean
                personal_conveyance_allowed:
                  type: boolean
                pinned_add_in_ids:
                  type: array
                  items:
                    type: string
              required:
                - username
                - group_ids
      responses:
        '201':
          description: The created driver.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Driver'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /drivers/query:
    post:
      operationId: queryDriver
      summary: Query drivers with structured filters
      description: >-
        Drivers (from the users collection); credentials and security state are never exposed.
        Structured alternative to `GET /drivers` for expressing per-field filters (see "Filtering"
        in the API description).

        **Example**


        ```bash

        # requires scope: drivers:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/drivers/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/DriverFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of drivers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Driver'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /drivers/{id}:
    get:
      operationId: getDriver
      summary: Get a driver by id
      description: |-
        Drivers (from the users collection); credentials and security state are never exposed.
        **Example**

        ```bash
        # requires scope: drivers:read
        curl -sS 'https://trax-public-api.zendu.one/v1/drivers/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The driver.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Driver'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateDriver
      summary: Update a driver
      description: |-
        Drivers (from the users collection); credentials and security state are never exposed.
        **Example**

        ```bash
        # requires scope: drivers:write
        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/drivers/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "first_name": "string",
          "last_name": "string",
          "group_ids": [],
          "email": "string",
          "phone": "string",
          "units": "string",
          "language": "string",
          "user_type": "string",
          "working_hours": {},
          "license_number": "string",
          "license_state": "string",
          "license_country": "string",
          "time_zone": "string",
          "photo_url": "string",
          "region_ids": [],
          "business_group_ids": [],
          "people_group_ids": [],
          "employee_id": "string",
          "can_assign_job_itself": true,
          "default_view": "string",
          "fetch_location_from_mobile": true,
          "feature_preview": true,
          "supervisor_ids": [],
          "driver_app_data": {},
          "map_provider": "string",
          "custom_fields": {},
          "driver_identification": "string",
          "show_self_data": true,
          "comments": "string",
          "live_notification_settings": {},
          "hos_enabled": true,
          "hos_exempted": true,
          "rule_set": "string",
          "us_hos_cycle": "string",
          "home_terminal_name": "string",
          "home_terminal_address": {},
          "exemption_annotation": "string",
          "yard_move_allowed": true,
          "personal_conveyance_allowed": true,
          "pinned_add_in_ids": []
        }'
        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                first_name:
                  type: string
                last_name:
                  type: string
                group_ids:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: >-
                    Group ids the driver belongs to. Required on create — at least one group must be
                    supplied.
                email:
                  type: string
                phone:
                  type: string
                units:
                  type: string
                language:
                  type: string
                user_type:
                  type: string
                working_hours:
                  type: object
                  description: >-
                    Per-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: {
                    from, to } }, … }).
                  example:
                    Mon:
                      active: true
                      hours:
                        from: '09:00'
                        to: '17:00'
                license_number:
                  type: string
                license_state:
                  type: string
                license_country:
                  type: string
                time_zone:
                  type: string
                photo_url:
                  type: string
                region_ids:
                  type: array
                  items:
                    type: string
                business_group_ids:
                  type: array
                  items:
                    type: string
                people_group_ids:
                  type: array
                  items:
                    type: string
                employee_id:
                  type: string
                can_assign_job_itself:
                  type: boolean
                default_view:
                  type: string
                fetch_location_from_mobile:
                  type: boolean
                feature_preview:
                  type: boolean
                supervisor_ids:
                  type: array
                  items:
                    type: string
                driver_app_data:
                  type: object
                  nullable: true
                  description: Driver app data — check-in/out, breaks, work-time tracking, forwarded as-is.
                map_provider:
                  type: string
                custom_fields:
                  type: object
                  description: Tenant-defined custom field values, keyed by field name, forwarded as-is.
                driver_identification:
                  type: string
                show_self_data:
                  type: boolean
                comments:
                  type: string
                live_notification_settings:
                  type: object
                  nullable: true
                  description: Live-notification preferences, forwarded as-is.
                hos_enabled:
                  type: boolean
                hos_exempted:
                  type: boolean
                rule_set:
                  type: string
                us_hos_cycle:
                  type: string
                home_terminal_name:
                  type: string
                home_terminal_address:
                  type: object
                  nullable: true
                  description: >-
                    Home-terminal location ({ Location: { latitude, longitude }, LocationName }),
                    forwarded as-is.
                  example:
                    Location:
                      latitude: 43.6532
                      longitude: -79.3832
                    LocationName: Main Depot
                exemption_annotation:
                  type: string
                yard_move_allowed:
                  type: boolean
                personal_conveyance_allowed:
                  type: boolean
                pinned_add_in_ids:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: The updated driver.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Driver'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteDriver
      summary: Delete a driver
      description: |-
        Drivers (from the users collection); credentials and security state are never exposed.
        **Example**

        ```bash
        # requires scope: drivers:write
        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/drivers/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the driver.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /trips:
    get:
      operationId: listTrips
      summary: List trips
      description: >-
        Completed trips (distance, durations, speed), tenant-scoped through the owning device.

        **Example**


        ```bash

        # requires scope: trips:read

        curl -sS
        'https://trax-public-api.zendu.one/v1/trips?device_id=<device_id>&driver_id=<driver_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Trips
      security:
        - oauth2:
            - trips:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `start_time:asc`, `start_time:desc`. Default `start_time:desc`.'
          schema:
            type: string
            enum:
              - start_time:asc
              - start_time:desc
            default: start_time:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
        - name: driver_id
          in: query
          required: false
          description: Filter by driver_id.
          schema:
            type: string
      responses:
        '200':
          description: A page of trips.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Trip'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /trips/query:
    post:
      operationId: queryTrip
      summary: Query trips with structured filters
      description: >-
        Completed trips (distance, durations, speed), tenant-scoped through the owning device.
        Structured alternative to `GET /trips` for expressing per-field filters (see "Filtering" in
        the API description).

        **Example**


        ```bash

        # requires scope: trips:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/trips/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Trips
      security:
        - oauth2:
            - trips:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/TripFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of trips.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Trip'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /trips/{id}:
    get:
      operationId: getTrip
      summary: Get a trip by id
      description: |-
        Completed trips (distance, durations, speed), tenant-scoped through the owning device.
        **Example**

        ```bash
        # requires scope: trips:read
        curl -sS 'https://trax-public-api.zendu.one/v1/trips/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Trips
      security:
        - oauth2:
            - trips:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The trip.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Trip'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /safety-events:
    get:
      operationId: listSafetyEvents
      summary: List safety events
      description: >-
        Rule violations / safety exceptions with derived handling status.

        **Example**


        ```bash

        # requires scope: safety:read

        curl -sS
        'https://trax-public-api.zendu.one/v1/safety-events?device_id=<device_id>&driver_id=<driver_id>'
        \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Safety events
      security:
        - oauth2:
            - safety:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `occurred_at:asc`, `occurred_at:desc`. Default `occurred_at:desc`.'
          schema:
            type: string
            enum:
              - occurred_at:asc
              - occurred_at:desc
            default: occurred_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
        - name: driver_id
          in: query
          required: false
          description: Filter by driver_id.
          schema:
            type: string
        - name: rule_id
          in: query
          required: false
          description: Filter by rule_id.
          schema:
            type: string
        - name: zone_id
          in: query
          required: false
          description: Filter by zone_id.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
            enum:
              - Needs Review
              - Needs Coaching
      responses:
        '200':
          description: A page of safety events.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SafetyEvent'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /safety-events/query:
    post:
      operationId: querySafetyEvent
      summary: Query safety events with structured filters
      description: >-
        Rule violations / safety exceptions with derived handling status. Structured alternative to
        `GET /safety-events` for expressing per-field filters (see "Filtering" in the API
        description).

        **Example**


        ```bash

        # requires scope: safety:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/safety-events/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Safety events
      security:
        - oauth2:
            - safety:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/SafetyEventFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of safety events.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SafetyEvent'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /safety-events/{id}:
    get:
      operationId: getSafetyEvent
      summary: Get a safety event by id
      description: |-
        Rule violations / safety exceptions with derived handling status.
        **Example**

        ```bash
        # requires scope: safety:read
        curl -sS 'https://trax-public-api.zendu.one/v1/safety-events/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Safety events
      security:
        - oauth2:
            - safety:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The safety event.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SafetyEvent'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /rules:
    get:
      operationId: listRules
      summary: List rules
      description: |-
        Safety rule definitions.
        **Example**

        ```bash
        # requires scope: rules:read
        curl -sS 'https://trax-public-api.zendu.one/v1/rules' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Rules
      security:
        - oauth2:
            - rules:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: group_id
          in: query
          required: false
          description: Filter by group_id.
          schema:
            type: string
        - name: is_active
          in: query
          required: false
          description: Filter by is_active.
          schema:
            type: string
      responses:
        '200':
          description: A page of rules.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Rule'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /rules/query:
    post:
      operationId: queryRule
      summary: Query rules with structured filters
      description: >-
        Safety rule definitions. Structured alternative to `GET /rules` for expressing per-field
        filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: rules:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/rules/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Rules
      security:
        - oauth2:
            - rules:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/RuleFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of rules.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Rule'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /rules/{id}:
    get:
      operationId: getRule
      summary: Get a rule by id
      description: |-
        Safety rule definitions.
        **Example**

        ```bash
        # requires scope: rules:read
        curl -sS 'https://trax-public-api.zendu.one/v1/rules/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Rules
      security:
        - oauth2:
            - rules:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The rule.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Rule'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /zones:
    get:
      operationId: listZones
      summary: List zones
      description: |-
        Geofences / zones.
        **Example**

        ```bash
        # requires scope: zones:read
        curl -sS 'https://trax-public-api.zendu.one/v1/zones' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Zones
      security:
        - oauth2:
            - zones:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: group_id
          in: query
          required: false
          description: Filter by group_id.
          schema:
            type: string
        - name: type
          in: query
          required: false
          description: Filter by type. Discover valid values via `GET /v1/zones`.
          schema:
            type: string
        - name: name
          in: query
          required: false
          description: Filter by name. Discover valid values via `GET /v1/zones`.
          schema:
            type: string
      responses:
        '200':
          description: A page of zones.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Zone'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createZone
      summary: Create a zone
      description: |-
        Geofences / zones.
        **Example**

        ```bash
        # requires scope: zones:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/zones' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "type": "string",
          "color": "string",
          "group_ids": [],
          "address": "string",
          "city": "string",
          "country": "string",
          "postal_code": "string",
          "street_address": "string",
          "geometry": {},
          "open_from": "string",
          "open_to": "string",
          "expected_stop_seconds": 0,
          "tag_id": "string",
          "instructions": "string",
          "address_notes": "string",
          "state": "string",
          "contact_name": "string",
          "contact_email": "string",
          "phone": "string",
          "account_id": "string",
          "custom": {},
          "indoor_geometry": {},
          "indoor_map_id": "string",
          "expiry": "string",
          "transparency": 0,
          "unit_number": "string"
        }'
        ```
      tags:
        - Zones
      security:
        - oauth2:
            - zones:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                type:
                  type: string
                  description: >-
                    The zone's tag, stored as a tag id (UUID) — not a shape or free-text category.
                    Required on create.
                color:
                  type: string
                  description: Zone display colour as a hex string, e.g. `#2f80ed`. Required on create.
                group_ids:
                  type: array
                  items:
                    type: string
                address:
                  type: string
                city:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                street_address:
                  type: string
                geometry:
                  type: object
                  nullable: true
                  description: >-
                    Outdoor zone shape, forwarded as-is in PascalCase. Either a circle `{ "Type":
                    "circle", "Center": { "Latitude": <n>, "Longitude": <n> }, "Radius": <n> }` or a
                    polygon `{ "Type": "polygon", "Points": [ { "Latitude": <n>, "Longitude": <n> },
                    … (min 3) ] }`. `Type` must be lowercase `circle` or `polygon`. Provide EITHER
                    `geometry` (outdoor, lat/lng) OR `indoor_geometry` + `indoor_map_id` (indoor) —
                    never both.
                  example:
                    Type: circle
                    Center:
                      Latitude: 43.6532
                      Longitude: -79.3832
                    Radius: 200
                open_from:
                  type: string
                open_to:
                  type: string
                expected_stop_seconds:
                  type: number
                tag_id:
                  type: string
                instructions:
                  type: string
                address_notes:
                  type: string
                state:
                  type: string
                contact_name:
                  type: string
                contact_email:
                  type: string
                phone:
                  type: string
                account_id:
                  type: string
                custom:
                  type: object
                  nullable: true
                  additionalProperties:
                    type: string
                  description: >-
                    Tenant-defined custom data for integrations, keyed by field name (string or
                    number values), forwarded as-is. null when not set.
                indoor_geometry:
                  type: object
                  nullable: true
                  description: >-
                    Indoor zone shape on an uploaded indoor map, forwarded as-is in PascalCase (uses
                    `Center.X`/`Center.Y`, not latitude/longitude). Requires `indoor_map_id`.
                    Mutually exclusive with `geometry`; null for outdoor zones.
                  example:
                    Type: circle
                    Center:
                      X: 120
                      'Y': 240
                    Radius: 30
                indoor_map_id:
                  type: string
                  nullable: true
                  description: >-
                    Id of the indoor map an indoor zone belongs to. Required when `indoor_geometry`
                    is set; must be omitted for outdoor (`geometry`) zones — sending it on an
                    outdoor zone is rejected with "Outdoor zone can't have indoor map id".
                expiry:
                  type: string
                  format: date-time
                  nullable: true
                  description: >-
                    Zone expiration date — the collection has a TTL index that deletes expired
                    zones. null when the zone doesn't expire.
                transparency:
                  type: number
                  description: Map rendering opacity, in percent (0-100).
                unit_number:
                  type: string
              required:
                - name
                - type
                - color
      responses:
        '201':
          description: The created zone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Zone'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /zones/query:
    post:
      operationId: queryZone
      summary: Query zones with structured filters
      description: >-
        Geofences / zones. Structured alternative to `GET /zones` for expressing per-field filters
        (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: zones:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/zones/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Zones
      security:
        - oauth2:
            - zones:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/ZoneFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of zones.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Zone'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /zones/{id}:
    get:
      operationId: getZone
      summary: Get a zone by id
      description: |-
        Geofences / zones.
        **Example**

        ```bash
        # requires scope: zones:read
        curl -sS 'https://trax-public-api.zendu.one/v1/zones/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Zones
      security:
        - oauth2:
            - zones:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The zone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Zone'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateZone
      summary: Update a zone
      description: |-
        Geofences / zones.
        **Example**

        ```bash
        # requires scope: zones:write
        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/zones/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "type": "string",
          "color": "string",
          "group_ids": [],
          "address": "string",
          "city": "string",
          "country": "string",
          "postal_code": "string",
          "street_address": "string",
          "geometry": {},
          "open_from": "string",
          "open_to": "string",
          "expected_stop_seconds": 0,
          "tag_id": "string",
          "instructions": "string",
          "address_notes": "string",
          "state": "string",
          "contact_name": "string",
          "contact_email": "string",
          "phone": "string",
          "account_id": "string",
          "custom": {},
          "indoor_geometry": {},
          "indoor_map_id": "string",
          "expiry": "string",
          "transparency": 0,
          "unit_number": "string"
        }'
        ```
      tags:
        - Zones
      security:
        - oauth2:
            - zones:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                type:
                  type: string
                  description: >-
                    The zone's tag, stored as a tag id (UUID) — not a shape or free-text category.
                    Required on create.
                color:
                  type: string
                  description: Zone display colour as a hex string, e.g. `#2f80ed`. Required on create.
                group_ids:
                  type: array
                  items:
                    type: string
                address:
                  type: string
                city:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                street_address:
                  type: string
                geometry:
                  type: object
                  nullable: true
                  description: >-
                    Outdoor zone shape, forwarded as-is in PascalCase. Either a circle `{ "Type":
                    "circle", "Center": { "Latitude": <n>, "Longitude": <n> }, "Radius": <n> }` or a
                    polygon `{ "Type": "polygon", "Points": [ { "Latitude": <n>, "Longitude": <n> },
                    … (min 3) ] }`. `Type` must be lowercase `circle` or `polygon`. Provide EITHER
                    `geometry` (outdoor, lat/lng) OR `indoor_geometry` + `indoor_map_id` (indoor) —
                    never both.
                  example:
                    Type: circle
                    Center:
                      Latitude: 43.6532
                      Longitude: -79.3832
                    Radius: 200
                open_from:
                  type: string
                open_to:
                  type: string
                expected_stop_seconds:
                  type: number
                tag_id:
                  type: string
                instructions:
                  type: string
                address_notes:
                  type: string
                state:
                  type: string
                contact_name:
                  type: string
                contact_email:
                  type: string
                phone:
                  type: string
                account_id:
                  type: string
                custom:
                  type: object
                  nullable: true
                  additionalProperties:
                    type: string
                  description: >-
                    Tenant-defined custom data for integrations, keyed by field name (string or
                    number values), forwarded as-is. null when not set.
                indoor_geometry:
                  type: object
                  nullable: true
                  description: >-
                    Indoor zone shape on an uploaded indoor map, forwarded as-is in PascalCase (uses
                    `Center.X`/`Center.Y`, not latitude/longitude). Requires `indoor_map_id`.
                    Mutually exclusive with `geometry`; null for outdoor zones.
                  example:
                    Type: circle
                    Center:
                      X: 120
                      'Y': 240
                    Radius: 30
                indoor_map_id:
                  type: string
                  nullable: true
                  description: >-
                    Id of the indoor map an indoor zone belongs to. Required when `indoor_geometry`
                    is set; must be omitted for outdoor (`geometry`) zones — sending it on an
                    outdoor zone is rejected with "Outdoor zone can't have indoor map id".
                expiry:
                  type: string
                  format: date-time
                  nullable: true
                  description: >-
                    Zone expiration date — the collection has a TTL index that deletes expired
                    zones. null when the zone doesn't expire.
                transparency:
                  type: number
                  description: Map rendering opacity, in percent (0-100).
                unit_number:
                  type: string
      responses:
        '200':
          description: The updated zone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Zone'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteZone
      summary: Delete a zone
      description: |-
        Geofences / zones.
        **Example**

        ```bash
        # requires scope: zones:write
        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/zones/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Zones
      security:
        - oauth2:
            - zones:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the zone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /groups:
    get:
      operationId: listGroups
      summary: List groups
      description: |-
        The group hierarchy used to scope and filter every other entity.
        **Example**

        ```bash
        # requires scope: groups:read
        curl -sS 'https://trax-public-api.zendu.one/v1/groups' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Groups
      security:
        - oauth2:
            - groups:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: name
          in: query
          required: false
          description: Filter by name. Discover valid values via `GET /v1/groups`.
          schema:
            type: string
      responses:
        '200':
          description: A page of groups.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createGroup
      summary: Create a group
      description: |-
        The group hierarchy used to scope and filter every other entity.
        **Example**

        ```bash
        # requires scope: groups:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/groups' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "image_url": "string",
          "parent_id": "string"
        }'
        ```
      tags:
        - Groups
      security:
        - oauth2:
            - groups:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: Group name. Required on create.
                image_url:
                  type: string
                parent_id:
                  type: string
                  nullable: true
                  description: >-
                    Parent group id for (re)parenting. Virtual write-only param (not a stored
                    field): omit to keep the current parent, send null/empty to move to root. Never
                    returned — discover the hierarchy via each group's child_ids.
              required:
                - name
      responses:
        '201':
          description: The created group.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Group'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /groups/query:
    post:
      operationId: queryGroup
      summary: Query groups with structured filters
      description: >-
        The group hierarchy used to scope and filter every other entity. Structured alternative to
        `GET /groups` for expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: groups:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/groups/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Groups
      security:
        - oauth2:
            - groups:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/GroupFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of groups.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /groups/{id}:
    get:
      operationId: getGroup
      summary: Get a group by id
      description: |-
        The group hierarchy used to scope and filter every other entity.
        **Example**

        ```bash
        # requires scope: groups:read
        curl -sS 'https://trax-public-api.zendu.one/v1/groups/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Groups
      security:
        - oauth2:
            - groups:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The group.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Group'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateGroup
      summary: Update a group
      description: |-
        The group hierarchy used to scope and filter every other entity.
        **Example**

        ```bash
        # requires scope: groups:write
        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/groups/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "image_url": "string",
          "parent_id": "string"
        }'
        ```
      tags:
        - Groups
      security:
        - oauth2:
            - groups:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: Group name. Required on create.
                image_url:
                  type: string
                parent_id:
                  type: string
                  nullable: true
                  description: >-
                    Parent group id for (re)parenting. Virtual write-only param (not a stored
                    field): omit to keep the current parent, send null/empty to move to root. Never
                    returned — discover the hierarchy via each group's child_ids.
      responses:
        '200':
          description: The updated group.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Group'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteGroup
      summary: Delete a group
      description: |-
        The group hierarchy used to scope and filter every other entity.
        **Example**

        ```bash
        # requires scope: groups:write
        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/groups/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Groups
      security:
        - oauth2:
            - groups:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the group.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /faults:
    get:
      operationId: listVehicleFaults
      summary: List vehicle faults
      description: >-
        Detected vehicle faults with triage state, one row per fault raised on a device, scoped to
        the token's company. Status is one of New, Triaged, Assigned, WorkOrder, Active, Dismissed,
        Closed. The shared code catalog is embeddable via `include=insight`.

        **Example**


        ```bash

        # requires scope: faults:read

        curl -sS 'https://trax-public-api.zendu.one/v1/faults?device_id=<device_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Faults
      security:
        - oauth2:
            - faults:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `created_at:asc`, `created_at:desc`, `detected_on:asc`,
            `detected_on:desc`, `last_updated_at:asc`, `last_updated_at:desc`, `closed_at:asc`,
            `closed_at:desc`. Default `created_at:desc`.
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
              - detected_on:asc
              - detected_on:desc
              - last_updated_at:asc
              - last_updated_at:desc
              - closed_at:asc
              - closed_at:desc
            default: created_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
        - name: code
          in: query
          required: false
          description: Filter by code.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
        - name: severity
          in: query
          required: false
          description: Filter by severity.
          schema:
            type: string
      responses:
        '200':
          description: A page of vehicle faults.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VehicleFault'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /faults/query:
    post:
      operationId: queryVehicleFault
      summary: Query vehicle faults with structured filters
      description: >-
        Detected vehicle faults with triage state, one row per fault raised on a device, scoped to
        the token's company. Status is one of New, Triaged, Assigned, WorkOrder, Active, Dismissed,
        Closed. The shared code catalog is embeddable via `include=insight`. Structured alternative
        to `GET /faults` for expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: faults:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/faults/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Faults
      security:
        - oauth2:
            - faults:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/VehicleFaultFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of vehicle faults.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VehicleFault'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /faults/{id}:
    get:
      operationId: getVehicleFault
      summary: Get a vehicle fault by id
      description: >-
        Detected vehicle faults with triage state, one row per fault raised on a device, scoped to
        the token's company. Status is one of New, Triaged, Assigned, WorkOrder, Active, Dismissed,
        Closed. The shared code catalog is embeddable via `include=insight`.

        **Example**


        ```bash

        # requires scope: faults:read

        curl -sS 'https://trax-public-api.zendu.one/v1/faults/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Faults
      security:
        - oauth2:
            - faults:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The vehicle fault.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/VehicleFault'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /fault-codes:
    get:
      operationId: listFaultCodes
      summary: List fault codes
      description: |-
        Global, AI-enriched diagnostic-code catalog (shared reference data; no tenant scoping).
        **Example**

        ```bash
        # requires scope: faults:read
        curl -sS 'https://trax-public-api.zendu.one/v1/fault-codes' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Fault codes
      security:
        - oauth2:
            - faults:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: code
          in: query
          required: false
          description: Filter by code.
          schema:
            type: string
        - name: component
          in: query
          required: false
          description: Filter by component.
          schema:
            type: string
        - name: severity
          in: query
          required: false
          description: Filter by severity.
          schema:
            type: string
            enum:
              - Low
              - Moderate
              - High
              - Critical
      responses:
        '200':
          description: A page of fault codes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FaultCode'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /fault-codes/query:
    post:
      operationId: queryFaultCode
      summary: Query fault codes with structured filters
      description: >-
        Global, AI-enriched diagnostic-code catalog (shared reference data; no tenant scoping).
        Structured alternative to `GET /fault-codes` for expressing per-field filters (see
        "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: faults:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/fault-codes/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Fault codes
      security:
        - oauth2:
            - faults:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/FaultCodeFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of fault codes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FaultCode'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /fault-codes/{id}:
    get:
      operationId: getFaultCode
      summary: Get a fault code by id
      description: |-
        Global, AI-enriched diagnostic-code catalog (shared reference data; no tenant scoping).
        **Example**

        ```bash
        # requires scope: faults:read
        curl -sS 'https://trax-public-api.zendu.one/v1/fault-codes/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Fault codes
      security:
        - oauth2:
            - faults:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The fault code.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FaultCode'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /maintenance-requests:
    get:
      operationId: listMaintenanceRequests
      summary: List maintenance requests
      description: |-
        Vehicle maintenance service requests.
        **Example**

        ```bash
        # requires scope: maintenance:read
        curl -sS 'https://trax-public-api.zendu.one/v1/maintenance-requests' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `created_at:asc`, `created_at:desc`, `resolved_at:asc`,
            `resolved_at:desc`. Default `created_at:desc`.
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
              - resolved_at:asc
              - resolved_at:desc
            default: created_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
            enum:
              - Pending Assignment
              - Assigned
              - In Progress
              - On Hold
              - Completed
              - Cancelled
      responses:
        '200':
          description: A page of maintenance requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MaintenanceRequest'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createMaintenanceRequest
      summary: Create a maintenance request
      description: |-
        Vehicle maintenance service requests.
        **Example**

        ```bash
        # requires scope: maintenance:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/maintenance-requests' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "status": "string",
          "details": {},
          "tags": [],
          "service_provider_id": "string",
          "assigned_to": "string",
          "added_products": [],
          "defect": "string"
        }'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                status:
                  type: string
                details:
                  type: object
                  description: >-
                    Maintenance request details, forwarded as-is (camelCase sub-keys) to the
                    maintenance service. Required on create — the request is built from this object.
                    In practice set `asset` (the vehicle/device id) and a valid `dueDate`; the other
                    sub-keys are optional.
                  properties:
                    asset:
                      type: string
                      description: Vehicle/device id the request is for.
                    maintenanceType:
                      type: string
                    reference:
                      type: string
                    dueDate:
                      type: string
                      format: date-time
                      description: Due date (ISO-8601).
                    summary:
                      type: string
                    priority:
                      type: string
                tags:
                  type: array
                  items:
                    type: string
                service_provider_id:
                  type: string
                assigned_to:
                  type: string
                added_products:
                  type: array
                  description: >-
                    Product/part line items attached to the request, forwarded as-is (camelCase
                    sub-keys, matching the stored shape).
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      type:
                        type: string
                      quantityOrHours:
                        type: number
                      unitCost:
                        type: number
                      totalCost:
                        type: number
                      disableUnitCost:
                        type: boolean
                      estimatedTime:
                        type: number
                defect:
                  type: string
              required:
                - details
      responses:
        '201':
          description: The created maintenance request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MaintenanceRequest'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /maintenance-requests/query:
    post:
      operationId: queryMaintenanceRequest
      summary: Query maintenance requests with structured filters
      description: >-
        Vehicle maintenance service requests. Structured alternative to `GET /maintenance-requests`
        for expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: maintenance:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/maintenance-requests/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/MaintenanceRequestFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of maintenance requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MaintenanceRequest'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /maintenance-requests/{id}:
    get:
      operationId: getMaintenanceRequest
      summary: Get a maintenance request by id
      description: |-
        Vehicle maintenance service requests.
        **Example**

        ```bash
        # requires scope: maintenance:read
        curl -sS 'https://trax-public-api.zendu.one/v1/maintenance-requests/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The maintenance request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MaintenanceRequest'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateMaintenanceRequest
      summary: Update a maintenance request
      description: |-
        Vehicle maintenance service requests.
        **Example**

        ```bash
        # requires scope: maintenance:write
        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/maintenance-requests/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "status": "string",
          "details": {},
          "tags": [],
          "completion_odometer_km": 0,
          "completion_engine_hours": 0,
          "completed_at": "string",
          "added_products": [],
          "defect": "string"
        }'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                status:
                  type: string
                details:
                  type: object
                  description: >-
                    Maintenance request details, forwarded as-is (camelCase sub-keys) to the
                    maintenance service. Required on create — the request is built from this object.
                    In practice set `asset` (the vehicle/device id) and a valid `dueDate`; the other
                    sub-keys are optional.
                  properties:
                    asset:
                      type: string
                      description: Vehicle/device id the request is for.
                    maintenanceType:
                      type: string
                    reference:
                      type: string
                    dueDate:
                      type: string
                      format: date-time
                      description: Due date (ISO-8601).
                    summary:
                      type: string
                    priority:
                      type: string
                tags:
                  type: array
                  items:
                    type: string
                completion_odometer_km:
                  type: number
                completion_engine_hours:
                  type: number
                completed_at:
                  type: string
                  format: date-time
                added_products:
                  type: array
                  description: >-
                    Product/part line items attached to the request, forwarded as-is (camelCase
                    sub-keys, matching the stored shape).
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      type:
                        type: string
                      quantityOrHours:
                        type: number
                      unitCost:
                        type: number
                      totalCost:
                        type: number
                      disableUnitCost:
                        type: boolean
                      estimatedTime:
                        type: number
                defect:
                  type: string
      responses:
        '200':
          description: The updated maintenance request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MaintenanceRequest'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteMaintenanceRequest
      summary: Delete a maintenance request
      description: |-
        Vehicle maintenance service requests.
        **Example**

        ```bash
        # requires scope: maintenance:write
        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/maintenance-requests/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "cancellation_reason": "string"
        }'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                cancellation_reason:
                  type: string
      responses:
        '200':
          description: Deleted the maintenance request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /repair-orders:
    get:
      operationId: listRepairOrders
      summary: List repair orders
      description: |-
        Repair orders (curated totals; raw cost breakdowns hidden).
        **Example**

        ```bash
        # requires scope: maintenance:read
        curl -sS 'https://trax-public-api.zendu.one/v1/repair-orders' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `created_at:asc`, `created_at:desc`, `assigned_at:asc`,
            `assigned_at:desc`. Default `created_at:desc`.
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
              - assigned_at:asc
              - assigned_at:desc
            default: created_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
            enum:
              - Pending Assignment
              - Assigned
              - In Progress
              - On Hold
              - Completed
              - Cancelled
      responses:
        '200':
          description: A page of repair orders.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RepairOrder'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createRepairOrder
      summary: Create a repair order
      description: |-
        Repair orders (curated totals; raw cost breakdowns hidden).
        **Example**

        ```bash
        # requires scope: maintenance:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/repair-orders' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "status": "string",
          "details": {},
          "added_services": []
        }'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                status:
                  type: string
                details:
                  type: object
                  description: >-
                    Repair order details, forwarded as-is (camelCase sub-keys) to the maintenance
                    service. Required on create; in practice set `asset` and a valid `dueDate`.
                    `assignTo`/`serviceProvider` also propagate onto the linked service requests.
                  properties:
                    asset:
                      type: string
                      description: Vehicle/device id the order is for.
                    priority:
                      type: string
                    assignTo:
                      type: string
                    serviceProvider:
                      type: string
                    summary:
                      type: string
                    dueDate:
                      type: string
                      format: date-time
                      description: Due date (ISO-8601).
                    reference:
                      type: string
                added_services:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: >-
                    Maintenance service request ids attached to this repair order. Required on
                    create: at least one id, each an existing service request in the company that is
                    not already attached to another repair order.
              required:
                - details
                - added_services
      responses:
        '201':
          description: The created repair order.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RepairOrder'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /repair-orders/query:
    post:
      operationId: queryRepairOrder
      summary: Query repair orders with structured filters
      description: >-
        Repair orders (curated totals; raw cost breakdowns hidden). Structured alternative to `GET
        /repair-orders` for expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: maintenance:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/repair-orders/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/RepairOrderFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of repair orders.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RepairOrder'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /repair-orders/{id}:
    get:
      operationId: getRepairOrder
      summary: Get a repair order by id
      description: |-
        Repair orders (curated totals; raw cost breakdowns hidden).
        **Example**

        ```bash
        # requires scope: maintenance:read
        curl -sS 'https://trax-public-api.zendu.one/v1/repair-orders/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The repair order.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RepairOrder'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateRepairOrder
      summary: Update a repair order
      description: |-
        Repair orders (curated totals; raw cost breakdowns hidden).
        **Example**

        ```bash
        # requires scope: maintenance:write
        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/repair-orders/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "status": "string",
          "details": {},
          "added_services": []
        }'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                status:
                  type: string
                details:
                  type: object
                  description: >-
                    Repair order details, forwarded as-is (camelCase sub-keys) to the maintenance
                    service. Required on create; in practice set `asset` and a valid `dueDate`.
                    `assignTo`/`serviceProvider` also propagate onto the linked service requests.
                  properties:
                    asset:
                      type: string
                      description: Vehicle/device id the order is for.
                    priority:
                      type: string
                    assignTo:
                      type: string
                    serviceProvider:
                      type: string
                    summary:
                      type: string
                    dueDate:
                      type: string
                      format: date-time
                      description: Due date (ISO-8601).
                    reference:
                      type: string
                added_services:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: >-
                    Maintenance service request ids attached to this repair order. Required on
                    create: at least one id, each an existing service request in the company that is
                    not already attached to another repair order.
      responses:
        '200':
          description: The updated repair order.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RepairOrder'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteRepairOrder
      summary: Delete a repair order
      description: |-
        Repair orders (curated totals; raw cost breakdowns hidden).
        **Example**

        ```bash
        # requires scope: maintenance:write
        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/repair-orders/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "cancellation_reason": "string"
        }'
        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                cancellation_reason:
                  type: string
      responses:
        '200':
          description: Deleted the repair order.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /diagnostics:
    get:
      operationId: listDiagnosticReadings
      summary: List diagnostic readings
      description: |-
        Sensor/telemetry time-series (list-only, date-cursored).
        **Example**

        ```bash
        # requires scope: diagnostics:read
        curl -sS 'https://trax-public-api.zendu.one/v1/diagnostics?device_id=<device_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Diagnostics
      security:
        - oauth2:
            - diagnostics:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `recorded_at:asc`, `recorded_at:desc`. Default `recorded_at:desc`.'
          schema:
            type: string
            enum:
              - recorded_at:asc
              - recorded_at:desc
            default: recorded_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: device_id
          in: query
          required: true
          description: Filter by device_id. Required.
          schema:
            type: string
        - name: type
          in: query
          required: false
          description: Filter by type.
          schema:
            type: string
            enum:
              - InDoor
              - OutDoor
              - DoorState
              - RemovalState
              - BLEConnection
              - Battery
              - Humidity
              - Temperature
              - Impact
              - Pressure
              - Light
              - Tamper
              - RSSI
              - Fuel
              - FuelLevel
              - Odometer
              - TirePressureLF
              - TirePressureRF
              - TirePressureLR
              - TirePressureRR
              - CoolantTemperature
              - BatteryVoltage
              - BackupBatteryVoltage
              - EngineOnTime
              - RPM
              - EngineSpeed
              - EngineHours
              - EngineLoad
              - TotalMileage
              - AverageOilConsumption
              - Break
              - OilPressure
              - MassAirFlow
              - Ignition
              - AccAxisX
              - AccAxisY
              - AccAxisZ
              - Button
              - Fault
              - RemainingFuel
              - InstantFuelConsumption
              - TotalFuel
              - MovingMode
              - Interrupt
              - Speed
              - EngineTemperature
              - FuelRate
              - BatteryTemperature
              - OBDIgnition
              - LoadPercentage
              - LoadingMode
              - FloorCapacityRatio
              - FloorAreaRemaining
              - PowerSource
              - ChargeType
      responses:
        '200':
          description: A page of diagnostic readings.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiagnosticReading'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /diagnostics/query:
    post:
      operationId: queryDiagnosticReading
      summary: Query diagnostic readings with structured filters
      description: >-
        Sensor/telemetry time-series (list-only, date-cursored). Structured alternative to `GET
        /diagnostics` for expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: diagnostics:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/diagnostics/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Diagnostics
      security:
        - oauth2:
            - diagnostics:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/DiagnosticReadingFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of diagnostic readings.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiagnosticReading'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /locations:
    get:
      operationId: listLocations
      summary: List locations
      description: |-
        Historical vehicle locations / breadcrumbs (list-only, date-cursored).
        **Example**

        ```bash
        # requires scope: locations:read
        curl -sS 'https://trax-public-api.zendu.one/v1/locations?device_id=<device_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Locations
      security:
        - oauth2:
            - locations:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `located_at:asc`, `located_at:desc`. Default `located_at:desc`.'
          schema:
            type: string
            enum:
              - located_at:asc
              - located_at:desc
            default: located_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: device_id
          in: query
          required: true
          description: Filter by device_id. Required.
          schema:
            type: string
      responses:
        '200':
          description: A page of locations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Location'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /locations/query:
    post:
      operationId: queryLocation
      summary: Query locations with structured filters
      description: >-
        Historical vehicle locations / breadcrumbs (list-only, date-cursored). Structured
        alternative to `GET /locations` for expressing per-field filters (see "Filtering" in the API
        description).

        **Example**


        ```bash

        # requires scope: locations:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/locations/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Locations
      security:
        - oauth2:
            - locations:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/LocationFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of locations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Location'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /forms:
    get:
      operationId: listForms
      summary: List forms
      description: >-
        Company form definitions (layout, DVIR/safety config, reusability); notification routing
        details are never exposed.

        **Example**


        ```bash

        # requires scope: forms:read

        curl -sS
        'https://trax-public-api.zendu.one/v1/forms?driver_id=<driver_id>&device_id=<device_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: form_category
          in: query
          required: false
          description: Filter by form_category.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
        - name: driver_id
          in: query
          required: false
          description: Filter by driver_id.
          schema:
            type: string
        - name: group_id
          in: query
          required: false
          description: Filter by group_id.
          schema:
            type: string
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
      responses:
        '200':
          description: A page of forms.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Form'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /forms/query:
    post:
      operationId: queryForm
      summary: Query forms with structured filters
      description: >-
        Company form definitions (layout, DVIR/safety config, reusability); notification routing
        details are never exposed. Structured alternative to `GET /forms` for expressing per-field
        filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: forms:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/forms/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/FormFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of forms.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Form'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /forms/{id}:
    get:
      operationId: getForm
      summary: Get a form by id
      description: >-
        Company form definitions (layout, DVIR/safety config, reusability); notification routing
        details are never exposed.

        **Example**


        ```bash

        # requires scope: forms:read

        curl -sS 'https://trax-public-api.zendu.one/v1/forms/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The form.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Form'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteForm
      summary: Delete a form
      description: >-
        Company form definitions (layout, DVIR/safety config, reusability); notification routing
        details are never exposed.

        **Example**


        ```bash

        # requires scope: forms:write

        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/forms/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the form.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /form-submissions:
    get:
      operationId: listFormSubmissions
      summary: List form submissions
      description: >-
        Submitted forms (dispatch tasks carrying a completed form), list-only and date-cursored; raw
        layout is sanitized into `answers`.

        **Example**


        ```bash

        # requires scope: forms:read

        curl -sS
        'https://trax-public-api.zendu.one/v1/form-submissions?driver_id=<driver_id>&device_id=<device_id>'
        \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `created:asc`, `created:desc`. Default `created:desc`.'
          schema:
            type: string
            enum:
              - created:asc
              - created:desc
            default: created:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: driver_id
          in: query
          required: false
          description: Filter by driver_id.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
        - name: form_id
          in: query
          required: false
          description: Filter by form_id.
          schema:
            type: string
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
        - name: form_category
          in: query
          required: false
          description: Filter by form_category.
          schema:
            type: string
      responses:
        '200':
          description: A page of form submissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormSubmission'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /form-submissions/query:
    post:
      operationId: queryFormSubmission
      summary: Query form submissions with structured filters
      description: >-
        Submitted forms (dispatch tasks carrying a completed form), list-only and date-cursored; raw
        layout is sanitized into `answers`. Structured alternative to `GET /form-submissions` for
        expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: forms:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/form-submissions/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/FormSubmissionFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of form submissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormSubmission'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /form-schedules:
    get:
      operationId: listFormSchedules
      summary: List form schedules
      description: |-
        Scheduled form dispatches — one row per scheduled execution of a form on a device/driver.
        **Example**

        ```bash
        # requires scope: forms:read
        curl -sS 'https://trax-public-api.zendu.one/v1/form-schedules' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `next_run_at:asc`, `next_run_at:desc`. Default `next_run_at:desc`.'
          schema:
            type: string
            enum:
              - next_run_at:asc
              - next_run_at:desc
            default: next_run_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
      responses:
        '200':
          description: A page of form schedules.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormSchedule'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /form-schedules/query:
    post:
      operationId: queryFormSchedule
      summary: Query form schedules with structured filters
      description: >-
        Scheduled form dispatches — one row per scheduled execution of a form on a device/driver.
        Structured alternative to `GET /form-schedules` for expressing per-field filters (see
        "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: forms:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/form-schedules/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/FormScheduleFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of form schedules.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormSchedule'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /form-schedules/{id}:
    get:
      operationId: getFormSchedule
      summary: Get a form schedule by id
      description: |-
        Scheduled form dispatches — one row per scheduled execution of a form on a device/driver.
        **Example**

        ```bash
        # requires scope: forms:read
        curl -sS 'https://trax-public-api.zendu.one/v1/form-schedules/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The form schedule.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormSchedule'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /products:
    get:
      operationId: listProducts
      summary: List products
      description: |-
        Marketplace/dispatch products (pricing, stock, zone/device association).
        **Example**

        ```bash
        # requires scope: products:read
        curl -sS 'https://trax-public-api.zendu.one/v1/products' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Products
      security:
        - oauth2:
            - products:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: name
          in: query
          required: false
          description: Filter by name. Discover valid values via `GET /v1/products`.
          schema:
            type: string
        - name: zone_id
          in: query
          required: false
          description: Filter by zone_id.
          schema:
            type: string
      responses:
        '200':
          description: A page of products.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Product'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createProduct
      summary: Create a product
      description: |-
        Marketplace/dispatch products (pricing, stock, zone/device association).
        **Example**

        ```bash
        # requires scope: products:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/products' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "description": "string",
          "price": 0,
          "unique_id": "string",
          "title": "string",
          "image_url": "string",
          "zone_id": "string",
          "type": "string",
          "quantity_in_hand": 0,
          "tags": [],
          "device_ids": [],
          "is_archived": true,
          "is_marketplace_product": true,
          "order_lead_time": {}
        }'
        ```
      tags:
        - Products
      security:
        - oauth2:
            - products:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                description:
                  type: string
                price:
                  type: number
                unique_id:
                  type: string
                title:
                  type: string
                image_url:
                  type: string
                zone_id:
                  type: string
                type:
                  type: string
                quantity_in_hand:
                  type: number
                tags:
                  type: array
                  items:
                    type: string
                device_ids:
                  type: array
                  items:
                    type: string
                is_archived:
                  type: boolean
                is_marketplace_product:
                  type: boolean
                order_lead_time:
                  type: object
                  nullable: true
                  description: Order lead time before dispatch ({ Days, Hours, Minutes }), forwarded as-is.
                  example:
                    Days: 1
                    Hours: 2
                    Minutes: 0
      responses:
        '201':
          description: The created product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Product'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /products/query:
    post:
      operationId: queryProduct
      summary: Query products with structured filters
      description: >-
        Marketplace/dispatch products (pricing, stock, zone/device association). Structured
        alternative to `GET /products` for expressing per-field filters (see "Filtering" in the API
        description).

        **Example**


        ```bash

        # requires scope: products:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/products/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Products
      security:
        - oauth2:
            - products:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/ProductFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of products.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Product'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /products/{id}:
    get:
      operationId: getProduct
      summary: Get a product by id
      description: |-
        Marketplace/dispatch products (pricing, stock, zone/device association).
        **Example**

        ```bash
        # requires scope: products:read
        curl -sS 'https://trax-public-api.zendu.one/v1/products/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Products
      security:
        - oauth2:
            - products:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Product'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateProduct
      summary: Update a product
      description: |-
        Marketplace/dispatch products (pricing, stock, zone/device association).
        **Example**

        ```bash
        # requires scope: products:write
        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/products/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "description": "string",
          "price": 0,
          "unique_id": "string",
          "title": "string",
          "image_url": "string",
          "zone_id": "string",
          "type": "string",
          "quantity_in_hand": 0,
          "tags": [],
          "device_ids": [],
          "is_archived": true,
          "is_marketplace_product": true,
          "order_lead_time": {}
        }'
        ```
      tags:
        - Products
      security:
        - oauth2:
            - products:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                description:
                  type: string
                price:
                  type: number
                unique_id:
                  type: string
                title:
                  type: string
                image_url:
                  type: string
                zone_id:
                  type: string
                type:
                  type: string
                quantity_in_hand:
                  type: number
                tags:
                  type: array
                  items:
                    type: string
                device_ids:
                  type: array
                  items:
                    type: string
                is_archived:
                  type: boolean
                is_marketplace_product:
                  type: boolean
                order_lead_time:
                  type: object
                  nullable: true
                  description: Order lead time before dispatch ({ Days, Hours, Minutes }), forwarded as-is.
                  example:
                    Days: 1
                    Hours: 2
                    Minutes: 0
      responses:
        '200':
          description: The updated product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Product'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteProduct
      summary: Delete a product
      description: |-
        Marketplace/dispatch products (pricing, stock, zone/device association).
        **Example**

        ```bash
        # requires scope: products:write
        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/products/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Products
      security:
        - oauth2:
            - products:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs:
    get:
      operationId: listJobs
      summary: List jobs
      description: >-
        Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only —
        stops/device/user/assignment-type are create-only and frozen after creation to avoid
        triggering dispatch-service ETA recompute, reassignment, or Order-sync.

        **Example**


        ```bash

        # requires scope: jobs:read

        curl -sS 'https://trax-public-api.zendu.one/v1/jobs?device_id=<device_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `created_at:asc`, `created_at:desc`, `due_date:asc`,
            `due_date:desc`. Default `created_at:desc`.
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
              - due_date:asc
              - due_date:desc
            default: created_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
        - name: user_id
          in: query
          required: false
          description: Filter by user_id.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
            enum:
              - Unassigned
              - Assigned
              - Dispatched
              - En_route_stop
              - Arrived_stop
              - Completed_stop
              - Completed
              - Cancelled
              - Rejected
        - name: assignment_type
          in: query
          required: false
          description: Filter by assignment_type.
          schema:
            type: string
            enum:
              - VEHICLE
              - DRIVER
        - name: reference
          in: query
          required: false
          description: Filter by reference.
          schema:
            type: string
      responses:
        '200':
          description: A page of jobs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createJob
      summary: Create a job
      description: >-
        Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only —
        stops/device/user/assignment-type are create-only and frozen after creation to avoid
        triggering dispatch-service ETA recompute, reassignment, or Order-sync.

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/jobs' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "reference": "string",
          "device_id": "string",
          "user_id": "string",
          "assignment_type": "string",
          "due_date": "string",
          "estimated_start_date": "string",
          "notes": [],
          "is_pre_booked": true,
          "custom": {},
          "default_form_id": "string",
          "stops": []
        }'

        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: Job name. Required on create.
                reference:
                  type: string
                device_id:
                  type: string
                user_id:
                  type: string
                assignment_type:
                  type: string
                  enum:
                    - VEHICLE
                    - DRIVER
                  description: >-
                    How the job is assigned. Optional (defaults to `VEHICLE`). Assignment is
                    optional overall — the three shapes are: set `device_id` for a vehicle-assigned
                    job, `user_id` for a driver-assigned job, or omit both to create an Unassigned
                    job.
                due_date:
                  type: string
                  format: date-time
                  description: When the job is due. Required on create and must not be in the past (ISO-8601).
                estimated_start_date:
                  type: string
                  format: date-time
                notes:
                  type: array
                  description: >-
                    Job notes, forwarded as-is (PascalCase sub-keys, matching the stored/downstream
                    shape and the read response) to the dispatch service.
                  items:
                    type: object
                    properties:
                      Text:
                        type: string
                      Username:
                        type: string
                      Files:
                        type: array
                        items:
                          type: string
                      Date:
                        type: string
                        format: date-time
                is_pre_booked:
                  type: boolean
                custom:
                  type: object
                  description: Custom key/value data for app integrations. Values may be string or number.
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: number
                default_form_id:
                  type: string
                stops:
                  type: array
                  minItems: 1
                  description: >-
                    Job stops, forwarded as-is (PascalCase sub-keys, matching the stored/downstream
                    shape and the read response) to the dispatch service. Required on create: at
                    least one stop, and each stop must have numeric `Latitude` and `Longitude` (a
                    non-zero position). `Eta`/`Actual`/`WorkOrders` are read-only.
                  items:
                    type: object
                    properties:
                      Id:
                        type: string
                      Name:
                        type: string
                      Address:
                        type: string
                      CustomerId:
                        type: string
                      Latitude:
                        type: number
                      Longitude:
                        type: number
                      Note:
                        type: string
                      IsStartLocation:
                        type: boolean
                      Eta:
                        type: object
                        readOnly: true
                        description: Server-computed timing. Read-only — has no effect if sent on a write.
                        properties:
                          StopDuration:
                            type: number
                            description: Stop duration, ms.
                          Duration:
                            type: number
                            description: Trip duration, ms.
                          Distance:
                            type: number
                            description: Trip distance, meters.
                          ArrivalDate:
                            type: string
                            format: date-time
                          DepartureDate:
                            type: string
                            format: date-time
                      Actual:
                        type: object
                        readOnly: true
                        description: Server-computed timing. Read-only — has no effect if sent on a write.
                        properties:
                          StopDuration:
                            type: number
                            description: Stop duration, ms.
                          Duration:
                            type: number
                            description: Trip duration, ms.
                          Distance:
                            type: number
                            description: Trip distance, meters.
                          ArrivalDate:
                            type: string
                            format: date-time
                          DepartureDate:
                            type: string
                            format: date-time
                      WorkOrders:
                        type: array
                        readOnly: true
                        description: >-
                          Work orders attached to the stop. Read-only — populated by the dispatch
                          service (Submit), not settable on a write.
                        items:
                          type: object
              required:
                - name
                - due_date
                - stops
      responses:
        '201':
          description: The created job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Job'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs/query:
    post:
      operationId: queryJob
      summary: Query jobs with structured filters
      description: >-
        Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only —
        stops/device/user/assignment-type are create-only and frozen after creation to avoid
        triggering dispatch-service ETA recompute, reassignment, or Order-sync. Structured
        alternative to `GET /jobs` for expressing per-field filters (see "Filtering" in the API
        description).

        **Example**


        ```bash

        # requires scope: jobs:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/jobs/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/JobFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of jobs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs/{id}:
    get:
      operationId: getJob
      summary: Get a job by id
      description: >-
        Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only —
        stops/device/user/assignment-type are create-only and frozen after creation to avoid
        triggering dispatch-service ETA recompute, reassignment, or Order-sync.

        **Example**


        ```bash

        # requires scope: jobs:read

        curl -sS 'https://trax-public-api.zendu.one/v1/jobs/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Job'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateJob
      summary: Update a job
      description: >-
        Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only —
        stops/device/user/assignment-type are create-only and frozen after creation to avoid
        triggering dispatch-service ETA recompute, reassignment, or Order-sync.

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/jobs/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "name": "string",
          "reference": "string",
          "device_id": "string",
          "user_id": "string",
          "assignment_type": "string",
          "due_date": "string",
          "estimated_start_date": "string",
          "notes": [],
          "is_pre_booked": true,
          "custom": {},
          "default_form_id": "string",
          "stops": []
        }'

        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: Job name. Required on create.
                reference:
                  type: string
                device_id:
                  type: string
                user_id:
                  type: string
                assignment_type:
                  type: string
                  enum:
                    - VEHICLE
                    - DRIVER
                  description: >-
                    How the job is assigned. Optional (defaults to `VEHICLE`). Assignment is
                    optional overall — the three shapes are: set `device_id` for a vehicle-assigned
                    job, `user_id` for a driver-assigned job, or omit both to create an Unassigned
                    job.
                due_date:
                  type: string
                  format: date-time
                  description: When the job is due. Required on create and must not be in the past (ISO-8601).
                estimated_start_date:
                  type: string
                  format: date-time
                notes:
                  type: array
                  description: >-
                    Job notes, forwarded as-is (PascalCase sub-keys, matching the stored/downstream
                    shape and the read response) to the dispatch service.
                  items:
                    type: object
                    properties:
                      Text:
                        type: string
                      Username:
                        type: string
                      Files:
                        type: array
                        items:
                          type: string
                      Date:
                        type: string
                        format: date-time
                is_pre_booked:
                  type: boolean
                custom:
                  type: object
                  description: Custom key/value data for app integrations. Values may be string or number.
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: number
                default_form_id:
                  type: string
                stops:
                  type: array
                  minItems: 1
                  description: >-
                    Job stops, forwarded as-is (PascalCase sub-keys, matching the stored/downstream
                    shape and the read response) to the dispatch service. Required on create: at
                    least one stop, and each stop must have numeric `Latitude` and `Longitude` (a
                    non-zero position). `Eta`/`Actual`/`WorkOrders` are read-only.
                  items:
                    type: object
                    properties:
                      Id:
                        type: string
                      Name:
                        type: string
                      Address:
                        type: string
                      CustomerId:
                        type: string
                      Latitude:
                        type: number
                      Longitude:
                        type: number
                      Note:
                        type: string
                      IsStartLocation:
                        type: boolean
                      Eta:
                        type: object
                        readOnly: true
                        description: Server-computed timing. Read-only — has no effect if sent on a write.
                        properties:
                          StopDuration:
                            type: number
                            description: Stop duration, ms.
                          Duration:
                            type: number
                            description: Trip duration, ms.
                          Distance:
                            type: number
                            description: Trip distance, meters.
                          ArrivalDate:
                            type: string
                            format: date-time
                          DepartureDate:
                            type: string
                            format: date-time
                      Actual:
                        type: object
                        readOnly: true
                        description: Server-computed timing. Read-only — has no effect if sent on a write.
                        properties:
                          StopDuration:
                            type: number
                            description: Stop duration, ms.
                          Duration:
                            type: number
                            description: Trip duration, ms.
                          Distance:
                            type: number
                            description: Trip distance, meters.
                          ArrivalDate:
                            type: string
                            format: date-time
                          DepartureDate:
                            type: string
                            format: date-time
                      WorkOrders:
                        type: array
                        readOnly: true
                        description: >-
                          Work orders attached to the stop. Read-only — populated by the dispatch
                          service (Submit), not settable on a write.
                        items:
                          type: object
      responses:
        '200':
          description: The updated job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Job'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteJob
      summary: Delete a job
      description: >-
        Dispatch jobs (work orders) with stops, assignment and status. Update is metadata-only —
        stops/device/user/assignment-type are create-only and frozen after creation to avoid
        triggering dispatch-service ETA recompute, reassignment, or Order-sync.

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/jobs/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /tracker-types:
    get:
      operationId: listTrackerTypes
      summary: List tracker types
      description: >-
        Global device tracker-type catalog (device category, docs and support links; shared
        reference data, no tenant scoping).

        **Example**


        ```bash

        # requires scope: devices:read

        curl -sS 'https://trax-public-api.zendu.one/v1/tracker-types' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Tracker types
      security:
        - oauth2:
            - devices:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: name
          in: query
          required: false
          description: Filter by name. Discover valid values via `GET /v1/tracker-types`.
          schema:
            type: string
      responses:
        '200':
          description: A page of tracker types.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrackerType'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /tracker-types/query:
    post:
      operationId: queryTrackerType
      summary: Query tracker types with structured filters
      description: >-
        Global device tracker-type catalog (device category, docs and support links; shared
        reference data, no tenant scoping). Structured alternative to `GET /tracker-types` for
        expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: devices:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/tracker-types/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Tracker types
      security:
        - oauth2:
            - devices:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/TrackerTypeFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of tracker types.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrackerType'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /tracker-types/{id}:
    get:
      operationId: getTrackerType
      summary: Get a tracker type by id
      description: >-
        Global device tracker-type catalog (device category, docs and support links; shared
        reference data, no tenant scoping).

        **Example**


        ```bash

        # requires scope: devices:read

        curl -sS 'https://trax-public-api.zendu.one/v1/tracker-types/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Tracker types
      security:
        - oauth2:
            - devices:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The tracker type.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TrackerType'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /custom-maps:
    get:
      operationId: listCustomMaps
      summary: List custom maps
      description: |-
        Custom (Indoor/Web) map overlays for a company's locations, tenant-scoped.
        **Example**

        ```bash
        # requires scope: maps:read
        curl -sS 'https://trax-public-api.zendu.one/v1/custom-maps' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Custom maps
      security:
        - oauth2:
            - maps:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: id
          in: query
          required: false
          description: Filter by id.
          schema:
            type: string
        - name: type
          in: query
          required: false
          description: Filter by type.
          schema:
            type: string
            enum:
              - Indoor
              - Web
      responses:
        '200':
          description: A page of custom maps.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomMap'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /custom-maps/query:
    post:
      operationId: queryCustomMap
      summary: Query custom maps with structured filters
      description: >-
        Custom (Indoor/Web) map overlays for a company's locations, tenant-scoped. Structured
        alternative to `GET /custom-maps` for expressing per-field filters (see "Filtering" in the
        API description).

        **Example**


        ```bash

        # requires scope: maps:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/custom-maps/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Custom maps
      security:
        - oauth2:
            - maps:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/CustomMapFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of custom maps.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomMap'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /custom-maps/{id}:
    get:
      operationId: getCustomMap
      summary: Get a custom map by id
      description: |-
        Custom (Indoor/Web) map overlays for a company's locations, tenant-scoped.
        **Example**

        ```bash
        # requires scope: maps:read
        curl -sS 'https://trax-public-api.zendu.one/v1/custom-maps/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Custom maps
      security:
        - oauth2:
            - maps:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The custom map.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomMap'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /comments:
    get:
      operationId: listComments
      summary: List comments
      description: >-
        Comments attached to a parent entity (polymorphic ParentId, commonly a safety event),
        tenant-scoped, list-only, date-cursored.

        **Example**


        ```bash

        # requires scope: comments:read

        curl -sS 'https://trax-public-api.zendu.one/v1/comments' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Comments
      security:
        - oauth2:
            - comments:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: 'Sort order. One of: `created_at:asc`, `created_at:desc`. Default `created_at:desc`.'
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
            default: created_at:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: parent_id
          in: query
          required: true
          description: Filter by parent_id. Required.
          schema:
            type: string
      responses:
        '200':
          description: A page of comments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Comment'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /comments/query:
    post:
      operationId: queryComment
      summary: Query comments with structured filters
      description: >-
        Comments attached to a parent entity (polymorphic ParentId, commonly a safety event),
        tenant-scoped, list-only, date-cursored. Structured alternative to `GET /comments` for
        expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: comments:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/comments/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Comments
      security:
        - oauth2:
            - comments:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/CommentFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of comments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Comment'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /users:
    get:
      operationId: listUsers
      summary: List users
      description: >-
        All users (from the users collection, not just drivers; filter with `is_driver` to narrow);
        credentials and security state are never exposed.

        **Example**


        ```bash

        # requires scope: users:read

        curl -sS 'https://trax-public-api.zendu.one/v1/users' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Users
      security:
        - oauth2:
            - users:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `created_at:asc`, `created_at:desc`, `last_login:asc`,
            `last_login:desc`.
          schema:
            type: string
            enum:
              - created_at:asc
              - created_at:desc
              - last_login:asc
              - last_login:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: username
          in: query
          required: false
          description: Filter by username.
          schema:
            type: string
        - name: is_driver
          in: query
          required: false
          description: Filter by is_driver.
          schema:
            type: string
        - name: group_id
          in: query
          required: false
          description: Filter by group_id.
          schema:
            type: string
      responses:
        '200':
          description: A page of users.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createUser
      summary: Create a user
      description: >-
        All users (from the users collection, not just drivers; filter with `is_driver` to narrow);
        credentials and security state are never exposed.

        **Example**


        ```bash

        # requires scope: users:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/users' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "username": "string",
          "first_name": "string",
          "last_name": "string",
          "group_ids": [],
          "email": "string",
          "phone": "string",
          "units": "string",
          "language": "string",
          "user_type": "string",
          "employee_id": "string",
          "license_number": "string",
          "license_state": "string",
          "license_country": "string",
          "working_hours": {},
          "password": "string",
          "time_zone": "string",
          "photo_url": "string",
          "region_ids": [],
          "business_group_ids": [],
          "people_group_ids": [],
          "can_assign_job_itself": true,
          "default_view": "string",
          "fetch_location_from_mobile": true,
          "feature_preview": true,
          "supervisor_ids": [],
          "driver_app_data": {},
          "map_provider": "string",
          "custom_fields": {},
          "driver_identification": "string",
          "show_self_data": true,
          "comments": "string",
          "live_notification_settings": {},
          "hos_enabled": true,
          "hos_exempted": true,
          "rule_set": "string",
          "us_hos_cycle": "string",
          "home_terminal_name": "string",
          "home_terminal_address": {},
          "exemption_annotation": "string",
          "yard_move_allowed": true,
          "personal_conveyance_allowed": true,
          "pinned_add_in_ids": []
        }'

        ```
      tags:
        - Users
      security:
        - oauth2:
            - users:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                username:
                  type: string
                  description: >-
                    Login username. Required on create; create-only. A `password` is auto-generated
                    when omitted.
                first_name:
                  type: string
                last_name:
                  type: string
                group_ids:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: >-
                    Group ids the user belongs to. Required on create — at least one group must be
                    supplied.
                email:
                  type: string
                phone:
                  type: string
                units:
                  type: string
                language:
                  type: string
                user_type:
                  type: string
                  description: >-
                    User role. Optional — defaults to `Driver`; an unrecognised value is rejected on
                    create with "Invalid UserType".
                employee_id:
                  type: string
                license_number:
                  type: string
                license_state:
                  type: string
                license_country:
                  type: string
                working_hours:
                  type: object
                  description: >-
                    Per-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: {
                    from, to } }, … }).
                  example:
                    Mon:
                      active: true
                      hours:
                        from: '09:00'
                        to: '17:00'
                password:
                  type: string
                  format: password
                  description: >-
                    Initial password; hashed server-side, never returned. Optional — auto-generated
                    when omitted.
                time_zone:
                  type: string
                photo_url:
                  type: string
                region_ids:
                  type: array
                  items:
                    type: string
                business_group_ids:
                  type: array
                  items:
                    type: string
                people_group_ids:
                  type: array
                  items:
                    type: string
                can_assign_job_itself:
                  type: boolean
                default_view:
                  type: string
                fetch_location_from_mobile:
                  type: boolean
                feature_preview:
                  type: boolean
                supervisor_ids:
                  type: array
                  items:
                    type: string
                driver_app_data:
                  type: object
                  nullable: true
                  description: Driver app data — check-in/out, breaks, work-time tracking, forwarded as-is.
                map_provider:
                  type: string
                custom_fields:
                  type: object
                  description: Tenant-defined custom field values, keyed by field name, forwarded as-is.
                driver_identification:
                  type: string
                show_self_data:
                  type: boolean
                comments:
                  type: string
                live_notification_settings:
                  type: object
                  nullable: true
                  description: Live-notification preferences, forwarded as-is.
                hos_enabled:
                  type: boolean
                hos_exempted:
                  type: boolean
                rule_set:
                  type: string
                us_hos_cycle:
                  type: string
                home_terminal_name:
                  type: string
                home_terminal_address:
                  type: object
                  nullable: true
                  description: >-
                    Home-terminal location ({ Location: { latitude, longitude }, LocationName }),
                    forwarded as-is.
                  example:
                    Location:
                      latitude: 43.6532
                      longitude: -79.3832
                    LocationName: Main Depot
                exemption_annotation:
                  type: string
                yard_move_allowed:
                  type: boolean
                personal_conveyance_allowed:
                  type: boolean
                pinned_add_in_ids:
                  type: array
                  items:
                    type: string
              required:
                - username
                - group_ids
      responses:
        '201':
          description: The created user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /users/query:
    post:
      operationId: queryUser
      summary: Query users with structured filters
      description: >-
        All users (from the users collection, not just drivers; filter with `is_driver` to narrow);
        credentials and security state are never exposed. Structured alternative to `GET /users` for
        expressing per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: users:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/users/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Users
      security:
        - oauth2:
            - users:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/UserFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                include:
                  type: array
                  items:
                    type: string
                  description: Relationships to expand inline (allow-listed per resource).
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
              additionalProperties: false
      responses:
        '200':
          description: A page of users.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /users/{id}:
    get:
      operationId: getUser
      summary: Get a user by id
      description: >-
        All users (from the users collection, not just drivers; filter with `is_driver` to narrow);
        credentials and security state are never exposed.

        **Example**


        ```bash

        # requires scope: users:read

        curl -sS 'https://trax-public-api.zendu.one/v1/users/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Users
      security:
        - oauth2:
            - users:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
      responses:
        '200':
          description: The user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateUser
      summary: Update a user
      description: >-
        All users (from the users collection, not just drivers; filter with `is_driver` to narrow);
        credentials and security state are never exposed.

        **Example**


        ```bash

        # requires scope: users:write

        curl -sS -X PATCH 'https://trax-public-api.zendu.one/v1/users/<id>' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "first_name": "string",
          "last_name": "string",
          "group_ids": [],
          "email": "string",
          "phone": "string",
          "units": "string",
          "language": "string",
          "user_type": "string",
          "employee_id": "string",
          "license_number": "string",
          "license_state": "string",
          "license_country": "string",
          "working_hours": {},
          "time_zone": "string",
          "photo_url": "string",
          "region_ids": [],
          "business_group_ids": [],
          "people_group_ids": [],
          "can_assign_job_itself": true,
          "default_view": "string",
          "fetch_location_from_mobile": true,
          "feature_preview": true,
          "supervisor_ids": [],
          "driver_app_data": {},
          "map_provider": "string",
          "custom_fields": {},
          "driver_identification": "string",
          "show_self_data": true,
          "comments": "string",
          "live_notification_settings": {},
          "hos_enabled": true,
          "hos_exempted": true,
          "rule_set": "string",
          "us_hos_cycle": "string",
          "home_terminal_name": "string",
          "home_terminal_address": {},
          "exemption_annotation": "string",
          "yard_move_allowed": true,
          "personal_conveyance_allowed": true,
          "pinned_add_in_ids": []
        }'

        ```
      tags:
        - Users
      security:
        - oauth2:
            - users:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                first_name:
                  type: string
                last_name:
                  type: string
                group_ids:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: >-
                    Group ids the user belongs to. Required on create — at least one group must be
                    supplied.
                email:
                  type: string
                phone:
                  type: string
                units:
                  type: string
                language:
                  type: string
                user_type:
                  type: string
                  description: >-
                    User role. Optional — defaults to `Driver`; an unrecognised value is rejected on
                    create with "Invalid UserType".
                employee_id:
                  type: string
                license_number:
                  type: string
                license_state:
                  type: string
                license_country:
                  type: string
                working_hours:
                  type: object
                  description: >-
                    Per-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: {
                    from, to } }, … }).
                  example:
                    Mon:
                      active: true
                      hours:
                        from: '09:00'
                        to: '17:00'
                time_zone:
                  type: string
                photo_url:
                  type: string
                region_ids:
                  type: array
                  items:
                    type: string
                business_group_ids:
                  type: array
                  items:
                    type: string
                people_group_ids:
                  type: array
                  items:
                    type: string
                can_assign_job_itself:
                  type: boolean
                default_view:
                  type: string
                fetch_location_from_mobile:
                  type: boolean
                feature_preview:
                  type: boolean
                supervisor_ids:
                  type: array
                  items:
                    type: string
                driver_app_data:
                  type: object
                  nullable: true
                  description: Driver app data — check-in/out, breaks, work-time tracking, forwarded as-is.
                map_provider:
                  type: string
                custom_fields:
                  type: object
                  description: Tenant-defined custom field values, keyed by field name, forwarded as-is.
                driver_identification:
                  type: string
                show_self_data:
                  type: boolean
                comments:
                  type: string
                live_notification_settings:
                  type: object
                  nullable: true
                  description: Live-notification preferences, forwarded as-is.
                hos_enabled:
                  type: boolean
                hos_exempted:
                  type: boolean
                rule_set:
                  type: string
                us_hos_cycle:
                  type: string
                home_terminal_name:
                  type: string
                home_terminal_address:
                  type: object
                  nullable: true
                  description: >-
                    Home-terminal location ({ Location: { latitude, longitude }, LocationName }),
                    forwarded as-is.
                  example:
                    Location:
                      latitude: 43.6532
                      longitude: -79.3832
                    LocationName: Main Depot
                exemption_annotation:
                  type: string
                yard_move_allowed:
                  type: boolean
                personal_conveyance_allowed:
                  type: boolean
                pinned_add_in_ids:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: The updated user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteUser
      summary: Delete a user
      description: >-
        All users (from the users collection, not just drivers; filter with `is_driver` to narrow);
        credentials and security state are never exposed.

        **Example**


        ```bash

        # requires scope: users:write

        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/users/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Users
      security:
        - oauth2:
            - users:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Deleted the user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /coaching-sessions:
    get:
      operationId: listCoachingSessions
      summary: List coaching sessions
      description: >-
        Driver coaching deliveries (AI or manual): who was coached, when, on which safety events,
        and the delivery status.

        **Example**


        ```bash

        # requires scope: coaching:read

        curl -sS
        'https://trax-public-api.zendu.one/v1/coaching-sessions?driver_id=<driver_id>&device_id=<device_id>'
        \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Coaching sessions
      security:
        - oauth2:
            - coaching:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: sort
          in: query
          required: false
          description: >-
            Sort order. One of: `coaching_date:asc`, `coaching_date:desc`. Default
            `coaching_date:desc`.
          schema:
            type: string
            enum:
              - coaching_date:asc
              - coaching_date:desc
            default: coaching_date:desc
        - name: count
          in: query
          required: false
          description: >-
            When `true`, also returns `meta.total` — the total number of rows matching the query,
            ignoring pagination. Costs an extra count query, so it's opt-in.
          schema:
            type: boolean
        - name: driver_id
          in: query
          required: false
          description: Filter by driver_id.
          schema:
            type: string
        - name: device_id
          in: query
          required: false
          description: Filter by device_id.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status.
          schema:
            type: string
            enum:
              - Pending
              - WaitingForSafeWindow
              - Delivering
              - Completed
              - Cancelled
              - Failed
        - name: method
          in: query
          required: false
          description: Filter by method.
          schema:
            type: string
            enum:
              - AI
              - MANUAL
      responses:
        '200':
          description: A page of coaching sessions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CoachingSession'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /coaching-sessions/query:
    post:
      operationId: queryCoachingSession
      summary: Query coaching sessions with structured filters
      description: >-
        Driver coaching deliveries (AI or manual): who was coached, when, on which safety events,
        and the delivery status. Structured alternative to `GET /coaching-sessions` for expressing
        per-field filters (see "Filtering" in the API description).

        **Example**


        ```bash

        # requires scope: coaching:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/coaching-sessions/query' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "filters": {},
          "limit": 100
        }'

        ```
      tags:
        - Coaching sessions
      security:
        - oauth2:
            - coaching:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                See "Filtering" in the API description for the full `filters` shape and operator
                list.
              properties:
                filters:
                  $ref: '#/components/schemas/CoachingSessionFilter'
                fields:
                  type: array
                  items:
                    type: string
                  description: Optional fields to include beyond the defaults.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Page size (default 100, max 1000).
                cursor:
                  type: string
                  description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
                from:
                  type: string
                  format: date
                  description: >-
                    Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is
                    accepted.
                to:
                  type: string
                  format: date
                  description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
              additionalProperties: false
      responses:
        '200':
          description: A page of coaching sessions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CoachingSession'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /coaching-sessions/{id}:
    get:
      operationId: getCoachingSession
      summary: Get a coaching session by id
      description: >-
        Driver coaching deliveries (AI or manual): who was coached, when, on which safety events,
        and the delivery status.

        **Example**


        ```bash

        # requires scope: coaching:read

        curl -sS 'https://trax-public-api.zendu.one/v1/coaching-sessions/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Coaching sessions
      security:
        - oauth2:
            - coaching:read
      parameters:
        - $ref: '#/components/parameters/idPath'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The coaching session.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CoachingSession'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /devices/{id}/status:
    get:
      operationId: getDeviceStatus
      summary: Get a device's current state
      description: |-

        **Example**

        ```bash
        # requires scope: devices:read
        curl -sS 'https://trax-public-api.zendu.one/v1/devices/<id>/status' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:read
      parameters:
        - $ref: '#/components/parameters/idPath'
      responses:
        '200':
          description: Current device state (live position, ignition).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DeviceStatus'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /company:
    get:
      operationId: getCompany
      summary: Get the caller's company
      description: |-
        Company details for the authenticated token's tenant, including timezone.
        **Example**

        ```bash
        # requires: a valid access token (no scope)
        curl -sS 'https://trax-public-api.zendu.one/v1/company' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Company
      security:
        - oauth2: []
      responses:
        '200':
          description: The caller's company.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Company'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /summaries/driver/{driverId}:
    get:
      operationId: getDriverSummary
      summary: Get a driver summary for a date range
      description: |-

        **Example**

        ```bash
        # requires scope: summaries:read
        curl -sS 'https://trax-public-api.zendu.one/v1/summaries/driver/<driverId>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Summaries
      security:
        - oauth2:
            - summaries:read
      parameters:
        - name: driverId
          in: path
          required: true
          description: The driver id.
          schema:
            type: string
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The aggregated driver summary.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DriverSummary'
                  meta:
                    $ref: '#/components/schemas/SummaryMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /summaries/vehicle/{deviceId}:
    get:
      operationId: getVehicleSummary
      summary: Get a vehicle summary for a date range
      description: |-

        **Example**

        ```bash
        # requires scope: summaries:read
        curl -sS 'https://trax-public-api.zendu.one/v1/summaries/vehicle/<deviceId>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Summaries
      security:
        - oauth2:
            - summaries:read
      parameters:
        - name: deviceId
          in: path
          required: true
          description: The device id.
          schema:
            type: string
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: The aggregated vehicle summary.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/VehicleSummary'
                  meta:
                    $ref: '#/components/schemas/SummaryMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /ifta-summaries:
    get:
      operationId: listIftaSummaries
      summary: List IFTA / state-mileage summaries
      description: >-
        Distance by vehicle × jurisdiction × month, aggregated from trips. State is the trip's start
        jurisdiction (cross-state trips are not split). Only trips with a resolved start state are
        included. Max range 31 days (paginate longer spans yourself).

        **Example**


        ```bash

        # requires scope: ifta:read

        curl -sS 'https://trax-public-api.zendu.one/v1/ifta-summaries?device_id=<device_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Summaries
      security:
        - oauth2:
            - ifta:read
      parameters:
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - name: device_id
          in: query
          required: false
          description: Filter to a single vehicle.
          schema:
            type: string
      responses:
        '200':
          description: A page of IFTA summary rows.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IftaSummary'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /form-dispatches:
    post:
      operationId: createFormDispatch
      summary: Send a form to drivers/groups (dispatch task)
      description: >-
        Dispatches a form to one or more drivers and/or groups ("Send Task"). Create-only action,
        not a CRUD entity — see `forms` for form definitions, `form-submissions` for completed
        dispatches, and `form-schedules` for recurring schedules. At least one of
        `driver_ids`/`group_ids` is required.

        **Example**


        ```bash

        # requires scope: forms:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/form-dispatches' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "form_id": "string",
          "driver_ids": [],
          "group_ids": [],
          "note": "string",
          "dispatch_location": "string"
        }'

        ```
      tags:
        - Forms
      security:
        - oauth2:
            - forms:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                form_id:
                  type: string
                  description: The form to dispatch. Must belong to the caller's company.
                driver_ids:
                  type: array
                  items:
                    type: string
                  description: >-
                    Drivers to dispatch the form to. At least one of `driver_ids`/`group_ids` is
                    required.
                group_ids:
                  type: array
                  items:
                    type: string
                  description: >-
                    Groups to dispatch the form to (resolved to their member drivers). At least one
                    of `driver_ids`/`group_ids` is required.
                note:
                  type: string
                dispatch_location:
                  $ref: '#/components/schemas/FormDispatchLocation'
              required:
                - form_id
      responses:
        '201':
          description: Dispatch created — one task per recipient driver.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormDispatchResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /files:
    post:
      operationId: uploadFile
      summary: Upload a file
      description: >-
        Uploads a file to private cloud storage and returns an opaque `id`. The file is stored under
        the caller's company and is NOT publicly accessible — retrieve it with `GET /v1/files/{id}`,
        which returns a short-lived signed URL. Send the file as `multipart/form-data` in a field
        named `file`. Allowed types: jpg, jpeg, png, pdf, csv, xls, xlsx (max 30 MB per file). Each
        company has an aggregate storage limit of 5 GB across all uploaded files; once reached,
        further uploads return `507 Insufficient Storage`.

        **Example**


        ```bash

        # requires scope: files:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/v1/files' \
          -H 'Authorization: Bearer <token>' \
          -F 'file=@/path/to/document.pdf'
        ```
      tags:
        - Files
      security:
        - oauth2:
            - files:write
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    The file to upload. Allowed types: jpg, jpeg, png, pdf, csv, xls, xlsx. Max 30
                    MB.
              required:
                - file
      responses:
        '201':
          description: File stored.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FileUploadResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
        '507':
          description: Company aggregate storage quota (5 GB across all files) exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /files/{id}:
    get:
      operationId: getFileDownloadUrl
      summary: Get a file download URL
      description: >-
        Returns a short-lived signed URL for a previously uploaded file. The `id` is the value
        returned by `POST /v1/files`. Only files uploaded by the caller's own company are
        retrievable.

        **Example**


        ```bash

        # requires scope: files:read

        curl -sS 'https://trax-public-api.zendu.one/v1/v1/files/<id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Files
      security:
        - oauth2:
            - files:read
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The file id returned by POST /v1/files.
      responses:
        '200':
          description: A signed download URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FileDownloadUrl'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/video-requests:
    post:
      operationId: createMediaVideoRequest
      summary: Request a video clip from a device
      description: >-
        Requests a video clip for a device over a time range. Asynchronous: returns a `task_id`;
        poll `GET /v1/media/tasks/{task_id}` for the result. Results expire ~20 minutes after
        completion, and a task may stay `pending` until the device next comes online.

        **Example**


        ```bash

        # requires scope: media:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/media/video-requests' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string",
          "from": "string",
          "time_length_ms": 0
        }'

        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The camera device to request media from.
                from:
                  type: string
                  format: date-time
                  description: Start of the requested time range (ISO 8601).
                time_length_ms:
                  type: integer
                  description: >-
                    Length of the requested clip in milliseconds. Defaults to a provider-specific
                    value when omitted.
              required:
                - device_id
                - from
      responses:
        '200':
          description: Video request accepted — returns a task id.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MediaTaskResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/snapshot-requests:
    post:
      operationId: createMediaSnapshotRequest
      summary: Request a snapshot from a device
      description: >-
        Requests a snapshot for a device over a time range. Asynchronous: returns a `task_id`; poll
        `GET /v1/media/tasks/{task_id}` for the result. Results expire ~20 minutes after completion,
        and a task may stay `pending` until the device next comes online.

        **Example**


        ```bash

        # requires scope: media:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/media/snapshot-requests' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string",
          "from": "string",
          "time_length_ms": 0
        }'

        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The camera device to request media from.
                from:
                  type: string
                  format: date-time
                  description: Start of the requested time range (ISO 8601).
                time_length_ms:
                  type: integer
                  description: >-
                    Length of the requested clip in milliseconds. Defaults to a provider-specific
                    value when omitted.
              required:
                - device_id
                - from
      responses:
        '200':
          description: Snapshot request accepted — returns a task id.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MediaTaskResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/tasks/{task_id}:
    get:
      operationId: getMediaTaskStatus
      summary: Get a media task's status/result
      description: >-
        Polls the status of an async video/snapshot request. `status` is one of `pending` (device
        not yet responded — may remain `pending` until the device next comes online), `completed`
        (`result` present), `failed` (see `message`), or `expired` (the ~20-minute result TTL
        elapsed before it was retrieved).

        **Example**


        ```bash

        # requires scope: media:read

        curl -sS 'https://trax-public-api.zendu.one/v1/media/tasks/<task_id>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:read
      parameters:
        - name: task_id
          in: path
          required: true
          schema:
            type: string
          description: >-
            The task id returned by POST /v1/media/video-requests or POST
            /v1/media/snapshot-requests.
      responses:
        '200':
          description: Task status (and result, when completed).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MediaTaskStatus'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/live-streams:
    post:
      operationId: createMediaLiveStream
      summary: Get a live stream URL for a device
      description: >-
        Returns live stream source(s) for a device's camera channel(s). Synchronous — no polling
        required. `format`/`protocol` and the `raw` payload are provider-dependent (shape varies by
        camera provider).

        **Example**


        ```bash

        # requires scope: media:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/media/live-streams' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string",
          "channels": [],
          "format": "string"
        }'

        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The camera device to stream from.
                channels:
                  type: array
                  items:
                    type: integer
                  description: Camera channels to stream. All channels if omitted.
                format:
                  type: string
                  description: Requested stream format (provider-dependent).
              required:
                - device_id
      responses:
        '200':
          description: Live stream source(s).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LiveSource'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/historical-streams:
    post:
      operationId: createMediaHistoricalStream
      summary: Get a historical stream URL for a device
      description: >-
        Returns historical stream source(s) for a device's camera over a time range. Synchronous —
        no polling required. The requested range is capped at 10 minutes.

        **Example**


        ```bash

        # requires scope: media:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/media/historical-streams' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string",
          "from": "string",
          "stream_type": 0
        }'

        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The camera device to stream from.
                from:
                  type: string
                  format: date-time
                  description: Start of the requested time range (ISO 8601). Max range is 10 minutes.
                stream_type:
                  type: integer
                  description: Provider-specific stream type selector.
              required:
                - device_id
                - from
      responses:
        '200':
          description: Historical stream source(s).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LiveSource'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/recordings:
    post:
      operationId: createMediaRecordings
      summary: List recording segments for a device over a time range
      description: >-
        Returns the available recording SEGMENTS for a device's camera over a time range — an INDEX
        of footage windows (`date_from`/`date_to`/`channel`/`stream_type`), NOT downloadable files
        (the DVR generates media on demand). Typical flow: (1) call this to discover what footage
        exists, then for a chosen segment either (2a) WATCH it — `POST /media/historical-streams`
        with the segment's `date_from` returns a playable stream URL, or (2b) DOWNLOAD a clip —
        `POST /media/video-requests` with the window returns a `task_id`; poll `GET
        /media/tasks/{task_id}` for the resulting `MediaItem` (with a `url`). This listing call
        itself is synchronous — no polling required.

        **Example**


        ```bash

        # requires scope: media:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/media/recordings' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string",
          "from": "string"
        }'

        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The camera device to fetch recordings for.
                from:
                  type: string
                  format: date-time
                  description: Start of the requested time range (ISO 8601).
              required:
                - device_id
                - from
      responses:
        '200':
          description: Available recording segments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RecordingSegment'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /media/wake:
    post:
      operationId: createMediaWake
      summary: Wake a camera device from standby
      description: |-
        Wakes a camera from standby so it can respond to subsequent media requests.
        **Example**

        ```bash
        # requires scope: media:write
        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/media/wake' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string"
        }'
        ```
      tags:
        - Media
      security:
        - oauth2:
            - media:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The camera device to wake from standby.
              required:
                - device_id
      responses:
        '200':
          description: Wake request sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MediaWakeResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /geocoding/addresses:
    post:
      operationId: createGeocodingAddresses
      summary: Reverse-geocode coordinates to addresses
      description: >-
        Reverse-geocodes a list of coordinates to formatted addresses, along with the company's
        containing zone for each coordinate (when it falls inside one). Results are returned in the
        same order as the input `coordinates`.

        **Example**


        ```bash

        # requires scope: geocoding:read

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/geocoding/addresses' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "coordinates": []
        }'

        ```
      tags:
        - Geocoding
      security:
        - oauth2:
            - geocoding:read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                coordinates:
                  type: array
                  items:
                    $ref: '#/components/schemas/Coordinate'
                  description: Coordinates to reverse-geocode. Must be non-empty.
              required:
                - coordinates
      responses:
        '200':
          description: Reverse-geocoded addresses.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/GeocodedAddress'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /tts/messages:
    post:
      operationId: createTtsMessage
      summary: Send a text-to-speech message to StreamMax cameras
      description: >-
        Sends a text-to-speech audio message to one or more StreamMax camera devices. Synchronous —
        no polling required. Text is capped at 150 characters. Devices that are not StreamMax (or
        otherwise reject the message) come back in `failed` alongside any devices that succeeded in
        `success`.

        **Example**


        ```bash

        # requires scope: tts:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/tts/messages' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_ids": [],
          "text": "string",
          "language": "string"
        }'

        ```
      tags:
        - TTS
      security:
        - oauth2:
            - tts:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_ids:
                  type: array
                  items:
                    type: string
                  description: >-
                    StreamMax camera devices to send the message to. Non-StreamMax devices come back
                    in `failed`.
                text:
                  type: string
                  maxLength: 150
                  description: Message text to speak. Max 150 characters.
                language:
                  type: string
                  enum:
                    - english
                    - spanish
                  description: Voice language. Defaults to english.
              required:
                - device_ids
                - text
      responses:
        '200':
          description: Per-device send result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TtsMessageResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /devices/{id}/assign-driver:
    post:
      operationId: assignDeviceDriver
      summary: Assign a driver to a device
      description: >-
        Assigns a primary driver (and optional additional drivers) to a device. An action, not a
        CRUD write — `assigned_driver_id` on the device is read-only; use this endpoint to change
        it. Assigning a primary driver auto-unassigns them from any other device.

        **Example**


        ```bash

        # requires scope: devices:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/devices/<id>/assign-driver' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "driver_id": "string",
          "additional_driver_ids": []
        }'

        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                driver_id:
                  type: string
                  description: >-
                    The primary driver to assign. Must belong to the caller's company. Assigning a
                    primary driver auto-unassigns them from any other device.
                additional_driver_ids:
                  type: array
                  items:
                    type: string
                  description: >-
                    Optional additional drivers to assign alongside the primary. Must belong to the
                    caller's company.
              required:
                - driver_id
      responses:
        '200':
          description: Driver assigned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DeviceDriverResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /devices/{id}/remove-driver:
    post:
      operationId: removeDeviceDriver
      summary: Remove drivers from a device
      description: >-
        Removes one or more drivers (primary and/or additional) from a device. An action, not a CRUD
        write — `assigned_driver_id` on the device is read-only; use this endpoint to change it.

        **Example**


        ```bash

        # requires scope: devices:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/devices/<id>/remove-driver' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "driver_ids": []
        }'

        ```
      tags:
        - Devices
      security:
        - oauth2:
            - devices:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                driver_ids:
                  type: array
                  items:
                    type: string
                  description: >-
                    Drivers to remove from the device (primary and/or additional). Must be a
                    non-empty array.
              required:
                - driver_ids
      responses:
        '200':
          description: Drivers removed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DeviceDriverResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /drivers/{id}/reset-password:
    post:
      operationId: resetDriverPassword
      summary: Reset a driver's password
      description: >-
        Resets a driver's password. An action, not a CRUD write — `password` on the `drivers` entity
        is create-only + write-only (never returned), so a password *change* has no PATCH body to
        ride on; use this endpoint instead.

        **Example**


        ```bash

        # requires scope: drivers:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/drivers/<id>/reset-password' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "password": "string"
        }'

        ```
      tags:
        - Drivers
      security:
        - oauth2:
            - drivers:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                password:
                  type: string
                  format: password
                  description: The new plaintext password; hashed server-side, never returned.
              required:
                - password
      responses:
        '200':
          description: Password reset.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/UserResetPasswordResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs/{id}/submit:
    post:
      operationId: submitJob
      summary: Submit a job's work order
      description: >-
        Submits part or all of a job's work order. An action, not a CRUD write — status/assignment
        transitions on `jobs` happen through action endpoints, never a direct field write.

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/jobs/<id>/submit' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "work_order_id": "string",
          "data": "string",
          "form_data": "string"
        }'

        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                work_order_id:
                  type: string
                  description: The work order (on this job's stop) being submitted.
                data:
                  description: >-
                    Submitted work-order data — form field values, forwarded as-is to the dispatch
                    service.
                form_data:
                  description: Optional additional form data captured with the submission.
              required:
                - work_order_id
                - data
      responses:
        '200':
          description: Work order submitted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/JobActionResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs/{id}/assign-device:
    post:
      operationId: assignJobDevice
      summary: Assign a device to a job
      description: >-
        Assigns (or reassigns) the device running this job. An action, not a CRUD write —
        `device_id` is frozen on the `jobs` entity's own update; use this endpoint to change it.

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/jobs/<id>/assign-device' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "device_id": "string",
          "scheduled_date": "string"
        }'

        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                device_id:
                  type: string
                  description: The device to run this job. Must belong to the caller's company.
                scheduled_date:
                  type: string
                  format: date-time
                  description: Optional scheduled start time for the job.
              required:
                - device_id
      responses:
        '200':
          description: Device assigned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/JobActionResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs/{id}/stops:
    post:
      operationId: addJobStop
      summary: Add a stop to a job
      description: >-
        Adds a stop to the job's route. An action, not a CRUD write — `stops` is frozen on the
        `jobs` entity's own update (changing stops after creation triggers ETA recompute and route
        validation); use this endpoint to add one.

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/jobs/<id>/stops' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "stop": "string"
        }'

        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                stop:
                  $ref: '#/components/schemas/JobStopCreate'
              required:
                - stop
      responses:
        '201':
          description: Stop added.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/JobAddStopResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /jobs/{id}/stops/{stopId}:
    delete:
      operationId: deleteJobStop
      summary: Delete a stop from a job
      description: >-
        Removes a stop from the job's route (the dispatch service rejects deleting a job's last
        remaining stop).

        **Example**


        ```bash

        # requires scope: jobs:write

        curl -sS -X DELETE 'https://trax-public-api.zendu.one/v1/jobs/<id>/stops/<stopId>' \
          -H 'Authorization: Bearer <token>'
        ```
      tags:
        - Jobs
      security:
        - oauth2:
            - jobs:write
      parameters:
        - $ref: '#/components/parameters/idPath'
        - name: stopId
          in: path
          required: true
          schema:
            type: string
          description: The stop to delete.
      responses:
        '200':
          description: Stop deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/JobActionResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /repair-orders/{id}/status:
    post:
      operationId: changeRepairOrderStatus
      summary: Change a repair order's status
      description: >-
        Changes a repair order's status. An action, not a CRUD write — status transitions on
        `repair-orders` happen through this endpoint, never a direct field write. `status` must be
        one of the allow-listed values.

        **Example**


        ```bash

        # requires scope: maintenance:write

        curl -sS -X POST 'https://trax-public-api.zendu.one/v1/repair-orders/<id>/status' \
          -H 'Authorization: Bearer <token>' \
          -H 'Content-Type: application/json' \
          -d '{
          "status": "string"
        }'

        ```
      tags:
        - Maintenance
      security:
        - oauth2:
            - maintenance:write
      parameters:
        - $ref: '#/components/parameters/idPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                status:
                  type: string
                  enum:
                    - Pending Assignment
                    - Assigned
                    - In Progress
                    - On Hold
                    - Completed
                    - Cancelled
                  description: The new repair order status.
              required:
                - status
      responses:
        '200':
          description: Status changed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RepairOrderChangeStatusResult'
                  meta:
                    $ref: '#/components/schemas/BaseMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 **client-credentials** grant. Exchange your `client_id` + `client_secret` for a
        bearer token, then send it as `Authorization: Bearer <access_token>` on every request.


        **Get a token** — `POST https://service-prod.zendu.one/Public/OAuth/Token` with a
        form-urlencoded (or JSON) body:


        ```bash

        curl -sS -X POST 'https://service-prod.zendu.one/Public/OAuth/Token' \
          -H 'Content-Type: application/x-www-form-urlencoded' \
          -d grant_type=client_credentials \
          -d client_id=YOUR_CLIENT_ID \
          -d client_secret=YOUR_CLIENT_SECRET
        ```


        Response: `{ "access_token": "...", "token_type": "Bearer", "expires_in": 3600, "scope":
        "..." }`. The optional space-separated `scope` parameter narrows the token to specific
        scopes (omit it to receive every scope granted to the client; requesting a scope the client
        was not granted returns `400 invalid_scope`). Tokens last `expires_in` seconds (1 hour) —
        cache and reuse until expiry, then mint a new one.
      flows:
        clientCredentials:
          tokenUrl: https://service-prod.zendu.one/Public/OAuth/Token
          scopes:
            coaching:read: Read driver coaching sessions
            comments:read: comments:read
            devices:read: Read devices and their live status
            devices:write: Create devices, update device metadata, and assign/remove drivers
            diagnostics:read: Read diagnostic readings
            drivers:read: Read drivers
            drivers:write: Create, update and delete drivers, and reset a driver's password
            faults:read: Read vehicle faults and the fault-code catalog
            files:read: Get a download URL for an uploaded file
            files:write: Upload files
            forms:read: Read forms, submissions and schedules
            forms:write: Deactivate forms; send (dispatch) a form to drivers/groups
            geocoding:read: Reverse-geocode coordinates to addresses and the company's containing zones
            groups:read: Read groups
            groups:write: Create, update and delete groups
            ifta:read: Read IFTA / state-mileage summaries
            jobs:read: Read dispatch jobs
            jobs:write: Create dispatch jobs; update job metadata; delete dispatch jobs
            locations:read: Read historical vehicle locations
            maintenance:read: Read maintenance requests and repair orders
            maintenance:write: Create, update and cancel maintenance requests and repair orders
            maps:read: maps:read
            media:read: Read camera media — live/historical stream URLs, recordings, and media task status
            media:write: Request camera media (video/snapshot jobs) and wake devices
            products:read: Read products
            products:write: Create, update and delete products
            rules:read: Read rules
            safety:read: Read safety events
            summaries:read: Read driver and vehicle summaries
            trips:read: Read trips
            tts:write: Send a text-to-speech audio message to StreamMax cameras
            users:read: users:read
            users:write: users:write
            zones:read: Read zones / geofences
            zones:write: Create, update and delete geofence zones
  parameters:
    cursor:
      name: cursor
      in: query
      required: false
      description: Keyset pagination cursor (pass the previous response's `meta.next_cursor`).
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      description: Page size (default 100, max 1000).
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated optional fields to include beyond the defaults.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    include:
      name: include
      in: query
      required: false
      description: Comma-separated relationships to expand inline (allow-listed per resource).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    from:
      name: from
      in: query
      required: false
      description: Inclusive start of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
      schema:
        type: string
        format: date
    to:
      name: to
      in: query
      required: false
      description: Inclusive end of the range. ISO-8601 date (YYYY-MM-DD) or datetime is accepted.
      schema:
        type: string
        format: date
    idPath:
      name: id
      in: path
      required: true
      description: Resource id.
      schema:
        type: string
  responses:
    BadRequest:
      description: Invalid request (e.g. a date range longer than 31 days).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The token lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource for this tenant.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Device:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        serial:
          type: string
          description: >-
            Device hardware serial (ESN/IMEI). Optional, but must be unique within the company when
            supplied. Create-only (frozen after creation).
        type:
          type: string
          description: >-
            Tracker type. Optional and create-only; currently only `CustomTracker` is accepted (any
            other value is rejected), and it defaults to `CustomTracker` when omitted.
        status:
          type: string
        company_id:
          type: string
        has_camera:
          type: boolean
          nullable: true
        last_connected_at:
          type: string
          format: date-time
        last_known_location:
          type: object
          nullable: true
          description: >-
            Last-known GPS position from the device's latest packet. null when the device has never
            reported a fix.
          properties:
            latitude:
              type: number
            longitude:
              type: number
            located_at:
              type: string
              format: date-time
              description: Packet time the position was recorded.
        speed_kmh:
          type: number
        heading:
          type: number
        is_ignition_on:
          type: boolean
        odometer_km:
          type: number
        group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        vin:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_plate:
          type: string
          description: Optional — returned only when requested via `fields`.
        manufacturer:
          type: string
          description: Optional — returned only when requested via `fields`.
        model:
          type: string
          description: Optional — returned only when requested via `fields`.
        year:
          type: number
          description: Optional — returned only when requested via `fields`.
        engine_hours:
          type: number
          description: Optional — returned only when requested via `fields`.
        activation_date:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        tracker_model:
          type: string
          description: Optional — returned only when requested via `fields`.
        assigned_driver_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        parent_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        asset_tag:
          type: string
          description: Optional — returned only when requested via `fields`.
        is_active:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        one_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        region_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        business_group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        altitude:
          type: number
          description: Optional — returned only when requested via `fields`.
        state_duration_ms:
          type: number
          description: Optional — returned only when requested via `fields`.
        last_packet_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        last_online_packet_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        last_gps_packet_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        created_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        removed_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        shipped_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        vendor_warranty_expires_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        phone:
          type: string
          description: Optional — returned only when requested via `fields`.
        geotab_serial:
          type: string
          description: Optional — returned only when requested via `fields`.
        globalstar_esn:
          type: string
          description: Optional — returned only when requested via `fields`.
        smartwitness_drid:
          type: string
          description: Optional — returned only when requested via `fields`.
        billing_sku:
          type: string
          description: Optional — returned only when requested via `fields`.
        billing_sku_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        surfsight_serial:
          type: string
          description: Optional — returned only when requested via `fields`.
        bewhere_beacon_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        imei:
          type: string
          description: Optional — returned only when requested via `fields`.
        comment:
          type: string
          description: Optional — returned only when requested via `fields`.
        additional_driver_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        driver_assignment_mode:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom_price:
          type: number
          description: Optional — returned only when requested via `fields`.
        share_master_device_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        suspend_exception_video:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        is_suspended:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        camera_online:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        camera_standby:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        last_camera_contact_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        oldest_recording_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        latest_recording_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        parent_geotab_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        indoor_data:
          type: object
          nullable: true
          description: >-
            Indoor-tracking connection data (BLE beacons only), forwarded as-is. null when not
            applicable. Optional — returned only when requested via `fields`.
        signal_dbm:
          type: number
          description: Optional — returned only when requested via `fields`.
        beacon_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        is_health_recording:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        has_video_loss:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        camera_channels:
          type: array
          items:
            type: number
          description: Optional — returned only when requested via `fields`.
        iccid:
          type: string
          description: Optional — returned only when requested via `fields`.
        telematic_serial:
          type: string
          description: Optional — returned only when requested via `fields`.
        color:
          type: string
          description: Optional — returned only when requested via `fields`.
        skill_tags:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        asset_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        image_url:
          type: string
          description: Optional — returned only when requested via `fields`.
        asset_status:
          type: string
          description: Optional — returned only when requested via `fields`.
        data_usage_status:
          type: string
          description: Optional — returned only when requested via `fields`.
        termination_date:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        device_plan:
          type: string
          description: Optional — returned only when requested via `fields`.
        billing_tag:
          type: string
          description: Optional — returned only when requested via `fields`.
        so_number:
          type: string
          description: Optional — returned only when requested via `fields`.
        agreement_length_months:
          type: number
          description: Optional — returned only when requested via `fields`.
        subscription_price:
          type: number
          description: Optional — returned only when requested via `fields`.
        data_plan_mb:
          type: number
          description: Optional — returned only when requested via `fields`.
        sim_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        is_streamax_v3:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        has_pending_media:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        acc_status:
          type: object
          nullable: true
          description: >-
            Streamax ACC (ignition switch) detection state, forwarded as-is. null when not
            available. Optional — returned only when requested via `fields`.
        finance:
          type: object
          nullable: true
          description: >-
            Billing/finance details, forwarded as-is. Optional — returned only when requested via
            `fields`.
        config_template_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        config_template_status:
          type: string
          description: Optional — returned only when requested via `fields`.
        config_odometer_status:
          type: string
          description: Optional — returned only when requested via `fields`.
        last_config_template_applied_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        last_odometer_update_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        pending_commands:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        protocol:
          type: string
          description: Optional — returned only when requested via `fields`.
        address:
          type: string
          description: Optional — returned only when requested via `fields`.
        address_color:
          type: string
          description: Optional — returned only when requested via `fields`.
        face_channel:
          type: number
          description: Optional — returned only when requested via `fields`.
        installer_email:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom_fields:
          type: object
          description: >-
            Tenant-defined custom field values, keyed by field name, forwarded as-is. Optional —
            returned only when requested via `fields`.
        device_plan_configuration:
          type: object
          nullable: true
          description: >-
            Device plan configuration, forwarded as-is. Optional — returned only when requested via
            `fields`.
        streamax_device_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        is_tracing_enabled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        is_obd_available:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        whitelist_enabled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        is_outdoor_ble:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        tx_power:
          type: number
          description: Optional — returned only when requested via `fields`.
        is_obd_engine_hours_available:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        is_obd_odometer_available:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        hos_enabled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        license_state:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_country:
          type: string
          description: Optional — returned only when requested via `fields`.
        registration_expires_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        switchboard_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        device_category:
          type: string
          nullable: true
          description: >-
            Normalized device category from the matching tracker type (trackertypes.DeviceCategory),
            e.g. "Asset Tracker". null when the device Type has no matching tracker type.
        groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            description: Expanded when `include=groups`.
          description: Expanded when `include=groups`.
        assigned_driver:
          type: object
          properties:
            id:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            username:
              type: string
          description: >-
            Expanded when `include=assigned_driver`. null when this record has no linked
            assigned_driver, or the linked record no longer exists.
          nullable: true
      required:
        - id
        - has_camera
        - last_known_location
        - device_category
    DeviceFilter:
      type: object
      description: >-
        Filter conditions for device fields. Multiple fields combine with AND. See "Filtering" in
        the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/devices`.
        serial:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `serial`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `serial`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        type:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `type`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/devices`.
        status:
          oneOf:
            - type: string
              enum:
                - Active
                - Suspended
                - Terminated
            - type: array
              items:
                type: string
                enum:
                  - Active
                  - Suspended
                  - Terminated
            - type: object
              description: >-
                Explicit operator form for `status`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Active
                    - Suspended
                    - Terminated
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Active
                      - Suspended
                      - Terminated
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        company_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `company_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `company_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        has_camera:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `has_camera`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `has_camera`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
        last_connected_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `last_connected_at`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `last_connected_at`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        speed_kmh:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `speed_kmh`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `speed_kmh`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        heading:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `heading`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `heading`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        is_ignition_on:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_ignition_on`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_ignition_on`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
        odometer_km:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `odometer_km`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `odometer_km`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        group_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `group_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `group_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        vin:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `vin`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `vin`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        license_plate:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_plate`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_plate`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        manufacturer:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `manufacturer`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `manufacturer`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        model:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `model`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `model`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        year:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `year`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `year`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        engine_hours:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `engine_hours`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `engine_hours`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        activation_date:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `activation_date`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `activation_date`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        tracker_model:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `tracker_model`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `tracker_model`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        assigned_driver_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `assigned_driver_id`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `assigned_driver_id`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        parent_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `parent_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `parent_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        asset_tag:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `asset_tag`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `asset_tag`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        is_active:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_active`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_active`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
      additionalProperties: false
    Driver:
      type: object
      properties:
        id:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        username:
          type: string
          description: >-
            Login username. Required on create; create-only (a username change is a separate,
            deferred operation). A `password` is auto-generated when omitted.
        full_name:
          type: string
          nullable: true
        group_ids:
          type: array
          items:
            type: string
          minItems: 1
          description: >-
            Group ids the driver belongs to. Required on create — at least one group must be
            supplied. Optional — returned only when requested via `fields`.
        email:
          type: string
          description: Optional — returned only when requested via `fields`.
        phone:
          type: string
          description: Optional — returned only when requested via `fields`.
        units:
          type: string
          description: Optional — returned only when requested via `fields`.
        language:
          type: string
          description: Optional — returned only when requested via `fields`.
        user_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        skill_tags:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        working_hours:
          type: object
          description: >-
            Per-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: { from, to
            } }, … }). Optional — returned only when requested via `fields`.
          example:
            Mon:
              active: true
              hours:
                from: '09:00'
                to: '17:00'
        created_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        last_login:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_number:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_state:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_country:
          type: string
          description: Optional — returned only when requested via `fields`.
        time_zone:
          type: string
          description: Optional — returned only when requested via `fields`.
        photo_url:
          type: string
          description: Optional — returned only when requested via `fields`.
        telegram_chat_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        region_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        business_group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        people_group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        employee_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        can_assign_job_itself:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        default_view:
          type: string
          description: Optional — returned only when requested via `fields`.
        fetch_location_from_mobile:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        feature_preview:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        supervisor_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        driver_app_data:
          type: object
          nullable: true
          description: >-
            Driver app data — check-in/out, breaks, work-time tracking, forwarded as-is. Optional —
            returned only when requested via `fields`.
        map_provider:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom_fields:
          type: object
          description: >-
            Tenant-defined custom field values, keyed by field name, forwarded as-is. Optional —
            returned only when requested via `fields`.
        driver_identification:
          type: string
          description: Optional — returned only when requested via `fields`.
        verification_phone_number:
          type: string
          description: Optional — returned only when requested via `fields`.
        show_self_data:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        comments:
          type: string
          description: Optional — returned only when requested via `fields`.
        live_notification_settings:
          type: object
          nullable: true
          description: >-
            Live-notification preferences, forwarded as-is. Optional — returned only when requested
            via `fields`.
        switchboard_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        hos_enabled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        hos_exempted:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        rule_set:
          type: string
          description: Optional — returned only when requested via `fields`.
        us_hos_cycle:
          type: string
          description: Optional — returned only when requested via `fields`.
        home_terminal_name:
          type: string
          description: Optional — returned only when requested via `fields`.
        home_terminal_address:
          type: object
          nullable: true
          description: >-
            Home-terminal location ({ Location: { latitude, longitude }, LocationName }), forwarded
            as-is. Optional — returned only when requested via `fields`.
          example:
            Location:
              latitude: 43.6532
              longitude: -79.3832
            LocationName: Main Depot
        exemption_annotation:
          type: string
          description: Optional — returned only when requested via `fields`.
        yard_move_allowed:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        personal_conveyance_allowed:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        pinned_add_in_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        is_driver:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            description: Expanded when `include=groups`.
          description: Expanded when `include=groups`.
      required:
        - id
        - full_name
    DriverFilter:
      type: object
      description: >-
        Filter conditions for driver fields. Multiple fields combine with AND. See "Filtering" in
        the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        first_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `first_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `first_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        last_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `last_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `last_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        username:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `username`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `username`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        group_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `group_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `group_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        email:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `email`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `email`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        phone:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `phone`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `phone`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        units:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `units`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `units`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        language:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `language`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `language`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        user_type:
          oneOf:
            - type: string
              enum:
                - Driver
                - End Customer
                - EndUser
                - General User
                - Passenger
                - Technician
            - type: array
              items:
                type: string
                enum:
                  - Driver
                  - End Customer
                  - EndUser
                  - General User
                  - Passenger
                  - Technician
            - type: object
              description: >-
                Explicit operator form for `user_type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Driver
                    - End Customer
                    - EndUser
                    - General User
                    - Passenger
                    - Technician
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Driver
                      - End Customer
                      - EndUser
                      - General User
                      - Passenger
                      - Technician
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `user_type`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        skill_tags:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `skill_tags`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `skill_tags`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        last_login:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `last_login`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `last_login`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        company_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `company_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `company_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        license_number:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_number`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_number`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        license_state:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_state`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_state`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        license_country:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_country`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_country`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    Trip:
      type: object
      properties:
        id:
          type: string
        device_id:
          type: string
        driver_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        distance_km:
          type: number
        idling_seconds:
          type: number
          nullable: true
        stop_seconds:
          type: number
          nullable: true
        max_speed_kmh:
          type: number
        start_coordinates:
          type: object
          nullable: true
          description: GPS position. null when not resolvable.
          properties:
            latitude:
              type: number
            longitude:
              type: number
        end_coordinates:
          type: object
          nullable: true
          description: GPS position. null when not resolvable.
          properties:
            latitude:
              type: number
            longitude:
              type: number
        start_position:
          type: string
          description: Optional — returned only when requested via `fields`.
        end_position:
          type: string
          description: Optional — returned only when requested via `fields`.
        bounding_box:
          type: string
          description: Optional — returned only when requested via `fields`.
        start_address_country:
          type: string
          description: Optional — returned only when requested via `fields`.
        start_address_state:
          type: string
          description: Optional — returned only when requested via `fields`.
        stop_address:
          type: string
          description: Optional — returned only when requested via `fields`.
        stop_seconds_on_start:
          type: string
          description: Optional — returned only when requested via `fields`.
        geotab_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        ifta_report_group_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        device:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            serial:
              type: string
          description: >-
            Expanded when `include=device`. null when this record has no linked device, or the
            linked record no longer exists.
          nullable: true
        driver:
          type: object
          properties:
            id:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            username:
              type: string
          description: >-
            Expanded when `include=driver`. null when this record has no linked driver, or the
            linked record no longer exists.
          nullable: true
      required:
        - id
        - idling_seconds
        - stop_seconds
        - start_coordinates
        - end_coordinates
    TripFilter:
      type: object
      description: >-
        Filter conditions for trip fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        driver_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `driver_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `driver_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        start_time:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `start_time`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `start_time`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        end_time:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `end_time`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `end_time`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        distance_km:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `distance_km`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `distance_km`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        idling_seconds:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `idling_seconds`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `idling_seconds`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        stop_seconds:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `stop_seconds`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `stop_seconds`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        max_speed_kmh:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `max_speed_kmh`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `max_speed_kmh`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        start_address_country:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `start_address_country`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `start_address_country`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        start_address_state:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `start_address_state`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `start_address_state`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        stop_address:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `stop_address`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `stop_address`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        stop_seconds_on_start:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `stop_seconds_on_start`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `stop_seconds_on_start`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
      additionalProperties: false
    SafetyEvent:
      type: object
      properties:
        id:
          type: string
        device_id:
          type: string
        driver_id:
          type: string
        rule_id:
          type: string
        occurred_at:
          type: string
          format: date-time
        ended_at:
          type: string
          format: date-time
        speed_kmh:
          type: number
        status:
          type: string
          nullable: true
        latitude:
          type: number
          description: Optional — returned only when requested via `fields`.
        longitude:
          type: number
          description: Optional — returned only when requested via `fields`.
        road_speed_limit_kmh:
          type: number
          description: Optional — returned only when requested via `fields`.
        odometer_km:
          type: number
          description: Optional — returned only when requested via `fields`.
        engine_hours:
          type: number
          description: Optional — returned only when requested via `fields`.
        zone_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        comment:
          type: string
          description: Optional — returned only when requested via `fields`.
        event:
          type: string
          description: Optional — returned only when requested via `fields`.
        event_class:
          type: string
          description: Optional — returned only when requested via `fields`.
        geotab_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        parent_device_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        username:
          type: string
          description: Optional — returned only when requested via `fields`.
        dismiss_state:
          type: number
          description: Optional — returned only when requested via `fields`.
        is_handled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        notify_state:
          type: object
          nullable: true
          description: >-
            Deprecated notification-state payload, forwarded as-is. Optional — returned only when
            requested via `fields`.
        viewed:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        starred:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        engine_code:
          type: string
          description: Optional — returned only when requested via `fields`.
        errors_description:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        indoor_position:
          type: object
          nullable: true
          description: >-
            Indoor position (BLE beacon events). null when not applicable. Optional — returned only
            when requested via `fields`.
          properties:
            x:
              type: number
              nullable: true
            'y':
              type: number
              nullable: true
            map_id:
              type: string
              nullable: true
        linked_exceptions:
          type: array
          items:
            type: object
            properties:
              exception_id:
                type: string
                nullable: true
              rule_id:
                type: string
                nullable: true
          description: Optional — returned only when requested via `fields`.
        channels:
          type: string
          description: Optional — returned only when requested via `fields`.
        job_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        stop_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        video_status:
          type: object
          nullable: true
          description: >-
            Status of a pending/failed video-clip request. null when no request is in flight or has
            ever completed. Optional — returned only when requested via `fields`.
          properties:
            request_status:
              type: string
              nullable: true
            error:
              type: string
              nullable: true
            date:
              type: string
              format: date-time
              nullable: true
        review_issue_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        review_issue_tag_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        review_reviewer:
          type: string
          description: Optional — returned only when requested via `fields`.
        review_date:
          type: string
          format: date-time
          nullable: true
          description: Optional — returned only when requested via `fields`.
        review_coach_comment:
          type: string
          description: Optional — returned only when requested via `fields`.
        review_coached_user_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        review_coach_date:
          type: string
          format: date-time
          nullable: true
          description: Optional — returned only when requested via `fields`.
        review_coach_user_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        type:
          type: string
          x-extensible-enum:
            - blind_spot
            - camera_obstruction
            - crash
            - distracted
            - eating_drinking
            - fatigue
            - fault
            - following_distance
            - harsh_acceleration
            - harsh_brake
            - harsh_turn
            - idling
            - lane_departure
            - other
            - panic
            - pedestrian_collision
            - phone_use
            - power_failure
            - rolling_stop
            - seatbelt
            - smoking
            - speeding
            - tamper
            - zone
          description: >-
            Normalized safety-event category. Derived from the raw `event` string (camera/AI events)
            or, for rule-engine events (speeding, idling, zone, fault), the linked rule's condition
            — so map THIS field, not `rule`/`severity`, which are null for camera events. `crash` is
            a confirmed impact; forward-collision and headway warnings are `following_distance`, not
            `crash`. `x-extensible-enum` lists the explicitly-categorised values; any other event is
            returned as a snake_cased form of its raw `event` (e.g. `lens_covered`) rather than a
            blanket `other`, so the set is open.
          nullable: true
        severity:
          type: string
          nullable: true
        video:
          type: array
          description: >-
            Camera clips for the event. Each element is one camera channel's recording of the event.
            Optional — returned only when requested via `fields`.
          items:
            type: object
            properties:
              channel:
                type: integer
                description: Camera channel number (platform-specific).
              facing:
                type: string
                enum:
                  - forward
                  - inward
                description: >-
                  Camera orientation (forward = road-facing, inward = cabin). SurfSight/StreamMax
                  default to CH1=forward, CH2=inward. Omitted for non-dashcam devices (e.g.
                  body/cargo cams), a forward-only model's second channel, and unmapped platforms.
              url:
                type: string
                nullable: true
                description: URL to the clip.
              screenshot_url:
                type: string
                nullable: true
              starts_at:
                type: string
                format: date-time
                description: Clip start (footage window, not the incident window).
              ends_at:
                type: string
                format: date-time
              ai_video_url:
                type: string
                description: AI-annotated clip; present only when available.
              video_id:
                type: string
                description: Platform video id; present only when available.
              mdt_url:
                type: string
                description: Sensor-analysis file (MDT); present only when available.
              short_screenshot_url:
                type: string
                description: Shortened screenshot URL; present only when available.
        device:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            serial:
              type: string
          description: >-
            Expanded when `include=device`. null when this record has no linked device, or the
            linked record no longer exists.
          nullable: true
        driver:
          type: object
          properties:
            id:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            username:
              type: string
          description: >-
            Expanded when `include=driver`. null when this record has no linked driver, or the
            linked record no longer exists.
          nullable: true
        rule:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            description:
              type: string
            is_active:
              type: boolean
            score:
              type: number
            severity_band:
              type: string
            color:
              type: string
            rule_type:
              type: string
            trigger_type:
              type: string
            condition_types:
              type: array
              items:
                type: string
              description: >-
                Raw (non-normalized) condition leaf types found anywhere in the rule's condition
                tree, e.g. ["Speed"]. Includes the type from a rule's deprecated single-condition
                form even when `condition` returns only the newer tree, so an entry here may have no
                counterpart in `condition`.
            condition:
              allOf:
                - $ref: '#/components/schemas/RuleConditionNode'
              nullable: true
              description: The rule's condition tree. null when the rule has no conditions.
          description: >-
            Expanded when `include=rule`. null when this record has no linked rule, or the linked
            record no longer exists.
          nullable: true
        zone:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            type:
              type: string
          description: >-
            Expanded when `include=zone`. null when this record has no linked zone, or the linked
            record no longer exists.
          nullable: true
      required:
        - id
        - status
        - type
        - severity
    SafetyEventFilter:
      type: object
      description: >-
        Filter conditions for safety event fields. Multiple fields combine with AND. See "Filtering"
        in the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        driver_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `driver_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `driver_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        rule_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `rule_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `rule_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        occurred_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `occurred_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `occurred_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        ended_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `ended_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `ended_at`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        speed_kmh:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `speed_kmh`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `speed_kmh`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        status:
          oneOf:
            - type: string
              enum:
                - Needs Review
                - Needs Coaching
            - type: array
              items:
                type: string
                enum:
                  - Needs Review
                  - Needs Coaching
            - type: object
              description: 'Explicit operator form for `status`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  enum:
                    - Needs Review
                    - Needs Coaching
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Needs Review
                      - Needs Coaching
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`. See "Filtering" in the API description.
        latitude:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `latitude`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `latitude`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        longitude:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `longitude`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `longitude`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        road_speed_limit_kmh:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `road_speed_limit_kmh`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `road_speed_limit_kmh`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        odometer_km:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `odometer_km`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `odometer_km`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        engine_hours:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `engine_hours`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `engine_hours`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        zone_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `zone_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `zone_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        comment:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `comment`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `comment`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        event:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `event`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `event`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        event_class:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `event_class`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `event_class`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    Rule:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        is_active:
          type: boolean
        score:
          type: number
        group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        color:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom_message:
          type: string
          description: Optional — returned only when requested via `fields`.
        notification_period:
          type: string
          description: Optional — returned only when requested via `fields`.
        severity_band:
          type: string
          description: Optional — returned only when requested via `fields`.
        rule_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        trigger_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        condition_types:
          type: array
          items:
            type: string
          description: >-
            Raw (non-normalized) condition leaf types found anywhere in the rule's condition tree,
            e.g. ["Speed"]. Includes the type from a rule's deprecated single-condition form even
            when `condition` returns only the newer tree, so an entry here may have no counterpart
            in `condition`. Optional — returned only when requested via `fields`.
        condition:
          allOf:
            - $ref: '#/components/schemas/RuleConditionNode'
          nullable: true
          description: >-
            The rule's condition tree. null when the rule has no conditions. Optional — returned
            only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        is_readonly:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        device_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        driver_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        escalations:
          type: array
          items:
            type: object
          description: >-
            Escalation steps (Id, Delay, DisplayDelay, DisplayDelayType, Name, UserId), forwarded
            as-is. Optional — returned only when requested via `fields`.
        notifications:
          type: array
          items:
            type: object
          description: >-
            Notification routing rules (Id, EventType, EmailTo, CustomEmails, SmsTo, CustomPhone,
            MessageSubject, MessageBody, TtsLanguage, TtsAudioFileId, TtsMessage, WebhookUrl,
            CommandChannels, CommandAction), forwarded as-is. Optional — returned only when
            requested via `fields`.
        notify_by_sms:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        notify_by_call:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        request_form_submission:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        form_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        attach_video:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        attach_video_enabled_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        download_channels:
          type: array
          items:
            type: number
          description: Optional — returned only when requested via `fields`.
        use_snapshots:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        use_snapshots_enabled_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        snapshot_time_length:
          type: number
          description: Optional — returned only when requested via `fields`.
        remind:
          type: object
          description: >-
            Maintenance-reminder detail (RemindDate, RemindMileage, Decription, DevicesIds),
            forwarded as-is. Optional — returned only when requested via `fields`.
        managed_review:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        coaches:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        action_data:
          type: object
          description: >-
            Maintenance trigger/form action data, forwarded as-is. Optional — returned only when
            requested via `fields`.
        is_general:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        is_direct_coaching_enabled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        notify_driver:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        rule_action:
          type: array
          items:
            type: object
          description: >-
            Configured rule actions (Enabled, Type, TargetGroupId), forwarded as-is. Optional —
            returned only when requested via `fields`.
        groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            description: Expanded when `include=groups`.
          description: Expanded when `include=groups`.
      required:
        - id
    RuleFilter:
      type: object
      description: >-
        Filter conditions for rule fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/rules`.
        description:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `description`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `description`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        is_active:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_active`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_active`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
        score:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `score`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `score`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        group_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `group_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `group_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        color:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `color`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `color`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        custom_message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `custom_message`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `custom_message`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        notification_period:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `notification_period`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `notification_period`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        rule_type:
          oneOf:
            - type: string
              enum:
                - CameraSafety
                - CustomSafety
                - GeneralSafety
            - type: array
              items:
                type: string
                enum:
                  - CameraSafety
                  - CustomSafety
                  - GeneralSafety
            - type: object
              description: >-
                Explicit operator form for `rule_type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - CameraSafety
                    - CustomSafety
                    - GeneralSafety
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - CameraSafety
                      - CustomSafety
                      - GeneralSafety
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `rule_type`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        trigger_type:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `trigger_type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `trigger_type`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    Zone:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
          description: >-
            The zone's tag, stored as a tag id (UUID) — not a shape or free-text category. Required
            on create.
        color:
          type: string
          description: Zone display colour as a hex string, e.g. `#2f80ed`. Required on create.
        group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        address:
          type: string
          description: Optional — returned only when requested via `fields`.
        city:
          type: string
          description: Optional — returned only when requested via `fields`.
        country:
          type: string
          description: Optional — returned only when requested via `fields`.
        postal_code:
          type: string
          description: Optional — returned only when requested via `fields`.
        street_address:
          type: string
          description: Optional — returned only when requested via `fields`.
        geometry:
          type: object
          nullable: true
          description: >-
            Outdoor zone shape, forwarded as-is in PascalCase. Either a circle `{ "Type": "circle",
            "Center": { "Latitude": <n>, "Longitude": <n> }, "Radius": <n> }` or a polygon `{
            "Type": "polygon", "Points": [ { "Latitude": <n>, "Longitude": <n> }, … (min 3) ] }`.
            `Type` must be lowercase `circle` or `polygon`. Provide EITHER `geometry` (outdoor,
            lat/lng) OR `indoor_geometry` + `indoor_map_id` (indoor) — never both. Optional —
            returned only when requested via `fields`.
          example:
            Type: circle
            Center:
              Latitude: 43.6532
              Longitude: -79.3832
            Radius: 200
        open_from:
          type: string
          description: Optional — returned only when requested via `fields`.
        open_to:
          type: string
          description: Optional — returned only when requested via `fields`.
        expected_stop_seconds:
          type: number
          description: Optional — returned only when requested via `fields`.
        created_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        tag_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        instructions:
          type: string
          description: Optional — returned only when requested via `fields`.
        address_notes:
          type: string
          description: Optional — returned only when requested via `fields`.
        state:
          type: string
          description: Optional — returned only when requested via `fields`.
        contact_name:
          type: string
          description: Optional — returned only when requested via `fields`.
        contact_email:
          type: string
          description: Optional — returned only when requested via `fields`.
        phone:
          type: string
          description: Optional — returned only when requested via `fields`.
        account_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: >-
            Tenant-defined custom data for integrations, keyed by field name (string or number
            values), forwarded as-is. null when not set. Optional — returned only when requested via
            `fields`.
        indoor_geometry:
          type: object
          nullable: true
          description: >-
            Indoor zone shape on an uploaded indoor map, forwarded as-is in PascalCase (uses
            `Center.X`/`Center.Y`, not latitude/longitude). Requires `indoor_map_id`. Mutually
            exclusive with `geometry`; null for outdoor zones. Optional — returned only when
            requested via `fields`.
          example:
            Type: circle
            Center:
              X: 120
              'Y': 240
            Radius: 30
        indoor_map_id:
          type: string
          nullable: true
          description: >-
            Id of the indoor map an indoor zone belongs to. Required when `indoor_geometry` is set;
            must be omitted for outdoor (`geometry`) zones — sending it on an outdoor zone is
            rejected with "Outdoor zone can't have indoor map id". Optional — returned only when
            requested via `fields`.
        expiry:
          type: string
          format: date-time
          nullable: true
          description: >-
            Zone expiration date — the collection has a TTL index that deletes expired zones. null
            when the zone doesn't expire. Optional — returned only when requested via `fields`.
        transparency:
          type: number
          description: >-
            Map rendering opacity, in percent (0-100). Optional — returned only when requested via
            `fields`.
        unit_number:
          type: string
          description: Optional — returned only when requested via `fields`.
        geotab_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            description: Expanded when `include=groups`.
          description: Expanded when `include=groups`.
      required:
        - id
    ZoneFilter:
      type: object
      description: >-
        Filter conditions for zone fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/zones`.
        type:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `type`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/zones`.
        color:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `color`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `color`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        group_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `group_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `group_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        address:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `address`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `address`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        city:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `city`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `city`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        country:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `country`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `country`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        postal_code:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `postal_code`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `postal_code`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        street_address:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `street_address`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `street_address`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        expected_stop_seconds:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `expected_stop_seconds`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `expected_stop_seconds`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
      additionalProperties: false
    Group:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: Group name. Required on create.
        child_ids:
          type: array
          items:
            type: string
          nullable: true
        image_url:
          type: string
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        geotab_id:
          type: string
          description: Optional — returned only when requested via `fields`.
      required:
        - id
        - child_ids
    GroupFilter:
      type: object
      description: >-
        Filter conditions for group fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/groups`.
        child_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `child_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `child_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        image_url:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `image_url`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `image_url`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    VehicleFault:
      type: object
      properties:
        id:
          type: string
        device_id:
          type: string
        code:
          type: string
        status:
          type: string
        severity:
          type: string
        title:
          type: string
        detected_on:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        reoccurrence_count:
          type: number
        description:
          type: string
          description: Optional — returned only when requested via `fields`.
        category:
          type: string
          description: Optional — returned only when requested via `fields`.
        issue_source:
          type: string
          description: Optional — returned only when requested via `fields`.
        last_updated_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        closed_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        assigned_to:
          type: string
          description: Optional — returned only when requested via `fields`.
        work_order_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        service_request_number:
          type: number
          description: Optional — returned only when requested via `fields`.
        fault_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        timeline:
          type: array
          items:
            type: object
          description: >-
            Fault triage timeline entries
            (reported/triaged/assigned/closed/reopened/comment/linked_wo), forwarded as-is. Optional
            — returned only when requested via `fields`.
        attachments:
          type: array
          items:
            type: object
          description: >-
            Attached files ({Url, Name}), forwarded as-is. Optional — returned only when requested
            via `fields`.
        closed_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        watcher_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        device:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            serial:
              type: string
          description: >-
            Expanded when `include=device`. null when this record has no linked device, or the
            linked record no longer exists.
          nullable: true
        insight:
          type: object
          properties:
            code:
              type: string
            component:
              type: string
            severity:
              type: string
            summary:
              type: string
            description:
              type: string
            source:
              type: string
            detected_symptoms:
              type: array
              items:
                type: string
            recommended_actions:
              type: array
              items:
                type: string
            most_likely_root_cause:
              type: object
              nullable: true
              description: AI-assessed most likely root cause. null when the catalog row has no assessment.
              properties:
                cause:
                  type: string
                  nullable: true
                confidence_level:
                  type: number
                  nullable: true
                  description: Confidence 0–100.
            potential_impact:
              type: array
              items:
                type: string
            manufacturer:
              type: string
            model:
              type: string
            make_year:
              type: string
          description: >-
            Expanded when `include=insight`. null when this record has no linked insight, or the
            linked record no longer exists.
          nullable: true
      required:
        - id
    VehicleFaultFilter:
      type: object
      description: >-
        Filter conditions for vehicle fault fields. Multiple fields combine with AND. See
        "Filtering" in the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        code:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `code`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `code`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        status:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `status`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        severity:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `severity`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `severity`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        title:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `title`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `title`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        detected_on:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `detected_on`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `detected_on`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        reoccurrence_count:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `reoccurrence_count`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `reoccurrence_count`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        description:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `description`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `description`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        category:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `category`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `category`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        issue_source:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `issue_source`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `issue_source`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        last_updated_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `last_updated_at`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `last_updated_at`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        closed_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `closed_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `closed_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        assigned_to:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `assigned_to`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `assigned_to`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        work_order_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `work_order_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `work_order_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        service_request_number:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `service_request_number`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `service_request_number`. Bare value = `eq` (bare array = `in`), or an
            operator object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the
            API description.
        fault_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `fault_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `fault_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
      additionalProperties: false
    FaultCode:
      type: object
      properties:
        id:
          type: string
        code:
          type: string
        component:
          type: string
        severity:
          type: string
        summary:
          type: string
        source:
          type: string
        description:
          type: string
          description: Optional — returned only when requested via `fields`.
        detected_symptoms:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        recommended_actions:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        most_likely_root_cause:
          type: object
          nullable: true
          description: >-
            AI-assessed most likely root cause. null when the catalog row has no assessment.
            Optional — returned only when requested via `fields`.
          properties:
            cause:
              type: string
              nullable: true
            confidence_level:
              type: number
              nullable: true
              description: Confidence 0–100.
        potential_impact:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        manufacturer:
          type: string
          description: Optional — returned only when requested via `fields`.
        model:
          type: string
          description: Optional — returned only when requested via `fields`.
        protocol:
          type: string
          description: Optional — returned only when requested via `fields`.
        make_year:
          type: string
          description: Optional — returned only when requested via `fields`.
      required:
        - id
    FaultCodeFilter:
      type: object
      description: >-
        Filter conditions for fault code fields. Multiple fields combine with AND. See "Filtering"
        in the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        code:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `code`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `code`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        component:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `component`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `component`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        severity:
          oneOf:
            - type: string
              enum:
                - Low
                - Moderate
                - High
                - Critical
            - type: array
              items:
                type: string
                enum:
                  - Low
                  - Moderate
                  - High
                  - Critical
            - type: object
              description: >-
                Explicit operator form for `severity`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Low
                    - Moderate
                    - High
                    - Critical
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Low
                      - Moderate
                      - High
                      - Critical
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `severity`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        summary:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `summary`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `summary`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        source:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `source`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `source`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        description:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `description`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `description`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        detected_symptoms:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `detected_symptoms`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `detected_symptoms`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`. See "Filtering" in the API description.
        recommended_actions:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `recommended_actions`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `recommended_actions`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`. See "Filtering" in the API description.
        potential_impact:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `potential_impact`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `potential_impact`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`. See "Filtering" in the API description.
        manufacturer:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `manufacturer`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `manufacturer`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        model:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `model`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `model`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        protocol:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `protocol`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `protocol`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        make_year:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `make_year`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                gte:
                  type: string
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `make_year`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
      additionalProperties: false
    MaintenanceRequest:
      type: object
      properties:
        id:
          type: string
        service_number:
          type: number
        status:
          type: string
        odometer_km:
          type: number
        engine_hours:
          type: number
        created_at:
          type: string
          format: date-time
        resolved_at:
          type: string
          format: date-time
        total_cost:
          type: number
        details:
          type: object
          description: >-
            Maintenance request details, forwarded as-is (camelCase sub-keys) to the maintenance
            service. Required on create — the request is built from this object. In practice set
            `asset` (the vehicle/device id) and a valid `dueDate`; the other sub-keys are optional.
            Optional — returned only when requested via `fields`.
          properties:
            asset:
              type: string
              description: Vehicle/device id the request is for.
            maintenanceType:
              type: string
            reference:
              type: string
            dueDate:
              type: string
              format: date-time
              description: Due date (ISO-8601).
            summary:
              type: string
            priority:
              type: string
        labour_cost:
          type: number
          description: Optional — returned only when requested via `fields`.
        parts_cost:
          type: number
          description: Optional — returned only when requested via `fields`.
        service_cost:
          type: number
          description: Optional — returned only when requested via `fields`.
        tags:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        created_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        resolved_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        is_open:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        status_changed_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        source:
          type: string
          description: Optional — returned only when requested via `fields`.
        repair_order_number:
          type: number
          description: Optional — returned only when requested via `fields`.
        repair_order_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        service_provider_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        logged_time:
          type: number
          description: Optional — returned only when requested via `fields`.
        added_to_repair:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        assigned_to:
          type: string
          description: Optional — returned only when requested via `fields`.
        assigned_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        assigned_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        resolved_odometer_km:
          type: number
          description: Optional — returned only when requested via `fields`.
        resolved_engine_hours:
          type: number
          description: Optional — returned only when requested via `fields`.
        rule_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        cancellation_reason:
          type: string
          description: Optional — returned only when requested via `fields`.
        completion_odometer_km:
          type: number
          description: Optional — returned only when requested via `fields`.
        completion_engine_hours:
          type: number
          description: Optional — returned only when requested via `fields`.
        completed_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        added_products:
          type: array
          description: >-
            Product/part line items attached to the request, forwarded as-is (camelCase sub-keys,
            matching the stored shape). Optional — returned only when requested via `fields`.
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              type:
                type: string
              quantityOrHours:
                type: number
              unitCost:
                type: number
              totalCost:
                type: number
              disableUnitCost:
                type: boolean
              estimatedTime:
                type: number
        product_labours:
          type: string
          description: Optional — returned only when requested via `fields`.
        defect:
          type: string
          description: Optional — returned only when requested via `fields`.
        submission_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
      required:
        - id
    MaintenanceRequestFilter:
      type: object
      description: >-
        Filter conditions for maintenance request fields. Multiple fields combine with AND. See
        "Filtering" in the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        service_number:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `service_number`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `service_number`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        status:
          oneOf:
            - type: string
              enum:
                - Pending Assignment
                - Assigned
                - In Progress
                - On Hold
                - Completed
                - Cancelled
            - type: array
              items:
                type: string
                enum:
                  - Pending Assignment
                  - Assigned
                  - In Progress
                  - On Hold
                  - Completed
                  - Cancelled
            - type: object
              description: >-
                Explicit operator form for `status`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Pending Assignment
                    - Assigned
                    - In Progress
                    - On Hold
                    - Completed
                    - Cancelled
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Pending Assignment
                      - Assigned
                      - In Progress
                      - On Hold
                      - Completed
                      - Cancelled
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        odometer_km:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `odometer_km`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `odometer_km`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        engine_hours:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `engine_hours`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `engine_hours`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        resolved_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `resolved_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `resolved_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        total_cost:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `total_cost`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `total_cost`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        labour_cost:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `labour_cost`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `labour_cost`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        parts_cost:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `parts_cost`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `parts_cost`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        service_cost:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `service_cost`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `service_cost`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        tags:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `tags`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `tags`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`. See "Filtering" in the API description.
        created_by:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `created_by`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_by`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        resolved_by:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `resolved_by`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `resolved_by`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        is_open:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_open`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_open`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
      additionalProperties: false
    RepairOrder:
      type: object
      properties:
        id:
          type: string
        order_number:
          type: number
        status:
          type: string
        total_cost:
          type: number
          nullable: true
        created_at:
          type: string
          format: date-time
        request_count:
          type: number
          nullable: true
        service_request_ids:
          type: array
          items:
            type: string
        details:
          type: object
          description: >-
            Repair order details, forwarded as-is (camelCase sub-keys) to the maintenance service.
            Required on create; in practice set `asset` and a valid `dueDate`.
            `assignTo`/`serviceProvider` also propagate onto the linked service requests. Optional —
            returned only when requested via `fields`.
          properties:
            asset:
              type: string
              description: Vehicle/device id the order is for.
            priority:
              type: string
            assignTo:
              type: string
            serviceProvider:
              type: string
            summary:
              type: string
            dueDate:
              type: string
              format: date-time
              description: Due date (ISO-8601).
            reference:
              type: string
        assigned_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        assigned_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        added_services:
          type: array
          items:
            type: string
          minItems: 1
          description: >-
            Maintenance service request ids attached to this repair order. Required on create: at
            least one id, each an existing service request in the company that is not already
            attached to another repair order. Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        created_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        resolved_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        resolved_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        status_changed_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        cancellation_reason:
          type: string
          description: Optional — returned only when requested via `fields`.
        product_labours:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
          description: Optional — returned only when requested via `fields`.
        estimated_time:
          type: number
          description: Optional — returned only when requested via `fields`.
        logged_time:
          type: number
          description: Optional — returned only when requested via `fields`.
        service_amount:
          type: number
          description: Optional — returned only when requested via `fields`.
        goods_amount:
          type: number
          description: Optional — returned only when requested via `fields`.
        subtotal:
          type: number
          description: Optional — returned only when requested via `fields`.
        discount:
          type: object
          nullable: true
          description: >-
            Discount applied to the order total. null when summary/discount isn't set. Optional —
            returned only when requested via `fields`.
          properties:
            value:
              type: number
            type:
              type: string
              enum:
                - Dollar
                - Percent
            final_value:
              type: number
        tax:
          type: object
          nullable: true
          description: >-
            Tax applied to the order total. null when summary/tax isn't set. Optional — returned
            only when requested via `fields`.
          properties:
            value:
              type: number
            type:
              type: string
              enum:
                - Dollar
                - Percent
            final_value:
              type: number
      required:
        - id
        - total_cost
        - request_count
    RepairOrderFilter:
      type: object
      description: >-
        Filter conditions for repair order fields. Multiple fields combine with AND. See "Filtering"
        in the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        order_number:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `order_number`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `order_number`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        status:
          oneOf:
            - type: string
              enum:
                - Pending Assignment
                - Assigned
                - In Progress
                - On Hold
                - Completed
                - Cancelled
            - type: array
              items:
                type: string
                enum:
                  - Pending Assignment
                  - Assigned
                  - In Progress
                  - On Hold
                  - Completed
                  - Cancelled
            - type: object
              description: >-
                Explicit operator form for `status`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Pending Assignment
                    - Assigned
                    - In Progress
                    - On Hold
                    - Completed
                    - Cancelled
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Pending Assignment
                      - Assigned
                      - In Progress
                      - On Hold
                      - Completed
                      - Cancelled
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        service_request_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `service_request_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `service_request_ids`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`. See "Filtering" in the API description.
        assigned_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `assigned_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `assigned_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        assigned_by:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `assigned_by`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `assigned_by`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        added_services:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `added_services`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `added_services`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
      additionalProperties: false
    DiagnosticReading:
      type: object
      properties:
        device_id:
          type: string
        type:
          type: string
        value:
          type: number
        recorded_at:
          type: string
          format: date-time
        text_value:
          type: string
          description: Optional — returned only when requested via `fields`.
        diff:
          type: string
          description: Optional — returned only when requested via `fields`.
        source:
          type: string
          description: Optional — returned only when requested via `fields`.
        device:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            serial:
              type: string
          description: >-
            Expanded when `include=device`. null when this record has no linked device, or the
            linked record no longer exists.
          nullable: true
      required:
        - device_id
    DiagnosticReadingFilter:
      type: object
      description: >-
        Filter conditions for diagnostic reading fields. Multiple fields combine with AND. See
        "Filtering" in the API description for the full body shape and operator list.
      properties:
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        type:
          oneOf:
            - type: string
              enum:
                - InDoor
                - OutDoor
                - DoorState
                - RemovalState
                - BLEConnection
                - Battery
                - Humidity
                - Temperature
                - Impact
                - Pressure
                - Light
                - Tamper
                - RSSI
                - Fuel
                - FuelLevel
                - Odometer
                - TirePressureLF
                - TirePressureRF
                - TirePressureLR
                - TirePressureRR
                - CoolantTemperature
                - BatteryVoltage
                - BackupBatteryVoltage
                - EngineOnTime
                - RPM
                - EngineSpeed
                - EngineHours
                - EngineLoad
                - TotalMileage
                - AverageOilConsumption
                - Break
                - OilPressure
                - MassAirFlow
                - Ignition
                - AccAxisX
                - AccAxisY
                - AccAxisZ
                - Button
                - Fault
                - RemainingFuel
                - InstantFuelConsumption
                - TotalFuel
                - MovingMode
                - Interrupt
                - Speed
                - EngineTemperature
                - FuelRate
                - BatteryTemperature
                - OBDIgnition
                - LoadPercentage
                - LoadingMode
                - FloorCapacityRatio
                - FloorAreaRemaining
                - PowerSource
                - ChargeType
            - type: array
              items:
                type: string
                enum:
                  - InDoor
                  - OutDoor
                  - DoorState
                  - RemovalState
                  - BLEConnection
                  - Battery
                  - Humidity
                  - Temperature
                  - Impact
                  - Pressure
                  - Light
                  - Tamper
                  - RSSI
                  - Fuel
                  - FuelLevel
                  - Odometer
                  - TirePressureLF
                  - TirePressureRF
                  - TirePressureLR
                  - TirePressureRR
                  - CoolantTemperature
                  - BatteryVoltage
                  - BackupBatteryVoltage
                  - EngineOnTime
                  - RPM
                  - EngineSpeed
                  - EngineHours
                  - EngineLoad
                  - TotalMileage
                  - AverageOilConsumption
                  - Break
                  - OilPressure
                  - MassAirFlow
                  - Ignition
                  - AccAxisX
                  - AccAxisY
                  - AccAxisZ
                  - Button
                  - Fault
                  - RemainingFuel
                  - InstantFuelConsumption
                  - TotalFuel
                  - MovingMode
                  - Interrupt
                  - Speed
                  - EngineTemperature
                  - FuelRate
                  - BatteryTemperature
                  - OBDIgnition
                  - LoadPercentage
                  - LoadingMode
                  - FloorCapacityRatio
                  - FloorAreaRemaining
                  - PowerSource
                  - ChargeType
            - type: object
              description: >-
                Explicit operator form for `type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - InDoor
                    - OutDoor
                    - DoorState
                    - RemovalState
                    - BLEConnection
                    - Battery
                    - Humidity
                    - Temperature
                    - Impact
                    - Pressure
                    - Light
                    - Tamper
                    - RSSI
                    - Fuel
                    - FuelLevel
                    - Odometer
                    - TirePressureLF
                    - TirePressureRF
                    - TirePressureLR
                    - TirePressureRR
                    - CoolantTemperature
                    - BatteryVoltage
                    - BackupBatteryVoltage
                    - EngineOnTime
                    - RPM
                    - EngineSpeed
                    - EngineHours
                    - EngineLoad
                    - TotalMileage
                    - AverageOilConsumption
                    - Break
                    - OilPressure
                    - MassAirFlow
                    - Ignition
                    - AccAxisX
                    - AccAxisY
                    - AccAxisZ
                    - Button
                    - Fault
                    - RemainingFuel
                    - InstantFuelConsumption
                    - TotalFuel
                    - MovingMode
                    - Interrupt
                    - Speed
                    - EngineTemperature
                    - FuelRate
                    - BatteryTemperature
                    - OBDIgnition
                    - LoadPercentage
                    - LoadingMode
                    - FloorCapacityRatio
                    - FloorAreaRemaining
                    - PowerSource
                    - ChargeType
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - InDoor
                      - OutDoor
                      - DoorState
                      - RemovalState
                      - BLEConnection
                      - Battery
                      - Humidity
                      - Temperature
                      - Impact
                      - Pressure
                      - Light
                      - Tamper
                      - RSSI
                      - Fuel
                      - FuelLevel
                      - Odometer
                      - TirePressureLF
                      - TirePressureRF
                      - TirePressureLR
                      - TirePressureRR
                      - CoolantTemperature
                      - BatteryVoltage
                      - BackupBatteryVoltage
                      - EngineOnTime
                      - RPM
                      - EngineSpeed
                      - EngineHours
                      - EngineLoad
                      - TotalMileage
                      - AverageOilConsumption
                      - Break
                      - OilPressure
                      - MassAirFlow
                      - Ignition
                      - AccAxisX
                      - AccAxisY
                      - AccAxisZ
                      - Button
                      - Fault
                      - RemainingFuel
                      - InstantFuelConsumption
                      - TotalFuel
                      - MovingMode
                      - Interrupt
                      - Speed
                      - EngineTemperature
                      - FuelRate
                      - BatteryTemperature
                      - OBDIgnition
                      - LoadPercentage
                      - LoadingMode
                      - FloorCapacityRatio
                      - FloorAreaRemaining
                      - PowerSource
                      - ChargeType
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `type`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        value:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `value`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `value`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        recorded_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `recorded_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `recorded_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        text_value:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `text_value`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `text_value`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        diff:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `diff`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `diff`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        source:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `source`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `source`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
      additionalProperties: false
    Location:
      type: object
      properties:
        device_id:
          type: string
        located_at:
          type: string
          format: date-time
        timezone:
          type: string
          nullable: true
        latitude:
          type: number
        longitude:
          type: number
        speed_kmh:
          type: number
        heading:
          type: number
        altitude:
          type: string
          description: Optional — returned only when requested via `fields`.
        hdop:
          type: number
          nullable: true
          description: >-
            Horizontal dilution of precision of the GPS fix. Lower is more precise. null when the
            device didn't report it. Optional — returned only when requested via `fields`.
        satellite_count:
          type: integer
          nullable: true
          description: >-
            Number of satellites used for the GPS fix. null when the device didn't report it.
            Optional — returned only when requested via `fields`.
        road_speed_limit_kmh:
          type: number
          description: Optional — returned only when requested via `fields`.
        event:
          type: string
          description: Optional — returned only when requested via `fields`.
        odometer_km:
          type: number
          description: Optional — returned only when requested via `fields`.
        battery_percentage:
          type: string
          description: Optional — returned only when requested via `fields`.
        battery_voltage:
          type: string
          description: Optional — returned only when requested via `fields`.
        external_adc_voltage:
          type: string
          description: Optional — returned only when requested via `fields`.
        rfid_scan:
          type: string
          description: Optional — returned only when requested via `fields`.
        alarm_input:
          type: string
          description: Optional — returned only when requested via `fields`.
        engine_code:
          type: string
          description: Optional — returned only when requested via `fields`.
        errors_description:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        source_type:
          type: string
          description: Optional — returned only when requested via `fields`.
        indoor_position:
          type: object
          nullable: true
          description: >-
            Position on the indoor map ({x, y, map_id}), forwarded from the stored Indoor
            sub-document. null when not applicable. Optional — returned only when requested via
            `fields`.
        passenger_count:
          type: number
          description: Optional — returned only when requested via `fields`.
        channels:
          type: string
          description: Optional — returned only when requested via `fields`.
        event_action:
          type: string
          description: Optional — returned only when requested via `fields`.
        device:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            serial:
              type: string
          description: >-
            Expanded when `include=device`. null when this record has no linked device, or the
            linked record no longer exists.
          nullable: true
      required:
        - device_id
        - timezone
    LocationFilter:
      type: object
      description: >-
        Filter conditions for location fields. Multiple fields combine with AND. See "Filtering" in
        the API description for the full body shape and operator list.
      properties:
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        located_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `located_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `located_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        latitude:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `latitude`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `latitude`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        longitude:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `longitude`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `longitude`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        speed_kmh:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `speed_kmh`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `speed_kmh`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        heading:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `heading`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `heading`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        altitude:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `altitude`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `altitude`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        hdop:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `hdop`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `hdop`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        satellite_count:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `satellite_count`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `satellite_count`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        road_speed_limit_kmh:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `road_speed_limit_kmh`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `road_speed_limit_kmh`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        event:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `event`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `event`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        battery_percentage:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `battery_percentage`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `battery_percentage`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        battery_voltage:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `battery_voltage`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `battery_voltage`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        external_adc_voltage:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `external_adc_voltage`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `external_adc_voltage`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        rfid_scan:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `rfid_scan`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `rfid_scan`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        alarm_input:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `alarm_input`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `alarm_input`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        engine_code:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `engine_code`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `engine_code`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        source_type:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `source_type`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `source_type`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        passenger_count:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `passenger_count`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `passenger_count`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        channels:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `channels`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `channels`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        event_action:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `event_action`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `event_action`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    Form:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        form_category:
          type: string
        status:
          type: string
        created:
          type: string
        created_by:
          type: string
        estimate_time_in_minutes:
          type: string
        is_reusable:
          type: boolean
        group_ids:
          type: array
          items:
            type: string
        device_ids:
          type: array
          items:
            type: string
        driver_ids:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        layout:
          type: string
          description: Optional — returned only when requested via `fields`.
        mobile_layout:
          type: string
          description: Optional — returned only when requested via `fields`.
        dvir_config:
          type: string
          description: Optional — returned only when requested via `fields`.
        safety_config:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom_field_config:
          type: string
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        tag_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        form_condition_groups:
          type: array
          items:
            type: object
          description: >-
            Show/hide conditional-logic groups keyed by fieldId, forwarded as-is. Optional —
            returned only when requested via `fields`.
        form_notification:
          type: array
          items:
            type: object
          description: >-
            Submit-notification routing (EventType, CustomEmails, CustomPhone), forwarded as-is.
            Optional — returned only when requested via `fields`.
        is_send_notification:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        send_for_approval:
          type: boolean
          description: Optional — returned only when requested via `fields`.
      required:
        - id
    FormFilter:
      type: object
      description: >-
        Filter conditions for form fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties: {}
      additionalProperties: false
    FormSubmission:
      type: object
      properties:
        id:
          type: string
        form_id:
          type: string
        name:
          type: string
        form_category:
          type: string
        assigned_driver_id:
          type: string
        status:
          type: string
        created:
          type: string
        created_by:
          type: string
        submitted:
          type: string
        submitted_by:
          type: string
        device_id:
          type: string
        submitted_location:
          type: string
          nullable: true
        job:
          type: string
        note:
          type: string
        form_description:
          type: string
        answers:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
                nullable: true
              name:
                type: string
                nullable: true
              value:
                nullable: true
                description: Answer value; shape depends on the field's `type` (text, number, date, etc).
              type:
                type: string
                nullable: true
              options:
                type: array
                description: Multi-select/checkbox choices. Empty for answer types with no options.
                items:
                  type: object
                  properties:
                    check_or_selected:
                      type: boolean
                      nullable: true
                    option:
                      type: string
                      nullable: true
                    info:
                      type: string
                      nullable: true
                    custom_field:
                      type: array
                      description: >-
                        Nested repeater/sub-form answers (e.g. a grouped follow-up question set),
                        sanitized the same way as top-level `answers` — recursively, so a
                        sub-answer's own `options[].custom_field` can nest further.
                      items:
                        type: object
              files:
                type: array
                description: Uploaded file/photo/signature references. Empty for answer types with no files.
                items:
                  type: string
              location:
                type: object
                nullable: true
                description: >-
                  Per-answer GPS stamp, distinct from the submission-level
                  `submitted_location`/`dispatch_location`. null when not captured for this answer.
                properties:
                  lat:
                    type: number
                  lng:
                    type: number
              unit_field_detail:
                type: object
                nullable: true
                description: >-
                  Unit and value for a unit-typed numeric answer (e.g. odometer/fuel readings). null
                  for non-unit answers.
                properties:
                  unit:
                    type: string
                    nullable: true
                  value:
                    nullable: true
          description: Optional — returned only when requested via `fields`.
        dispatch_location:
          type: string
          description: Optional — returned only when requested via `fields`.
        updated:
          type: string
          description: Optional — returned only when requested via `fields`.
        updated_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        rejected:
          type: string
          description: Optional — returned only when requested via `fields`.
        rejected_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        rejected_note:
          type: string
          description: Optional — returned only when requested via `fields`.
        approved_on:
          type: string
          description: Optional — returned only when requested via `fields`.
        approved_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        needs_supervisor_approval:
          type: string
          description: Optional — returned only when requested via `fields`.
        dvir_config:
          type: string
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        device_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        driver_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        tags:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        tag_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        mobile_layout:
          type: string
          description: Optional — returned only when requested via `fields`.
        estimate_time_in_minutes:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
      required:
        - id
        - submitted_location
    FormSubmissionFilter:
      type: object
      description: >-
        Filter conditions for form submission fields. Multiple fields combine with AND. See
        "Filtering" in the API description for the full body shape and operator list.
      properties: {}
      additionalProperties: false
    FormSchedule:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        recurrence:
          type: string
        next_run_at:
          type: string
          format: date-time
        last_run_at:
          type: string
          format: date-time
        created_by:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        last_dispatch_task_ids:
          type: array
          items:
            type: string
      required:
        - id
    FormScheduleFilter:
      type: object
      description: >-
        Filter conditions for form schedule fields. Multiple fields combine with AND. See
        "Filtering" in the API description for the full body shape and operator list.
      properties: {}
      additionalProperties: false
    Product:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        price:
          type: number
        unique_id:
          type: string
        title:
          type: string
        image_url:
          type: string
          description: Optional — returned only when requested via `fields`.
        zone_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        type:
          type: string
          description: Optional — returned only when requested via `fields`.
        quantity_in_hand:
          type: number
          description: Optional — returned only when requested via `fields`.
        tags:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        device_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        is_archived:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        is_marketplace_product:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        created_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        order_lead_time:
          type: object
          nullable: true
          description: >-
            Order lead time before dispatch ({ Days, Hours, Minutes }), forwarded as-is. Optional —
            returned only when requested via `fields`.
          example:
            Days: 1
            Hours: 2
            Minutes: 0
      required:
        - id
    ProductFilter:
      type: object
      description: >-
        Filter conditions for product fields. Multiple fields combine with AND. See "Filtering" in
        the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/products`.
        price:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `price`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `price`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        unique_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `unique_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `unique_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        zone_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `zone_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `zone_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        quantity_in_hand:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `quantity_in_hand`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `quantity_in_hand`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        tags:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `tags`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `tags`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`. See "Filtering" in the API description.
        device_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `device_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        is_archived:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_archived`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_archived`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
        is_marketplace_product:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_marketplace_product`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_marketplace_product`. Bare value = `eq`, or an operator object using `eq`.
            See "Filtering" in the API description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        company_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `company_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `company_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    Job:
      type: object
      properties:
        id:
          type: string
        number:
          type: number
        name:
          type: string
          description: Job name. Required on create.
        reference:
          type: string
        status:
          type: string
        device_id:
          type: string
        user_id:
          type: string
        assignment_type:
          type: string
          enum:
            - VEHICLE
            - DRIVER
          description: >-
            How the job is assigned. Optional (defaults to `VEHICLE`). Assignment is optional
            overall — the three shapes are: set `device_id` for a vehicle-assigned job, `user_id`
            for a driver-assigned job, or omit both to create an Unassigned job.
        due_date:
          type: string
          format: date-time
          description: When the job is due. Required on create and must not be in the past (ISO-8601).
        created_at:
          type: string
          format: date-time
        created_by:
          type: string
        modified_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        modified_by:
          type: string
          description: Optional — returned only when requested via `fields`.
        estimated_start_date:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        scheduled_date:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        completed_date:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        notes:
          type: array
          description: >-
            Job notes, forwarded as-is (PascalCase sub-keys, matching the stored/downstream shape
            and the read response) to the dispatch service. Optional — returned only when requested
            via `fields`.
          items:
            type: object
            properties:
              Text:
                type: string
              Username:
                type: string
              Files:
                type: array
                items:
                  type: string
              Date:
                type: string
                format: date-time
        is_pre_booked:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        custom:
          type: object
          description: >-
            Custom key/value data for app integrations. Values may be string or number. Optional —
            returned only when requested via `fields`.
          additionalProperties:
            oneOf:
              - type: string
              - type: number
        default_form_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        stops:
          type: array
          minItems: 1
          description: >-
            Job stops, forwarded as-is (PascalCase sub-keys, matching the stored/downstream shape
            and the read response) to the dispatch service. Required on create: at least one stop,
            and each stop must have numeric `Latitude` and `Longitude` (a non-zero position).
            `Eta`/`Actual`/`WorkOrders` are read-only. Optional — returned only when requested via
            `fields`.
          items:
            type: object
            properties:
              Id:
                type: string
              Name:
                type: string
              Address:
                type: string
              CustomerId:
                type: string
              Latitude:
                type: number
              Longitude:
                type: number
              Note:
                type: string
              IsStartLocation:
                type: boolean
              Eta:
                type: object
                readOnly: true
                description: Server-computed timing. Read-only — has no effect if sent on a write.
                properties:
                  StopDuration:
                    type: number
                    description: Stop duration, ms.
                  Duration:
                    type: number
                    description: Trip duration, ms.
                  Distance:
                    type: number
                    description: Trip distance, meters.
                  ArrivalDate:
                    type: string
                    format: date-time
                  DepartureDate:
                    type: string
                    format: date-time
              Actual:
                type: object
                readOnly: true
                description: Server-computed timing. Read-only — has no effect if sent on a write.
                properties:
                  StopDuration:
                    type: number
                    description: Stop duration, ms.
                  Duration:
                    type: number
                    description: Trip duration, ms.
                  Distance:
                    type: number
                    description: Trip distance, meters.
                  ArrivalDate:
                    type: string
                    format: date-time
                  DepartureDate:
                    type: string
                    format: date-time
              WorkOrders:
                type: array
                readOnly: true
                description: >-
                  Work orders attached to the stop. Read-only — populated by the dispatch service
                  (Submit), not settable on a write.
                items:
                  type: object
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        recurring_reference_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        recurring_display_text:
          type: string
          description: Optional — returned only when requested via `fields`.
        job_source:
          type: string
          description: Optional — returned only when requested via `fields`.
        bus_journey_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        bus_route_id:
          type: string
          description: Optional — returned only when requested via `fields`.
      required:
        - id
    JobFilter:
      type: object
      description: >-
        Filter conditions for job fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        number:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `number`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `number`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/jobs`.
        reference:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `reference`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `reference`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        status:
          oneOf:
            - type: string
              enum:
                - Unassigned
                - Assigned
                - Dispatched
                - En_route_stop
                - Arrived_stop
                - Completed_stop
                - Completed
                - Cancelled
                - Rejected
            - type: array
              items:
                type: string
                enum:
                  - Unassigned
                  - Assigned
                  - Dispatched
                  - En_route_stop
                  - Arrived_stop
                  - Completed_stop
                  - Completed
                  - Cancelled
                  - Rejected
            - type: object
              description: >-
                Explicit operator form for `status`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Unassigned
                    - Assigned
                    - Dispatched
                    - En_route_stop
                    - Arrived_stop
                    - Completed_stop
                    - Completed
                    - Cancelled
                    - Rejected
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Unassigned
                      - Assigned
                      - Dispatched
                      - En_route_stop
                      - Arrived_stop
                      - Completed_stop
                      - Completed
                      - Cancelled
                      - Rejected
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        user_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `user_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `user_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        assignment_type:
          oneOf:
            - type: string
              enum:
                - VEHICLE
                - DRIVER
            - type: array
              items:
                type: string
                enum:
                  - VEHICLE
                  - DRIVER
            - type: object
              description: >-
                Explicit operator form for `assignment_type`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - VEHICLE
                    - DRIVER
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - VEHICLE
                      - DRIVER
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `assignment_type`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        due_date:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `due_date`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `due_date`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        created_by:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `created_by`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_by`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        modified_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `modified_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `modified_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        modified_by:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `modified_by`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `modified_by`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        estimated_start_date:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `estimated_start_date`. One or more of: `eq`, `in`,
                `gte`, `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `estimated_start_date`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        scheduled_date:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `scheduled_date`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `scheduled_date`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        completed_date:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `completed_date`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `completed_date`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        is_pre_booked:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_pre_booked`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_pre_booked`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
        default_form_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `default_form_id`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `default_form_id`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    TrackerType:
      type: object
      properties:
        name:
          type: string
        display_name:
          type: string
        device_category:
          type: string
        description:
          type: string
          description: Optional — returned only when requested via `fields`.
        image_url:
          type: string
          description: Optional — returned only when requested via `fields`.
        portal_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        setup_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        support_email:
          type: string
          description: Optional — returned only when requested via `fields`.
        support_phone:
          type: string
          description: Optional — returned only when requested via `fields`.
        trax_pricing:
          type: number
          description: Optional — returned only when requested via `fields`.
        geotab_custom_pricing:
          type: number
          description: Optional — returned only when requested via `fields`.
        training:
          type: number
          description: Optional — returned only when requested via `fields`.
        sla_documentation_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        accessories_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        installation_document_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        partner_installation_video_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        troubleshooting_document_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        partner_video_link:
          type: string
          description: Optional — returned only when requested via `fields`.
        data_plan_mb:
          type: number
          description: Optional — returned only when requested via `fields`.
        features:
          type: array
          items:
            type: object
          description: >-
            Tracker-type feature list, forwarded as-is per stored item shape. Optional — returned
            only when requested via `fields`.
        crm_product:
          type: object
          nullable: true
          description: >-
            CRM product/SKU mapping, forwarded as-is. Optional — returned only when requested via
            `fields`.
      required:
        - name
    TrackerTypeFilter:
      type: object
      description: >-
        Filter conditions for tracker type fields. Multiple fields combine with AND. See "Filtering"
        in the API description for the full body shape and operator list.
      properties:
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/tracker-types`.
        display_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `display_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `display_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        device_category:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `device_category`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_category`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        description:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `description`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `description`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        support_email:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `support_email`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `support_email`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        support_phone:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `support_phone`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `support_phone`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    CustomMap:
      type: object
      properties:
        id:
          type: string
        map_name:
          type: string
        name:
          type: string
        type:
          type: string
        web_url:
          type: string
          nullable: true
        indoor_image_url:
          type: string
          nullable: true
        order:
          type: string
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        location_name:
          type: string
          description: Optional — returned only when requested via `fields`.
        location_lat:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
        location_lng:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
        indoor_rotation:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
        indoor_devices:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              left:
                type: number
              top:
                type: number
              device_placed:
                type: boolean
          description: Optional — returned only when requested via `fields`.
        indoor_beacons:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              left:
                type: number
              top:
                type: number
              device_placed:
                type: boolean
          description: Optional — returned only when requested via `fields`.
        indoor_scale:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
        indoor_image_width:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
        indoor_image_height:
          type: number
          nullable: true
          description: Optional — returned only when requested via `fields`.
      required:
        - id
        - web_url
        - indoor_image_url
    CustomMapFilter:
      type: object
      description: >-
        Filter conditions for custom map fields. Multiple fields combine with AND. See "Filtering"
        in the API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        map_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `map_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `map_name`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `name`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
            Discover valid values via `GET /v1/custom-maps`.
        type:
          oneOf:
            - type: string
              enum:
                - Indoor
                - Web
            - type: array
              items:
                type: string
                enum:
                  - Indoor
                  - Web
            - type: object
              description: >-
                Explicit operator form for `type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Indoor
                    - Web
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Indoor
                      - Web
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `type`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        order:
          oneOf:
            - type: number
            - type: array
              items:
                type: number
            - type: object
              description: >-
                Explicit operator form for `order`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: number
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: number
                  description: Match any of a list of values.
                gte:
                  type: number
                  description: Greater-than-or-equal.
                lte:
                  type: number
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `order`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API description.
        company_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `company_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `company_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        location_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `location_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `location_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    Comment:
      type: object
      properties:
        id:
          type: string
        parent_id:
          type: string
        text:
          type: string
        created_at:
          type: string
          format: date-time
        user_id:
          type: string
        user_full_name:
          type: string
        updated_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        is_visible_to_driver:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        attachments:
          type: array
          items:
            type: object
          description: >-
            Attached files ({Url, Name}), forwarded as-is. Optional — returned only when requested
            via `fields`.
        link:
          type: object
          nullable: true
          description: >-
            Linked resource ({Url, Title}), forwarded as-is. null when not set. Optional — returned
            only when requested via `fields`.
        is_editable:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        additional_notes:
          type: array
          items:
            type: object
          description: >-
            Additional key/value notes ({Key, Value}), forwarded as-is. Optional — returned only
            when requested via `fields`.
        updated_by_user_id:
          type: string
          description: Optional — returned only when requested via `fields`.
      required:
        - id
    CommentFilter:
      type: object
      description: >-
        Filter conditions for comment fields. Multiple fields combine with AND. See "Filtering" in
        the API description for the full body shape and operator list.
      properties:
        parent_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `parent_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `parent_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        text:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `text`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `text`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        user_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `user_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `user_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        user_full_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `user_full_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `user_full_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        updated_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `updated_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `updated_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        is_visible_to_driver:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_visible_to_driver`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_visible_to_driver`. Bare value = `eq`, or an operator object using `eq`.
            See "Filtering" in the API description.
      additionalProperties: false
    User:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
          description: >-
            Login username. Required on create; create-only. A `password` is auto-generated when
            omitted.
        first_name:
          type: string
        last_name:
          type: string
        full_name:
          type: string
          nullable: true
        is_driver:
          type: boolean
        group_ids:
          type: array
          items:
            type: string
          minItems: 1
          description: >-
            Group ids the user belongs to. Required on create — at least one group must be supplied.
            Optional — returned only when requested via `fields`.
        email:
          type: string
          description: Optional — returned only when requested via `fields`.
        phone:
          type: string
          description: Optional — returned only when requested via `fields`.
        units:
          type: string
          description: Optional — returned only when requested via `fields`.
        language:
          type: string
          description: Optional — returned only when requested via `fields`.
        user_type:
          type: string
          description: >-
            User role. Optional — defaults to `Driver`; an unrecognised value is rejected on create
            with "Invalid UserType". Optional — returned only when requested via `fields`.
        employee_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        created_at:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        last_login:
          type: string
          format: date-time
          description: Optional — returned only when requested via `fields`.
        company_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_number:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_state:
          type: string
          description: Optional — returned only when requested via `fields`.
        license_country:
          type: string
          description: Optional — returned only when requested via `fields`.
        working_hours:
          type: object
          description: >-
            Per-day working-hours schedule, forwarded as-is (e.g. { Mon: { active, hours: { from, to
            } }, … }). Optional — returned only when requested via `fields`.
          example:
            Mon:
              active: true
              hours:
                from: '09:00'
                to: '17:00'
        time_zone:
          type: string
          description: Optional — returned only when requested via `fields`.
        photo_url:
          type: string
          description: Optional — returned only when requested via `fields`.
        telegram_chat_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        region_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        business_group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        people_group_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        can_assign_job_itself:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        default_view:
          type: string
          description: Optional — returned only when requested via `fields`.
        fetch_location_from_mobile:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        feature_preview:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        supervisor_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        driver_app_data:
          type: object
          nullable: true
          description: >-
            Driver app data — check-in/out, breaks, work-time tracking, forwarded as-is. Optional —
            returned only when requested via `fields`.
        map_provider:
          type: string
          description: Optional — returned only when requested via `fields`.
        custom_fields:
          type: object
          description: >-
            Tenant-defined custom field values, keyed by field name, forwarded as-is. Optional —
            returned only when requested via `fields`.
        driver_identification:
          type: string
          description: Optional — returned only when requested via `fields`.
        verification_phone_number:
          type: string
          description: Optional — returned only when requested via `fields`.
        show_self_data:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        comments:
          type: string
          description: Optional — returned only when requested via `fields`.
        live_notification_settings:
          type: object
          nullable: true
          description: >-
            Live-notification preferences, forwarded as-is. Optional — returned only when requested
            via `fields`.
        switchboard_id:
          type: string
          description: Optional — returned only when requested via `fields`.
        hos_enabled:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        hos_exempted:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        rule_set:
          type: string
          description: Optional — returned only when requested via `fields`.
        us_hos_cycle:
          type: string
          description: Optional — returned only when requested via `fields`.
        home_terminal_name:
          type: string
          description: Optional — returned only when requested via `fields`.
        home_terminal_address:
          type: object
          nullable: true
          description: >-
            Home-terminal location ({ Location: { latitude, longitude }, LocationName }), forwarded
            as-is. Optional — returned only when requested via `fields`.
          example:
            Location:
              latitude: 43.6532
              longitude: -79.3832
            LocationName: Main Depot
        exemption_annotation:
          type: string
          description: Optional — returned only when requested via `fields`.
        yard_move_allowed:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        personal_conveyance_allowed:
          type: boolean
          description: Optional — returned only when requested via `fields`.
        pinned_add_in_ids:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            description: Expanded when `include=groups`.
          description: Expanded when `include=groups`.
      required:
        - id
        - full_name
    UserFilter:
      type: object
      description: >-
        Filter conditions for user fields. Multiple fields combine with AND. See "Filtering" in the
        API description for the full body shape and operator list.
      properties:
        id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `id`. Bare value = `eq` (bare array = `in`), or an operator object using one
            of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        username:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `username`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `username`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        first_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `first_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `first_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        last_name:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `last_name`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `last_name`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        is_driver:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_driver`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_driver`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
        group_ids:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `group_ids`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `group_ids`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        email:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `email`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `email`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        phone:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `phone`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `phone`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        units:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `units`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `units`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        language:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `language`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `language`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API description.
        user_type:
          oneOf:
            - type: string
              enum:
                - Driver
                - End Customer
                - EndUser
                - General User
                - Passenger
                - Technician
            - type: array
              items:
                type: string
                enum:
                  - Driver
                  - End Customer
                  - EndUser
                  - General User
                  - Passenger
                  - Technician
            - type: object
              description: >-
                Explicit operator form for `user_type`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  enum:
                    - Driver
                    - End Customer
                    - EndUser
                    - General User
                    - Passenger
                    - Technician
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Driver
                      - End Customer
                      - EndUser
                      - General User
                      - Passenger
                      - Technician
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `user_type`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        employee_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `employee_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `employee_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        created_at:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `created_at`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `created_at`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        last_login:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `last_login`. One or more of: `eq`, `in`, `gte`, `lte`,
                `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `last_login`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        company_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `company_id`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `company_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        license_number:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_number`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_number`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        license_state:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_state`. One or more of: `eq`, `in`, `contains`,
                `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_state`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
        license_country:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: >-
                Explicit operator form for `license_country`. One or more of: `eq`, `in`,
                `contains`, `starts_with`.
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
                contains:
                  type: string
                  description: Case-insensitive substring match.
                starts_with:
                  type: string
                  description: Case-insensitive prefix match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `license_country`. Bare value = `eq` (bare array = `in`), or an operator
            object using one of `eq`, `in`, `contains`, `starts_with`. See "Filtering" in the API
            description.
      additionalProperties: false
    CoachingSession:
      type: object
      properties:
        id:
          type: string
        driver_id:
          type: string
        device_id:
          type: string
        coaching_date:
          type: string
          format: date-time
        method:
          type: string
        coach_id:
          type: string
        status:
          type: string
        digest_type:
          type: string
        exceptions_coached:
          type: string
        badges:
          type: string
        rule_ids:
          type: array
          items:
            type: string
        is_acknowledged:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        coaching_notes:
          type: string
          description: Optional — returned only when requested via `fields`.
      required:
        - id
    CoachingSessionFilter:
      type: object
      description: >-
        Filter conditions for coaching session fields. Multiple fields combine with AND. See
        "Filtering" in the API description for the full body shape and operator list.
      properties:
        driver_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `driver_id`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `driver_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        device_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `device_id`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `device_id`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        coaching_date:
          oneOf:
            - type: string
              format: date-time
            - type: array
              items:
                type: string
                format: date-time
            - type: object
              description: >-
                Explicit operator form for `coaching_date`. One or more of: `eq`, `in`, `gte`,
                `lte`, `between`.
              properties:
                eq:
                  type: string
                  format: date-time
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    format: date-time
                  description: Match any of a list of values.
                gte:
                  type: string
                  format: date-time
                  description: Greater-than-or-equal.
                lte:
                  type: string
                  format: date-time
                  description: Less-than-or-equal.
                between:
                  type: array
                  items:
                    type: string
                    format: date-time
                  minItems: 2
                  maxItems: 2
                  description: 'Inclusive range: a two-element `[min, max]` array.'
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `coaching_date`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`, `gte`, `lte`, `between`. See "Filtering" in the API
            description.
        method:
          oneOf:
            - type: string
              enum:
                - AI
                - MANUAL
            - type: array
              items:
                type: string
                enum:
                  - AI
                  - MANUAL
            - type: object
              description: 'Explicit operator form for `method`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  enum:
                    - AI
                    - MANUAL
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - AI
                      - MANUAL
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `method`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`. See "Filtering" in the API description.
        coach_id:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              description: 'Explicit operator form for `coach_id`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `coach_id`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`. See "Filtering" in the API description.
        status:
          oneOf:
            - type: string
              enum:
                - Pending
                - WaitingForSafeWindow
                - Delivering
                - Completed
                - Cancelled
                - Failed
            - type: array
              items:
                type: string
                enum:
                  - Pending
                  - WaitingForSafeWindow
                  - Delivering
                  - Completed
                  - Cancelled
                  - Failed
            - type: object
              description: 'Explicit operator form for `status`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  enum:
                    - Pending
                    - WaitingForSafeWindow
                    - Delivering
                    - Completed
                    - Cancelled
                    - Failed
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - Pending
                      - WaitingForSafeWindow
                      - Delivering
                      - Completed
                      - Cancelled
                      - Failed
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `status`. Bare value = `eq` (bare array = `in`), or an operator object using
            one of `eq`, `in`. See "Filtering" in the API description.
        digest_type:
          oneOf:
            - type: string
              enum:
                - daily
                - weekly
                - monthly
            - type: array
              items:
                type: string
                enum:
                  - daily
                  - weekly
                  - monthly
            - type: object
              description: 'Explicit operator form for `digest_type`. One or more of: `eq`, `in`.'
              properties:
                eq:
                  type: string
                  enum:
                    - daily
                    - weekly
                    - monthly
                  description: Equality match.
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - daily
                      - weekly
                      - monthly
                  description: Match any of a list of values.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `digest_type`. Bare value = `eq` (bare array = `in`), or an operator object
            using one of `eq`, `in`. See "Filtering" in the API description.
        is_acknowledged:
          oneOf:
            - type: boolean
            - type: object
              description: 'Explicit operator form for `is_acknowledged`. One or more of: `eq`.'
              properties:
                eq:
                  type: boolean
                  description: Equality match.
              additionalProperties: false
              minProperties: 1
          description: >-
            Filter by `is_acknowledged`. Bare value = `eq`, or an operator object using `eq`. See
            "Filtering" in the API description.
      additionalProperties: false
    DeviceStatus:
      type: object
      properties:
        device_id:
          type: string
        latitude:
          type: number
        longitude:
          type: number
        speed_kmh:
          type: number
        heading:
          type: number
        is_ignition_on:
          type: boolean
        is_moving:
          type: boolean
        is_communicating:
          type: boolean
        updated_at:
          type: string
          format: date-time
      required:
        - device_id
    Company:
      type: object
      properties:
        company_id:
          type: string
        name:
          type: string
        timezone:
          type: string
        location:
          type: object
          nullable: true
          description: Company's registered address coordinates. null when not set.
          properties:
            latitude:
              type: number
            longitude:
              type: number
        location_name:
          type: string
        industry:
          type: string
        plan:
          type: string
        size:
          type: string
        status:
          type: string
        created_at:
          type: string
          format: date-time
      required:
        - company_id
        - name
        - timezone
        - location
        - location_name
        - industry
        - plan
        - size
        - status
        - created_at
    SummaryPeriod:
      type: object
      properties:
        from:
          type: string
          example: '2026-06-01'
        to:
          type: string
          example: '2026-06-07'
      required:
        - from
        - to
    DriverSummary:
      type: object
      properties:
        driver_id:
          type: string
        driver_name:
          type: string
        driver_email:
          type: string
        period:
          $ref: '#/components/schemas/SummaryPeriod'
        distance:
          type: number
          description: Distance in kilometres.
        driving_duration:
          type: number
          description: Driving time in seconds.
        idling_duration:
          type: number
          description: Idling time in seconds.
        trip_count:
          type: number
        max_speed_kmh:
          type: number
        avg_speed_kmh:
          type: number
        idling_ratio:
          type: number
          description: Idling over driving + idling time, as a fraction 0–1.
        safety_score:
          type: number
          description: Safety score 0–100; higher is safer.
        risk_band:
          type: string
        p_accident:
          type: number
          description: Modelled accident probability, 0–1.
        avg_trip_dist_km:
          type: number
          description: Optional — returned only when requested via `fields`.
        speeding_duration:
          type: number
          description: Speeding time in seconds. Optional — returned only when requested via `fields`.
        speeding_event_count:
          type: number
          description: Optional — returned only when requested via `fields`.
        harsh_braking_count:
          type: number
          description: Optional — returned only when requested via `fields`.
        harsh_acceleration_count:
          type: number
          description: Optional — returned only when requested via `fields`.
        seatbelt_violations:
          type: number
          description: Optional — returned only when requested via `fields`.
        idling_event_count:
          type: number
          description: Optional — returned only when requested via `fields`.
        exceptions:
          type: object
          additionalProperties:
            type: integer
          description: Map of name → count. Optional — returned only when requested via `fields`.
        after_hours_driving_duration:
          type: number
          description: >-
            After-hours driving time in seconds. Optional — returned only when requested via
            `fields`.
        after_hours_distance:
          type: number
          description: >-
            After-hours distance in kilometres. Optional — returned only when requested via
            `fields`.
        after_hours_stop_duration:
          type: number
          description: >-
            After-hours stopped time in seconds. Optional — returned only when requested via
            `fields`.
        speeding_ratio:
          type: number
          description: >-
            Speeding over driving time, as a fraction 0–1. Optional — returned only when requested
            via `fields`.
        after_hours_ratio:
          type: number
          description: >-
            After-hours over driving time, as a fraction 0–1. Optional — returned only when
            requested via `fields`.
        braking_per_100km:
          type: number
          description: >-
            Harsh-braking events per 100 kilometres. Optional — returned only when requested via
            `fields`.
        accel_per_100km:
          type: number
          description: >-
            Harsh-acceleration events per 100 kilometres. Optional — returned only when requested
            via `fields`.
        speeding_pct:
          type: number
          description: >-
            Same quantity as `speeding_ratio`, as a percentage 0–100. Optional — returned only when
            requested via `fields`.
        idling_pct:
          type: number
          description: >-
            Same quantity as `idling_ratio`, as a percentage 0–100. Optional — returned only when
            requested via `fields`.
        after_hours_pct:
          type: number
          description: >-
            Same quantity as `after_hours_ratio`, as a percentage 0–100. Optional — returned only
            when requested via `fields`.
      required:
        - driver_id
        - driver_name
        - driver_email
        - period
        - distance
        - driving_duration
        - idling_duration
        - trip_count
        - max_speed_kmh
        - avg_speed_kmh
        - idling_ratio
        - safety_score
        - risk_band
        - p_accident
    VehicleSummary:
      type: object
      properties:
        device_id:
          type: string
        license_plate:
          type: string
        vin:
          type: string
        period:
          $ref: '#/components/schemas/SummaryPeriod'
        distance:
          type: number
          description: Distance in kilometres.
        driving_duration:
          type: number
          description: Driving time in seconds.
        idling_duration:
          type: number
          description: Idling time in seconds.
        trip_count:
          type: number
        avg_speed_kmh:
          type: number
        idling_ratio:
          type: number
          description: Idling over driving + idling time, as a fraction 0–1.
        odometer_km:
          type: number
        after_hours_driving_duration:
          type: number
          description: >-
            After-hours driving time in seconds. Optional — returned only when requested via
            `fields`.
        after_hours_distance:
          type: number
          description: >-
            After-hours distance in kilometres. Optional — returned only when requested via
            `fields`.
        after_hours_stop_duration:
          type: number
          description: >-
            After-hours stopped time in seconds. Optional — returned only when requested via
            `fields`.
        work_driving_duration:
          type: number
          description: >-
            On-schedule driving time in seconds. Optional — returned only when requested via
            `fields`.
        work_distance:
          type: number
          description: >-
            On-schedule distance in kilometres. Optional — returned only when requested via
            `fields`.
        work_stop_duration:
          type: number
          description: >-
            On-schedule stopped time in seconds. Optional — returned only when requested via
            `fields`.
        daily_distance_km_ecu:
          type: number
          description: Optional — returned only when requested via `fields`.
        engine_hours_total:
          type: number
          description: Optional — returned only when requested via `fields`.
        driver_change_count:
          type: number
          description: Optional — returned only when requested via `fields`.
        drivers_on_vehicle:
          type: array
          items:
            type: string
          description: Optional — returned only when requested via `fields`.
        after_hours_ratio:
          type: number
          description: >-
            After-hours over driving time, as a fraction 0–1. Optional — returned only when
            requested via `fields`.
      required:
        - device_id
        - license_plate
        - vin
        - period
        - distance
        - driving_duration
        - idling_duration
        - trip_count
        - avg_speed_kmh
        - idling_ratio
        - odometer_km
    IftaSummary:
      type: object
      properties:
        device_id:
          type: string
        jurisdiction:
          type: string
          description: US state / CA province of the trip's start position.
        country:
          type: string
        month:
          type: string
          example: 2026-01
          description: YYYY-MM (UTC).
        distance_km:
          type: number
          description: Summed trip distance for the vehicle in that jurisdiction and month (km).
        trip_count:
          type: integer
      required:
        - device_id
        - jurisdiction
        - country
        - month
        - distance_km
        - trip_count
    FormDispatchLocation:
      type: object
      description: Optional location to attach to the dispatch.
      properties:
        lat:
          type: number
        lng:
          type: number
      required:
        - lat
        - lng
    FormDispatchCreate:
      type: object
      additionalProperties: false
      properties:
        form_id:
          type: string
          description: The form to dispatch. Must belong to the caller's company.
        driver_ids:
          type: array
          items:
            type: string
          description: Drivers to dispatch the form to. At least one of `driver_ids`/`group_ids` is required.
        group_ids:
          type: array
          items:
            type: string
          description: >-
            Groups to dispatch the form to (resolved to their member drivers). At least one of
            `driver_ids`/`group_ids` is required.
        note:
          type: string
        dispatch_location:
          $ref: '#/components/schemas/FormDispatchLocation'
      required:
        - form_id
    FormDispatchResult:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: Ids of the created dispatch tasks, one per recipient driver.
      required:
        - ids
    FileUploadForm:
      type: object
      properties:
        file:
          type: string
          format: binary
          description: 'The file to upload. Allowed types: jpg, jpeg, png, pdf, csv, xls, xlsx. Max 30 MB.'
      required:
        - file
    FileUploadResult:
      type: object
      properties:
        id:
          type: string
          description: Opaque file id. Pass to GET /v1/files/{id} to obtain a short-lived download URL.
        filename:
          type: string
        content_type:
          type: string
        size:
          type: integer
          description: File size in bytes.
      required:
        - id
        - filename
        - size
    FileDownloadUrl:
      type: object
      properties:
        url:
          type: string
          description: Short-lived signed URL to download the file (valid ~15 minutes).
        expires_at:
          type: string
          format: date-time
          description: When the signed URL expires.
      required:
        - url
        - expires_at
    MediaAsyncRequestCreate:
      type: object
      additionalProperties: false
      properties:
        device_id:
          type: string
          description: The camera device to request media from.
        from:
          type: string
          format: date-time
          description: Start of the requested time range (ISO 8601).
        time_length_ms:
          type: integer
          description: >-
            Length of the requested clip in milliseconds. Defaults to a provider-specific value when
            omitted.
      required:
        - device_id
        - from
    MediaTaskResult:
      type: object
      properties:
        task_id:
          type: string
          description: Opaque task id. Poll GET /v1/media/tasks/{task_id} for the result.
      required:
        - task_id
    MediaItem:
      type: object
      description: >-
        A single piece of retrieved media (video clip, snapshot, or recording). The mapped keys are
        convenience accessors for the common fields; `raw` carries the provider's full record
        verbatim, so provider-specific fields (which vary by camera type) are never hidden.
      properties:
        url:
          type: string
        full_url:
          type: string
        mdt_url:
          type: string
        screenshot:
          type: string
        short_screenshot_url:
          type: string
        date_from:
          type: string
          format: date-time
        date_to:
          type: string
          format: date-time
        channel:
          type: integer
        video_id:
          type: string
        ai_video_url:
          type: string
        raw:
          type: object
          description: The provider's full media record verbatim; shape varies by camera provider.
    RecordingSegment:
      type: object
      description: >-
        An available recording segment — a footage window on a channel, NOT a downloadable file; it
        is an INDEX entry. To RECEIVE the footage, feed its `date_from` (and window) into one of:
        `POST /media/historical-streams` to WATCH it (returns a playable stream URL), or `POST
        /media/video-requests` to DOWNLOAD a clip (async — poll the task for a `MediaItem` with a
        `url`). `raw` carries the provider's full record verbatim.
      properties:
        device_id:
          type: string
        channel:
          type: integer
        date_from:
          type: string
          format: date-time
        date_to:
          type: string
          format: date-time
        stream_type:
          type: integer
        raw:
          type: object
          description: The provider's full recording record verbatim; shape varies by camera provider.
    MediaTaskStatus:
      type: object
      properties:
        status:
          type: string
          enum:
            - pending
            - completed
            - failed
            - expired
          description: >-
            `pending` until the device (or upstream provider) produces a result — a task may stay
            `pending` until the device next comes online. `expired` means the ~20-minute result TTL
            elapsed before the result was retrieved.
        result:
          type: array
          items:
            $ref: '#/components/schemas/MediaItem'
          description: >-
            Present only when `status` is `completed`. Results expire ~20 minutes after completion —
            after that, `status` becomes `expired` and `result` is absent.
        message:
          type: string
          description: Upstream detail, e.g. on `failed`.
      required:
        - status
    LiveSource:
      type: object
      description: >-
        A live or historical stream source. Format/protocol are provider-dependent — `raw` carries
        the provider-specific payload verbatim.
      properties:
        url:
          type: string
        protocol:
          type: string
        channel:
          type: integer
        format:
          type: string
        expires_at:
          type: string
          format: date-time
        raw:
          type: object
          description: Provider-specific payload, shape varies by camera provider.
      required:
        - url
        - raw
    MediaLiveStreamCreate:
      type: object
      additionalProperties: false
      properties:
        device_id:
          type: string
          description: The camera device to stream from.
        channels:
          type: array
          items:
            type: integer
          description: Camera channels to stream. All channels if omitted.
        format:
          type: string
          description: Requested stream format (provider-dependent).
      required:
        - device_id
    MediaHistoricalStreamCreate:
      type: object
      additionalProperties: false
      properties:
        device_id:
          type: string
          description: The camera device to stream from.
        from:
          type: string
          format: date-time
          description: Start of the requested time range (ISO 8601). Max range is 10 minutes.
        stream_type:
          type: integer
          description: Provider-specific stream type selector.
      required:
        - device_id
        - from
    MediaRecordingsCreate:
      type: object
      additionalProperties: false
      properties:
        device_id:
          type: string
          description: The camera device to fetch recordings for.
        from:
          type: string
          format: date-time
          description: Start of the requested time range (ISO 8601).
      required:
        - device_id
        - from
    MediaWakeCreate:
      type: object
      additionalProperties: false
      properties:
        device_id:
          type: string
          description: The camera device to wake from standby.
      required:
        - device_id
    MediaWakeResult:
      type: object
      properties:
        success:
          type: boolean
      required:
        - success
    Coordinate:
      type: object
      additionalProperties: false
      properties:
        lat:
          type: number
          description: Latitude.
        lng:
          type: number
          description: Longitude.
      required:
        - lat
        - lng
    GeocodingAddressesCreate:
      type: object
      additionalProperties: false
      properties:
        coordinates:
          type: array
          items:
            $ref: '#/components/schemas/Coordinate'
          description: Coordinates to reverse-geocode. Must be non-empty.
      required:
        - coordinates
    ZoneRef:
      type: object
      description: The company zone containing the coordinate, when it falls inside one.
      properties:
        id:
          type: string
        name:
          type: string
        color:
          type: string
      required:
        - id
        - name
    GeocodedAddress:
      type: object
      description: A single reverse-geocoded address, parallel to the input coordinates array.
      properties:
        formatted_address:
          type: string
        zone:
          anyOf:
            - $ref: '#/components/schemas/ZoneRef'
            - type: 'null'
          description: The company zone containing the coordinate, or null if none.
      required:
        - formatted_address
        - zone
    TtsMessageCreate:
      type: object
      additionalProperties: false
      properties:
        device_ids:
          type: array
          items:
            type: string
          description: >-
            StreamMax camera devices to send the message to. Non-StreamMax devices come back in
            `failed`.
        text:
          type: string
          maxLength: 150
          description: Message text to speak. Max 150 characters.
        language:
          type: string
          enum:
            - english
            - spanish
          description: Voice language. Defaults to english.
      required:
        - device_ids
        - text
    TtsMessageResult:
      type: object
      properties:
        success:
          type: array
          items:
            type: string
          description: Device ids the message was sent to.
        failed:
          type: array
          items:
            type: object
            properties:
              device_id:
                type: string
              error:
                type: string
            required:
              - device_id
              - error
          description: >-
            Device ids the message could not be sent to, with an error per device (e.g. not a
            StreamMax device).
      required:
        - success
        - failed
    DeviceAssignDriverCreate:
      type: object
      additionalProperties: false
      properties:
        driver_id:
          type: string
          description: >-
            The primary driver to assign. Must belong to the caller's company. Assigning a primary
            driver auto-unassigns them from any other device.
        additional_driver_ids:
          type: array
          items:
            type: string
          description: >-
            Optional additional drivers to assign alongside the primary. Must belong to the caller's
            company.
      required:
        - driver_id
    DeviceRemoveDriverCreate:
      type: object
      additionalProperties: false
      properties:
        driver_ids:
          type: array
          items:
            type: string
          description: >-
            Drivers to remove from the device (primary and/or additional). Must be a non-empty
            array.
      required:
        - driver_ids
    DeviceDriverResult:
      type: object
      properties:
        id:
          type: string
          description: Id of the device whose driver assignment changed.
      required:
        - id
    UserResetPasswordResult:
      type: object
      properties:
        id:
          type: string
          description: Id of the driver whose password was reset.
      required:
        - id
    JobSubmitCreate:
      type: object
      additionalProperties: false
      properties:
        work_order_id:
          type: string
          description: The work order (on this job's stop) being submitted.
        data:
          description: Submitted work-order data — form field values, forwarded as-is to the dispatch service.
        form_data:
          description: Optional additional form data captured with the submission.
      required:
        - work_order_id
        - data
    JobActionResult:
      type: object
      properties:
        id:
          type: string
          description: Id of the job the action applied to.
    JobAssignDeviceCreate:
      type: object
      additionalProperties: false
      properties:
        device_id:
          type: string
          description: The device to run this job. Must belong to the caller's company.
        scheduled_date:
          type: string
          format: date-time
          description: Optional scheduled start time for the job.
      required:
        - device_id
    JobStopCreate:
      type: object
      description: The stop to add to the job's route.
      additionalProperties: false
      properties:
        name:
          type: string
        address:
          type: string
        latitude:
          type: number
        longitude:
          type: number
        note:
          type: string
        customer_id:
          type: string
        is_start_location:
          type: boolean
      required:
        - name
        - address
        - latitude
        - longitude
    JobAddStopCreate:
      type: object
      additionalProperties: false
      properties:
        stop:
          $ref: '#/components/schemas/JobStopCreate'
      required:
        - stop
    JobAddStopResult:
      type: object
      properties:
        stop_id:
          type: string
          description: Id of the newly added stop.
    RepairOrderChangeStatusCreate:
      type: object
      additionalProperties: false
      properties:
        status:
          type: string
          enum:
            - Pending Assignment
            - Assigned
            - In Progress
            - On Hold
            - Completed
            - Cancelled
          description: The new repair order status.
      required:
        - status
    RepairOrderChangeStatusResult:
      type: object
      properties:
        id:
          type: string
          description: Id of the repair order whose status changed.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: not_found
            message:
              type: string
            request_id:
              type: string
          required:
            - code
            - message
      required:
        - error
    BaseMeta:
      type: object
      properties:
        request_id:
          type: string
    ListMeta:
      type: object
      properties:
        request_id:
          type: string
        count:
          type: integer
        next_cursor:
          type: string
          nullable: true
        has_more:
          type: boolean
        total:
          type: integer
          description: >-
            Total rows matching the query, ignoring pagination. Only present when the request passed
            `count=true`.
    RuleConditionNode:
      type: object
      description: >-
        One node of a rule's condition tree. Branch nodes carry `operation` + `arguments`; leaf
        nodes carry `condition`. A rule using the deprecated single-condition form is returned as a
        root node with only `condition`. Only the leaf keys relevant to that condition's `type` are
        present.
      properties:
        operation:
          type: string
          enum:
            - and
            - or
          description: How this node's `arguments` combine.
        arguments:
          type: array
          items:
            $ref: '#/components/schemas/RuleConditionNode'
        condition:
          type: object
          properties:
            type:
              type: string
              description: >-
                Raw condition type as stored, e.g. Speed, SpeedLimit, Idling, EnteredZone,
                InsideZone, Faults.
            tracker_type:
              type: string
            duration_minutes:
              type: number
            speed_kmh:
              type: number
            speed_duration_sec:
              type: number
            zone_id:
              type: string
            zone_type:
              type: string
            status:
              type: string
            input:
              type: string
            battery_level_pct:
              type: number
            temperature:
              type: number
            temperature_units:
              type: string
            fuel_level_pct:
              type: number
            humidity:
              type: number
            value:
              type: number
            comparison:
              type: string
              enum:
                - lower
                - greater
            low_limit:
              type: number
            high_limit:
              type: number
            sources:
              type: array
              items:
                type: string
            direction:
              type: string
              enum:
                - left
                - right
            grace_period_ms:
              type: number
            speed_threshold_kmh:
              type: number
            time_window_ms:
              type: number
    SummaryMeta:
      type: object
      properties:
        request_id:
          type: string
        period:
          $ref: '#/components/schemas/SummaryPeriod'
        timezone_resolved:
          type: boolean
        work_schedule_available:
          type: boolean
        low_distance:
          type: boolean
