From 74548358485831067a9550c616cacbc376515038 Mon Sep 17 00:00:00 2001 From: Brandon Salzberg Date: Mon, 5 Oct 2026 15:28:19 -0700 Subject: [PATCH] Point plugins at developer.rhombus.com and fix integration guidance Docs and contact: - Developer docs, llms.txt and deep links now use developer.rhombus.com; drop the legacy apidocs line and the forum links; contact is support@rhombus.com. The docs MCP URL (api-docs.rhombus.community/mcp) is unchanged until developer.rhombus.com serves /mcp. Corrections, checked against the live OpenAPI spec: - Federated tokens: mint with POST /api/org/generateFederatedSessionToken (durationSec, optional deviceUUid/domain), send x-auth-scheme: federated-token + x-auth-ft (headers or media-URL query params); never in x-auth-apikey; LAN devices accept only federated tokens. - Webhooks: organization webhooks sign with x-rhombus-signature-sha1 and rule webhook actions with x-rhombus-signature-sha256 (lowercase-hex HMAC of the raw body, secret as-is). Real org and rule payloads, constant-time verification code checked against a test vector. - Replace endpoints that don't exist (getVodUri, door/unlockDoor, developer/*Webhook, lockdown/executePlan, user/getOrgUserList, event/createSeekpoint, and others) with the real ones; every /api/ path in the repo now resolves in the spec. MCP tool table uses the real rhombus-node-mcp tool names. - Rate limits: per-organization token bucket, per-second refill, ~10x burst, 429 + Retry-After. - API keys: Settings > Integrations & Developer Resources > API Tokens > Add API Key (partners: Settings > API Management). - EU base URL https://api2.eu.rhombussystems.com wherever a base URL is given. - EdgeCaster re-streams Rhombus cameras as RTSP (one direction); third-party cameras come in through a Rhombus Relay. - Refresh the bundled OpenAPI spec (986 endpoints) and fix the two spec grep recipes that no longer matched its layout. - Bump rhombus-developer, rhombus-user and rhombus-partner to 2.0.1. Co-Authored-By: Claude Opus 5.5 (1M context) --- README.md | 2 + plugins/developer/.claude-plugin/plugin.json | 4 +- plugins/developer/README.md | 11 +- .../developer/agents/rhombus-api-architect.md | 14 +- .../agents/rhombus-webhook-debugger.md | 50 +- plugins/developer/commands/rhombus-curl.md | 4 +- plugins/developer/commands/rhombus-sdk.md | 2 + .../developer/hooks/rhombus-api-intercept.md | 4 +- plugins/developer/skills/api-doc/SKILL.md | 2 +- plugins/developer/skills/rhombus-api/SKILL.md | 97 +- .../rhombus-api/references/examples-index.md | 2 +- .../references/mcp-tool-reference.md | 65 +- .../rhombus-api/references/quickstart.md | 129 +- .../rhombus-api/references/rhombus-api.json | 151021 +++++++++------ .../skills/rhombus-edge-streaming/SKILL.md | 66 +- .../references/rtsp-onvif.md | 62 +- .../skills/rhombus-sdk-codegen/SKILL.md | 3 +- .../references/codegen-matrix.md | 10 +- .../skills/rhombus-webhook-receiver/SKILL.md | 60 +- .../references/webhook-payloads.md | 214 +- plugins/partner/.claude-plugin/plugin.json | 2 +- .../references/commands.md | 3 +- plugins/user/.claude-plugin/plugin.json | 2 +- plugins/user/skills/rhombus-cli/SKILL.md | 2 +- .../skills/rhombus-cli/references/commands.md | 3 +- .../skills/rhombus-support-links/SKILL.md | 3 +- .../references/community-channels.md | 13 +- .../references/support-articles.md | 10 +- 28 files changed, 90615 insertions(+), 61245 deletions(-) diff --git a/README.md b/README.md index 97774ab..f75c3b0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A plugin marketplace for Claude Code, organized by persona. Install only the plugin relevant to you. +Docs: https://developer.rhombus.com/claude-code-plugins · Support: support@rhombus.com + ## Quick Start ### 1. Add the marketplace diff --git a/plugins/developer/.claude-plugin/plugin.json b/plugins/developer/.claude-plugin/plugin.json index 661a06d..b778663 100644 --- a/plugins/developer/.claude-plugin/plugin.json +++ b/plugins/developer/.claude-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "rhombus-developer", - "description": "Build on Rhombus. Auto-configures the official rhombus-node-mcp and docs.rhombus.community MCP servers. Ships six /rhombus-* commands (find-endpoint, schema, curl, sdk, mcp-status, newproject), API-architect and webhook-debugger agents, and five skills covering full API reference (892+ endpoints including Relay/NVR and third-party RTSP), SDK codegen, webhook scaffolding, code review, API doc generation, and edge streaming (RTSP/ONVIF).", - "version": "2.0.0", + "description": "Build on Rhombus. Auto-configures the official rhombus-node-mcp and the Rhombus docs MCP servers. Ships six /rhombus-* commands (find-endpoint, schema, curl, sdk, mcp-status, newproject), API-architect and webhook-debugger agents, and five skills covering full API reference (980+ endpoints including Relay/NVR and third-party RTSP), SDK codegen, webhook scaffolding, code review, API doc generation, and edge streaming (RTSP/ONVIF). Docs: https://developer.rhombus.com", + "version": "2.0.1", "author": { "name": "Rhombus" }, "hooks": { "SessionStart": [ diff --git a/plugins/developer/README.md b/plugins/developer/README.md index 9476177..28a3e6b 100644 --- a/plugins/developer/README.md +++ b/plugins/developer/README.md @@ -13,7 +13,7 @@ Tools for engineers building on the Rhombus platform. Version **2.0.0**. The plugin wires MCP servers automatically via `.mcp.json`. You only need: -1. **`RHOMBUS_API_KEY`** exported in the shell that launches Claude Code (generate from Rhombus Console → API Key Settings). +1. **`RHOMBUS_API_KEY`** exported in the shell that launches Claude Code. Create it in the Rhombus Console under **Settings → Integrations & Developer Resources → API Tokens → Add API Key** with Auth Type **Api Token** (partner organizations: **Settings → API Management → Add API Key**). 2. **Node 18+** on PATH so `npx` can fetch `rhombus-node-mcp` on first run. Verify with `/rhombus-mcp-status`. @@ -40,10 +40,10 @@ Verify with `/rhombus-mcp-status`. | Skill | Triggers when user asks about | |---|---| -| `rhombus-api` | Rhombus API, endpoints, cURL, any "how do I build X on Rhombus" question (covers 892+ endpoints inc. Relay/NVR + third-party RTSP) | +| `rhombus-api` | Rhombus API, endpoints, cURL, any "how do I build X on Rhombus" question (covers 980+ endpoints inc. Relay/NVR + third-party RTSP) | | `rhombus-sdk-codegen` | Scaffolding typed SDK clients (Python, TS, Java, Go, C#) | | `rhombus-webhook-receiver` | Building webhook listeners (Express, FastAPI, Lambda) | -| `rhombus-edge-streaming` | RTSP, ONVIF, Secure Raw Streams, custom seekpoints, embedded player | +| `rhombus-edge-streaming` | RTSP, ONVIF, Secure Raw Streams, custom seekpoints, LAN streaming, embedded player | | `code-review` | Generic code review | | `api-doc` | Generic API doc generation | @@ -54,6 +54,11 @@ Verify with `/rhombus-mcp-status`. | `rhombus-api-intercept` | PreToolUse (Bash) | Suggests MCP tool → CLI → cURL order when raw Rhombus HTTP calls are detected | | `rhombus-openapi-freshness.sh` | SessionStart | Warns if bundled OpenAPI spec is >90 days old | +## Docs and support + +- Developer docs: https://developer.rhombus.com +- Support: support@rhombus.com + ## Typical workflow ``` diff --git a/plugins/developer/agents/rhombus-api-architect.md b/plugins/developer/agents/rhombus-api-architect.md index d209065..497c5b3 100644 --- a/plugins/developer/agents/rhombus-api-architect.md +++ b/plugins/developer/agents/rhombus-api-architect.md @@ -11,8 +11,8 @@ description: >- Slack incoming webhook) and recommend architecture trade-offs. PR review — user submits a PR that polls door events every 30 seconds. The architect should flag that polling is an anti-pattern when - webhooks exist and recommend switching to the Developer Webservice webhook - pattern. + webhooks exist and recommend switching to an organization webhook or a rule + webhook action. tools: Read, Grep, Glob, Bash color: "#8E44AD" --- @@ -28,7 +28,7 @@ You are a Rhombus API integration architect. You design end-to-end integrations - CLI (for one-shot scripts, bulk ops, developer workflows) - Direct API call via typed SDK (for production services) 3. **Chain endpoints with data flow.** Identify UUIDs returned by one call that feed the next. Flag any pagination, rate-limit, or long-running-operation concerns. -4. **Call out anti-patterns.** Common ones on Rhombus: polling when a webhook exists, fetching full camera state when `getMinimal*` suffices, embedding API keys in browser apps instead of using federated session tokens, ignoring the 1,000 req/hr rate limit. +4. **Call out anti-patterns.** Common ones on Rhombus: polling when a webhook exists, fetching full camera state when `getMinimal*` suffices, embedding API keys in browser apps instead of minting federated tokens (`x-auth-scheme: federated-token` + `x-auth-ft`), ignoring the per-organization rate limit (one token bucket shared by every API key and OAuth token in the org, per-second refill with roughly 10x burst; see https://developer.rhombus.com/rate-limits). 5. **Recommend reference repos.** For common integration shapes, point the user at the closest matching example under `RhombusSystems/*` — see `plugins/developer/skills/rhombus-api/references/examples-index.md`. ## Process @@ -37,7 +37,7 @@ You are a Rhombus API integration architect. You design end-to-end integrations 2. Use `mcp__rhombus-docs__search-documentation` (if attached) or grep the local OpenAPI spec to enumerate candidate endpoints. 3. Draw the data flow. Use a simple sequence diagram in text: ``` - [External event] → webhook → your listener → validates → mcp__rhombus__getClip → your store + [Rhombus event] → webhook → your listener → verifies signature → POST /api/event/getPolicyAlertDetails (alertUuid) → your store ``` 4. Flag constraints: auth, rate limits, latency budget, failure modes. 5. Recommend a next action: "Run `/rhombus-newproject ` to scaffold this", or "Open `rhombus-webhook-receiver` skill to generate the listener." @@ -66,6 +66,8 @@ Provide a structured recommendation: ## Edge cases -- If the workflow requires browser-side Rhombus calls, always recommend the federated session token pattern and a server-side proxy — never embed API keys client-side. -- If the workflow volume exceeds 1,000 req/hr, recommend event-driven webhooks over polling. +- If the workflow requires browser-side Rhombus calls, always recommend minting a federated token on the server (`POST /api/org/generateFederatedSessionToken`) and sending it as `x-auth-scheme: federated-token` + `x-auth-ft` — never embed API keys client-side. +- If the workflow streams from devices on the customer's LAN, use device-scoped federated tokens (`deviceUUid`); LAN devices never accept API keys. +- Rate limits are per organization, not per key: adding API keys doesn't add throughput. If polling would compete with the organization's other integrations for that budget, recommend event-driven webhooks over polling. +- If the organization is in the EU region, every host changes (API base URL `https://api2.eu.rhombussystems.com`), and API keys only work in their own region. - If the user is integrating with a system Rhombus already has a direct integration for (PagerDuty, ServiceNow, OAuth providers, Zapier, Make.com), point them at the existing integration first. diff --git a/plugins/developer/agents/rhombus-webhook-debugger.md b/plugins/developer/agents/rhombus-webhook-debugger.md index e2bf79c..61a0ec8 100644 --- a/plugins/developer/agents/rhombus-webhook-debugger.md +++ b/plugins/developer/agents/rhombus-webhook-debugger.md @@ -9,8 +9,9 @@ description: >- configuration check, delivery-log inspection, signature verification, and payload validation. User reports signature mismatch errors for Rhombus webhook payloads. - The agent runs the signature-verification checklist (raw-body vs parsed-JSON, - HMAC-SHA256 construction, constant-time compare, clock skew). + The agent runs the signature-verification checklist (raw body vs parsed JSON, + which header is present (x-rhombus-signature-sha1 or -sha256), HMAC + algorithm, per-URL secret, lowercase hex, constant-time compare). tools: Read, Bash color: "#D35400" --- @@ -21,38 +22,51 @@ You are a Rhombus webhook troubleshooter. Your job: take a "my webhook isn't wor Walk through these in order. Stop at the first failure. +First identify which kind of webhook the user has. They differ in setup, body and signature: + +| | Organization webhook | Rule webhook action | +|---|---|---| +| Set up in | Console **Settings → Integrations & Developer Resources → Webhooks** (Activity or Diagnostic) | A rule's webhook action | +| Signature header | `x-rhombus-signature-sha1` (HMAC-SHA1) | `x-rhombus-signature-sha256` (HMAC-SHA256) | +| Secret | **Webhook Secret** column in the Console, or `webhookSecret` from the API | `webhookSecrets` map returned by `createRule` / `updateRule` | + ### 1. Is the webhook configured? -Via MCP (`mcp__rhombus__*` Developer Webservice tool) or CLI: +Via the Console (**Settings → Integrations & Developer Resources → Webhooks**), or the CLI: ```bash -rhombus developer get-webhooks +rhombus webhook-integrations get-webhook-integration # organization webhooks +rhombus rules get-rules-for-org # rules and their webhook actions ``` -Confirm the target URL, event types, and active status. A common failure is a webhook created for only specific event types that don't match what the user is testing with. +(API equivalents: `POST /api/integrations/webhooks/getWebhookIntegration`, `POST /api/rules/getRulesForOrg`.) + +For an organization webhook, confirm the URL is listed under the right trigger type (`activityWebhooksV2` for Activity, `diagnosticWebhooksV2` for Diagnostic), that `webhookDisabled` isn't true, and that the webhook integration itself is enabled. For a rule webhook action, confirm the rule is enabled and its triggers match what the user is testing with. ### 2. Is the listener actually reachable from the internet? -- Probe with `curl -X POST -d '{}'` from somewhere external. +- Probe with `curl -X POST -H 'Content-Type: application/json' -d '{}'` from somewhere external. - If the listener is behind a tunnel (ngrok, cloudflared), confirm the tunnel is up. - Check the listener logs for *any* requests at all — if none are arriving, the problem is network-side. ### 3. Is Rhombus attempting delivery? -Check the developer webhook delivery log via the API (Developer Webservice endpoints). Look for: -- Delivery attempts with non-2xx response codes → listener is rejecting. -- No delivery attempts at all → event may not match webhook filters. +Rhombus doesn't retry failed deliveries; it records them as diagnostics in the organization. Look for a "Custom Webhook" notification failure (organization webhooks; try `POST /api/report/getIntegrationDiagnosticEvents` with `timestampMsAfter` / `timestampMsBefore`) or `EXTERNAL_WEBHOOK_FAILURE` (rule webhook actions; try `POST /api/report/getDiagnosticFeed`). +- Failures present → the listener is rejecting or timing out. Rule webhook actions treat only `200` and `202` as success. +- No failures and no requests → the event didn't match the webhook's trigger type or the rule's triggers. ### 4. Is the payload shape what the listener expects? -Rhombus payloads vary by event type. Refer to `plugins/developer/skills/rhombus-webhook-receiver/references/webhook-payloads.md` for known shapes. Common mistake: treating all events as having the same `cameraUuid` field — some events (door, user) use different identifier fields. +Organization webhooks and rule webhook actions send different bodies. Refer to `plugins/developer/skills/rhombus-webhook-receiver/references/webhook-payloads.md`. Common mistakes: expecting a `type` or `eventUuid` field on an organization webhook (it sends `activityTrigger` / `diagnosticTrigger` and `alertUuid`), treating `location` as a name (it's a location UUID), or assuming every event is from a camera (check `deviceType`). ### 5. Is signature verification failing? -- Rhombus signs webhook payloads with a secret configured at webhook creation. -- Compute HMAC-SHA256 of the raw request body (bytes, not parsed JSON) using the secret. -- Compare constant-time to the `X-Rhombus-Signature` (or equivalent) header. -- Common mistake: verifying after the JSON middleware has re-serialized the body. You must use the raw body bytes. +- Read the header that's present: `x-rhombus-signature-sha1` (organization webhooks, HMAC-SHA1) or `x-rhombus-signature-sha256` (rule webhook actions, HMAC-SHA256). Rhombus sends no other signature header and no delivery-ID header. +- Compute the HMAC over the raw request body bytes (not parsed and re-serialized JSON), keyed with the secret string as-is (UTF-8; don't base64-decode it), and hex-encode it in lowercase. +- Use the secret for **that** URL: every webhook URL has its own secret. +- Compare in constant time (`crypto.timingSafeEqual` after a length check, or `hmac.compare_digest`). +- A rule webhook action created before signing was available has no secret and arrives unsigned; updating the rule assigns one. +- Check the implementation with the test vector: secret `AAAAAAAAAAAAAAAAAAAAAA`, body `{"version":"2","summary":"Test webhook"}` → SHA1 `7c67f32d7b1320f76fa6d171a1a54dd6808570b6`, SHA256 `5d3808f7c72ed8b6e52c12cf3ae13e72667d316178c6110081d58282828b2482`. ### 6. Are there duplicates? -Rhombus may retry deliveries. Listeners must be idempotent: -- Dedupe by the event's unique UUID (`eventUuid` or `uuid`). -- Return 2xx quickly (<5s) to avoid timeout-driven retries. +Listeners should still be idempotent: +- Dedupe by `alertUuid` (organization webhooks) or `uuid` (rule webhook actions). +- Return `200` quickly and do heavy work asynchronously. ## Output format @@ -72,5 +86,5 @@ After diagnosis, produce: ## Edge cases - If the user has no webhook yet, redirect to the `rhombus-webhook-receiver` skill to scaffold one. -- If the user's issue is latency (>30s delivery), that is a platform concern — direct them to `api@rhombus.com`. +- If the user's issue is latency (>30s delivery), that is a platform concern — direct them to `support@rhombus.com`. - Do not ask the user for their API key or webhook secret; instruct them to check locally. diff --git a/plugins/developer/commands/rhombus-curl.md b/plugins/developer/commands/rhombus-curl.md index 1a98933..54ad9a1 100644 --- a/plugins/developer/commands/rhombus-curl.md +++ b/plugins/developer/commands/rhombus-curl.md @@ -6,7 +6,7 @@ argument-hint: "[operationId]" Emit a runnable cURL command for the Rhombus API endpoint with operationId `$ARGUMENTS`. 1. Resolve the endpoint path and request schema using `/rhombus-schema $ARGUMENTS` (or the docs MCP if attached). -2. Produce the cURL in this exact shape: +2. Produce the cURL in this exact shape (for an EU organization, use the host `https://api2.eu.rhombussystems.com`): ```bash curl -X POST "https://api2.rhombussystems.com/api/" \ @@ -25,4 +25,4 @@ curl -X POST "https://api2.rhombussystems.com/api/" \ - Required fields populated with realistic example values (base64 url-safe UUIDs like `AAAAAAAAAAAAAAAAAAAAAA`, millisecond epoch timestamps like `1234567890000`) - Optional fields included in a trailing comment for discoverability -4. If the user probably wanted to *run* the call rather than copy a shell example, remind them: *"If you want to execute this, `mcp__rhombus__` handles auth and typing for you."* +4. If the user probably wanted to *run* the call rather than copy a shell example, remind them that the `rhombus` MCP tools (`mcp__rhombus__*`, see `skills/rhombus-api/references/mcp-tool-reference.md`) or the `rhombus` CLI handle auth for them. diff --git a/plugins/developer/commands/rhombus-sdk.md b/plugins/developer/commands/rhombus-sdk.md index c9a5955..cfd0dfe 100644 --- a/plugins/developer/commands/rhombus-sdk.md +++ b/plugins/developer/commands/rhombus-sdk.md @@ -26,6 +26,8 @@ openapi-generator-cli generate \ -o ``` +For EU organizations, set the generated client's base URL to `https://api2.eu.rhombussystems.com` (the spec's `servers` entry is the US host). + Prerequisites check: - `openapi-generator-cli` available on PATH (`which openapi-generator-cli`) - Network access to `api2.rhombussystems.com` diff --git a/plugins/developer/hooks/rhombus-api-intercept.md b/plugins/developer/hooks/rhombus-api-intercept.md index 7e36fe5..033dc60 100644 --- a/plugins/developer/hooks/rhombus-api-intercept.md +++ b/plugins/developer/hooks/rhombus-api-intercept.md @@ -7,9 +7,9 @@ type: prompt Inspect the bash command about to be executed. If it contains a `curl`, `wget`, or `fetch` call targeting any of these Rhombus API domains: -- `api2.rhombussystems.com` +- `api2.rhombussystems.com` (EU: `api2.eu.rhombussystems.com`) - `api.rhombussystems.com` -- `media.rhombussystems.com` +- `media.rhombussystems.com` (EU: `media.eu.rhombussystems.com`) - `auth.rhombussystems.com` Then surface a suggestion in this priority order (do NOT block — only suggest): diff --git a/plugins/developer/skills/api-doc/SKILL.md b/plugins/developer/skills/api-doc/SKILL.md index 7844c21..17662d2 100644 --- a/plugins/developer/skills/api-doc/SKILL.md +++ b/plugins/developer/skills/api-doc/SKILL.md @@ -31,7 +31,7 @@ Generate clear, complete API documentation from source code. For each endpoint, document: -- **Method & Path**: `GET /api/v1/users/:id` +- **Method & Path**: `GET /v1/users/:id` - **Description**: What this endpoint does (infer from handler logic and naming) - **Authentication**: Required auth (check for auth middleware/decorators) - **Parameters**: Path params, query params, headers diff --git a/plugins/developer/skills/rhombus-api/SKILL.md b/plugins/developer/skills/rhombus-api/SKILL.md index 9748e32..db17759 100644 --- a/plugins/developer/skills/rhombus-api/SKILL.md +++ b/plugins/developer/skills/rhombus-api/SKILL.md @@ -1,6 +1,6 @@ --- name: rhombus-api -description: Comprehensive guide for working with the Rhombus API and building applications on the Rhombus platform. Use when the user asks questions about the Rhombus API, requests cURL examples, needs endpoint documentation, wants to build apps integrating Rhombus cameras/access control/sensors, asks "How do I [X] using the Rhombus API", or asks about streaming video, LPR, face recognition, webhooks, door controllers, IoT sensors, alarm monitoring, relay/NVR management, third-party RTSP cameras, or any Rhombus development task. Also trigger when the user mentions Rhombus platform capabilities, wants to generate SDK clients, or references the Rhombus OpenAPI spec. Covers all 65+ API service categories across 892+ endpoints including camera management, access control, IoT sensors, face recognition, vehicle/LPR, alarm monitoring, lockdown plans, occupancy, elevators, relay/NVR, webhooks, user management, and more. +description: Comprehensive guide for working with the Rhombus API and building applications on the Rhombus platform. Use when the user asks questions about the Rhombus API, requests cURL examples, needs endpoint documentation, wants to build apps integrating Rhombus cameras/access control/sensors, asks "How do I [X] using the Rhombus API", or asks about streaming video, LPR, face recognition, webhooks, door controllers, IoT sensors, alarm monitoring, relay/NVR management, third-party RTSP cameras, or any Rhombus development task. Also trigger when the user mentions Rhombus platform capabilities, wants to generate SDK clients, or references the Rhombus OpenAPI spec. Covers all 65+ API service categories across 980+ endpoints including camera management, access control, IoT sensors, face recognition, vehicle/LPR, alarm monitoring, lockdown plans, occupancy, elevators, relay/NVR, webhooks, user management, and more. --- # Rhombus API Skill @@ -31,15 +31,13 @@ Always start by reading `references/quickstart.md` for authentication patterns, ## Key Resources -- **Base URL**: `https://api2.rhombussystems.com` -- **OpenAPI Spec (live)**: `https://api2.rhombussystems.com/api/openapi/public.json` -- **OpenAPI Spec (local)**: `references/rhombus-api.json` (138,595 lines, 892 endpoints) -- **Developer Docs (beta)**: `https://api-docs.rhombus.community/` +- **Base URL**: US `https://api2.rhombussystems.com`, EU `https://api2.eu.rhombussystems.com`. An organization lives in one region and its API keys only work against that region's base URL; paths, headers and payloads are identical. See `https://developer.rhombus.com/api-regions`. +- **OpenAPI Spec (live)**: `https://api2.rhombussystems.com/api/openapi/public.json` (EU: `https://api2.eu.rhombussystems.com/api/openapi/public.json`) +- **OpenAPI Spec (local)**: `references/rhombus-api.json` (167,856 lines, 986 endpoints) +- **Developer Docs**: `https://developer.rhombus.com/` - **Documentation MCP**: `https://api-docs.rhombus.community/mcp` (live doc search for AI tools) -- **Docs Index (for AI)**: `https://api-docs.rhombus.community/llms.txt` -- **Legacy Docs**: `https://apidocs.rhombussystems.com/` -- **Developer Community**: `https://rhombus.community` -- **Support**: `api@rhombus.com` +- **Docs Index (for AI)**: `https://developer.rhombus.com/llms.txt` +- **Support**: `support@rhombus.com` ## Authentication @@ -50,7 +48,21 @@ x-auth-scheme: api-token x-auth-apikey: YOUR_API_KEY ``` -There is also a federated session token flow for browser-based apps where you cannot expose the API key directly. Generate a short-lived token via `/org/generateFederatedSessionToken` and use it with `x-auth-scheme: federated-session-token`. +Customers create API keys in the Rhombus Console under **Settings → Integrations & Developer Resources → API Tokens → Add API Key** (choose Auth Type **Api Token** for header-based keys; the modal defaults to Certificate). Partner organizations use **Settings → API Management → Add API Key**. + +### Federated tokens (browsers, video players, LAN devices) + +Use a federated token anywhere you can't safely put your API key. + +1. **Mint it on your server** with your API key: `POST /api/org/generateFederatedSessionToken` with body `{"durationSec": 3600}`. Optional fields: `deviceUUid` (limits the token to one device; use this for LAN streaming) and `domain`. The response is `{"federatedSessionToken": "..."}`. +2. **Send it** as `x-auth-scheme: federated-token` plus `x-auth-ft: `, either as headers or, on media URLs and LAN device URLs, as query parameters: `?x-auth-scheme=federated-token&x-auth-ft=`. + +Rules: +- The scheme value is exactly `federated-token` (no other spelling works). +- A federated token never goes in `x-auth-apikey`. +- Devices on the customer's LAN never accept API keys. They accept only federated tokens, ideally device-scoped with `deviceUUid`. A device-scoped token can't call the cloud API. + +Details: `https://developer.rhombus.com/implementations/lan-streaming`. ## Complete API Category Reference @@ -60,7 +72,7 @@ The Rhombus API is organized into **65+ service categories**. When searching the - `"Camera Webservice"` — Camera CRUD, settings, snapshots, VOD URIs, media URIs, shared streams - `"Component Webservice"` — Device lifecycle, firmware, health monitoring across all device types - `"Door Controller Webservice"` — Door controller hardware configuration and monitoring -- `"Door Webservice"` — Logical door state, lock/unlock, door events +- `"Door Webservice"` — Door **sensors** (open/close state and events). To lock or unlock an access-controlled door, use `POST /api/accesscontrol/unlockAccessControlledDoor` (Access Control Webservice); list access-controlled doors with `POST /api/component/findAccessControlledDoors` (Component Webservice) - `"Doorbell Camera Webservice"` — Doorbell-specific camera operations - `"Sensor Webservice"` — IoT sensor data retrieval (environmental, motion) - `"Climate Webservice"` — Temperature, humidity, air quality sensor data @@ -113,8 +125,8 @@ The Rhombus API is organized into **65+ service categories**. When searching the - `"Partner Webservice"` — Partner/reseller operations ### Integrations & Developer -- `"Developer Webservice"` — API key management, webhook configuration -- `"Webhook Integrations Webservice"` — Webhook endpoint management +- `"Developer Webservice"` — Event listeners (`/api/developer/createEventListener`, `getAllEventListeners`, `deleteEventListener`) +- `"Webhook Integrations Webservice"` — Organization webhooks (`/api/integrations/webhooks/getWebhookIntegration`, `updateWebhookIntegrationV2`) - `"Integrations Webservice"` — General integration configuration - `"Org Integrations Webservice"` — Organization-level integrations - `"Incident Management Integrations Webservice"` — Incident management (e.g., PagerDuty) @@ -133,7 +145,7 @@ The Rhombus API is organized into **65+ service categories**. When searching the ## Working with the API Spec -The complete OpenAPI spec is at `references/rhombus-api.json` (138,595 lines). Never try to read it in full. Use targeted grep searches. +The complete OpenAPI spec is at `references/rhombus-api.json` (167,856 lines). Never try to read it in full. Use targeted grep or `jq` searches. Note that an operationId does not always match the last path segment (for example, `POST /api/camera/getMediaUris` has operationId `getCameraMediaUris`). ### Search Patterns @@ -144,7 +156,7 @@ grep -i "keyword" references/rhombus-api.json | grep '"operationId"' **List ALL endpoints in a category:** ```bash -grep -B5 '"tags" : \[ "Camera Webservice"' references/rhombus-api.json | grep '"operationId"' +jq -r '.paths | to_entries[] | .key as $p | .value[] | select(.tags[0] == "Camera Webservice") | "\(.operationId) \($p)"' references/rhombus-api.json ``` **Count endpoints per category:** @@ -174,7 +186,7 @@ grep '"operationId" : "create' references/rhombus-api.json **Find deprecated endpoints:** ```bash -grep -B5 '"deprecated" : true' references/rhombus-api.json | grep '"operationId"' +grep -A3 '"deprecated" : true' references/rhombus-api.json | grep '"operationId"' ``` **Extract request body schema for an endpoint:** @@ -201,7 +213,7 @@ Rhombus maintains official example repos at `https://github.com/RhombusSystems/` ### player-example (CURRENT — recommended reference) - **Repo**: `https://github.com/RhombusSystems/player-example` - **What it does**: Lightweight HTML/JS camera stream player using DashJS -- **Key patterns**: Federated session token auth → getMediaUris → DashJS MPEG-DASH player +- **Key patterns**: Server mints a federated token and calls getMediaUris → browser plays the MPEG-DASH URI in DashJS with `x-auth-scheme=federated-token&x-auth-ft=` on each media request - **Architecture**: Requires server-side proxy to protect API keys (never expose keys in frontend code) - **When to reference**: Any video streaming, camera player, or embedded video implementation @@ -264,6 +276,8 @@ curl -X POST "https://api2.rhombussystems.com/api/ENDPOINT_PATH" \ }' ``` +For EU organizations, replace the host with `https://api2.eu.rhombussystems.com`. + Checklist: both auth headers present, POST method, Content-Type set, JSON body formatted, required vs optional fields annotated, realistic example values (base64 url-safe UUIDs like `"AAAAAAAAAAAAAAAAAAAAAA"`, millisecond epoch timestamps like `1234567890000`). ## SDK Client Generation @@ -284,32 +298,36 @@ openapi-generator-cli generate \ # Java, C#, Go, PHP, etc. — same pattern, swap the -g flag ``` +The spec's `servers` entry lists only the US host. For EU organizations, set the generated client's base URL to `https://api2.eu.rhombussystems.com`. + The JavaScript examples repo uses Rhombus Codegen for typed stubs — this is an alternative to openapi-generator. ## Common Workflows ### Video Streaming (Browser) -1. Server generates federated token: `POST /org/generateFederatedSessionToken` -2. Server fetches media URIs: `POST /camera/getMediaUris` with cameraUuid -3. Client initializes DashJS player with returned MPEG-DASH URI +1. Server mints a federated token: `POST /api/org/generateFederatedSessionToken` with `{"durationSec": 3600}` → `federatedSessionToken` +2. Server fetches media URIs with its API key: `POST /api/camera/getMediaUris` with `{"cameraUuid": "..."}` → `wanLiveMpdUri` (also `wanLiveM3u8Uri`, `wanLiveH264Uri`) +3. Browser initializes DashJS with the MPEG-DASH URI and appends `x-auth-scheme=federated-token&x-auth-ft=` to every media request 4. See `player-example` repo for full implementation ### Video Retrieval (VOD / Clips) -1. Get camera list: `POST /camera/getMinimalCameraStateList` -2. Get VOD URI: `POST /camera/getVodUri` with cameraUuid, startTime, duration -3. Download from returned URI with auth headers -4. For exact frames: `POST /video/getExactFrameUri` (supports cropping) +1. Get camera list: `POST /api/camera/getMinimalCameraStateList` +2. Get the VOD URI template: `POST /api/camera/getMediaUris` with `{"cameraUuid": "..."}` → `wanVodMpdUriTemplate` (or `wanVodM3u8UriTemplate`) +3. Replace `{START_TIME}` with a Unix timestamp in **seconds** and `{DURATION}` with a length in seconds +4. Fetch the manifest and every segment with auth: a federated token (`x-auth-scheme: federated-token` + `x-auth-ft`, as headers or query parameters), or API-key headers from a server-side client +5. For exact frames: `POST /api/video/getExactFrameUri` with `{"cameraUuid": "...", "timestampMs": 1712345678000}` → `frameUri` (optional crop: `permyriadCropX`, `permyriadCropY`, `permyriadCropWidth`, `permyriadCropHeight`) ### Shared Stream Embedding (iFrame) -1. Create shared stream: `POST /camera/createSharedLiveVideoStream` +1. Create shared stream: `POST /api/camera/createSharedLiveVideoStream` with `{"cameraUuid": "..."}` → `sharedLiveVideoStreamUrl` 2. Embed returned URL in iframe: `` 3. URL params: `disableautoplay`, `hideevents`, `realtime`, `showheader` (true/false) ### Access Control Setup -1. Create user: `POST /user/createUser` -2. Create credential: `POST /accesscontrol/createStandardCsnCredential` -3. Assign credential: `POST /accesscontrol/assignAccessControlCredential` -4. Create access grant: `POST /accesscontrol/createAccessGrant` +1. Create user: `POST /api/user/createUser` (`email`, `name`) +2. Create credential: `POST /api/accesscontrol/createStandardCsnCredential` (`credentialValue`, `userUuid`) +3. Assign credential: `POST /api/accesscontrol/assignAccessControlCredential` (`credentialHexValue`, `userUuid`) +4. Create access grant: `POST /api/accesscontrol/createAccessGrant` (`accessGrant`) +5. Unlock a door: `POST /api/accesscontrol/unlockAccessControlledDoor` with `{"accessControlledDoorUuid": "..."}` (list doors with `POST /api/component/findAccessControlledDoors`) ### Face Recognition Pipeline 1. Create known person: Use Face Recognition Person endpoints @@ -324,10 +342,11 @@ The JavaScript examples repo uses Rhombus Codegen for typed stubs — this is an 4. Use `getExactFrameUri` with crop parameters for vehicle image extraction ### Webhook Setup -1. Create webhook: Use Developer Webservice endpoints -2. Configure event types to listen for -3. Implement a listener endpoint (see `low-code-no-code` repo for examples) -4. Webhook payloads include all data needed to fetch associated clips/events +Rhombus sends two kinds of webhooks: +1. **Organization webhooks** (Activity or Diagnostic). Add one in the Console under **Settings → Integrations & Developer Resources → Webhooks**, or with the API: call `POST /api/integrations/webhooks/getWebhookIntegration`, then `POST /api/integrations/webhooks/updateWebhookIntegrationV2` with the current settings as `updatedWebhookSettings` plus `webhookUrl` (and `isDiagnostic: true` for a Diagnostic webhook). The response returns that URL's `webhookSecret`. Deliveries carry `x-rhombus-signature-sha1`. +2. **Rule webhook actions**. Add a webhook action to a rule with `POST /api/rules/createRule` or `POST /api/rules/updateRule`; the response's `webhookSecrets` maps each webhook URL to its secret. Deliveries carry `x-rhombus-signature-sha256` (actions without a secret are sent unsigned). +3. Implement a listener that verifies the signature over the raw body before parsing. Use the `rhombus-webhook-receiver` skill to scaffold one. +4. Details: `https://developer.rhombus.com/webhooks` ### Alarm Monitoring 1. Configure alarm rules via Alert Monitoring Webservice @@ -335,9 +354,9 @@ The JavaScript examples repo uses Rhombus Codegen for typed stubs — this is an 3. Integrate with RapidSOS for emergency dispatch ### Lockdown Execution -1. Create lockdown plan: Use Lockdown Plan Webservice -2. Execute lockdown: triggers door locks, camera presets, notifications -3. Release lockdown when clear +1. Create or find a plan: `POST /api/accesscontrol/lockdownPlan/createLocationLockdownPlan`, `POST /api/accesscontrol/lockdownPlan/findLockdownPlansByLocation` +2. Activate: `POST /api/accesscontrol/lockdownPlan/activateLockdownForLocation` with `locationUuid` and `lockdownPlanUuids` +3. Release when clear: `POST /api/accesscontrol/lockdownPlan/deactivateLockdownForLocation` with `locationUuid` ### IoT / Environmental Monitoring 1. Query sensor data: Use Sensor Webservice or Climate Webservice @@ -348,11 +367,11 @@ The JavaScript examples repo uses Rhombus Codegen for typed stubs — this is an **Performance**: Use `getMinimal*` endpoints when full details aren't needed. Cache location and device lists (they change infrequently). Implement pagination for large result sets. Use appropriate time ranges to limit results. -**Rate Limits**: 1,000 requests/hour and 100 requests/minute burst. Implement exponential backoff when hitting limits. +**Rate Limits**: Limits are enforced per organization: every API key and OAuth token in the org shares one token bucket, so extra keys don't add throughput. The bucket refills at a per-second rate and allows bursts of roughly 10x that rate. A throttled request gets `429` with a `Retry-After` header (seconds); wait that long, then retry with exponential backoff and jitter. See `https://developer.rhombus.com/rate-limits`. -**Security**: Never hardcode API keys — use environment variables or secret managers. For browser apps, use a server-side proxy with federated session tokens. Rotate API keys periodically. Use HTTPS for all requests. +**Security**: Never hardcode API keys — use environment variables or secret managers. For browser apps, keep the key on a server and hand the browser a short-lived federated token (`x-auth-scheme: federated-token` + `x-auth-ft`). Rotate API keys periodically. Use HTTPS for all requests. -**Error Handling**: 401 = auth failure (check API key + headers), 400 = bad request body, 404 = resource not found, 500 = server error (retry with exponential backoff). +**Error Handling**: 401 = auth failure (check API key + headers), 400 = bad request body, 404 = resource not found, 429 = rate limited (wait `Retry-After` seconds), 500 = server error (retry with exponential backoff). A `403` with "Invalid api key" often means the key belongs to the other region (US vs EU). **Architecture**: Rhombus uses POST for all operations, including reads. UUIDs are base64 url-safe encoded strings. Timestamps are Unix epoch milliseconds. The API is the same API that Rhombus's own web console and mobile apps use — if you can do it in the UI, you can do it via API. diff --git a/plugins/developer/skills/rhombus-api/references/examples-index.md b/plugins/developer/skills/rhombus-api/references/examples-index.md index 3f59849..d89bd17 100644 --- a/plugins/developer/skills/rhombus-api/references/examples-index.md +++ b/plugins/developer/skills/rhombus-api/references/examples-index.md @@ -82,4 +82,4 @@ Annotated index of the public `RhombusSystems/*` repos, with "when to use" guida ## Recency note -Recency of repos varies. Before copying patterns, check the repo's last commit date — anything untouched for >18 months may use older auth patterns (e.g., pre-federated-session-token). When in doubt, prefer `player-example`, `rhombus-api-examples-python`, and `rhombus-cli` — these are the actively maintained references. +Recency of repos varies. Before copying patterns, check the repo's last commit date — anything untouched for >18 months may use older auth patterns (e.g., API keys in browser code instead of federated tokens). When in doubt, prefer `player-example`, `rhombus-api-examples-python`, and `rhombus-cli` — these are the actively maintained references. diff --git a/plugins/developer/skills/rhombus-api/references/mcp-tool-reference.md b/plugins/developer/skills/rhombus-api/references/mcp-tool-reference.md index 048d405..84fa6ad 100644 --- a/plugins/developer/skills/rhombus-api/references/mcp-tool-reference.md +++ b/plugins/developer/skills/rhombus-api/references/mcp-tool-reference.md @@ -2,65 +2,68 @@ Quick map: common API tasks → MCP tool to call first. -The exact tool names depend on the version of `rhombus-node-mcp` you have connected. Run `/rhombus-mcp-status` to confirm. Tool names surface as `mcp__rhombus__` in Claude. +`rhombus-node-mcp` exposes a small set of task-level tools (for example `camera-tool`, `access-control-tool`), not one tool per endpoint. Most tools take a `requestType` (or `eventType` / `queryType`) argument that selects the operation. Tool names surface as `mcp__rhombus__` in Claude. The exact set depends on the version of `rhombus-node-mcp` you have connected; run `/rhombus-mcp-status` to confirm. + +Every fallback endpoint below exists in the bundled spec (`rhombus-api.json`). All are `POST`. ## Cameras -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| List cameras | `mcp__rhombus__getMinimalCameraStateList` | `POST /api/camera/getMinimalCameraStateList` | -| Fetch camera detail | `mcp__rhombus__getCameraState` | `POST /api/camera/getCameraState` | -| Get media URIs | `mcp__rhombus__getMediaUris` | `POST /api/camera/getMediaUris` | -| VOD clip URL | `mcp__rhombus__getVodUri` | `POST /api/camera/getVodUri` | -| Exact frame | `mcp__rhombus__getExactFrameUri` | `POST /api/video/getExactFrameUri` | -| Create shared stream | `mcp__rhombus__createSharedLiveVideoStream` | `POST /api/camera/createSharedLiveVideoStream` | +| List cameras | `mcp__rhombus__get-entity-tool` | `POST /api/camera/getMinimalCameraStateList` | +| Camera settings | `mcp__rhombus__camera-tool` (`get-settings`) | `POST /api/deviceconfig/getFacetedConfig` | +| Get media URIs (live and VOD templates) | `mcp__rhombus__camera-tool` (`get-media-uris`) | `POST /api/camera/getMediaUris` | +| VOD clip URL | `mcp__rhombus__camera-tool` (`get-media-uris`) | `POST /api/camera/getMediaUris`, then fill `{START_TIME}` / `{DURATION}` (seconds) in `wanVodMpdUriTemplate` | +| Exact frame | `mcp__rhombus__camera-tool` (`image`) | `POST /api/video/getExactFrameUri` | +| Create shared stream | none | `POST /api/camera/createSharedLiveVideoStream` | ## Alerts and events -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| Recent alerts | `mcp__rhombus__getRecentAlerts` | `POST /api/alert/getRecentAlerts` | -| Search events | `mcp__rhombus__searchEvents` | `POST /api/eventsearch/search` | -| Create custom event | `mcp__rhombus__createEvent` | `POST /api/event/createEvent` | -| Create seekpoint | `mcp__rhombus__createSeekpoint` | `POST /api/event/createSeekpoint` | +| Recent alerts | `mcp__rhombus__policy-alerts-tool` | `POST /api/event/getPolicyAlerts` | +| Device and access events | `mcp__rhombus__events-tool` | `POST /api/component/findPaginatedComponentEventsByAccessControlledDoor` (door events); per-device `get...Events...` endpoints for sensors | +| Saved clips | `mcp__rhombus__clips-tool` | `POST /api/event/getSavedClipsV2` | +| Create custom seekpoints | none | `POST /api/camera/createCustomFootageSeekpoints` | ## Access control -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| Create credential | `mcp__rhombus__createStandardCsnCredential` | `POST /api/accesscontrol/createStandardCsnCredential` | -| Assign credential | `mcp__rhombus__assignAccessControlCredential` | `POST /api/accesscontrol/assignAccessControlCredential` | -| Create access grant | `mcp__rhombus__createAccessGrant` | `POST /api/accesscontrol/createAccessGrant` | -| Door unlock | `mcp__rhombus__unlockDoor` | `POST /api/door/unlockDoor` | +| List access-controlled doors | `mcp__rhombus__get-entity-tool` | `POST /api/component/findAccessControlledDoors` | +| Create credential | none | `POST /api/accesscontrol/createStandardCsnCredential` | +| Assign credential | `mcp__rhombus__access-control-tool` | `POST /api/accesscontrol/assignAccessControlCredential` | +| Create access grant | `mcp__rhombus__access-control-tool` | `POST /api/accesscontrol/createAccessGrant` | +| Door unlock | `mcp__rhombus__access-control-tool` | `POST /api/accesscontrol/unlockAccessControlledDoor` | ## Vehicle / LPR -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| Search vehicle events | `mcp__rhombus__searchVehicleEvents` | `POST /api/vehicle/searchVehicleEvents` | -| Add known plate | `mcp__rhombus__createKnownVehicle` | `POST /api/vehicle/createKnownVehicle` | +| Search vehicle events | `mcp__rhombus__lpr-tool` | `POST /api/vehicle/getVehicleEvents` | +| Save a known plate | `mcp__rhombus__lpr-tool` | `POST /api/vehicle/saveVehicle` | ## Face recognition -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| Add known person | `mcp__rhombus__createKnownPerson` | `POST /api/facerecognition/createKnownPerson` | -| Search FR events | `mcp__rhombus__searchFaceRecognitionEvents` | `POST /api/facerecognition/searchEvents` | +| Add known person | none | `POST /api/faceRecognition/person/createPerson` | +| Search face events | `mcp__rhombus__faces-tool` | `POST /api/faceRecognition/faceEvent/findFaceEventsByOrg` | ## Webhooks -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| List webhooks | `mcp__rhombus__getWebhooks` | `POST /api/developer/getWebhooks` | -| Create webhook | `mcp__rhombus__createWebhook` | `POST /api/developer/createWebhook` | -| Delete webhook | `mcp__rhombus__deleteWebhook` | `POST /api/developer/deleteWebhook` | +| List organization webhooks and secrets | none | `POST /api/integrations/webhooks/getWebhookIntegration` | +| Add or change an organization webhook | none | `POST /api/integrations/webhooks/updateWebhookIntegrationV2` (pass the current settings as `updatedWebhookSettings`; add `webhookUrl` to create one, which returns its `webhookSecret`) | +| Rule with a webhook action | `mcp__rhombus__rules-tool` | `POST /api/rules/createRule`, `POST /api/rules/updateRule` (response `webhookSecrets`) | ## Lockdown and emergency -| Task | MCP tool (typical) | Fallback endpoint | +| Task | MCP tool | Fallback endpoint | |---|---|---| -| Execute lockdown plan | `mcp__rhombus__executeLockdownPlan` | `POST /api/lockdown/executePlan` | -| Release lockdown | `mcp__rhombus__releaseLockdown` | `POST /api/lockdown/releasePlan` | +| Activate lockdown | `mcp__rhombus__access-control-tool` | `POST /api/accesscontrol/lockdownPlan/activateLockdownForLocation` | +| Release lockdown | `mcp__rhombus__access-control-tool` | `POST /api/accesscontrol/lockdownPlan/deactivateLockdownForLocation` | ## Discovering tools not in this table diff --git a/plugins/developer/skills/rhombus-api/references/quickstart.md b/plugins/developer/skills/rhombus-api/references/quickstart.md index d9cb5e2..3815406 100644 --- a/plugins/developer/skills/rhombus-api/references/quickstart.md +++ b/plugins/developer/skills/rhombus-api/references/quickstart.md @@ -2,9 +2,12 @@ ## Base URL ``` -https://api2.rhombussystems.com +https://api2.rhombussystems.com # US organizations +https://api2.eu.rhombussystems.com # EU organizations ``` +An organization lives in one region, and its API keys only work against that region's base URL. Paths, headers and payloads are the same in both regions. See https://developer.rhombus.com/api-regions. + ## Authentication All Rhombus API requests require two headers: @@ -14,20 +17,29 @@ x-auth-scheme: api-token x-auth-apikey: YOUR_API_KEY_HERE ``` -For browser-based apps, use federated session tokens instead of exposing your API key: +Create the key in the Rhombus Console under **Settings → Integrations & Developer Resources → API Tokens → Add API Key**: enter a **Name**, set **Auth Type** to **Api Token** (the modal defaults to Certificate, which is for mTLS), pick a **Role**, and copy the key (it's shown only once). Partner organizations use **Settings → API Management → Add API Key**. + +For browsers, video players and devices on the LAN, use a federated token instead of exposing your API key: ```bash -# Step 1: Server-side — generate a short-lived federated token +# Step 1: Server-side — mint a short-lived federated token with your API key curl -X POST "https://api2.rhombussystems.com/api/org/generateFederatedSessionToken" \ -H "x-auth-scheme: api-token" \ -H "x-auth-apikey: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"durationSec": 3600}' +# Response: {"federatedSessionToken": "..."} +# Optional: "deviceUUid" limits the token to one device. Use device-scoped tokens for LAN streaming. -# Step 2: Client-side — use the federated token -x-auth-scheme: federated-session-token -x-auth-apikey: FEDERATED_TOKEN_FROM_STEP_1 +# Step 2: Client-side — send the federated token as headers... +x-auth-scheme: federated-token +x-auth-ft: FEDERATED_TOKEN_FROM_STEP_1 + +# ...or, on media URLs and LAN device URLs, as query parameters +?x-auth-scheme=federated-token&x-auth-ft=FEDERATED_TOKEN_FROM_STEP_1 ``` +The scheme value is exactly `federated-token`, and a federated token never goes in `x-auth-apikey`. Devices on the LAN never accept API keys; they accept only federated tokens. + ## Standard cURL Pattern ```bash @@ -45,7 +57,7 @@ curl -X POST "https://api2.rhombussystems.com/api/ENDPOINT_PATH" \ ```python import requests -api_url = "https://api2.rhombussystems.com" +api_url = "https://api2.rhombussystems.com" # EU: "https://api2.eu.rhombussystems.com" session = requests.session() session.headers = { "Accept": "application/json", @@ -84,8 +96,8 @@ The Rhombus API is organized into 65+ categories. The most commonly used: - **Doorbell Camera** — Doorbell-specific operations ### Access Control -- **Access Control** — Credentials, groups, grants, revocations, doors -- **Door** — Door state, lock/unlock operations +- **Access Control** — Credentials, groups, grants, revocations, door unlock +- **Door** — Door sensors (open/close state and events) - **Door Controller** — Door controller hardware - **Elevator** — Elevator floor access control - **Guest Management Kiosk** — Visitor management @@ -118,32 +130,29 @@ The Rhombus API is organized into 65+ categories. The most commonly used: - **Permission** — RBAC configuration ### Integrations -- **Developer** — API keys, webhooks -- **Webhook Integrations** — Webhook management +- **Developer** — Event listeners +- **Webhook Integrations** — Organization webhooks and their secrets - **OAuth** — OAuth flows - **Incident/Service Management Integrations** — PagerDuty, ServiceNow, etc. ## Common Endpoint Patterns +All paths start with `/api//` and every endpoint is `POST` with a JSON body (send `{}` when there are no fields). + ### Listing Resources -Most list endpoints follow this pattern: -- Path: `/api/category/list*` or `/api/category/getMinimal*` -- Method: POST +- Path: `/api//getMinimal...` (for example `/api/camera/getMinimalCameraStateList`), `/api//get...` or `/api//find...` - Body: Typically minimal or empty (`{}`) ### Creating Resources -- Path: `/api/category/create*` -- Method: POST +- Path: `/api//create...` - Body: Resource properties ### Updating Resources -- Path: `/api/category/update*` -- Method: POST +- Path: `/api//update...` - Body: Resource UUID + updated properties ### Deleting Resources -- Path: `/api/category/delete*` -- Method: POST +- Path: `/api//delete...` - Body: Resource UUID ## Frequently Used Endpoints @@ -152,22 +161,18 @@ Most list endpoints follow this pattern: ```bash # List all cameras POST /api/camera/getMinimalCameraStateList +Body: {} -# Get camera details -POST /api/camera/getCamera -Body: {"cameraUuid": "..."} - -# Get VOD URI for footage -POST /api/camera/getVodUri -Body: {"cameraUuid": "...", "startTime": 1234567890, "duration": 3600} - -# Get media URIs for streaming (used with DashJS player) -POST /camera/getMediaUris +# Get media URIs: live streams (wanLiveMpdUri, wanLiveM3u8Uri, wanLiveH264Uri), +# VOD templates (wanVodMpdUriTemplate, wanVodM3u8UriTemplate) and LAN URIs +POST /api/camera/getMediaUris Body: {"cameraUuid": "..."} +# Recorded footage: in a VOD template, replace {START_TIME} with a Unix timestamp +# in seconds and {DURATION} with a length in seconds. # Get exact frame (supports cropping for vehicle/face extraction) -POST /video/getExactFrameUri -Body: {"cameraUuid": "...", "timestamp": 1234567890000} +POST /api/video/getExactFrameUri +Body: {"cameraUuid": "...", "timestampMs": 1234567890000} # Create shared live stream (for iframe embedding) POST /api/camera/createSharedLiveVideoStream @@ -176,50 +181,57 @@ Body: {"cameraUuid": "..."} ### Access Control ```bash -# List access control doors -POST /api/door/getMinimalDoorStateList +# List access-controlled doors +POST /api/component/findAccessControlledDoors +Body: {} -# Lock/unlock a door -POST /api/door/updateDoorLockState -Body: {"doorUuid": "...", "lockState": "UNLOCKED"} +# Unlock an access-controlled door +POST /api/accesscontrol/unlockAccessControlledDoor +Body: {"accessControlledDoorUuid": "..."} # Create access credential POST /api/accesscontrol/createStandardCsnCredential -Body: {"csn": "...", "userId": "..."} +Body: {"credentialValue": "...", "userUuid": "..."} + +# Get access events for a door +POST /api/component/findPaginatedComponentEventsByAccessControlledDoor +Body: {"accessControlledDoorUuid": "...", "createdAfterMs": 1234567890000, "createdBeforeMs": 1234567990000} -# Get access events -POST /api/event/searchAccessControlActivityEvent -Body: {"startTime": 1234567890, "endTime": 1234567890} +# Door sensors (open/close), not access-controlled doors +POST /api/door/getMinimalDoorStateList ``` ### User Management ```bash # List users -POST /api/user/getOrgUserList +POST /api/user/getUsersInOrg +Body: {} # Create user POST /api/user/createUser -Body: {"email": "...", "firstName": "...", "lastName": "..."} +Body: {"email": "...", "name": "..."} ``` ### Location Management ```bash # List locations POST /api/location/getLocations +Body: {} -# Get location hierarchy -POST /api/location/getLocationHierarchy +# Get one location +POST /api/location/getLocation +Body: {"locationUuid": "..."} ``` ### IoT / Sensors ```bash -# Get sensor data -POST /api/sensor/getSensorData -Body: {"sensorUuid": "...", "startTime": 1234567890, "endTime": 1234567890} +# List environmental (climate) sensors and their current readings +POST /api/climate/getMinimalClimateStateList +Body: {} -# Get climate data -POST /api/climate/getClimateData -Body: {"sensorUuid": "...", "startTime": 1234567890, "endTime": 1234567890} +# Get climate events for one sensor +POST /api/climate/getClimateEventsForSensor +Body: {"sensorUuid": "...", "createdAfterMs": 1234567890000, "createdBeforeMs": 1234567990000} ``` ## Response Format @@ -241,13 +253,14 @@ Timestamps are Unix epoch time in milliseconds: ``` ### Pagination -Many list endpoints support pagination: +Pagination fields vary by endpoint, so check each request schema. The most common pattern is `maxPageSize` plus `lastEvaluatedKey`: send the `lastEvaluatedKey` from the previous response to get the next page, and stop when the response has none. ```json { - "pageSize": 100, - "pageToken": "optional_token_for_next_page" + "maxPageSize": 100, + "lastEvaluatedKey": "value_from_previous_response" } ``` +Other endpoints use `limit`, `maxResults` with `lastTimestampMs`/`lastUuid`, or a nested `pageRequest` object. ## SDK Client Generation @@ -265,9 +278,15 @@ Supported generators: python, typescript-fetch, java, csharp, go, php, and many Common error responses: - `401` — Authentication failed (check API key and headers) - `400` — Bad request (check request body format) +- `403` with "Invalid api key" — often a key from the other region (US vs EU) - `404` — Resource not found +- `429` — Rate limited: wait the `Retry-After` header's seconds, then retry with exponential backoff and jitter - `500` — Server error (retry with exponential backoff) +## Rate Limits + +Limits are enforced per organization. Every API key and OAuth token in the organization shares one token bucket, so adding keys doesn't add throughput. The bucket refills at a per-second rate and allows bursts of roughly 10x that rate. See https://developer.rhombus.com/rate-limits. + ## Best Practices 1. **Always include both authentication headers** — Missing either will result in authentication failure @@ -276,6 +295,6 @@ Common error responses: 4. **Handle pagination** — Large result sets require pagination 5. **Use minimal endpoints when possible** — `getMinimal*` endpoints return less data and are faster 6. **Cache location and device lists** — These change infrequently -7. **Use federated tokens for browser apps** — Never expose API keys in frontend code +7. **Use federated tokens for browser apps** — Never expose API keys in frontend code; send `x-auth-scheme: federated-token` + `x-auth-ft` 8. **Use server-side proxies for streaming** — Protects API tokens and resolves CORS issues 9. **Check for deprecated endpoints** — Some older endpoints are marked as deprecated diff --git a/plugins/developer/skills/rhombus-api/references/rhombus-api.json b/plugins/developer/skills/rhombus-api/references/rhombus-api.json index c597def..98227ca 100644 --- a/plugins/developer/skills/rhombus-api/references/rhombus-api.json +++ b/plugins/developer/skills/rhombus-api/references/rhombus-api.json @@ -591,6 +591,47 @@ "tags" : [ "Access Control Webservice" ] } }, + "/api/accesscontrol/createWiegandH10302Credential" : { + "post" : { + "description" : "Create a H10302 wiegand credential", + "operationId" : "createWiegandH10302Credential", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10302CredentialWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_CreateWiegandH10302CredentialWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Create H10302 Wiegand credential", + "tags" : [ "Access Control Webservice" ] + } + }, "/api/accesscontrol/createWiegandH10304Credential" : { "post" : { "description" : "Create a H10304 wiegand credential", @@ -837,6 +878,47 @@ "tags" : [ "Access Control Webservice" ] } }, + "/api/accesscontrol/findAccessControlCredentialByGuestPass" : { + "post" : { + "description" : "Find all access control credentials assigned to the specified guest pass", + "operationId" : "findAccessControlCredentialByGuestPass", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Find access control credentials by guest pass", + "tags" : [ "Access Control Webservice" ] + } + }, "/api/accesscontrol/findAccessControlCredentialByOrg" : { "post" : { "description" : "Find all access control credentials in the org", @@ -1903,6 +1985,47 @@ "tags" : [ "Access Control Webservice" ] } }, + "/api/accesscontrol/getAccessControlCredentialDetails" : { + "post" : { + "description" : "Retrieves an access control credential of any type, including sensitive details, by UUID.", + "operationId" : "getAccessControlCredentialDetails", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_GetAccessControlCredentialDetailsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_GetAccessControlCredentialDetailsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get access control credential details", + "tags" : [ "Access Control Webservice" ] + } + }, "/api/accesscontrol/getLocationAccessGrant" : { "post" : { "description" : "Retrieve a location access grant by id", @@ -1987,7 +2110,8 @@ }, "/api/accesscontrol/getRhombusSecureCsnCredentialDetails" : { "post" : { - "description" : "Retrieves a rhombus secure csn credential including sensitive details", + "deprecated" : true, + "description" : "Retrieves a rhombus secure csn credential including sensitive details. Deprecated: use getAccessControlCredentialDetails.", "operationId" : "getRhombusSecureCsnCredentialDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", @@ -2028,7 +2152,8 @@ }, "/api/accesscontrol/getStandardCsnCredentialDetails" : { "post" : { - "description" : "Retrieves a standard csn credential including sensitive details", + "deprecated" : true, + "description" : "Retrieves a standard csn credential including sensitive details. Deprecated: use getAccessControlCredentialDetails.", "operationId" : "getStandardCsnCredentialDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", @@ -3258,6 +3383,7 @@ }, "/api/alertmonitoring/cancelThreatCase" : { "post" : { + "deprecated" : true, "description" : "Cancel a threat case in alert monitoring.", "operationId" : "cancelThreatCase", "parameters" : [ { @@ -3299,6 +3425,7 @@ }, "/api/alertmonitoring/createCustomPinForLocation" : { "post" : { + "deprecated" : true, "description" : "Create a custom PIN for alert monitoring at a specific location.", "operationId" : "createCustomPinForLocation", "parameters" : [ { @@ -3340,6 +3467,7 @@ }, "/api/alertmonitoring/createPinForLocation" : { "post" : { + "deprecated" : true, "description" : "Create a PIN for alert monitoring at a specific location.", "operationId" : "createPinForLocation", "parameters" : [ { @@ -3381,6 +3509,7 @@ }, "/api/alertmonitoring/deletePinForLocation" : { "post" : { + "deprecated" : true, "description" : "Delete a PIN for alert monitoring at a specific location.", "operationId" : "deletePinForLocation", "parameters" : [ { @@ -3463,6 +3592,7 @@ }, "/api/alertmonitoring/dismissThreatCase" : { "post" : { + "deprecated" : true, "description" : "Dismiss a threat case in alert monitoring.", "operationId" : "dismissThreatCase", "parameters" : [ { @@ -3545,6 +3675,7 @@ }, "/api/alertmonitoring/escalateThreatCaseToAlarm" : { "post" : { + "deprecated" : true, "description" : "Escalate a threat case to an alarm for alert monitoring.", "operationId" : "escalateThreatCaseToAlarm", "parameters" : [ { @@ -3586,6 +3717,7 @@ }, "/api/alertmonitoring/getAlertMonitoringSettingsForLocation" : { "post" : { + "deprecated" : true, "description" : "Retrieve alert monitoring settings by location.", "operationId" : "getAlertMonitoringSettingsForLocation", "parameters" : [ { @@ -6629,6 +6761,47 @@ "tags" : [ "Camera Webservice" ] } }, + "/api/camera/getUptimeWindowsForOrg" : { + "post" : { + "description" : "Get uptime windows for all (or selected) cameras in the organization in a single call", + "operationId" : "getUptimeWindowsForOrg", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsForOrgWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsForOrgWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get camera uptime windows in batch", + "tags" : [ "Camera Webservice" ] + } + }, "/api/camera/getVideoWalls" : { "post" : { "description" : "Get list of video walls available for client", @@ -6670,6 +6843,47 @@ "tags" : [ "Camera Webservice" ] } }, + "/api/camera/ptzMove" : { + "post" : { + "description" : "Move a first-party mechanical PTZ camera by permyriad delta", + "operationId" : "ptzMoveCamera", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Camera_CameraPTZMoveWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Camera_CameraPTZMoveWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "PTZ move", + "tags" : [ "Camera Webservice" ] + } + }, "/api/camera/reboot" : { "post" : { "description" : "Send reboot command to camera", @@ -9124,6 +9338,47 @@ "tags" : [ "Component Webservice" ] } }, + "/api/component/findComponentEventsByGuestPass" : { + "post" : { + "description" : "Retrieve all component events relevant to the specified guest pass", + "operationId" : "findComponentEventsByGuestPass", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Component_FindComponentEventsByGuestPassWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Component_FindComponentEventsByGuestPassWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Retrieve all component events relevant to the specified guest pass", + "tags" : [ "Component Webservice" ] + } + }, "/api/component/findComponentEventsByLocation" : { "post" : { "description" : "Retrieve all component events relevant to the specified location", @@ -9576,6 +9831,47 @@ "tags" : [ "Component Webservice" ] } }, + "/api/component/findComponentShadowsByComponentComposites" : { + "post" : { + "description" : "Retrieve all component shadows for the components belonging to the specified component composites (doors, elevators, elevator landings). Each composite is expanded to its component references and the resulting set of component shadows is returned.", + "operationId" : "findComponentShadowsByComponentComposites", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Component_FindComponentShadowsByComponentCompositesWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Component_FindComponentShadowsByComponentCompositesWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Retrieve all component shadows for the components belonging to the specified component composites", + "tags" : [ "Component Webservice" ] + } + }, "/api/component/findComponentShadowsByOwnerDevice" : { "post" : { "description" : "Retrieve component shadows by the specified owner device uuid", @@ -9781,6 +10077,47 @@ "tags" : [ "Component Webservice" ] } }, + "/api/component/findPaginatedComponentEventsByOwnerDevice" : { + "post" : { + "description" : "Retrieve all component events relevant to the specified owner device (i.e. DC20's device uuid)", + "operationId" : "findPaginatedComponentEventsByOwnerDevice", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Component_FindPaginatedComponentEventsByOwnerDeviceWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Component_FindPaginatedComponentEventsByOwnerDeviceWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Retrieve all component events relevant to the specified owner device", + "tags" : [ "Component Webservice" ] + } + }, "/api/component/getAccessControlledDoorLabelsForOrg" : { "post" : { "description" : "Get all access controlled door labels for the organization", @@ -11093,6 +11430,47 @@ "tags" : [ "Doorbell Camera Webservice" ] } }, + "/api/doorbellcamera/createRawHttpStream" : { + "post" : { + "description" : "Create a raw HTTP stream for a doorbell camera.", + "operationId" : "createDoorbellCameraRawHttpStream", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Create a raw HTTP stream for a doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, "/api/doorbellcamera/createRuleForDoorbellCamera" : { "post" : { "description" : "Create rule for a doorbell camera.", @@ -11216,6 +11594,47 @@ "tags" : [ "Doorbell Camera Webservice" ] } }, + "/api/doorbellcamera/deleteRawHttpStream" : { + "post" : { + "description" : "Delete a raw HTTP stream for a doorbell camera.", + "operationId" : "deleteDoorbellCameraRawHttpStream", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete a raw HTTP stream for a doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, "/api/doorbellcamera/deleteRuleForDoorbellCamera" : { "post" : { "description" : "Delete rule for a doorbell camera.", @@ -11257,6 +11676,47 @@ "tags" : [ "Doorbell Camera Webservice" ] } }, + "/api/doorbellcamera/findAllRawHttpStreams" : { + "post" : { + "description" : "Get a list of all doorbell cameras raw HTTP streams.", + "operationId" : "findAllDoorbellCameraRawHttpStreams", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get a list of all doorbell cameras raw HTTP streams", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, "/api/doorbellcamera/findComponentEventsForDoorbellCamera" : { "post" : { "description" : "Retrieve all component events relevant to the specified Doorbell Camera", @@ -11380,6 +11840,88 @@ "tags" : [ "Doorbell Camera Webservice" ] } }, + "/api/doorbellcamera/getBoundingBoxes" : { + "post" : { + "description" : "Get object bounding boxes for a specified doorbell camera. Note: bounding box values are given as permyriad shorts relative to image. To convert to absolute pixel values, use the following: abs_pix = (rel_permyriad / 10000) * image_dim", + "operationId" : "getDoorbellCameraBoundingBoxes", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetBoundingBoxesWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetBoundingBoxesWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get object bounding boxes for a specified doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getConfig" : { + "post" : { + "description" : "Get a doorbell camera's config", + "operationId" : "getDoorbellCameraConfig", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Device_config_GetConfigWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraConfigWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get a doorbell camera's config", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, "/api/doorbellcamera/getDoorbellCameraRulesForOrg" : { "post" : { "description" : "Get rules for all doorbell cameras in an org.", @@ -11421,6 +11963,252 @@ "tags" : [ "Doorbell Camera Webservice" ] } }, + "/api/doorbellcamera/getFullState" : { + "post" : { + "description" : "Get detailed information about state of specified doorbell camera", + "operationId" : "getDoorbellCameraFullState", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetFullDeviceStateWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraFullStateWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get detailed information about state of specified doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getMediaUris" : { + "post" : { + "description" : "Get media uris for doorbell camera to retrieve footage and audio", + "operationId" : "getDoorbellCameraMediaUris", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetMediaUrisWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraMediaUrisWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get media uris for doorbell camera to retrieve footage and audio", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getMinimalStateList" : { + "post" : { + "description" : "Get basic state information about all doorbell cameras in organization", + "operationId" : "getDoorbellCameraMinimalStateList", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetMinimalDeviceStateListWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraMinimalStateListWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get basic state information about all doorbell cameras in organization", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getOfflineLanStreamingInfo" : { + "post" : { + "description" : "Get required information for offline lan streaming on all video intercoms", + "operationId" : "getDoorbellCameraOfflineLanStreamingInfo", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get required information for offline lan streaming on all video intercoms", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getPresenceWindows" : { + "post" : { + "description" : "Get stored video information for a doorbell camera", + "operationId" : "getDoorbellCameraPresenceWindows", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetPresenceWindowsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetPresenceWindowsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get stored video information for a doorbell camera", + "tags" : [ "Doorbell Webservice", "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getRawHttpStreams" : { + "post" : { + "description" : "Get info for all raw HTTP streams from a doorbell camera.", + "operationId" : "getDoorbellCameraRawHttpStreams", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_GetRawHttpStreamsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_GetRawHttpStreamsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get info for all raw HTTP streams from a doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, "/api/doorbellcamera/getRulesForDoorbellCamera" : { "post" : { "description" : "Get all rules for a doorbell camera.", @@ -11462,6 +12250,252 @@ "tags" : [ "Doorbell Camera Webservice" ] } }, + "/api/doorbellcamera/getSeekpoints" : { + "post" : { + "description" : "Get activity seekpoints for specified doorbell camera", + "operationId" : "getDoorbellCameraSeekPoints", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get activity seekpoints for specified doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/getUptimeWindows" : { + "post" : { + "description" : "Get uptime information for a doorbell camera", + "operationId" : "getDoorbellCameraUptimeWindows", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get uptime information for a doorbell camera", + "tags" : [ "Doorbell Webservice", "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/reboot" : { + "post" : { + "description" : "Reboot the specified doorbell camera", + "operationId" : "rebootDoorbellCamera", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_RebootDoorbellCameraWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Reboot the specified doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/reportTalkSession" : { + "post" : { + "description" : "Report that the calling operator started or ended talking through a video intercom. Emits an IntercomTalkEvent component event correlatable with the intercom's DoorbellEvent button presses; the STARTED and ENDED reports of one hold share a talkSessionUuid.", + "operationId" : "reportDoorbellCameraTalkSession", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_ReportTalkSessionWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_ReportTalkSessionWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Report an operator talk session on a video intercom", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/updateConfig" : { + "post" : { + "description" : "Update a doorbell camera's config", + "operationId" : "updateDoorbellCameraConfig", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_UpdateDoorbellCameraConfigWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_UpdateConfigWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update a doorbell camera's config", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, + "/api/doorbellcamera/updateDetails" : { + "post" : { + "description" : "Update hardware details of doorbell camera.", + "operationId" : "updateDoorbellCameraDetails", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Doorbellcamera_UpdateDoorbellCameraDetailsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Common_devices_UpdateDeviceDetailsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update hardware details of doorbell camera", + "tags" : [ "Doorbell Camera Webservice" ] + } + }, "/api/doorcontroller/registerDiscoveredRhombusReader" : { "post" : { "description" : "Register a Rhombus reader that a Door Controller has discovered", @@ -13725,47 +14759,6 @@ "tags" : [ "Export Webservice" ] } }, - "/api/export/peopleEvents" : { - "post" : { - "description" : "Download people event log", - "operationId" : "exportPeopleEvents", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Export_ExportPeopleEventsWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/StreamingOutput" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Download people event log", - "tags" : [ "Export Webservice" ] - } - }, "/api/export/proximityEvents" : { "post" : { "description" : "Download proximity tag event log", @@ -15549,6 +16542,47 @@ "tags" : [ "IoT Integrations Webservice" ] } }, + "/api/integrations/IoT/deleteTritonIntegration" : { + "post" : { + "description" : "Delete Triton audio sensor integration", + "operationId" : "deleteTritonIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete Triton Integration", + "tags" : [ "IoT Integrations Webservice" ] + } + }, "/api/integrations/IoT/getOmnialertIntegration" : { "post" : { "description" : "Get Omnialert integration", @@ -15795,6 +16829,211 @@ "tags" : [ "IoT Integrations Webservice" ] } }, + "/api/integrations/IoT/updateTritonIntegration" : { + "post" : { + "description" : "Update Triton audio sensor integration", + "operationId" : "updateTritonIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_UpdateTritonIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update Triton Integration", + "tags" : [ "IoT Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/connectHoneywellElements" : { + "post" : { + "description" : "Step 1 of the Elements setup wizard: validate the API key against Honeywell Elements and persist on success. After this call, subsequent endpoints (sites, devices, update) resolve credentials from the stored row and never require the API key again.", + "operationId" : "connectHoneywellElements", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_ConnectHoneywellElementsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Connect Honeywell Elements (validate + persist)", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/connectHoneywellNetBox" : { + "post" : { + "description" : "Activate the Honeywell NetBox integration for the calling org. NetBox is webhook-driven: the on-prem NetBox controller POSTs access events to a Rhombus webhook URL. On first activation the server generates the webhook rhombusToken and returns it (plus the fully-formed webhook URL); subsequent calls preserve the token so the configured forwarder keeps working as the door mapping changes. The request owns the door mapping and optional base URL.", + "operationId" : "connectHoneywellNetBox", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_ConnectHoneywellNetBoxWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_ConnectHoneywellNetBoxIntegrationWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Connect Honeywell NetBox (activate)", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/createOrUpdateHoneywellNetBoxIntegration" : { + "post" : { + "description" : "Activate or update the Honeywell NetBox integration from the on-prem side — the NetBox counterpart of createOrUpdateHoneywellOnGuardIntegration. Called by the Rhombus NetBox connector, which discovers portals via the NetBox GetPortals API and owns the door inventory; the console owns camera/location assignments. First activation (blank rhombusToken, no existing integration) generates the webhook token; re-calls merge the door map by portal key without overwriting console-made assignments, and keys absent from the request are preserved.", + "operationId" : "createOrUpdateHoneywellNetBoxIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Create or update Honeywell NetBox integration (on-prem connector)", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/createOrUpdateHoneywellOnGuardIntegration" : { + "post" : { + "description" : "Idempotent activation/update endpoint called by the OnGuard side from its setup tool. Generates the webhook token and pre-shared HMAC secret on first call; preserves both on subsequent calls so the deployed DLL keeps working as the door mapping changes. The request owns the door mapping; behavior flags (face recognition, clip saving, etc.) are managed separately from the Rhombus console.", + "operationId" : "createOrUpdateHoneywellOnGuardIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Create or update the Honeywell OnGuard integration", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, "/api/integrations/accessControl/deleteAmtIntegration" : { "post" : { "description" : "Delete Amt badge integration", @@ -16164,10 +17403,10 @@ "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/deleteInnerRangeIntegration" : { + "/api/integrations/accessControl/deleteHoneywellElementsIntegration" : { "post" : { - "description" : "Delete Inner Range integration", - "operationId" : "deleteInnerRangeIntegration", + "description" : "Delete Honeywell Elements integration", + "operationId" : "deleteHoneywellElementsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -16201,15 +17440,138 @@ "description" : "OK" } }, - "summary" : "Delete Inner Range integration", + "summary" : "Delete Honeywell Elements integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/deleteKisiIntegration" : { + "/api/integrations/accessControl/deleteHoneywellNetBoxIntegration" : { "post" : { - "deprecated" : true, - "description" : "Delete Kisi badge integration", - "operationId" : "deleteKisiIntegration", + "description" : "Delete Honeywell NetBox integration", + "operationId" : "deleteHoneywellNetBoxIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete Honeywell NetBox integration", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/deleteHoneywellOnGuardIntegration" : { + "post" : { + "description" : "Delete Honeywell OnGuard integration. Callable from the Rhombus console (admin) or from the OnGuard side (uninstall). Idempotent per deployment: deleting a rhombusToken that is unknown or already deleted returns success, so the client may safely retry after a network failure.", + "operationId" : "deleteHoneywellOnGuardIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_DeleteHoneywellOnGuardIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete Honeywell OnGuard integration", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/deleteInnerRangeIntegration" : { + "post" : { + "description" : "Delete Inner Range integration", + "operationId" : "deleteInnerRangeIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete Inner Range integration", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/deleteKisiIntegration" : { + "post" : { + "deprecated" : true, + "description" : "Delete Kisi badge integration", + "operationId" : "deleteKisiIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17067,10 +18429,10 @@ "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getInnerRangeConsoles" : { + "/api/integrations/accessControl/getHoneywellElementsDevices" : { "post" : { - "description" : "Get Inner Range console settings", - "operationId" : "getInnerRangeConsoles", + "description" : "Get list of available Honeywell Elements devices to assign cameras", + "operationId" : "getHoneywellElementsDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17087,7 +18449,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetInnerRangeConsolesWSRequest" + "$ref" : "#/components/schemas/Integration_GetHoneywellElementsDevicesWSRequest" } } } @@ -17097,22 +18459,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetInnerRangeConsolesWSResponse" + "$ref" : "#/components/schemas/Integration_GetHoneywellElementsDevicesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Inner Range console settings", + "summary" : "Get list of Honeywell Elements devices", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getInnerRangeDoors" : { + "/api/integrations/accessControl/getHoneywellElementsIntegration" : { "post" : { - "deprecated" : true, - "description" : "Get list of Inner Range doors", - "operationId" : "getInnerRangeDoors", + "description" : "Get Honeywell Elements integration settings", + "operationId" : "getHoneywellElementsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17129,7 +18490,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetInnerRangeDoorsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -17139,21 +18500,62 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetInnerRangeDoorsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Inner Range doors", + "summary" : "Get Honeywell Elements integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getInnerRangeIntegration" : { + "/api/integrations/accessControl/getHoneywellElementsSites" : { "post" : { - "description" : "Get Inner Range integration", - "operationId" : "getInnerRangeIntegration", + "description" : "Get list of available Honeywell Elements sites", + "operationId" : "getHoneywellElementsSites", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_ValidateHoneywellElementsCredentialsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetHoneywellElementsSitesWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get list of Honeywell Elements sites", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/getHoneywellElementsWebhookConfig" : { + "post" : { + "description" : "Returns the callback URL and suggested payload template the customer needs to paste into the Elements admin console when creating their webhook Automation. Elements does not support programmatic webhook creation, so this endpoint is the setup aid instead of a registration call.", + "operationId" : "getHoneywellElementsWebhookConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17180,22 +18582,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/Integration_GetHoneywellElementsWebhookConfigWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Inner Range integration", + "summary" : "Get Honeywell Elements webhook config", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getKisiDoors" : { + "/api/integrations/accessControl/getHoneywellNetBoxIntegration" : { "post" : { - "deprecated" : true, - "description" : "Get list of Kisi doors to assign cameras", - "operationId" : "getKisiDoors", + "description" : "Get Honeywell NetBox integration settings", + "operationId" : "getHoneywellNetBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17212,7 +18613,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetKisiDoorsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -17222,22 +18623,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetKisiDoorsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Kisi doors to assign cameras", + "summary" : "Get Honeywell NetBox integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getKisiIntegration" : { + "/api/integrations/accessControl/getHoneywellNetBoxWebhookConfig" : { "post" : { - "deprecated" : true, - "description" : "Get Kisi badge integration", - "operationId" : "getKisiIntegration", + "description" : "Returns the fully-formed callback URL and a suggested JSON payload template to configure in the Honeywell NetBox webhook forwarder. The integration must be activated (connectHoneywellNetBox) first so a webhook token exists; the returned URL is keyed off that token.", + "operationId" : "getHoneywellNetBoxWebhookConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17254,7 +18654,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -17264,21 +18664,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetKisiIntegrationWSResponse" + "$ref" : "#/components/schemas/Integration_GetHoneywellNetBoxWebhookConfigWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Kisi badge integration", + "summary" : "Get Honeywell NetBox webhook config", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getKisiIntegrationV2" : { + "/api/integrations/accessControl/getHoneywellOnGuardIntegration" : { "post" : { - "description" : "Get Kisi badge integration V2", - "operationId" : "getKisiIntegrationV2", + "description" : "Get Honeywell OnGuard integration settings, including the webhook URL and pre-shared secret (always retrievable for support/debugging).", + "operationId" : "getHoneywellOnGuardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17312,15 +18712,14 @@ "description" : "OK" } }, - "summary" : "Get Kisi badge integration V2", + "summary" : "Get Honeywell OnGuard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getKisiPlaces" : { + "/api/integrations/accessControl/getInnerRangeConsoles" : { "post" : { - "deprecated" : true, - "description" : "Get list of Kisi places to assign cameras", - "operationId" : "getKisiPlaces", + "description" : "Get Inner Range console settings", + "operationId" : "getInnerRangeConsoles", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17337,7 +18736,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetKisiPlacesWSRequest" + "$ref" : "#/components/schemas/Integration_GetInnerRangeConsolesWSRequest" } } } @@ -17347,21 +18746,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationPlacesWSResponse" + "$ref" : "#/components/schemas/Integration_GetInnerRangeConsolesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Kisi places to assign cameras", + "summary" : "Get Inner Range console settings", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getOpenpathDoors" : { + "/api/integrations/accessControl/getInnerRangeDoors" : { "post" : { - "description" : "Get list of Openpath doors to assign cameras", - "operationId" : "getOpenpathDoors", + "deprecated" : true, + "description" : "Get list of Inner Range doors", + "operationId" : "getInnerRangeDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17378,7 +18778,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenpathDoorsWSRequest" + "$ref" : "#/components/schemas/Integration_GetInnerRangeDoorsWSRequest" } } } @@ -17388,21 +18788,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" + "$ref" : "#/components/schemas/Integration_GetInnerRangeDoorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Openpath doors to assign cameras", + "summary" : "Get list of Inner Range doors", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getOpenpathLockdownPlans" : { + "/api/integrations/accessControl/getInnerRangeIntegration" : { "post" : { - "description" : "Get list of Openpath lockdown plans to trigger", - "operationId" : "getOpenpathLockdownPlans", + "description" : "Get Inner Range integration", + "operationId" : "getInnerRangeIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17419,7 +18819,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenpathDoorsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -17429,21 +18829,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenpathLockdownsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Openpath lockdown plans to trigger", + "summary" : "Get Inner Range integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getOpentechAllianceFacilities" : { + "/api/integrations/accessControl/getKisiDoors" : { "post" : { - "description" : "Get list of Opentech Alliance facilities", - "operationId" : "getOpentechAllianceFacilities", + "deprecated" : true, + "description" : "Get list of Kisi doors to assign cameras", + "operationId" : "getKisiDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17460,7 +18861,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSRequest" + "$ref" : "#/components/schemas/Integration_GetKisiDoorsWSRequest" } } } @@ -17470,21 +18871,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSResponse" + "$ref" : "#/components/schemas/Integration_GetKisiDoorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Opentech Alliance facilities", + "summary" : "Get list of Kisi doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getOpentechAllianceFacilitiesV2" : { + "/api/integrations/accessControl/getKisiIntegration" : { "post" : { - "description" : "Get list of Opentech Alliance facilities", - "operationId" : "getOpentechAllianceFacilitiesV2", + "deprecated" : true, + "description" : "Get Kisi badge integration", + "operationId" : "getKisiIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17501,7 +18903,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSRequest" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } @@ -17511,21 +18913,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSResponse" + "$ref" : "#/components/schemas/Integration_GetKisiIntegrationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of Opentech Alliance facilities V2", + "summary" : "Get Kisi badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getOpentechAllianceIntegrationV2" : { + "/api/integrations/accessControl/getKisiIntegrationV2" : { "post" : { - "description" : "Get Opentech Alliance integration", - "operationId" : "getOpentechAllianceIntegrationV2", + "description" : "Get Kisi badge integration V2", + "operationId" : "getKisiIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17559,14 +18961,15 @@ "description" : "OK" } }, - "summary" : "Get Opentech Alliance integration V2", + "summary" : "Get Kisi badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getPdkDoors" : { + "/api/integrations/accessControl/getKisiPlaces" : { "post" : { - "description" : "Get list of ProDataKey doors to assign cameras", - "operationId" : "getPdkDoors", + "deprecated" : true, + "description" : "Get list of Kisi places to assign cameras", + "operationId" : "getKisiPlaces", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17583,7 +18986,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetPdkDoorsWSRequest" + "$ref" : "#/components/schemas/Integration_GetKisiPlacesWSRequest" } } } @@ -17593,21 +18996,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetPdkDoorsWSResponse" + "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationPlacesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of ProDataKey doors to assign cameras", + "summary" : "Get list of Kisi places to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getPdkIntegration" : { + "/api/integrations/accessControl/getOpenpathDoors" : { "post" : { - "description" : "Get ProDataKey badge integration", - "operationId" : "getPdkIntegration", + "description" : "Get list of Openpath doors to assign cameras", + "operationId" : "getOpenpathDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17624,7 +19027,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOpenpathDoorsWSRequest" } } } @@ -17634,21 +19037,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get ProDataKey badge integration", + "summary" : "Get list of Openpath doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getPlaceOsDoors" : { + "/api/integrations/accessControl/getOpenpathLockdownPlans" : { "post" : { - "description" : "Get list of PlaceOs doors to assign cameras", - "operationId" : "getPlaceOsDoors", + "description" : "Get list of Openpath lockdown plans to trigger", + "operationId" : "getOpenpathLockdownPlans", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17665,7 +19068,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetPlaceOsDoorsWSRequest" + "$ref" : "#/components/schemas/Integration_GetOpenpathDoorsWSRequest" } } } @@ -17675,21 +19078,103 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationGenericDoorsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOpenpathLockdownsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of PlaceOs doors to assign cameras", + "summary" : "Get list of Openpath lockdown plans to trigger", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/getPlaceOsIntegrationV2" : { + "/api/integrations/accessControl/getOpentechAllianceFacilities" : { "post" : { - "description" : "Get PlaceOs integration", - "operationId" : "getPlaceOsIntegrationV2", + "description" : "Get list of Opentech Alliance facilities", + "operationId" : "getOpentechAllianceFacilities", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get list of Opentech Alliance facilities", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/getOpentechAllianceFacilitiesV2" : { + "post" : { + "description" : "Get list of Opentech Alliance facilities", + "operationId" : "getOpentechAllianceFacilitiesV2", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetOpentechAllianceFacilitiesWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get list of Opentech Alliance facilities V2", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/getOpentechAllianceIntegrationV2" : { + "post" : { + "description" : "Get Opentech Alliance integration", + "operationId" : "getOpentechAllianceIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17723,14 +19208,14 @@ "description" : "OK" } }, - "summary" : "Get PlaceOs integration V2", + "summary" : "Get Opentech Alliance integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/revertOpenpathLockdown" : { + "/api/integrations/accessControl/getPdkDoors" : { "post" : { - "description" : "Revert Openpath lockdown plan", - "operationId" : "revertOpenpathLockdown", + "description" : "Get list of ProDataKey doors to assign cameras", + "operationId" : "getPdkDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17747,7 +19232,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" + "$ref" : "#/components/schemas/Integration_GetPdkDoorsWSRequest" } } } @@ -17757,21 +19242,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" + "$ref" : "#/components/schemas/Integration_GetPdkDoorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Revert Openpath lockdown plan", + "summary" : "Get list of ProDataKey doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/testBoulevardConnection" : { + "/api/integrations/accessControl/getPdkIntegration" : { "post" : { - "description" : "Test Boulevard API connection with provided credentials", - "operationId" : "testBoulevardConnection", + "description" : "Get ProDataKey badge integration", + "operationId" : "getPdkIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17788,7 +19273,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -17798,21 +19283,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Test Boulevard API connection", + "summary" : "Get ProDataKey badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/triggerOpenpathLockdown" : { + "/api/integrations/accessControl/getPlaceOsDoors" : { "post" : { - "description" : "Trigger Openpath lockdown plan", - "operationId" : "triggerOpenpathLockdown", + "description" : "Get list of PlaceOs doors to assign cameras", + "operationId" : "getPlaceOsDoors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17829,7 +19314,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" + "$ref" : "#/components/schemas/Integration_GetPlaceOsDoorsWSRequest" } } } @@ -17839,21 +19324,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" + "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationGenericDoorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Trigger Openpath lockdown plan", + "summary" : "Get list of PlaceOs doors to assign cameras", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockBrivoDoor" : { + "/api/integrations/accessControl/getPlaceOsIntegrationV2" : { "post" : { - "description" : "Unlock Brivo door", - "operationId" : "unlockBrivoDoor", + "description" : "Get PlaceOs integration", + "operationId" : "getPlaceOsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17870,7 +19355,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -17880,21 +19365,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Unlock Brivo door", + "summary" : "Get PlaceOs integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockBrivoDoorV2" : { + "/api/integrations/accessControl/listHoneywellOnGuardIntegrations" : { "post" : { - "description" : "Unlock Brivo door", - "operationId" : "unlockBrivoDoorV2", + "description" : "List the calling org's OnGuard deployments: one summary per activated deployment (rhombusToken, display name, door count, assigned camera UUIDs). Lets the OnGuard setup tool show what already exists before minting a new deployment, and identifies orphans to pass to deleteHoneywellOnGuardIntegration. Pre-shared secrets are never returned.", + "operationId" : "listHoneywellOnGuardIntegrations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17911,7 +19396,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" + "$ref" : "#/components/schemas/Integration_ListHoneywellOnGuardIntegrationsWSRequest" } } } @@ -17921,21 +19406,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" + "$ref" : "#/components/schemas/Integration_ListHoneywellOnGuardIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Unlock Brivo door V2", + "summary" : "List Honeywell OnGuard deployments", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockGeneaDoor" : { + "/api/integrations/accessControl/revertOpenpathLockdown" : { "post" : { - "description" : "Unlock Genea door", - "operationId" : "unlockGeneaDoor", + "description" : "Revert Openpath lockdown plan", + "operationId" : "revertOpenpathLockdown", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17952,7 +19437,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockGeneaDoorWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" } } } @@ -17969,14 +19454,14 @@ "description" : "OK" } }, - "summary" : "Unlock Genea door", + "summary" : "Revert Openpath lockdown plan", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockInnerRangeDoor" : { + "/api/integrations/accessControl/testBoulevardConnection" : { "post" : { - "description" : "Unlock Inner Range door", - "operationId" : "unlockInnerRangeDoor", + "description" : "Test Boulevard API connection with provided credentials", + "operationId" : "testBoulevardConnection", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -17993,7 +19478,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" + "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSRequest" } } } @@ -18003,21 +19488,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" + "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSResponse" } } }, "description" : "OK" } }, - "summary" : "Unlock Inner Range door", + "summary" : "Test Boulevard API connection", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockKisiDoor" : { + "/api/integrations/accessControl/triggerOpenpathLockdown" : { "post" : { - "description" : "Unlock Kisi door", - "operationId" : "unlockKisiDoor", + "description" : "Trigger Openpath lockdown plan", + "operationId" : "triggerOpenpathLockdown", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18034,7 +19519,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockKisiDoorWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" } } } @@ -18051,14 +19536,14 @@ "description" : "OK" } }, - "summary" : "Unlock Kisi door", + "summary" : "Trigger Openpath lockdown plan", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockOpenpathDoor" : { + "/api/integrations/accessControl/unlockBrivoDoor" : { "post" : { - "description" : "Unlock Openpath door", - "operationId" : "unlockOpenpathDoor", + "description" : "Unlock Brivo door", + "operationId" : "unlockBrivoDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18075,7 +19560,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } @@ -18092,14 +19577,14 @@ "description" : "OK" } }, - "summary" : "Unlock Openpath door", + "summary" : "Unlock Brivo door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockOpentechAllianceDoor" : { + "/api/integrations/accessControl/unlockBrivoDoorV2" : { "post" : { - "description" : "Unlock Opentech Alliance door", - "operationId" : "unlockOpentechAllianceDoor", + "description" : "Unlock Brivo door", + "operationId" : "unlockBrivoDoorV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18133,14 +19618,55 @@ "description" : "OK" } }, - "summary" : "Unlock Opentech Alliance door", + "summary" : "Unlock Brivo door V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockOpentechAllianceDoorV2" : { + "/api/integrations/accessControl/unlockGeneaDoor" : { "post" : { - "description" : "Unlock Opentech Alliance door", - "operationId" : "unlockOpentechAllianceDoorV2", + "description" : "Unlock Genea door", + "operationId" : "unlockGeneaDoor", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_UnlockGeneaDoorWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Unlock Genea door", + "tags" : [ "Access Control Integrations Webservice" ] + } + }, + "/api/integrations/accessControl/unlockHoneywellElementsDoor" : { + "post" : { + "description" : "Unlock Honeywell Elements door", + "operationId" : "unlockHoneywellElementsDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18174,14 +19700,14 @@ "description" : "OK" } }, - "summary" : "Unlock Opentech Alliance door V2", + "summary" : "Unlock Honeywell Elements door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockPdkDoor" : { + "/api/integrations/accessControl/unlockHoneywellNetBoxDoor" : { "post" : { - "description" : "Unlock ProDataKey door", - "operationId" : "unlockPdkDoor", + "description" : "Publishes an unlock command to the per-org STOMP topic that the NetBox connector subscribes to. Fire-and-forget: returns success once the command is dispatched, the connector performs the actual relay and does not currently report back.", + "operationId" : "unlockHoneywellNetBoxDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18215,14 +19741,14 @@ "description" : "OK" } }, - "summary" : "Unlock ProDataKey door", + "summary" : "Unlock Honeywell NetBox door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/unlockPlaceOsDoor" : { + "/api/integrations/accessControl/unlockHoneywellOnGuardDoor" : { "post" : { - "description" : "Unlock PlaceOs door", - "operationId" : "unlockPlaceOsDoor", + "description" : "Publishes an unlock command to the per-org STOMP topic that the OnGuard connector subscribes to. Fire-and-forget: returns success once the command is dispatched, the connector performs the actual relay and does not currently report back.", + "operationId" : "unlockHoneywellOnGuardDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18256,14 +19782,14 @@ "description" : "OK" } }, - "summary" : "Unlock PlaceOs door", + "summary" : "Unlock Honeywell OnGuard door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateAmtIntegration" : { + "/api/integrations/accessControl/unlockInnerRangeDoor" : { "post" : { - "description" : "Update Amt badge integration", - "operationId" : "updateAmtIntegration", + "description" : "Unlock Inner Range door", + "operationId" : "unlockInnerRangeDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18280,7 +19806,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateAmtIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } @@ -18290,21 +19816,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update AMT badge integration", + "summary" : "Unlock Inner Range door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateAvigilonAltaIntegrationV2" : { + "/api/integrations/accessControl/unlockKisiDoor" : { "post" : { - "description" : "Update Avigilon Alta badge integration V2", - "operationId" : "updateAvigilonAltaIntegrationV2", + "description" : "Unlock Kisi door", + "operationId" : "unlockKisiDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18321,7 +19847,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateAvigilonAltaV2WSRequest" + "$ref" : "#/components/schemas/Integration_UnlockKisiDoorWSRequest" } } } @@ -18331,21 +19857,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Avigilon Alta badge integration V2", + "summary" : "Unlock Kisi door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateBoulevardIntegration" : { + "/api/integrations/accessControl/unlockOpenpathDoor" : { "post" : { - "description" : "Update Boulevard integration settings", - "operationId" : "updateBoulevardIntegration", + "description" : "Unlock Openpath door", + "operationId" : "unlockOpenpathDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18362,7 +19888,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateBoulevardIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockOpenpathDoorWSRequest" } } } @@ -18372,21 +19898,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Boulevard integration", + "summary" : "Unlock Openpath door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateBrivoIntegration" : { + "/api/integrations/accessControl/unlockOpentechAllianceDoor" : { "post" : { - "description" : "Update Brivo badge integration", - "operationId" : "updateBrivoIntegration", + "description" : "Unlock Opentech Alliance door", + "operationId" : "unlockOpentechAllianceDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18403,7 +19929,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateBrivoIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } @@ -18413,21 +19939,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Brivo badge integration", + "summary" : "Unlock Opentech Alliance door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateBrivoIntegrationV2" : { + "/api/integrations/accessControl/unlockOpentechAllianceDoorV2" : { "post" : { - "description" : "Update Brivo badge integration", - "operationId" : "updateBrivoIntegrationV2", + "description" : "Unlock Opentech Alliance door", + "operationId" : "unlockOpentechAllianceDoorV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18444,7 +19970,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateBrivoIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } @@ -18454,21 +19980,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Brivo badge integration V2", + "summary" : "Unlock Opentech Alliance door V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateButterflymxIntegration" : { + "/api/integrations/accessControl/unlockPdkDoor" : { "post" : { - "description" : "Update ButterflyMX badge integration", - "operationId" : "updateButterflymxIntegration", + "description" : "Unlock ProDataKey door", + "operationId" : "unlockPdkDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18485,7 +20011,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateButterflymxIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } @@ -18495,21 +20021,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update ButterflyMX badge integration", + "summary" : "Unlock ProDataKey door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateButterflymxIntegrationV2" : { + "/api/integrations/accessControl/unlockPlaceOsDoor" : { "post" : { - "description" : "Update ButterflyMX badge integration V2", - "operationId" : "updateButterflymxIntegrationV2", + "description" : "Unlock PlaceOs door", + "operationId" : "unlockPlaceOsDoor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18526,7 +20052,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateButterflymxIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UnlockIntegrationGenericDoorWSRequest" } } } @@ -18536,21 +20062,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_UnlockDoorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update ButterflyMX badge integration V2", + "summary" : "Unlock PlaceOs door", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateGeneaIntegration" : { + "/api/integrations/accessControl/updateAmtIntegration" : { "post" : { - "description" : "Update Genea badge integration", - "operationId" : "updateGeneaIntegration", + "description" : "Update Amt badge integration", + "operationId" : "updateAmtIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18567,7 +20093,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateGeneaIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateAmtIntegrationWSRequest" } } } @@ -18584,14 +20110,14 @@ "description" : "OK" } }, - "summary" : "Update Genea badge integration", + "summary" : "Update AMT badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateGeneaIntegrationV2" : { + "/api/integrations/accessControl/updateAvigilonAltaIntegrationV2" : { "post" : { - "description" : "Update Genea badge integration V2", - "operationId" : "updateGeneaIntegrationV2", + "description" : "Update Avigilon Alta badge integration V2", + "operationId" : "updateAvigilonAltaIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18608,7 +20134,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateGeneaIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateAvigilonAltaV2WSRequest" } } } @@ -18625,14 +20151,14 @@ "description" : "OK" } }, - "summary" : "Update Genea badge integration V2", + "summary" : "Update Avigilon Alta badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateInnerRangeIntegration" : { + "/api/integrations/accessControl/updateBoulevardIntegration" : { "post" : { - "description" : "Update Inner Range integration", - "operationId" : "updateInnerRangeIntegration", + "description" : "Update Boulevard integration settings", + "operationId" : "updateBoulevardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18649,7 +20175,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateInnerRangeIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateBoulevardIntegrationWSRequest" } } } @@ -18666,15 +20192,14 @@ "description" : "OK" } }, - "summary" : "Update Inner Range integration", + "summary" : "Update Boulevard integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateKisiIntegration" : { + "/api/integrations/accessControl/updateBrivoIntegration" : { "post" : { - "deprecated" : true, - "description" : "Update Kisi badge integration", - "operationId" : "updateKisiIntegration", + "description" : "Update Brivo badge integration", + "operationId" : "updateBrivoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18691,7 +20216,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateKisiIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateBrivoIntegrationWSRequest" } } } @@ -18708,14 +20233,14 @@ "description" : "OK" } }, - "summary" : "Update Kisi badge integration", + "summary" : "Update Brivo badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateKisiIntegrationV2" : { + "/api/integrations/accessControl/updateBrivoIntegrationV2" : { "post" : { - "description" : "Update Kisi badge integration V2", - "operationId" : "updateKisiIntegrationV2", + "description" : "Update Brivo badge integration", + "operationId" : "updateBrivoIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18732,7 +20257,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateKisiIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateBrivoIntegrationV2WSRequest" } } } @@ -18749,14 +20274,14 @@ "description" : "OK" } }, - "summary" : "Update Kisi badge integration V2", + "summary" : "Update Brivo badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateOpenpathIntegration" : { + "/api/integrations/accessControl/updateButterflymxIntegration" : { "post" : { - "description" : "Update Openpath badge integration", - "operationId" : "updateOpenpathIntegration", + "description" : "Update ButterflyMX badge integration", + "operationId" : "updateButterflymxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18773,7 +20298,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOpenpathIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateButterflymxIntegrationWSRequest" } } } @@ -18790,14 +20315,14 @@ "description" : "OK" } }, - "summary" : "Update Openpath badge integration", + "summary" : "Update ButterflyMX badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateOpentechAllianceIntegration" : { + "/api/integrations/accessControl/updateButterflymxIntegrationV2" : { "post" : { - "description" : "Update Opentech Alliance integration", - "operationId" : "updateOpentechAllianceIntegration", + "description" : "Update ButterflyMX badge integration V2", + "operationId" : "updateButterflymxIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18814,7 +20339,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOpentechAllianceIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateButterflymxIntegrationV2WSRequest" } } } @@ -18831,14 +20356,14 @@ "description" : "OK" } }, - "summary" : "Update Opentech Alliance integration", + "summary" : "Update ButterflyMX badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updateOpentechAllianceIntegrationV2" : { + "/api/integrations/accessControl/updateGeneaIntegration" : { "post" : { - "description" : "Update Opentech Alliance integration", - "operationId" : "updateOpentechAllianceIntegrationV2", + "description" : "Update Genea badge integration", + "operationId" : "updateGeneaIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18855,7 +20380,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOpentechAllianceIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateGeneaIntegrationWSRequest" } } } @@ -18872,14 +20397,14 @@ "description" : "OK" } }, - "summary" : "Update Opentech Alliance integration V2", + "summary" : "Update Genea badge integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updatePdkIntegration" : { + "/api/integrations/accessControl/updateGeneaIntegrationV2" : { "post" : { - "description" : "Update ProDataKey badge integration", - "operationId" : "updatePdkIntegration", + "description" : "Update Genea badge integration V2", + "operationId" : "updateGeneaIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18896,7 +20421,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdatePdkIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateGeneaIntegrationV2WSRequest" } } } @@ -18913,14 +20438,14 @@ "description" : "OK" } }, - "summary" : "Update ProDataKey badge integration", + "summary" : "Update Genea badge integration V2", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updatePdkIntegrationV2" : { + "/api/integrations/accessControl/updateHoneywellElementsIntegration" : { "post" : { - "description" : "Update ProDataKey badge integration", - "operationId" : "updatePdkIntegrationV2", + "description" : "Update Honeywell Elements integration settings", + "operationId" : "updateHoneywellElementsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18937,7 +20462,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdatePdkIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateHoneywellElementsIntegrationWSRequest" } } } @@ -18954,14 +20479,14 @@ "description" : "OK" } }, - "summary" : "Update ProDataKey badge integration V2", + "summary" : "Update Honeywell Elements integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updatePlaceOsSettings" : { + "/api/integrations/accessControl/updateHoneywellNetBoxIntegration" : { "post" : { - "description" : "Update PlaceOs badge integration", - "operationId" : "updatePlaceOsSettings", + "description" : "Update Honeywell NetBox integration settings (behavior flags, door mapping)", + "operationId" : "updateHoneywellNetBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -18978,7 +20503,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdatePlaceOsSettingsWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateHoneywellNetBoxIntegrationWSRequest" } } } @@ -18995,14 +20520,14 @@ "description" : "OK" } }, - "summary" : "Update PlaceOs badge integration", + "summary" : "Update Honeywell NetBox integration", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/accessControl/updatePlaceOsSettingsV2" : { + "/api/integrations/accessControl/updateHoneywellOnGuardIntegration" : { "post" : { - "description" : "Update PlaceOs badge integration", - "operationId" : "updatePlaceOsSettingsV2", + "description" : "Update Honeywell OnGuard behavior flags (face recognition, clip saving, etc.) and enabled state. Door mapping is owned by OnGuard and ignored on this endpoint.", + "operationId" : "updateHoneywellOnGuardIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19019,7 +20544,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdatePlaceOsSettingsV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateHoneywellOnGuardIntegrationWSRequest" } } } @@ -19036,15 +20561,14 @@ "description" : "OK" } }, - "summary" : "Update PlaceOs badge integration V2", + "summary" : "Update Honeywell OnGuard behavior flags", "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/deleteAmtIntegration" : { + "/api/integrations/accessControl/updateInnerRangeIntegration" : { "post" : { - "deprecated" : true, - "description" : "Delete Amt badge integration", - "operationId" : "deleteAmtIntegrationDep", + "description" : "Update Inner Range integration", + "operationId" : "updateInnerRangeIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19061,7 +20585,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateInnerRangeIntegrationWSRequest" } } } @@ -19071,22 +20595,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete AMT Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Inner Range integration", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/deleteDeviceIntegration" : { + "/api/integrations/accessControl/updateKisiIntegration" : { "post" : { "deprecated" : true, - "description" : "Delete Device integration", - "operationId" : "deleteDeviceIntegrationDep", + "description" : "Update Kisi badge integration", + "operationId" : "updateKisiIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19103,7 +20627,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateKisiIntegrationWSRequest" } } } @@ -19113,22 +20637,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Device Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Kisi badge integration", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/deleteMattermostIntegration" : { + "/api/integrations/accessControl/updateKisiIntegrationV2" : { "post" : { - "deprecated" : true, - "description" : "Delete Mattermost alert integration", - "operationId" : "deleteMattermostIntegrationDep", + "description" : "Update Kisi badge integration V2", + "operationId" : "updateKisiIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19145,7 +20668,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateKisiIntegrationV2WSRequest" } } } @@ -19155,22 +20678,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Mattermost Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Kisi badge integration V2", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/deleteOpenAIIntegration" : { + "/api/integrations/accessControl/updateOpenpathIntegration" : { "post" : { - "deprecated" : true, - "description" : "Delete OpenAI integration", - "operationId" : "deleteOpenAIIntegrationDep", + "description" : "Update Openpath badge integration", + "operationId" : "updateOpenpathIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19187,7 +20709,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateOpenpathIntegrationWSRequest" } } } @@ -19197,22 +20719,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete OpenAI Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Openpath badge integration", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/deleteWebhookIntegration" : { + "/api/integrations/accessControl/updateOpentechAllianceIntegration" : { "post" : { - "deprecated" : true, - "description" : "Delete outbound webhook alert integration", - "operationId" : "deleteWebhookIntegrationDep", + "description" : "Update Opentech Alliance integration", + "operationId" : "updateOpentechAllianceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19229,7 +20750,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateOpentechAllianceIntegrationWSRequest" } } } @@ -19239,22 +20760,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Webhook Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Opentech Alliance integration", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/deleteWebhookIntegrationV2" : { + "/api/integrations/accessControl/updateOpentechAllianceIntegrationV2" : { "post" : { - "deprecated" : true, - "description" : "Delete entire webhook integration", - "operationId" : "deleteWebhookIntegrationV2Dep", + "description" : "Update Opentech Alliance integration", + "operationId" : "updateOpentechAllianceIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19271,7 +20791,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateOpentechAllianceIntegrationV2WSRequest" } } } @@ -19281,22 +20801,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Webhook Integration V2", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Opentech Alliance integration V2", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/getAmtReaders" : { + "/api/integrations/accessControl/updatePdkIntegration" : { "post" : { - "deprecated" : true, - "description" : "Get list of AMT readers to assign cameras", - "operationId" : "getAmtReadersDep", + "description" : "Update ProDataKey badge integration", + "operationId" : "updatePdkIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19313,7 +20832,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetAmtReadersWSRequest" + "$ref" : "#/components/schemas/Integration_UpdatePdkIntegrationWSRequest" } } } @@ -19323,22 +20842,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get AMT Readers", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update ProDataKey badge integration", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/getApiTokenApplications" : { + "/api/integrations/accessControl/updatePdkIntegrationV2" : { "post" : { - "deprecated" : true, - "description" : "Get details of all open api token requests for organization", - "operationId" : "getApiTokenApplicationsDep", + "description" : "Update ProDataKey badge integration", + "operationId" : "updatePdkIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19355,7 +20873,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSRequest" + "$ref" : "#/components/schemas/Integration_UpdatePdkIntegrationV2WSRequest" } } } @@ -19365,22 +20883,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get API Token Applications", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update ProDataKey badge integration V2", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/getApiTokens" : { + "/api/integrations/accessControl/updatePlaceOsSettings" : { "post" : { - "deprecated" : true, - "description" : "Get list of all api tokens for organization", - "operationId" : "getApiTokensDep", + "description" : "Update PlaceOs badge integration", + "operationId" : "updatePlaceOsSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19397,7 +20914,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokensWSRequest" + "$ref" : "#/components/schemas/Integration_UpdatePlaceOsSettingsWSRequest" } } } @@ -19407,22 +20924,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get API Tokens", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update PlaceOs badge integration", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/getCalendlyEventDetails" : { + "/api/integrations/accessControl/updatePlaceOsSettingsV2" : { "post" : { - "deprecated" : true, - "description" : "Get Calendly event details", - "operationId" : "getCalendlyEventDetailsDep", + "description" : "Update PlaceOs badge integration", + "operationId" : "updatePlaceOsSettingsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19439,7 +20955,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSRequest" + "$ref" : "#/components/schemas/Integration_UpdatePlaceOsSettingsV2WSRequest" } } } @@ -19449,22 +20965,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Calendly Event Details", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update PlaceOs badge integration V2", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/getDeviceIntegration" : { + "/api/integrations/accessControl/validateHoneywellElementsCredentials" : { "post" : { - "deprecated" : true, - "description" : "Get Device integration", - "operationId" : "getDeviceIntegrationDep", + "description" : "Validate Honeywell Elements API credentials", + "operationId" : "validateHoneywellElementsCredentials", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19481,7 +20996,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_ValidateHoneywellElementsCredentialsWSRequest" } } } @@ -19491,22 +21006,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Device Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Validate Honeywell Elements API credentials", + "tags" : [ "Access Control Integrations Webservice" ] } }, - "/api/integrations/getOpenAIIntegration" : { + "/api/integrations/deleteAmtIntegration" : { "post" : { "deprecated" : true, - "description" : "Get OpenAI integration", - "operationId" : "getOpenAIIntegrationDep", + "description" : "Delete Amt badge integration", + "operationId" : "deleteAmtIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19533,64 +21048,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Get OpenAI Integration", - "tags" : [ "Integrations Webservice" ] - } - }, - "/api/integrations/getOpenAIModels" : { - "post" : { - "deprecated" : true, - "description" : "Get list of OpenAI models", - "operationId" : "getOpenAIModelsDep", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get OpenAI Models", + "summary" : "Delete AMT Integration", "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/getOrgIntegrations" : { + "/api/integrations/deleteDeviceIntegration" : { "post" : { "deprecated" : true, - "description" : "Get details of all third-party integrations for organization", - "operationId" : "getOrgIntegrationsDep", + "description" : "Delete Device integration", + "operationId" : "deleteDeviceIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19607,7 +21080,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -19617,22 +21090,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Organization Integrations", + "summary" : "Delete Device Integration", "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/getOrgIntegrationsV2" : { + "/api/integrations/deleteMattermostIntegration" : { "post" : { "deprecated" : true, - "description" : "Get details of all V2 third-party integrations for an organization", - "operationId" : "getOrgIntegrationsV2Dep", + "description" : "Delete Mattermost alert integration", + "operationId" : "deleteMattermostIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19649,7 +21122,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -19659,22 +21132,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetAllOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Organization Integrations V2", + "summary" : "Delete Mattermost Integration", "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/getWebhookIntegration" : { + "/api/integrations/deleteOpenAIIntegration" : { "post" : { "deprecated" : true, - "description" : "Get webhook integration", - "operationId" : "getWebhookIntegrationDep", + "description" : "Delete OpenAI integration", + "operationId" : "deleteOpenAIIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19701,21 +21174,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Webhook Integration", + "summary" : "Delete OpenAI Integration", "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteDiceIntegration" : { + "/api/integrations/deleteWebhookIntegration" : { "post" : { - "description" : "Delete Dice integration", - "operationId" : "deleteDiceIntegration", + "deprecated" : true, + "description" : "Delete outbound webhook alert integration", + "operationId" : "deleteWebhookIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19749,14 +21223,15 @@ "description" : "OK" } }, - "summary" : "Delete Dice Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Delete Webhook Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteEmailIntegration" : { + "/api/integrations/deleteWebhookIntegrationV2" : { "post" : { - "description" : "Delete email alert integration", - "operationId" : "deleteEmailIntegration", + "deprecated" : true, + "description" : "Delete entire webhook integration", + "operationId" : "deleteWebhookIntegrationV2Dep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19790,14 +21265,15 @@ "description" : "OK" } }, - "summary" : "Delete Email Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Delete Webhook Integration V2", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteInformacastIntegration" : { + "/api/integrations/getAmtReaders" : { "post" : { - "description" : "Delete Informacast integration", - "operationId" : "deleteInformacastIntegration", + "deprecated" : true, + "description" : "Get list of AMT readers to assign cameras", + "operationId" : "getAmtReadersDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19814,7 +21290,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetAmtReadersWSRequest" } } } @@ -19824,21 +21300,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetBadgeIntegrationDoorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Informacast Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get AMT Readers", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteLumeoIntegration" : { + "/api/integrations/getApiTokenApplications" : { "post" : { - "description" : "Delete Lumeo integration", - "operationId" : "deleteLumeoIntegration", + "deprecated" : true, + "description" : "Get details of all open api token requests for organization", + "operationId" : "getApiTokenApplicationsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19855,7 +21332,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSRequest" } } } @@ -19865,21 +21342,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Lumeo Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get API Token Applications", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteMattermostIntegration" : { + "/api/integrations/getApiTokens" : { "post" : { - "description" : "Delete Mattermost alert integration", - "operationId" : "deleteMattermostIntegration", + "deprecated" : true, + "description" : "Get list of all api tokens for organization", + "operationId" : "getApiTokensDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19896,7 +21374,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetApiTokensWSRequest" } } } @@ -19906,21 +21384,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Mattermost Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get API Tokens", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteMicrosoftTeamsIntegrationV2" : { + "/api/integrations/getCalendlyEventDetails" : { "post" : { - "description" : "Delete Microsoft Teams alert integration", - "operationId" : "deleteMicrosoftTeamsIntegrationV2", + "deprecated" : true, + "description" : "Get Calendly event details", + "operationId" : "getCalendlyEventDetailsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19937,7 +21416,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSRequest" } } } @@ -19947,21 +21426,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Microsoft Teams Integration V2", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get Calendly Event Details", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteMicrosoftTeamsUser" : { + "/api/integrations/getDeviceIntegration" : { "post" : { - "description" : "Remove configurations for Microsoft Teams user", - "operationId" : "deleteMicrosoftTeamsUser", + "deprecated" : true, + "description" : "Get Device integration", + "operationId" : "getDeviceIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -19988,21 +21468,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Microsoft Teams User", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get Device Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteOpenAIIntegration" : { + "/api/integrations/getOpenAIIntegration" : { "post" : { - "description" : "Delete OpenAI integration", - "operationId" : "deleteOpenAIIntegration", + "deprecated" : true, + "description" : "Get OpenAI integration", + "operationId" : "getOpenAIIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20029,21 +21510,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete OpenAI Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get OpenAI Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deletePagerDutyIntegration" : { + "/api/integrations/getOpenAIModels" : { "post" : { - "description" : "Delete PagerDuty alert integration", - "operationId" : "deletePagerDutyIntegration", + "deprecated" : true, + "description" : "Get list of OpenAI models", + "operationId" : "getOpenAIModelsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20060,7 +21542,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSRequest" } } } @@ -20070,21 +21552,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete PagerDuty Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get OpenAI Models", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteServiceNowIntegration" : { + "/api/integrations/getOrgIntegrations" : { "post" : { - "description" : "Delete ServiceNow alert integration", - "operationId" : "deleteServiceNowIntegration", + "deprecated" : true, + "description" : "Get details of all third-party integrations for organization", + "operationId" : "getOrgIntegrationsDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20101,7 +21584,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } @@ -20111,21 +21594,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete ServiceNow Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get Organization Integrations", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/deleteSlackIntegrationV2" : { + "/api/integrations/getOrgIntegrationsV2" : { "post" : { - "description" : "Delete Slack alert integration v2", - "operationId" : "deleteSlackIntegrationV2", + "deprecated" : true, + "description" : "Get details of all V2 third-party integrations for an organization", + "operationId" : "getOrgIntegrationsV2Dep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20142,7 +21626,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } @@ -20152,21 +21636,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetAllOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Slack Integration V2", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get Organization Integrations V2", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getDiceIntegration" : { + "/api/integrations/getWebhookIntegration" : { "post" : { - "description" : "Get Dice integration", - "operationId" : "getDiceIntegration", + "deprecated" : true, + "description" : "Get webhook integration", + "operationId" : "getWebhookIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20200,14 +21685,14 @@ "description" : "OK" } }, - "summary" : "Get Dice Integration", - "tags" : [ "Incident Management Integrations Webservice" ] + "summary" : "Get Webhook Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getInformacastIntegration" : { + "/api/integrations/incidentManagement/deleteDiceIntegration" : { "post" : { - "description" : "Get Informacast integration", - "operationId" : "getInformacastIntegration", + "description" : "Delete Dice integration", + "operationId" : "deleteDiceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20234,21 +21719,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Informacast Integration", + "summary" : "Delete Dice Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getInformacastScenarios" : { + "/api/integrations/incidentManagement/deleteEmailIntegration" : { "post" : { - "description" : "Get Informacast scenarios", - "operationId" : "getInformacastScenarios", + "description" : "Delete email alert integration", + "operationId" : "deleteEmailIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20275,21 +21760,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetInformacastScenariosWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Informacast Scenarios", + "summary" : "Delete Email Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getLumeoIntegration" : { + "/api/integrations/incidentManagement/deleteInformacastIntegration" : { "post" : { - "description" : "Get Lumeo integration", - "operationId" : "getLumeoIntegration", + "description" : "Delete Informacast integration", + "operationId" : "deleteInformacastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20316,21 +21801,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Lumeo Integration", + "summary" : "Delete Informacast Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getMicrosoftTeamsIntegration" : { + "/api/integrations/incidentManagement/deleteLumeoIntegration" : { "post" : { - "description" : "Get Microsoft Teams alert integration", - "operationId" : "getMicrosoftTeamsIntegration", + "description" : "Delete Lumeo integration", + "operationId" : "deleteLumeoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20357,21 +21842,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Microsoft Teams Integration", + "summary" : "Delete Lumeo Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getMicrosoftUsersJoinedTeams" : { + "/api/integrations/incidentManagement/deleteMattermostIntegration" : { "post" : { - "description" : "Get a list of teams a Microsoft Teams user joined", - "operationId" : "getMicrosoftUsersJoinedTeams", + "description" : "Delete Mattermost alert integration", + "operationId" : "deleteMattermostIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20398,21 +21883,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetMicrosoftUsersJoinedTeamsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get Microsoft Users Joined Teams", + "summary" : "Delete Mattermost Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getOpenAIIntegration" : { + "/api/integrations/incidentManagement/deleteMicrosoftTeamsIntegrationV2" : { "post" : { - "description" : "Get OpenAI integration", - "operationId" : "getOpenAIIntegration", + "description" : "Delete Microsoft Teams alert integration", + "operationId" : "deleteMicrosoftTeamsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20439,21 +21924,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get OpenAI Integration", + "summary" : "Delete Microsoft Teams Integration V2", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/getOpenAIModels" : { + "/api/integrations/incidentManagement/deleteMicrosoftTeamsUser" : { "post" : { - "description" : "Get list of OpenAI models", - "operationId" : "getOpenAIModels", + "description" : "Remove configurations for Microsoft Teams user", + "operationId" : "deleteMicrosoftTeamsUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20470,7 +21955,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20480,21 +21965,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get OpenAI Models", + "summary" : "Delete Microsoft Teams User", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/installMicrosoftTeamsBotForTeam" : { + "/api/integrations/incidentManagement/deleteOpenAIIntegration" : { "post" : { - "description" : "Install notification bot for Microsoft Teams team", - "operationId" : "installMicrosoftTeamsBotForTeam", + "description" : "Delete OpenAI integration", + "operationId" : "deleteOpenAIIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20511,7 +21996,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20528,14 +22013,14 @@ "description" : "OK" } }, - "summary" : "Install Microsoft Teams Bot For Team", + "summary" : "Delete OpenAI Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/installMicrosoftTeamsBotForUser" : { + "/api/integrations/incidentManagement/deletePagerDutyIntegration" : { "post" : { - "description" : "Install notification bot for Microsoft Teams user", - "operationId" : "installMicrosoftTeamsBotForUser", + "description" : "Delete PagerDuty alert integration", + "operationId" : "deletePagerDutyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20569,14 +22054,14 @@ "description" : "OK" } }, - "summary" : "Install Microsoft Teams Bot For User", + "summary" : "Delete PagerDuty Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForTeam" : { + "/api/integrations/incidentManagement/deleteServiceNowIntegration" : { "post" : { - "description" : "Uninstall notification bot for Microsoft Teams team", - "operationId" : "uninstallMicrosoftTeamsBotForTeam", + "description" : "Delete ServiceNow alert integration", + "operationId" : "deleteServiceNowIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20593,7 +22078,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20610,14 +22095,14 @@ "description" : "OK" } }, - "summary" : "Uninstall Microsoft Teams Bot For Team", + "summary" : "Delete ServiceNow Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForUser" : { + "/api/integrations/incidentManagement/deleteSlackIntegrationV2" : { "post" : { - "description" : "Uninstall notification bot for Microsoft Teams user", - "operationId" : "uninstallMicrosoftTeamsBotForUser", + "description" : "Delete Slack alert integration v2", + "operationId" : "deleteSlackIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20651,14 +22136,14 @@ "description" : "OK" } }, - "summary" : "Uninstall Microsoft Teams Bot For User", + "summary" : "Delete Slack Integration V2", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateDiceIntegration" : { + "/api/integrations/incidentManagement/getDiceIntegration" : { "post" : { - "description" : "Update Dice integration", - "operationId" : "updateDiceIntegration", + "description" : "Get Dice integration", + "operationId" : "getDiceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20675,7 +22160,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateDiceIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20685,21 +22170,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Dice Integration", + "summary" : "Get Dice Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateEmailIntegration" : { + "/api/integrations/incidentManagement/getInformacastIntegration" : { "post" : { - "description" : "Update email alert integration", - "operationId" : "updateEmailIntegration", + "description" : "Get Informacast integration", + "operationId" : "getInformacastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20716,7 +22201,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateEmailIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20726,21 +22211,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Email Integration", + "summary" : "Get Informacast Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateInformacastIntegration" : { + "/api/integrations/incidentManagement/getInformacastScenarios" : { "post" : { - "description" : "Update Informacast rules engine integration", - "operationId" : "updateInformacastIntegration", + "description" : "Get Informacast scenarios", + "operationId" : "getInformacastScenarios", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20757,7 +22242,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateInformacastIntegrationRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20767,21 +22252,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetInformacastScenariosWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Informacast Integration", + "summary" : "Get Informacast Scenarios", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateLumeoIntegration" : { + "/api/integrations/incidentManagement/getInformacastSites" : { "post" : { - "description" : "Update Lumeo integration", - "operationId" : "updateLumeoIntegration", + "description" : "Get Informacast sites for mapping Rhombus locations", + "operationId" : "getInformacastSites", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20798,7 +22283,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateLumeoIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20808,21 +22293,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetInformacastSitesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Lumeo Integration", + "summary" : "Get Informacast Sites", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateMattermostIntegration" : { + "/api/integrations/incidentManagement/getLumeoIntegration" : { "post" : { - "description" : "Update Mattermost alert integration", - "operationId" : "updateMattermostIntegration", + "description" : "Get Lumeo integration", + "operationId" : "getLumeoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20839,7 +22324,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateMattermostIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20849,21 +22334,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Mattermost Integration", + "summary" : "Get Lumeo Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateMicrosoftTeamsIntegrationV2" : { + "/api/integrations/incidentManagement/getMicrosoftTeamsIntegration" : { "post" : { - "description" : "Update Microsoft Teams alert integration", - "operationId" : "updateMicrosoftTeamsIntegrationV2", + "description" : "Get Microsoft Teams alert integration", + "operationId" : "getMicrosoftTeamsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20880,7 +22365,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20890,21 +22375,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Microsoft Teams Integration V2", + "summary" : "Get Microsoft Teams Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateOpenAIIntegration" : { + "/api/integrations/incidentManagement/getMicrosoftUsersJoinedTeams" : { "post" : { - "description" : "Update OpenAI integration", - "operationId" : "updateOpenAIIntegration", + "description" : "Get a list of teams a Microsoft Teams user joined", + "operationId" : "getMicrosoftUsersJoinedTeams", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20921,7 +22406,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOpenAIIntegrationRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20931,21 +22416,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetMicrosoftUsersJoinedTeamsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update OpenAI Integration", + "summary" : "Get Microsoft Users Joined Teams", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updatePagerDutyIntegration" : { + "/api/integrations/incidentManagement/getOpenAIIntegration" : { "post" : { - "description" : "Update PagerDuty alert integration", - "operationId" : "updatePagerDutyIntegration", + "description" : "Get OpenAI integration", + "operationId" : "getOpenAIIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -20962,7 +22447,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdatePagerDutyIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -20972,21 +22457,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Update PagerDuty Integration", + "summary" : "Get OpenAI Integration", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateServiceNowIntegration" : { + "/api/integrations/incidentManagement/getOpenAIModels" : { "post" : { - "description" : "Update ServiceNow alert integration", - "operationId" : "updateServiceNowIntegration", + "description" : "Get list of OpenAI models", + "operationId" : "getOpenAIModels", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21003,7 +22488,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateServiceNowIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSRequest" } } } @@ -21013,21 +22498,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetOpenAIModelsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update ServiceNow Integration", + "summary" : "Get OpenAI Models", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateSlackIntegration" : { + "/api/integrations/incidentManagement/installMicrosoftTeamsBotForTeam" : { "post" : { - "description" : "Update Slack alert integration", - "operationId" : "updateSlackIntegration", + "description" : "Install notification bot for Microsoft Teams team", + "operationId" : "installMicrosoftTeamsBotForTeam", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21044,7 +22529,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateSlackIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" } } } @@ -21054,21 +22539,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Slack Integration", + "summary" : "Install Microsoft Teams Bot For Team", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/incidentManagement/updateSlackIntegrationV2" : { + "/api/integrations/incidentManagement/installMicrosoftTeamsBotForUser" : { "post" : { - "description" : "Update Slack alert integration v2", - "operationId" : "updateSlackIntegrationV2", + "description" : "Install notification bot for Microsoft Teams user", + "operationId" : "installMicrosoftTeamsBotForUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21085,7 +22570,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateSlackIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -21095,227 +22580,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Slack Integration V2", + "summary" : "Install Microsoft Teams Bot For User", "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/org/getApiTokens" : { - "post" : { - "description" : "Get list of all api tokens for organization", - "operationId" : "getApiTokens", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokensWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Get API tokens", - "tags" : [ "Org Integrations Webservice" ] - } - }, - "/api/integrations/org/getOrgIntegrations" : { - "post" : { - "description" : "Get details of all third-party integrations for organization", - "operationId" : "getOrgIntegrations", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Get organization integrations", - "tags" : [ "Org Integrations Webservice" ] - } - }, - "/api/integrations/org/getOrgIntegrationsV2" : { - "post" : { - "description" : "Get details of all V2 third-party integrations for an organization", - "operationId" : "getOrgIntegrationsV2", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_GetAllOrgIntegrationsV2WSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Get organization integrations V2", - "tags" : [ "Org Integrations Webservice" ] - } - }, - "/api/integrations/org/revokeApiToken" : { - "post" : { - "description" : "Remove an api token from organization. Note: this is irreversible", - "operationId" : "revokeApiToken", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Revoke API token", - "tags" : [ "Org Integrations Webservice" ] - } - }, - "/api/integrations/revokeApiToken" : { - "post" : { - "deprecated" : true, - "description" : "Remove an api token from organization. Note: this is irreversible", - "operationId" : "revokeApiTokenDep", - "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Revoke API Token", - "tags" : [ "Integrations Webservice" ] - } - }, - "/api/integrations/serviceManagement/createEnvoyInvite" : { + "/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForTeam" : { "post" : { - "description" : "Create an invite with Envoy", - "operationId" : "createEnvoyInvite", + "description" : "Uninstall notification bot for Microsoft Teams team", + "operationId" : "uninstallMicrosoftTeamsBotForTeam", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21332,7 +22611,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_CreateEnvoyInviteWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" } } } @@ -21349,15 +22628,14 @@ "description" : "OK" } }, - "summary" : "Create Envoy invite", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Uninstall Microsoft Teams Bot For Team", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/deleteEnvoyIntegration" : { + "/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForUser" : { "post" : { - "deprecated" : true, - "description" : "Delete Envoy badge integration", - "operationId" : "deleteEnvoyIntegration", + "description" : "Uninstall notification bot for Microsoft Teams user", + "operationId" : "uninstallMicrosoftTeamsBotForUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21391,14 +22669,14 @@ "description" : "OK" } }, - "summary" : "Delete Envoy integration", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Uninstall Microsoft Teams Bot For User", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/deleteEnvoyIntegrationV2" : { + "/api/integrations/incidentManagement/updateDiceIntegration" : { "post" : { - "description" : "Delete Envoy integration", - "operationId" : "deleteEnvoyIntegrationV2", + "description" : "Update Dice integration", + "operationId" : "updateDiceIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21415,7 +22693,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateDiceIntegrationWSRequest" } } } @@ -21425,22 +22703,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Envoy integration V2", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Dice Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/deleteToastIntegration" : { + "/api/integrations/incidentManagement/updateEmailIntegration" : { "post" : { - "deprecated" : true, - "description" : "Delete Toast integration", - "operationId" : "deleteToastIntegration", + "description" : "Update email alert integration", + "operationId" : "updateEmailIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21457,7 +22734,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateEmailIntegrationWSRequest" } } } @@ -21467,21 +22744,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Toast integration", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Email Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/deleteToastIntegrationV2" : { + "/api/integrations/incidentManagement/updateInformacastIntegration" : { "post" : { - "description" : "Delete Toast integration", - "operationId" : "deleteToastIntegrationV2", + "description" : "Update Informacast rules engine integration", + "operationId" : "updateInformacastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21498,7 +22775,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateInformacastIntegrationRequest" } } } @@ -21508,21 +22785,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Toast integration V2", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Informacast Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/getCalendlyEventDetails" : { + "/api/integrations/incidentManagement/updateLumeoIntegration" : { "post" : { - "description" : "Get Calendly event details", - "operationId" : "getCalendlyEventDetails", + "description" : "Update Lumeo integration", + "operationId" : "updateLumeoIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21539,7 +22816,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateLumeoIntegrationWSRequest" } } } @@ -21549,21 +22826,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Calendly event details", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Lumeo Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/getEnvoyIntegration" : { + "/api/integrations/incidentManagement/updateMattermostIntegration" : { "post" : { - "description" : "Get Envoy integration", - "operationId" : "getEnvoyIntegration", + "description" : "Update Mattermost alert integration", + "operationId" : "updateMattermostIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21580,7 +22857,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateMattermostIntegrationWSRequest" } } } @@ -21590,21 +22867,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Envoy integration", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Mattermost Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/getToastIntegration" : { + "/api/integrations/incidentManagement/updateMicrosoftTeamsIntegrationV2" : { "post" : { - "description" : "Get Toast integration", - "operationId" : "getToastIntegration", + "description" : "Update Microsoft Teams alert integration", + "operationId" : "updateMicrosoftTeamsIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21621,7 +22898,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateMicrosoftTeamsIntegrationV2WSRequest" } } } @@ -21631,21 +22908,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Toast integration", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Microsoft Teams Integration V2", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/getToastServiceAreas" : { + "/api/integrations/incidentManagement/updateOpenAIIntegration" : { "post" : { - "description" : "Get list of Toast service areas to assign cameras", - "operationId" : "getToastServiceAreas", + "description" : "Update OpenAI integration", + "operationId" : "updateOpenAIIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21662,7 +22939,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetToastServiceAreasWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateOpenAIIntegrationRequest" } } } @@ -21672,21 +22949,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetToastServiceAreasWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Toast service areas", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update OpenAI Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/initiateEnvoyOAuth" : { + "/api/integrations/incidentManagement/updatePagerDutyIntegration" : { "post" : { - "description" : "Initiate the Envoy OAuth Process", - "operationId" : "initiateEnvoyOAuth", + "description" : "Update PagerDuty alert integration", + "operationId" : "updatePagerDutyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21703,7 +22980,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" + "$ref" : "#/components/schemas/Integration_UpdatePagerDutyIntegrationWSRequest" } } } @@ -21713,22 +22990,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Initiate Envoy OAuth", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update PagerDuty Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/updateEnvoyIntegration" : { + "/api/integrations/incidentManagement/updateServiceNowIntegration" : { "post" : { - "deprecated" : true, - "description" : "Update Envoy badge integration", - "operationId" : "updateEnvoyIntegration", + "description" : "Update ServiceNow alert integration", + "operationId" : "updateServiceNowIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21745,7 +23021,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateEnvoyIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateServiceNowIntegrationWSRequest" } } } @@ -21762,14 +23038,14 @@ "description" : "OK" } }, - "summary" : "Update Envoy integration", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update ServiceNow Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/updateEnvoyIntegrationV2" : { + "/api/integrations/incidentManagement/updateSlackIntegration" : { "post" : { - "description" : "Update Envoy integration", - "operationId" : "updateEnvoyIntegrationV2", + "description" : "Update Slack alert integration", + "operationId" : "updateSlackIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21786,7 +23062,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateEnvoyIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateSlackIntegrationWSRequest" } } } @@ -21803,15 +23079,14 @@ "description" : "OK" } }, - "summary" : "Update Envoy integration V2", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Slack Integration", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/updateToastIntegration" : { + "/api/integrations/incidentManagement/updateSlackIntegrationV2" : { "post" : { - "deprecated" : true, - "description" : "Update Toast integration", - "operationId" : "updateToastIntegration", + "description" : "Update Slack alert integration v2", + "operationId" : "updateSlackIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21828,7 +23103,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateToastIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateSlackIntegrationV2WSRequest" } } } @@ -21845,14 +23120,14 @@ "description" : "OK" } }, - "summary" : "Update Toast integration", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Update Slack Integration V2", + "tags" : [ "Incident Management Integrations Webservice" ] } }, - "/api/integrations/serviceManagement/updateToastIntegrationV2" : { + "/api/integrations/org/getApiTokens" : { "post" : { - "description" : "Update Toast integration", - "operationId" : "updateToastIntegrationV2", + "description" : "Get list of all api tokens for organization", + "operationId" : "getApiTokens", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21869,7 +23144,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateToastIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_GetApiTokensWSRequest" } } } @@ -21879,21 +23154,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Toast integration V2", - "tags" : [ "Service Management Integrations Webservice" ] + "summary" : "Get API tokens", + "tags" : [ "Org Integrations Webservice" ] } }, - "/api/integrations/storage/deleteAwsIntegration" : { + "/api/integrations/org/getOrgIntegrations" : { "post" : { - "description" : "Delete AWS S3 clip storage integration", - "operationId" : "deleteAwsIntegration", + "description" : "Get details of all third-party integrations for organization", + "operationId" : "getOrgIntegrations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21910,7 +23185,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } @@ -21920,21 +23195,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete AWS integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Get organization integrations", + "tags" : [ "Org Integrations Webservice" ] } }, - "/api/integrations/storage/deleteBoxIntegration" : { + "/api/integrations/org/getOrgIntegrationsV2" : { "post" : { - "description" : "Delete Box clip storage integration", - "operationId" : "deleteBoxIntegration", + "description" : "Get details of all V2 third-party integrations for an organization", + "operationId" : "getOrgIntegrationsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21951,7 +23226,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsWSRequest" } } } @@ -21961,21 +23236,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_GetAllOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Box integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Get organization integrations V2", + "tags" : [ "Org Integrations Webservice" ] } }, - "/api/integrations/storage/deleteDropboxIntegration" : { + "/api/integrations/org/revokeApiToken" : { "post" : { - "description" : "Delete Dropbox clip storage integration", - "operationId" : "deleteDropboxIntegration", + "description" : "Remove an api token from organization. Note: this is irreversible", + "operationId" : "revokeApiToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -21992,7 +23267,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" } } } @@ -22002,22 +23277,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete Dropbox integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Revoke API token", + "tags" : [ "Org Integrations Webservice" ] } }, - "/api/integrations/storage/deleteGoogleIntegration" : { + "/api/integrations/revokeApiToken" : { "post" : { "deprecated" : true, - "description" : "Delete Google Drive clip storage integration", - "operationId" : "deleteGoogleIntegration", + "description" : "Remove an api token from organization. Note: this is irreversible", + "operationId" : "revokeApiTokenDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22034,7 +23309,48 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Revoke API Token", + "tags" : [ "Integrations Webservice" ] + } + }, + "/api/integrations/serviceManagement/createEnvoyInvite" : { + "post" : { + "description" : "Create an invite with Envoy", + "operationId" : "createEnvoyInvite", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_CreateEnvoyInviteWSRequest" } } } @@ -22051,14 +23367,15 @@ "description" : "OK" } }, - "summary" : "Delete Google integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Create Envoy invite", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/deleteGoogleIntegrationV2" : { + "/api/integrations/serviceManagement/deleteEnvoyIntegration" : { "post" : { - "description" : "Delete Google Drive clip storage integration", - "operationId" : "deleteGoogleIntegrationV2", + "deprecated" : true, + "description" : "Delete Envoy badge integration", + "operationId" : "deleteEnvoyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22092,14 +23409,14 @@ "description" : "OK" } }, - "summary" : "Delete Google integration V2", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Delete Envoy integration", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/deleteOffice365Integration" : { + "/api/integrations/serviceManagement/deleteEnvoyIntegrationV2" : { "post" : { - "description" : "Delete Office365 Sharepoint clip storage integration", - "operationId" : "deleteOffice365Integration", + "description" : "Delete Envoy integration", + "operationId" : "deleteEnvoyIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22133,14 +23450,138 @@ "description" : "OK" } }, - "summary" : "Delete Office365 integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Delete Envoy integration V2", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/getGoogleIntegration" : { + "/api/integrations/serviceManagement/deleteToastIntegration" : { "post" : { - "description" : "Get Google Drive clip storage integration", - "operationId" : "getGoogleIntegration", + "deprecated" : true, + "description" : "Delete Toast integration", + "operationId" : "deleteToastIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete Toast integration", + "tags" : [ "Service Management Integrations Webservice" ] + } + }, + "/api/integrations/serviceManagement/deleteToastIntegrationV2" : { + "post" : { + "description" : "Delete Toast integration", + "operationId" : "deleteToastIntegrationV2", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete Toast integration V2", + "tags" : [ "Service Management Integrations Webservice" ] + } + }, + "/api/integrations/serviceManagement/getCalendlyEventDetails" : { + "post" : { + "description" : "Get Calendly event details", + "operationId" : "getCalendlyEventDetails", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_GetCalendlyEventDetailsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get Calendly event details", + "tags" : [ "Service Management Integrations Webservice" ] + } + }, + "/api/integrations/serviceManagement/getEnvoyIntegration" : { + "post" : { + "description" : "Get Envoy integration", + "operationId" : "getEnvoyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22174,14 +23615,14 @@ "description" : "OK" } }, - "summary" : "Get Google integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Get Envoy integration", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/initiateDropboxOAuth" : { + "/api/integrations/serviceManagement/getToastIntegration" : { "post" : { - "description" : "Initiate the Dropbox OAuth Process", - "operationId" : "initiateDropboxOAuth", + "description" : "Get Toast integration", + "operationId" : "getToastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22198,7 +23639,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22208,21 +23649,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Initiate Dropbox OAuth", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Get Toast integration", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/initiateGoogleOAuth" : { + "/api/integrations/serviceManagement/getToastServiceAreas" : { "post" : { - "description" : "Initiate the Google OAuth Process", - "operationId" : "initiateGoogleOAuth", + "description" : "Get list of Toast service areas to assign cameras", + "operationId" : "getToastServiceAreas", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22239,7 +23680,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" + "$ref" : "#/components/schemas/Integration_GetToastServiceAreasWSRequest" } } } @@ -22249,21 +23690,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" + "$ref" : "#/components/schemas/Integration_GetToastServiceAreasWSResponse" } } }, "description" : "OK" } }, - "summary" : "Initiate Google OAuth", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Get Toast service areas", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/initiateOffice365OAuth" : { + "/api/integrations/serviceManagement/initiateEnvoyOAuth" : { "post" : { - "description" : "Initiate the Office365 OAuth Process", - "operationId" : "initiateOffice365OAuth", + "description" : "Initiate the Envoy OAuth Process", + "operationId" : "initiateEnvoyOAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22297,14 +23738,15 @@ "description" : "OK" } }, - "summary" : "Initiate Office365 OAuth", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Initiate Envoy OAuth", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/refreshGoogleAccessToken" : { + "/api/integrations/serviceManagement/updateEnvoyIntegration" : { "post" : { - "description" : "Refresh Google access token", - "operationId" : "refreshGoogleAccessToken", + "deprecated" : true, + "description" : "Update Envoy badge integration", + "operationId" : "updateEnvoyIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22321,7 +23763,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_RefreshGoogleAccessTokenWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateEnvoyIntegrationWSRequest" } } } @@ -22331,21 +23773,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_RefreshGoogleAccessTokenWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Refresh Google access token", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Update Envoy integration", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/revokeGoogleDriveAccess" : { + "/api/integrations/serviceManagement/updateEnvoyIntegrationV2" : { "post" : { - "description" : "Revokes access to a Google Drive account", - "operationId" : "revokeGoogleDriveAccess", + "description" : "Update Envoy integration", + "operationId" : "updateEnvoyIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22362,7 +23804,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeGoogleDriveAccessWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateEnvoyIntegrationV2WSRequest" } } } @@ -22372,21 +23814,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Revoke Google Drive access", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Update Envoy integration V2", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/updateAwsIntegration" : { + "/api/integrations/serviceManagement/updateToastIntegration" : { "post" : { - "description" : "Update AWS S3 clip storage integration", - "operationId" : "updateAwsIntegration", + "deprecated" : true, + "description" : "Update Toast integration", + "operationId" : "updateToastIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22403,7 +23846,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateAwsIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateToastIntegrationWSRequest" } } } @@ -22420,14 +23863,14 @@ "description" : "OK" } }, - "summary" : "Update AWS integration", - "tags" : [ "Storage Integrations Webservice" ] + "summary" : "Update Toast integration", + "tags" : [ "Service Management Integrations Webservice" ] } }, - "/api/integrations/storage/updateBoxIntegration" : { + "/api/integrations/serviceManagement/updateToastIntegrationV2" : { "post" : { - "description" : "Update Box clip storage integration", - "operationId" : "updateBoxIntegration", + "description" : "Update Toast integration", + "operationId" : "updateToastIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22444,7 +23887,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateBoxIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateToastIntegrationV2WSRequest" } } } @@ -22461,14 +23904,55 @@ "description" : "OK" } }, - "summary" : "Update Box integration", + "summary" : "Update Toast integration V2", + "tags" : [ "Service Management Integrations Webservice" ] + } + }, + "/api/integrations/storage/deleteAwsIntegration" : { + "post" : { + "description" : "Delete AWS S3 clip storage integration", + "operationId" : "deleteAwsIntegration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseApiResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete AWS integration", "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/storage/updateDropboxIntegration" : { + "/api/integrations/storage/deleteBoxIntegration" : { "post" : { - "description" : "Update Dropbox clip storage integration", - "operationId" : "updateDropboxIntegration", + "description" : "Delete Box clip storage integration", + "operationId" : "deleteBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22485,7 +23969,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateDropboxIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22495,22 +23979,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Dropbox integration", + "summary" : "Delete Box integration", "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/storage/updateGoogleIntegration" : { + "/api/integrations/storage/deleteDropboxIntegration" : { "post" : { - "deprecated" : true, - "description" : "Update Google Drive clip storage integration", - "operationId" : "updateGoogleIntegration", + "description" : "Delete Dropbox clip storage integration", + "operationId" : "deleteDropboxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22527,7 +24010,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateGoogleIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22537,21 +24020,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Google integration", + "summary" : "Delete Dropbox integration", "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/storage/updateGoogleIntegrationV2" : { + "/api/integrations/storage/deleteGoogleIntegration" : { "post" : { - "description" : "Update Google Drive clip storage integration", - "operationId" : "updateGoogleIntegrationV2", + "deprecated" : true, + "description" : "Delete Google Drive clip storage integration", + "operationId" : "deleteGoogleIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22568,7 +24052,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateGoogleIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22578,21 +24062,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Google integration V2", + "summary" : "Delete Google integration", "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/storage/updateOffice365Integration" : { + "/api/integrations/storage/deleteGoogleIntegrationV2" : { "post" : { - "description" : "Update Office365 Sharepoint clip storage integration", - "operationId" : "updateOffice365Integration", + "description" : "Delete Google Drive clip storage integration", + "operationId" : "deleteGoogleIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22609,7 +24093,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOffice365IntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22619,22 +24103,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Office365 integration", + "summary" : "Delete Google integration V2", "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/submitApiTokenApplication" : { + "/api/integrations/storage/deleteOffice365Integration" : { "post" : { - "deprecated" : true, - "description" : "Request an api token for organization", - "operationId" : "submitApiTokenApplicationDep", + "description" : "Delete Office365 Sharepoint clip storage integration", + "operationId" : "deleteOffice365Integration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22651,7 +24134,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_SubmitApiTokenApplicationWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22661,22 +24144,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_SubmitApiTokenApplicationWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Submit API Token Application", - "tags" : [ "Integrations Webservice" ] + "summary" : "Delete Office365 integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/subscribeZapierWebhook" : { + "/api/integrations/storage/getGoogleIntegration" : { "post" : { - "deprecated" : true, - "description" : "Setup a Zapier webhook", - "operationId" : "subscribeZapierWebhookDep", + "description" : "Get Google Drive clip storage integration", + "operationId" : "getGoogleIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22693,7 +24175,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -22703,22 +24185,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Subscribe Zapier Webhook", - "tags" : [ "Integrations Webservice" ] + "summary" : "Get Google integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/unsubscribeZapierWebhook" : { + "/api/integrations/storage/initiateDropboxOAuth" : { "post" : { - "deprecated" : true, - "description" : "Delete a Zapier webhook", - "operationId" : "unsubscribeZapierWebhookDep", + "description" : "Initiate the Dropbox OAuth Process", + "operationId" : "initiateDropboxOAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22735,7 +24216,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UnsubscribeZapierWebhookWSRequest" + "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } @@ -22745,22 +24226,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" } }, - "summary" : "Unsubscribe Zapier Webhook", - "tags" : [ "Integrations Webservice" ] + "summary" : "Initiate Dropbox OAuth", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateAmtIntegration" : { + "/api/integrations/storage/initiateGoogleOAuth" : { "post" : { - "deprecated" : true, - "description" : "Update Amt badge integration", - "operationId" : "updateAmtIntegrationDep", + "description" : "Initiate the Google OAuth Process", + "operationId" : "initiateGoogleOAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22777,7 +24257,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateAmtIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } @@ -22787,22 +24267,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update AMT Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Initiate Google OAuth", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateDeviceIntegration" : { + "/api/integrations/storage/initiateOffice365OAuth" : { "post" : { - "deprecated" : true, - "description" : "Update Device integration", - "operationId" : "updateDeviceIntegrationDep", + "description" : "Initiate the Office365 OAuth Process", + "operationId" : "initiateOffice365OAuth", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22819,7 +24298,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateDeviceIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_InitiateOAuthWSRequest" } } } @@ -22829,22 +24308,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_InitiateOAuthWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Device Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Initiate Office365 OAuth", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateMattermostIntegration" : { + "/api/integrations/storage/refreshGoogleAccessToken" : { "post" : { - "deprecated" : true, - "description" : "Update Mattermost alert integration", - "operationId" : "updateMattermostIntegrationDep", + "description" : "Refresh Google access token", + "operationId" : "refreshGoogleAccessToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22861,7 +24339,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateMattermostIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_RefreshGoogleAccessTokenWSRequest" } } } @@ -22871,22 +24349,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Integration_RefreshGoogleAccessTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Mattermost Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Refresh Google access token", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateNoonlightSettings" : { + "/api/integrations/storage/revokeGoogleDriveAccess" : { "post" : { - "deprecated" : true, - "description" : "Update Noonlight integration", - "operationId" : "updateNoonlightSettings", + "description" : "Revokes access to a Google Drive account", + "operationId" : "revokeGoogleDriveAccess", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22903,7 +24380,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateNoonlightSettingsWSRequest" + "$ref" : "#/components/schemas/Integration_RevokeGoogleDriveAccessWSRequest" } } } @@ -22913,22 +24390,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update Noonlight Settings", - "tags" : [ "Integrations Webservice" ] + "summary" : "Revoke Google Drive access", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateOpenAIIntegration" : { + "/api/integrations/storage/updateAwsIntegration" : { "post" : { - "deprecated" : true, - "description" : "Update OpenAI integration", - "operationId" : "updateOpenAIIntegrationDep", + "description" : "Update AWS S3 clip storage integration", + "operationId" : "updateAwsIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22945,7 +24421,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateOpenAIIntegrationRequest" + "$ref" : "#/components/schemas/Integration_UpdateAwsIntegrationWSRequest" } } } @@ -22962,15 +24438,14 @@ "description" : "OK" } }, - "summary" : "Update OpenAI Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update AWS integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateWebhookIntegration" : { + "/api/integrations/storage/updateBoxIntegration" : { "post" : { - "deprecated" : true, - "description" : "Update outbound webhook alert integration", - "operationId" : "updateWebhookIntegrationDep", + "description" : "Update Box clip storage integration", + "operationId" : "updateBoxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -22987,7 +24462,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateBoxIntegrationWSRequest" } } } @@ -23004,15 +24479,14 @@ "description" : "OK" } }, - "summary" : "Update Webhook Integration", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Box integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/updateWebhookIntegrationV2" : { + "/api/integrations/storage/updateDropboxIntegration" : { "post" : { - "deprecated" : true, - "description" : "Update preexisting webhooks", - "operationId" : "updateWebhookIntegrationV2Dep", + "description" : "Update Dropbox clip storage integration", + "operationId" : "updateDropboxIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23029,7 +24503,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateDropboxIntegrationWSRequest" } } } @@ -23039,21 +24513,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Webhook Integration V2", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Dropbox integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/validateToken" : { + "/api/integrations/storage/updateGoogleIntegration" : { "post" : { - "description" : "Verifies an API token is still active", - "operationId" : "validateTokenDep", + "deprecated" : true, + "description" : "Update Google Drive clip storage integration", + "operationId" : "updateGoogleIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23066,26 +24541,35 @@ "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Integration_UpdateGoogleIntegrationWSRequest" + } + } + } + }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Validate API Token", - "tags" : [ "Integrations Webservice" ] + "summary" : "Update Google integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/webhooks/deleteWebhookIntegration" : { + "/api/integrations/storage/updateGoogleIntegrationV2" : { "post" : { - "description" : "Delete outbound webhook alert integration", - "operationId" : "deleteWebhookIntegration", + "description" : "Update Google Drive clip storage integration", + "operationId" : "updateGoogleIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23102,7 +24586,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateGoogleIntegrationV2WSRequest" } } } @@ -23112,21 +24596,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete webhook integration", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Update Google integration V2", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/webhooks/deleteWebhookIntegrationV2" : { + "/api/integrations/storage/updateOffice365Integration" : { "post" : { - "description" : "Delete entire webhook integration", - "operationId" : "deleteWebhookIntegrationV2", + "description" : "Update Office365 Sharepoint clip storage integration", + "operationId" : "updateOffice365Integration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23143,7 +24627,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateOffice365IntegrationWSRequest" } } } @@ -23153,21 +24637,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete webhook integration V2", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Update Office365 integration", + "tags" : [ "Storage Integrations Webservice" ] } }, - "/api/integrations/webhooks/getWebhookIntegration" : { + "/api/integrations/submitApiTokenApplication" : { "post" : { - "description" : "Get webhook integration", - "operationId" : "getWebhookIntegration", + "deprecated" : true, + "description" : "Request an api token for organization", + "operationId" : "submitApiTokenApplicationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23184,7 +24669,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_SubmitApiTokenApplicationWSRequest" } } } @@ -23194,21 +24679,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" + "$ref" : "#/components/schemas/Integration_SubmitApiTokenApplicationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get webhook integration", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Submit API Token Application", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/webhooks/subscribeZapierWebhook" : { + "/api/integrations/subscribeZapierWebhook" : { "post" : { + "deprecated" : true, "description" : "Setup a Zapier webhook", - "operationId" : "subscribeZapierWebhook", + "operationId" : "subscribeZapierWebhookDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23242,14 +24728,15 @@ "description" : "OK" } }, - "summary" : "Subscribe Zapier webhook", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Subscribe Zapier Webhook", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/webhooks/unsubscribeZapierWebhook" : { + "/api/integrations/unsubscribeZapierWebhook" : { "post" : { + "deprecated" : true, "description" : "Delete a Zapier webhook", - "operationId" : "unsubscribeZapierWebhook", + "operationId" : "unsubscribeZapierWebhookDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23283,14 +24770,15 @@ "description" : "OK" } }, - "summary" : "Unsubscribe Zapier webhook", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Unsubscribe Zapier Webhook", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/webhooks/updateWebhookIntegration" : { + "/api/integrations/updateAmtIntegration" : { "post" : { - "description" : "Update outbound webhook alert integration", - "operationId" : "updateWebhookIntegration", + "deprecated" : true, + "description" : "Update Amt badge integration", + "operationId" : "updateAmtIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23307,7 +24795,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateAmtIntegrationWSRequest" } } } @@ -23324,14 +24812,15 @@ "description" : "OK" } }, - "summary" : "Update webhook integration", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Update AMT Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/integrations/webhooks/updateWebhookIntegrationV2" : { + "/api/integrations/updateDeviceIntegration" : { "post" : { - "description" : "Update preexisting webhooks", - "operationId" : "updateWebhookIntegrationV2", + "deprecated" : true, + "description" : "Update Device integration", + "operationId" : "updateDeviceIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23348,7 +24837,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSRequest" + "$ref" : "#/components/schemas/Integration_UpdateDeviceIntegrationWSRequest" } } } @@ -23358,21 +24847,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update webhook integration V2", - "tags" : [ "Webhook Integrations Webservice" ] + "summary" : "Update Device Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/internal/sendShipmentShippedEmail" : { + "/api/integrations/updateMattermostIntegration" : { "post" : { - "description" : "Send shipment shipped email notification", - "operationId" : "sendShipmentShippedEmail", + "deprecated" : true, + "description" : "Update Mattermost alert integration", + "operationId" : "updateMattermostIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23389,7 +24879,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Internal_SendShipmentShippedEmailWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateMattermostIntegrationWSRequest" } } } @@ -23399,21 +24889,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Internal_ShipmentEmailWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Send shipment shipped email", - "tags" : [ "Internal Webservice" ] + "summary" : "Update Mattermost Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/keypad/claimKeypadActivationToken" : { + "/api/integrations/updateNoonlightSettings" : { "post" : { - "description" : "Connects a keypad to Rhombus services", - "operationId" : "claimKeypadActivationToken", + "deprecated" : true, + "description" : "Update Noonlight integration", + "operationId" : "updateNoonlightSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23430,7 +24921,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_ClaimKeypadActivationTokenRequest" + "$ref" : "#/components/schemas/Integration_UpdateNoonlightSettingsWSRequest" } } } @@ -23440,21 +24931,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_ClaimKeypadActivationTokenResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Claim keypad activation token", - "tags" : [ "Alarm Monitoring Keypad Webservice" ] + "summary" : "Update Noonlight Settings", + "tags" : [ "Integrations Webservice" ] } }, - "/api/keypad/getKeypadsForLocation" : { + "/api/integrations/updateOpenAIIntegration" : { "post" : { - "description" : "Get a list of all registered keypads for a location", - "operationId" : "getKeypadsForLocation", + "deprecated" : true, + "description" : "Update OpenAI integration", + "operationId" : "updateOpenAIIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23471,7 +24963,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_GetKeypadsForLocationWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateOpenAIIntegrationRequest" } } } @@ -23481,21 +24973,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_GetKeypadsForLocationWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get keypads for location", - "tags" : [ "Alarm Monitoring Keypad Webservice" ] + "summary" : "Update OpenAI Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/keypad/getKeypadsForOrg" : { + "/api/integrations/updateWebhookIntegration" : { "post" : { - "description" : "Get a list of all registered keypads for an org", - "operationId" : "getKeypadsForOrg", + "deprecated" : true, + "description" : "Update outbound webhook alert integration", + "operationId" : "updateWebhookIntegrationDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23512,7 +25005,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_GetKeypadsForOrgWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationWSRequest" } } } @@ -23522,21 +25015,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_GetKeypadsForOrgWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get keypads for organization", - "tags" : [ "Alarm Monitoring Keypad Webservice" ] + "summary" : "Update Webhook Integration", + "tags" : [ "Integrations Webservice" ] } }, - "/api/keypad/unregisterKeypad" : { + "/api/integrations/updateWebhookIntegrationV2" : { "post" : { - "description" : "Unregister a keypad", - "operationId" : "unregisterKeypad", + "deprecated" : true, + "description" : "Update preexisting webhooks", + "operationId" : "updateWebhookIntegrationV2Dep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23553,7 +25047,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_UnregisterKeypadRequest" + "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSRequest" } } } @@ -23563,21 +25057,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_UnregisterKeypadResponse" + "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Unregister keypad", - "tags" : [ "Alarm Monitoring Keypad Webservice" ] + "summary" : "Update Webhook Integration V2", + "tags" : [ "Integrations Webservice" ] } }, - "/api/keypad/updateKeypad" : { + "/api/integrations/validateToken" : { "post" : { - "description" : "Update keypad settings", - "operationId" : "updateKeypad", + "description" : "Verifies an API token is still active", + "operationId" : "validateTokenDep", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23590,35 +25084,26 @@ "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Keypad_UpdateKeypadRequest" - } - } - } - }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Keypad_UpdateKeypadResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update keypad", - "tags" : [ "Alarm Monitoring Keypad Webservice" ] + "summary" : "Validate API Token", + "tags" : [ "Integrations Webservice" ] } }, - "/api/kiosk/updateKiosk" : { + "/api/integrations/webhooks/deleteWebhookIntegration" : { "post" : { - "description" : "Update kiosk settings", - "operationId" : "updateKiosk", + "description" : "Delete outbound webhook alert integration", + "operationId" : "deleteWebhookIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23635,7 +25120,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Kiosk_UpdateKioskSelectiveRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -23645,21 +25130,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Kiosk_UpdateKioskResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Update kiosk", - "tags" : [ "Guest Management Kiosk Webservice" ] + "summary" : "Delete webhook integration", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/assignACUDoorLicense" : { + "/api/integrations/webhooks/deleteWebhookIntegrationV2" : { "post" : { - "description" : "Assign ACU door license", - "operationId" : "assignACUDoorLicense", + "description" : "Delete entire webhook integration", + "operationId" : "deleteWebhookIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23676,7 +25161,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignACUDoorLicenseWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -23686,21 +25171,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignACUDoorLicenseWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Assign ACU door license", - "tags" : [ "License Webservice" ] + "summary" : "Delete webhook integration V2", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/assignAlertMonitoringLicense" : { + "/api/integrations/webhooks/getWebhookIntegration" : { "post" : { - "description" : "Assign alert monitoring license", - "operationId" : "assignAlertMonitoringLicense", + "description" : "Get webhook integration", + "operationId" : "getWebhookIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23717,7 +25202,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignAlertMonitoringLicenseWSRequest" + "$ref" : "#/components/schemas/Integration_BaseIntegrationWSRequest" } } } @@ -23727,21 +25212,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignAlertMonitoringLicenseWSResponse" + "$ref" : "#/components/schemas/Integration_GetOrgIntegrationsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Assign alert monitoring license", - "tags" : [ "License Webservice" ] + "summary" : "Get webhook integration", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/assignDeviceLicense" : { + "/api/integrations/webhooks/subscribeZapierWebhook" : { "post" : { - "description" : "Assign or unassign a device license.", - "operationId" : "assignDeviceLicense", + "description" : "Setup a Zapier webhook", + "operationId" : "subscribeZapierWebhook", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23758,7 +25243,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignDeviceLicenseWSRequest" + "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSRequest" } } } @@ -23768,21 +25253,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignDeviceLicenseWSResponse" + "$ref" : "#/components/schemas/Integration_SubscribeZapierWebhookWSResponse" } } }, "description" : "OK" } }, - "summary" : "Assign device license", - "tags" : [ "License Webservice" ] + "summary" : "Subscribe Zapier webhook", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/assignLicense" : { + "/api/integrations/webhooks/unsubscribeZapierWebhook" : { "post" : { - "description" : "Assign an add-on license to a device", - "operationId" : "assignLicense", + "description" : "Delete a Zapier webhook", + "operationId" : "unsubscribeZapierWebhook", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23799,7 +25284,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignLicenseWSRequest" + "$ref" : "#/components/schemas/Integration_UnsubscribeZapierWebhookWSRequest" } } } @@ -23809,21 +25294,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_AssignLicenseWSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Assign license", - "tags" : [ "License Webservice" ] + "summary" : "Unsubscribe Zapier webhook", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/getACUDoorLicenses" : { + "/api/integrations/webhooks/updateWebhookIntegration" : { "post" : { - "description" : "Get list of access controlled door licenses licenses available in organization", - "operationId" : "getACUDoorLicenses", + "description" : "Update outbound webhook alert integration", + "operationId" : "updateWebhookIntegration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23840,7 +25325,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetACUDoorLicensesWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationWSRequest" } } } @@ -23850,30 +25335,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetACUDoorLicensesWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get ACU door licenses", - "tags" : [ "License Webservice" ] + "summary" : "Update webhook integration", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/getACUDoorLicensesForClientOrg" : { + "/api/integrations/webhooks/updateWebhookIntegrationV2" : { "post" : { - "description" : "Get list of access controlled door licenses licenses available for a client organization", - "operationId" : "getACUDoorLicensesForClientOrg", + "description" : "Update preexisting webhooks", + "operationId" : "updateWebhookIntegrationV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -23881,7 +25366,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetACUDoorLicensesForClientOrgWSRequest" + "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSRequest" } } } @@ -23891,21 +25376,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetACUDoorLicensesForClientOrgWSResponse" + "$ref" : "#/components/schemas/Integration_UpdateWebhookIntegrationV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get ACU door licenses for client org", - "tags" : [ "License Webservice" ] + "summary" : "Update webhook integration V2", + "tags" : [ "Webhook Integrations Webservice" ] } }, - "/api/license/getAlertMonitoringLicenses" : { + "/api/internal/sendShipmentShippedEmail" : { "post" : { - "description" : "Get list of alert monitoring licenses available in organization", - "operationId" : "getAlertMonitoringLicenses", + "description" : "Send shipment shipped email notification", + "operationId" : "sendShipmentShippedEmail", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -23922,7 +25407,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesWSRequest" + "$ref" : "#/components/schemas/Internal_SendShipmentShippedEmailWSRequest" } } } @@ -23932,30 +25417,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesWSResponse" + "$ref" : "#/components/schemas/Internal_ShipmentEmailWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get alert monitoring licenses", - "tags" : [ "License Webservice" ] + "summary" : "Send shipment shipped email", + "tags" : [ "Internal Webservice" ] } }, - "/api/license/getAlertMonitoringLicensesForClientOrg" : { + "/api/keypad/claimKeypadActivationToken" : { "post" : { - "description" : "Get list of alert monitoring licenses available for a client organization", - "operationId" : "getAlertMonitoringLicensesForClientOrg", + "description" : "Connects a keypad to Rhombus services", + "operationId" : "claimKeypadActivationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -23963,7 +25448,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesForClientOrgWSRequest" + "$ref" : "#/components/schemas/Keypad_ClaimKeypadActivationTokenRequest" } } } @@ -23973,21 +25458,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesForClientOrgWSResponse" + "$ref" : "#/components/schemas/Keypad_ClaimKeypadActivationTokenResponse" } } }, "description" : "OK" } }, - "summary" : "Get alert monitoring licenses for client org", - "tags" : [ "License Webservice" ] + "summary" : "Claim keypad activation token", + "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, - "/api/license/getDeviceLicenses" : { + "/api/keypad/getKeypadsForLocation" : { "post" : { - "description" : "Get list of device licenses available in organization", - "operationId" : "getDeviceLicenses", + "description" : "Get a list of all registered keypads for a location", + "operationId" : "getKeypadsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24004,7 +25489,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetDeviceLicensesWSRequest" + "$ref" : "#/components/schemas/Keypad_GetKeypadsForLocationWSRequest" } } } @@ -24014,30 +25499,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetDeviceLicensesWSResponse" + "$ref" : "#/components/schemas/Keypad_GetKeypadsForLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get device licenses", - "tags" : [ "License Webservice" ] + "summary" : "Get keypads for location", + "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, - "/api/license/getDeviceLicensesForClientOrg" : { + "/api/keypad/getKeypadsForOrg" : { "post" : { - "description" : "Get list of device licenses available for a client organization", - "operationId" : "getDeviceLicensesForClientOrg", + "description" : "Get a list of all registered keypads for an org", + "operationId" : "getKeypadsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24045,7 +25530,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest" + "$ref" : "#/components/schemas/Keypad_GetKeypadsForOrgWSRequest" } } } @@ -24055,21 +25540,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse" + "$ref" : "#/components/schemas/Keypad_GetKeypadsForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get device licenses for client org", - "tags" : [ "License Webservice" ] + "summary" : "Get keypads for organization", + "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, - "/api/license/getLicenses" : { + "/api/keypad/unregisterKeypad" : { "post" : { - "description" : "Get list of add-on licenses available in organization", - "operationId" : "getLicenses", + "description" : "Unregister a keypad", + "operationId" : "unregisterKeypad", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24086,7 +25571,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetLicensesWSRequest" + "$ref" : "#/components/schemas/Keypad_UnregisterKeypadRequest" } } } @@ -24096,30 +25581,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetLicensesWSResponse" + "$ref" : "#/components/schemas/Keypad_UnregisterKeypadResponse" } } }, "description" : "OK" } }, - "summary" : "Get licenses", - "tags" : [ "License Webservice" ] + "summary" : "Unregister keypad", + "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, - "/api/license/getLicensesForClientOrg" : { + "/api/keypad/updateKeypad" : { "post" : { - "description" : "Get a list of licenses available for a client organization", - "operationId" : "getLicensesForClientOrg", + "description" : "Update keypad settings", + "operationId" : "updateKeypad", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24127,7 +25612,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSRequest" + "$ref" : "#/components/schemas/Keypad_UpdateKeypadRequest" } } } @@ -24137,21 +25622,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSResponse" + "$ref" : "#/components/schemas/Keypad_UpdateKeypadResponse" } } }, "description" : "OK" } }, - "summary" : "Get licenses for client org", - "tags" : [ "License Webservice" ] + "summary" : "Update keypad", + "tags" : [ "Alarm Monitoring Keypad Webservice" ] } }, - "/api/location/addLocationLabel" : { + "/api/kiosk/updateKiosk" : { "post" : { - "description" : "Add a label to a location", - "operationId" : "addLocationLabel", + "description" : "Update kiosk settings", + "operationId" : "updateKiosk", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24168,7 +25653,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_AddLocationLabelWSRequest" + "$ref" : "#/components/schemas/Kiosk_UpdateKioskSelectiveRequest" } } } @@ -24178,21 +25663,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_AddLocationLabelWSResponse" + "$ref" : "#/components/schemas/Kiosk_UpdateKioskResponse" } } }, "description" : "OK" } }, - "summary" : "Add location label", - "tags" : [ "Location Webservice" ] + "summary" : "Update kiosk", + "tags" : [ "Guest Management Kiosk Webservice" ] } }, - "/api/location/createLocation" : { + "/api/license/assignACUDoorLicense" : { "post" : { - "description" : "Create a location", - "operationId" : "createlocation", + "description" : "Assign ACU door license", + "operationId" : "assignACUDoorLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24209,7 +25694,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_CreateLocationWSRequest" + "$ref" : "#/components/schemas/License_AssignACUDoorLicenseWSRequest" } } } @@ -24219,21 +25704,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_CreateLocationWSResponse" + "$ref" : "#/components/schemas/License_AssignACUDoorLicenseWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create location", - "tags" : [ "Location Webservice" ] + "summary" : "Assign ACU door license", + "tags" : [ "License Webservice" ] } }, - "/api/location/deleteLocation" : { + "/api/license/assignAlertMonitoringLicense" : { "post" : { - "description" : "Remove a location", - "operationId" : "deleteLocation", + "description" : "Assign alert monitoring license", + "operationId" : "assignAlertMonitoringLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24250,7 +25735,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_DeleteLocationWSRequest" + "$ref" : "#/components/schemas/License_AssignAlertMonitoringLicenseWSRequest" } } } @@ -24260,21 +25745,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_DeleteLocationWSResponse" + "$ref" : "#/components/schemas/License_AssignAlertMonitoringLicenseWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete location", - "tags" : [ "Location Webservice" ] + "summary" : "Assign alert monitoring license", + "tags" : [ "License Webservice" ] } }, - "/api/location/geoCode" : { + "/api/license/assignDeviceLicense" : { "post" : { - "description" : "Get the latitude and longitude of an address", - "operationId" : "geoCode", + "description" : "Assign or unassign a device license.", + "operationId" : "assignDeviceLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24291,7 +25776,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GeoCodeWSRequest" + "$ref" : "#/components/schemas/License_AssignDeviceLicenseWSRequest" } } } @@ -24301,21 +25786,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GeoCodeWSResponse" + "$ref" : "#/components/schemas/License_AssignDeviceLicenseWSResponse" } } }, "description" : "OK" } }, - "summary" : "Geocode address", - "tags" : [ "Location Webservice" ] + "summary" : "Assign device license", + "tags" : [ "License Webservice" ] } }, - "/api/location/getLocation" : { + "/api/license/assignGuestManagementLicense" : { "post" : { - "description" : "Get location by id", - "operationId" : "getLocation", + "description" : "Assign guest management license", + "operationId" : "assignGuestManagementLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24332,7 +25817,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationWSRequest" + "$ref" : "#/components/schemas/License_AssignGuestManagementLicenseWSRequest" } } } @@ -24342,21 +25827,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationWSResponse" + "$ref" : "#/components/schemas/License_AssignGuestManagementLicenseWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get location", - "tags" : [ "Location Webservice" ] + "summary" : "Assign guest management license", + "tags" : [ "License Webservice" ] } }, - "/api/location/getLocationLabelsForOrg" : { + "/api/license/assignLicense" : { "post" : { - "description" : "Get all location labels for an organization", - "operationId" : "getLocationLabelsForOrg", + "description" : "Assign an add-on license to a device", + "operationId" : "assignLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24373,7 +25858,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSRequest" + "$ref" : "#/components/schemas/License_AssignLicenseWSRequest" } } } @@ -24383,21 +25868,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSResponse" + "$ref" : "#/components/schemas/License_AssignLicenseWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get location labels for org", - "tags" : [ "Location Webservice" ] + "summary" : "Assign license", + "tags" : [ "License Webservice" ] } }, - "/api/location/getLocations" : { + "/api/license/assignPaneLicense" : { "post" : { - "description" : "Get list of locations in organization", - "operationId" : "getLocations", + "description" : "Assign a PANE app license to a pane, or unassign it by omitting paneId", + "operationId" : "assignPaneLicense", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24414,7 +25899,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationsWSRequest" + "$ref" : "#/components/schemas/License_AssignPaneLicenseWSRequest" } } } @@ -24424,30 +25909,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationsWSResponse" + "$ref" : "#/components/schemas/License_AssignPaneLicenseWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get locations", - "tags" : [ "Location Webservice" ] + "summary" : "Assign pane license", + "tags" : [ "License Webservice" ] } }, - "/api/location/getLocationsAssociatedToLocationLabelsByOrg" : { + "/api/license/claimkey/findClaimKeysByClientOrg" : { "post" : { - "description" : "Get all locations associated to location labels for an organization", - "operationId" : "getLocationsAssociatedToLocationLabelsByOrg", + "description" : "Find the claim keys claimed by the specified client organization, optionally filtered by state. The caller must be a partner with license administration access to the client organization. Each claim key carries the term of one purchase: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only claim keys of `type` `NEW` carry a `startDate` - a `RENEWAL` key extends the terms it renews and carries only an `endDate`. When filtering by state, note that a key past its `endDate` but inside its grace period has state `EXPIRED`, and a renewed key moves to `RENEWED` while its successor `RENEWAL` key carries the extended term - filtering to `CLAIMED` alone hides such coverage. To assess coverage, prefer `excludeUnclaimed: true` and compare `endDate`/`gracePeriodEndDate` per key. Client organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.", + "operationId" : "findClaimKeysByClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24455,7 +25940,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSRequest" + "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByClientOrgWSRequest" } } } @@ -24465,21 +25950,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSResponse" + "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get locations by labels", - "tags" : [ "Location Webservice" ] + "summary" : "Find claim keys by client org", + "tags" : [ "ClaimKey Webservice" ] } }, - "/api/location/getLocationsByGeo" : { + "/api/license/claimkey/findClaimKeysByOrg" : { "post" : { - "description" : "Get list of locations given latitude and longitude", - "operationId" : "getLocationsByGeo", + "description" : "Find the claim keys belonging to the authenticated organization, optionally filtered by state. Each claim key carries the term of one purchase, so this is how license term start/end dates are read programmatically. See `getClaimKey` for how to read the term fields. When filtering by state, note that a key past its `endDate` but inside its grace period has state `EXPIRED`, and a renewed key moves to `RENEWED` while its successor `RENEWAL` key carries the extended term - filtering to `CLAIMED` alone hides such coverage. To assess coverage, prefer `excludeUnclaimed: true` and compare `endDate`/`gracePeriodEndDate` per key. Organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.", + "operationId" : "findClaimKeysByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24496,7 +25981,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationsByGeoRequest" + "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByOrgWSRequest" } } } @@ -24506,21 +25991,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationsByGeoResponse" + "$ref" : "#/components/schemas/License_claimkey_FindClaimKeysByOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get locations by geo", - "tags" : [ "Location Webservice" ] + "summary" : "Find claim keys by org", + "tags" : [ "ClaimKey Webservice" ] } }, - "/api/location/getLocationsBySubLocationsHierarchyKey" : { + "/api/license/claimkey/getClaimKey" : { "post" : { - "description" : "Get nested locations by subLocationHierarchyKey", - "operationId" : "getLocationsBySubLocationsHierarchyKey", + "description" : "Get the claim key with the specified uuid. A claim key represents one purchased term: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only claim keys of `type` `NEW` carry a `startDate` - a `RENEWAL` key extends the terms it renews and carries only an `endDate`.", + "operationId" : "getClaimKey", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24537,7 +26022,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationsBySubLocationsHierarchyKeyWSRequest" + "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyWSRequest" } } } @@ -24547,21 +26032,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_GetLocationsBySubLocationsHierarchyKeyWSResponse" + "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get locations by hierarchy key", - "tags" : [ "Location Webservice" ] + "summary" : "Get claim key", + "tags" : [ "ClaimKey Webservice" ] } }, - "/api/location/removeLocationLabel" : { + "/api/license/findAssignedLicensesByLocation" : { "post" : { - "description" : "Remove a label from a location", - "operationId" : "removeLocationLabel", + "description" : "Find all licenses assigned to a location", + "operationId" : "findAssignedLicensesByLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24578,7 +26063,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_RemoveLocationLabelWSRequest" + "$ref" : "#/components/schemas/License_FindAssignedLicensesByLocationWSRequest" } } } @@ -24588,21 +26073,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_RemoveLocationLabelWSResponse" + "$ref" : "#/components/schemas/License_FindAssignedLicensesByLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Remove location label", - "tags" : [ "Location Webservice" ] + "summary" : "Find assigned licenses by location", + "tags" : [ "License Webservice" ] } }, - "/api/location/selectiveUpdateLocation" : { + "/api/license/getACUDoorLicenses" : { "post" : { - "description" : "Selectively update a location", - "operationId" : "selectiveUpdateLocation", + "description" : "Get list of access controlled door licenses licenses available in organization", + "operationId" : "getACUDoorLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24619,7 +26104,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_SelectiveUpdateLocationWSRequest" + "$ref" : "#/components/schemas/License_GetACUDoorLicensesWSRequest" } } } @@ -24629,30 +26114,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_SelectiveUpdateLocationWSResponse" + "$ref" : "#/components/schemas/License_GetACUDoorLicensesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Selective update location", - "tags" : [ "Location Webservice" ] + "summary" : "Get ACU door licenses", + "tags" : [ "License Webservice" ] } }, - "/api/location/updateLocation" : { + "/api/license/getACUDoorLicensesForClientOrg" : { "post" : { - "description" : "Update a location **NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation", - "operationId" : "updateLocation", + "description" : "Get list of access controlled door licenses licenses available for a client organization", + "operationId" : "getACUDoorLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24660,7 +26145,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_UpdateLocationWSRequest" + "$ref" : "#/components/schemas/License_GetACUDoorLicensesForClientOrgWSRequest" } } } @@ -24670,21 +26155,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Location_UpdateLocationWSResponse" + "$ref" : "#/components/schemas/License_GetACUDoorLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update location", - "tags" : [ "Location Webservice" ] + "summary" : "Get ACU door licenses for client org", + "tags" : [ "License Webservice" ] } }, - "/api/logistics/getRMAs" : { + "/api/license/getAlertMonitoringLicenses" : { "post" : { - "description" : "Get RMAs", - "operationId" : "getRMAs", + "description" : "Get list of alert monitoring licenses available in organization", + "operationId" : "getAlertMonitoringLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24701,7 +26186,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Logistics_GetRMAsWSRequest" + "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesWSRequest" } } } @@ -24711,30 +26196,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Logistics_GetRMAsWSResponse" + "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get RMAs", - "tags" : [ "Logistics Webservice" ] + "summary" : "Get alert monitoring licenses", + "tags" : [ "License Webservice" ] } }, - "/api/logistics/getShipments" : { + "/api/license/getAlertMonitoringLicensesForClientOrg" : { "post" : { - "description" : "Get shipments", - "operationId" : "getShipments", + "description" : "Get list of alert monitoring licenses available for a client organization", + "operationId" : "getAlertMonitoringLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24742,7 +26227,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Logistics_GetShipmentsWSRequest" + "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesForClientOrgWSRequest" } } } @@ -24752,21 +26237,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Logistics_GetShipmentsWSResponse" + "$ref" : "#/components/schemas/License_GetAlertMonitoringLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get shipments", - "tags" : [ "Logistics Webservice" ] + "summary" : "Get alert monitoring licenses for client org", + "tags" : [ "License Webservice" ] } }, - "/api/logistics/getWarrantyApprovedRMAs" : { + "/api/license/getDeviceLicenses" : { "post" : { - "description" : "Get warranty approved RMAs", - "operationId" : "getWarrantyApprovedRMAs", + "description" : "Get list of device licenses available in organization", + "operationId" : "getDeviceLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24783,7 +26268,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Internal_GetWarrantyApprovedRMAsWSRequest" + "$ref" : "#/components/schemas/License_GetDeviceLicensesWSRequest" } } } @@ -24793,30 +26278,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Internal_GetWarrantyApprovedRMAsWSResponse" + "$ref" : "#/components/schemas/License_GetDeviceLicensesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get warranty approved RMAs", - "tags" : [ "Logistics Webservice" ] + "summary" : "Get device licenses", + "tags" : [ "License Webservice" ] } }, - "/api/mediadevice/getBulkMediaDeviceDetails" : { + "/api/license/getDeviceLicensesForClientOrg" : { "post" : { - "description" : "Get media information of any video-supporting media device", - "operationId" : "getBulkMediaDeviceDetails", + "description" : "Get list of device licenses available for a client organization", + "operationId" : "getDeviceLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24824,7 +26309,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSRequest" + "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest" } } } @@ -24834,95 +26319,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSResponse" - } - } - }, - "description" : "OK" - } - }, - "summary" : "Get bulk media device details", - "tags" : [ "Media Device Webservice" ] - } - }, - "/api/oauth/authorize" : { - "get" : { - "description" : "User authorizes to share permission and ac settings, receives temporary authorization code", - "operationId" : "authorize", - "parameters" : [ { - "in" : "query", - "name" : "clientId", - "schema" : { - "type" : "string", - "nullable" : true - } - }, { - "in" : "query", - "name" : "redirectUri", - "schema" : { - "type" : "string", - "nullable" : true - } - }, { - "in" : "query", - "name" : "responseType", - "schema" : { - "type" : "string", - "nullable" : true - } - }, { - "in" : "query", - "name" : "state", - "schema" : { - "type" : "string", - "nullable" : true - } - }, { - "in" : "query", - "name" : "consentGiven", - "schema" : { - "type" : "boolean", - "nullable" : true - } - }, { - "in" : "query", - "name" : "codeChallenge", - "schema" : { - "type" : "string", - "nullable" : true - } - }, { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, - "schema" : { - "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] - } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Authorize OAuth application", - "tags" : [ "OAuth Webservice" ] + "summary" : "Get device licenses for client org", + "tags" : [ "License Webservice" ] } }, - "/api/oauth/deleteApplication" : { + "/api/license/getGuestManagementLicenses" : { "post" : { - "description" : "Delete application", - "operationId" : "deleteApplication", + "description" : "Get list of guest management licenses available in organization", + "operationId" : "getGuestManagementLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -24939,7 +26350,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" + "$ref" : "#/components/schemas/License_GetGuestManagementLicensesWSRequest" } } } @@ -24949,30 +26360,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/License_GetGuestManagementLicensesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete OAuth application", - "tags" : [ "OAuth Webservice" ] + "summary" : "Get guest management licenses", + "tags" : [ "License Webservice" ] } }, - "/api/oauth/getAllApplicationsForOrg" : { + "/api/license/getGuestManagementLicensesForClientOrg" : { "post" : { - "description" : "Get all applications for org", - "operationId" : "getAllApplicationsForOrg", + "description" : "Get list of guest management licenses available for a client organization", + "operationId" : "getGuestManagementLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -24980,7 +26391,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_GetAllApplicationsForOrgWSRequest" + "$ref" : "#/components/schemas/License_GetGuestManagementLicensesForClientOrgWSRequest" } } } @@ -24990,21 +26401,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_GetAllApplicationsForOrgWSResponse" + "$ref" : "#/components/schemas/License_GetGuestManagementLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get all applications for organization", - "tags" : [ "OAuth Webservice" ] + "summary" : "Get guest management licenses for client org", + "tags" : [ "License Webservice" ] } }, - "/api/oauth/getApplicationByClientId" : { + "/api/license/getLicenses" : { "post" : { - "description" : "Get application by clientId", - "operationId" : "getApplicationByClientId", + "description" : "Get list of add-on licenses available in organization", + "operationId" : "getLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25021,7 +26432,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_GetApplicationByClientIdWSRequest" + "$ref" : "#/components/schemas/License_GetLicensesWSRequest" } } } @@ -25031,30 +26442,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_GetApplicationByClientIdWSResponse" + "$ref" : "#/components/schemas/License_GetLicensesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get application by client ID", - "tags" : [ "OAuth Webservice" ] + "summary" : "Get licenses", + "tags" : [ "License Webservice" ] } }, - "/api/oauth/submitApplication" : { + "/api/license/getLicensesForClientOrg" : { "post" : { - "description" : "Application for client_id and client_secret", - "operationId" : "submitApplication", + "description" : "Get a list of licenses available for a client organization", + "operationId" : "getLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -25062,7 +26473,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" + "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSRequest" } } } @@ -25072,21 +26483,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSResponse" + "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Submit OAuth application", - "tags" : [ "OAuth Webservice" ] + "summary" : "Get licenses for client org", + "tags" : [ "License Webservice" ] } }, - "/api/oauth/updateApplication" : { + "/api/license/getPaneLicenseStatus" : { "post" : { - "description" : "Update application", - "operationId" : "updateApplication", + "description" : "Whether this organization is currently licensed to use a PANE app. Any member of the organization may ask; the PANE gateway asks on the visitor's behalf before serving the pane.", + "operationId" : "getPaneLicenseStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25103,7 +26514,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" + "$ref" : "#/components/schemas/License_GetPaneLicenseStatusWSRequest" } } } @@ -25113,21 +26524,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/BaseApiResponse" + "$ref" : "#/components/schemas/License_GetPaneLicenseStatusWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update OAuth application", - "tags" : [ "OAuth Webservice" ] + "summary" : "Get pane license status", + "tags" : [ "License Webservice" ] } }, - "/api/occupancy/getMinimalOccupancySensorStateList" : { + "/api/license/getPaneLicenses" : { "post" : { - "description" : "Get basic state information about all proximity tags in organization", - "operationId" : "getMinimalOccupancySensorStateList", + "description" : "Get the list of PANE app licenses in the organization", + "operationId" : "getPaneLicenses", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25144,7 +26555,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" + "$ref" : "#/components/schemas/License_GetPaneLicensesWSRequest" } } } @@ -25154,30 +26565,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" + "$ref" : "#/components/schemas/License_GetPaneLicensesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get minimal occupancy sensor state list", - "tags" : [ "Occupancy Webservice" ] + "summary" : "Get pane licenses", + "tags" : [ "License Webservice" ] } }, - "/api/occupancy/getOccupancyEventsForSensor" : { + "/api/license/getPaneLicensesForClientOrg" : { "post" : { - "description" : "Get recent events for specified proximity tag", - "operationId" : "getOccupancyEventsForSensor", + "description" : "Get the list of PANE app licenses in a client organization", + "operationId" : "getPaneLicensesForClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -25185,7 +26596,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Occupancysensor_GetOccupancyEventsForSensorWSRequest" + "$ref" : "#/components/schemas/License_GetPaneLicensesForClientOrgWSRequest" } } } @@ -25195,21 +26606,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Occupancysensor_GetOccupancyEventsForSensorWSResponse" + "$ref" : "#/components/schemas/License_GetPaneLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get occupancy events for sensor", - "tags" : [ "Occupancy Webservice" ] + "summary" : "Get pane licenses for client org", + "tags" : [ "License Webservice" ] } }, - "/api/occupancy/getOccupancyPresenceWindows" : { + "/api/location/addLocationLabel" : { "post" : { - "description" : "Get stored video information for sensor", - "operationId" : "getOccupancyPresenceWindows", + "description" : "Add a label to a location", + "operationId" : "addLocationLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25226,7 +26637,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSRequest" + "$ref" : "#/components/schemas/Location_AddLocationLabelWSRequest" } } } @@ -25236,21 +26647,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSResponse" + "$ref" : "#/components/schemas/Location_AddLocationLabelWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get occupancy presence windows", - "tags" : [ "Occupancy Webservice" ] + "summary" : "Add location label", + "tags" : [ "Location Webservice" ] } }, - "/api/occupancy/updateDetails" : { + "/api/location/createLocation" : { "post" : { - "description" : "Update the details of an occupancy sensor", - "operationId" : "updateOccupancySensorDetails", + "description" : "Create a location", + "operationId" : "createlocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25267,7 +26678,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Occupancysensor_UpdateOccupancySensorDetailsWSRequest" + "$ref" : "#/components/schemas/Location_CreateLocationWSRequest" } } } @@ -25277,21 +26688,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Occupancysensor_UpdateOccupancySensorDetailsWSResponse" + "$ref" : "#/components/schemas/Location_CreateLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update occupancy sensor details", - "tags" : [ "Occupancy Webservice" ] + "summary" : "Create location", + "tags" : [ "Location Webservice" ] } }, - "/api/org/claimActivationToken" : { + "/api/location/deleteLocation" : { "post" : { - "description" : "Claim activation token for organization", - "operationId" : "claimActivationToken", + "description" : "Remove a location", + "operationId" : "deleteLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25308,7 +26719,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_ClaimActivationTokenWSRequest" + "$ref" : "#/components/schemas/Location_DeleteLocationWSRequest" } } } @@ -25318,21 +26729,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_ClaimActivationTokenWSResponse" + "$ref" : "#/components/schemas/Location_DeleteLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Claim activation token", - "tags" : [ "Org Webservice" ] + "summary" : "Delete location", + "tags" : [ "Location Webservice" ] } }, - "/api/org/claimShipmentRegistrationToken" : { + "/api/location/geoCode" : { "post" : { - "description" : "Claim shipment registration token for an organization", - "operationId" : "claimShipmentRegistrationToken", + "description" : "Get the latitude and longitude of an address", + "operationId" : "geoCode", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25349,7 +26760,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_ClaimShipmentRegistrationTokenWSRequest" + "$ref" : "#/components/schemas/Location_GeoCodeWSRequest" } } } @@ -25359,21 +26770,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_ClaimShipmentRegistrationTokenWSResponse" + "$ref" : "#/components/schemas/Location_GeoCodeWSResponse" } } }, "description" : "OK" } }, - "summary" : "Claim shipment registration token", - "tags" : [ "Org Webservice" ] + "summary" : "Geocode address", + "tags" : [ "Location Webservice" ] } }, - "/api/org/createPendingRegistration" : { + "/api/location/getFloorPlanWalls" : { "post" : { - "description" : "Create a pending registration. Registration will be completed when the hardware establishes connectivity", - "operationId" : "createPendingRegistration", + "description" : "Get the walls detected in a floor plan image", + "operationId" : "getFloorPlanWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25390,7 +26801,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_CreatePendingRegistrationRequest" + "$ref" : "#/components/schemas/Location_GetFloorPlanWallsWSRequest" } } } @@ -25400,21 +26811,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_CreatePendingRegistrationResponse" + "$ref" : "#/components/schemas/Location_GetFloorPlanWallsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create pending registration", - "tags" : [ "Org Webservice" ] + "summary" : "Get floor plan walls", + "tags" : [ "Location Webservice" ] } }, - "/api/org/deleteCloudArchivingConfig" : { + "/api/location/getLocation" : { "post" : { - "description" : "Delete scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device", - "operationId" : "deleteCloudArchivingConfig", + "description" : "Get location by id", + "operationId" : "getLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25431,7 +26842,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_DeleteCloudArchivingConfigWSRequest" + "$ref" : "#/components/schemas/Location_GetLocationWSRequest" } } } @@ -25441,21 +26852,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_DeleteCloudArchivingConfigWSResponse" + "$ref" : "#/components/schemas/Location_GetLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete cloud archiving config", - "tags" : [ "Org Webservice" ] + "summary" : "Get location", + "tags" : [ "Location Webservice" ] } }, - "/api/org/deleteKeypadLogo" : { + "/api/location/getLocationLabelsForOrg" : { "post" : { - "description" : "Delete keypad logo.", - "operationId" : "deleteKeypadLogo", + "description" : "Get all location labels for an organization", + "operationId" : "getLocationLabelsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25472,7 +26883,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_DeleteKeypadLogoWSRequest" + "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSRequest" } } } @@ -25482,21 +26893,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_DeleteKeypadLogoWSResponse" + "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete keypad logo", - "tags" : [ "Org Webservice" ] + "summary" : "Get location labels for org", + "tags" : [ "Location Webservice" ] } }, - "/api/org/deleteRhombusKeyLogo" : { + "/api/location/getLocations" : { "post" : { - "description" : "Delete rhombus key logo.", - "operationId" : "deleteRhombusKeyLogo", + "description" : "Get list of locations in organization", + "operationId" : "getLocations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25513,7 +26924,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_DeleteRhombusKeyLogoWSRequest" + "$ref" : "#/components/schemas/Location_GetLocationsWSRequest" } } } @@ -25523,21 +26934,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_DeleteRhombusKeyLogoWSResponse" + "$ref" : "#/components/schemas/Location_GetLocationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete rhombus key logo", - "tags" : [ "Org Webservice" ] + "summary" : "Get locations", + "tags" : [ "Location Webservice" ] } }, - "/api/org/findAllHardwareWithPendingRegistration" : { + "/api/location/getLocationsAssociatedToLocationLabelsByOrg" : { "post" : { - "description" : "Find all hardware for which a pending registrations exists", - "operationId" : "findAllHardwareWithPendingRegistration", + "description" : "Get all locations associated to location labels for an organization", + "operationId" : "getLocationsAssociatedToLocationLabelsByOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25554,7 +26965,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindAllHardwareWithPendingRegistrationRequest" + "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSRequest" } } } @@ -25564,21 +26975,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindAllHardwareWithPendingRegistrationResponse" + "$ref" : "#/components/schemas/Location_GetLocationLabelsForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find all hardware with pending registration", - "tags" : [ "Org Webservice" ] + "summary" : "Get locations by labels", + "tags" : [ "Location Webservice" ] } }, - "/api/org/findHardwareAvailableForPendingRegistration" : { + "/api/location/getLocationsByGeo" : { "post" : { - "description" : "Find hardware for which pending registrations can be created", - "operationId" : "findHardwareAvailableForPendingRegistration", + "description" : "Get list of locations given latitude and longitude", + "operationId" : "getLocationsByGeo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25595,7 +27006,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationRequest" + "$ref" : "#/components/schemas/Location_GetLocationsByGeoRequest" } } } @@ -25605,21 +27016,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationResponse" + "$ref" : "#/components/schemas/Location_GetLocationsByGeoResponse" } } }, "description" : "OK" } }, - "summary" : "Find hardware available for pending registration", - "tags" : [ "Org Webservice" ] + "summary" : "Get locations by geo", + "tags" : [ "Location Webservice" ] } }, - "/api/org/findIfTeamNameAvailable" : { + "/api/location/getLocationsBySubLocationsHierarchyKey" : { "post" : { - "description" : "Get organization team name if it is available", - "operationId" : "findIfTeamNameAvailable", + "description" : "Get nested locations by subLocationHierarchyKey", + "operationId" : "getLocationsBySubLocationsHierarchyKey", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25636,7 +27047,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindIfTeamNameAvailableRequest" + "$ref" : "#/components/schemas/Location_GetLocationsBySubLocationsHierarchyKeyWSRequest" } } } @@ -25646,21 +27057,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindIfTeamNameAvailableResponse" + "$ref" : "#/components/schemas/Location_GetLocationsBySubLocationsHierarchyKeyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find if team name available", - "tags" : [ "Org Webservice" ] + "summary" : "Get locations by hierarchy key", + "tags" : [ "Location Webservice" ] } }, - "/api/org/findSCIMSettingsForOrg" : { + "/api/location/refreshFloorPlanWalls" : { "post" : { - "description" : "Get SCIM configuration for organization", - "operationId" : "findSCIMSettingsForOrg", + "description" : "Re-detect and store the walls of a floor plan image", + "operationId" : "refreshFloorPlanWalls", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25677,7 +27088,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindSCIMSettingsForOrgWSRequest" + "$ref" : "#/components/schemas/Location_RefreshFloorPlanWallsWSRequest" } } } @@ -25687,21 +27098,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_FindSCIMSettingsForOrgWSResponse" + "$ref" : "#/components/schemas/Location_RefreshFloorPlanWallsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find SCIM settings for organization", - "tags" : [ "Org Webservice" ] + "summary" : "Refresh floor plan walls", + "tags" : [ "Location Webservice" ] } }, - "/api/org/generateFederatedSessionToken" : { + "/api/location/removeLocationLabel" : { "post" : { - "description" : "Generate a federated session token login for organization", - "operationId" : "generateFederatedSessionToken", + "description" : "Remove a label from a location", + "operationId" : "removeLocationLabel", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25718,7 +27129,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GenerateFederatedSessionTokenRequest" + "$ref" : "#/components/schemas/Location_RemoveLocationLabelWSRequest" } } } @@ -25728,30 +27139,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GenerateFederatedSessionTokenResponse" + "$ref" : "#/components/schemas/Location_RemoveLocationLabelWSResponse" } } }, "description" : "OK" } }, - "summary" : "Generate federated session token", - "tags" : [ "Org Webservice" ] + "summary" : "Remove location label", + "tags" : [ "Location Webservice" ] } }, - "/api/org/getClientOrg" : { + "/api/location/selectiveUpdateLocation" : { "post" : { - "description" : "Get details about the client organization", - "operationId" : "getClientOrg", + "description" : "Selectively update a location", + "operationId" : "selectiveUpdateLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -25759,7 +27170,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetClientOrgWSRequest" + "$ref" : "#/components/schemas/Location_SelectiveUpdateLocationWSRequest" } } } @@ -25769,21 +27180,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetClientOrgWSResponse" + "$ref" : "#/components/schemas/Location_SelectiveUpdateLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get client organization details", - "tags" : [ "Org Webservice" ] + "summary" : "Selective update location", + "tags" : [ "Location Webservice" ] } }, - "/api/org/getCloudArchivingConfigs" : { + "/api/location/updateLocation" : { "post" : { - "description" : "Get scoped cloud archiving configs. Note that the priority of scoping is Org > Location > Device", - "operationId" : "getCloudArchivingConfigs", + "description" : "Update a location **NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation", + "operationId" : "updateLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25800,7 +27211,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetCloudArchivingConfigsWSRequest" + "$ref" : "#/components/schemas/Location_UpdateLocationWSRequest" } } } @@ -25810,21 +27221,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetCloudArchivingConfigsWSResponse" + "$ref" : "#/components/schemas/Location_UpdateLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get cloud archiving configs", - "tags" : [ "Org Webservice" ] + "summary" : "Update location", + "tags" : [ "Location Webservice" ] } }, - "/api/org/getFeatures" : { + "/api/logistics/getActiveRMAs" : { "post" : { - "description" : "Get organization wide features", - "operationId" : "getFeatures", + "description" : "Get device uuids for active RMAs", + "operationId" : "getActiveRMAs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25841,7 +27252,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetFeaturesWSRequest" + "$ref" : "#/components/schemas/Internal_GetActiveRMAsWSRequest" } } } @@ -25851,22 +27262,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetFeaturesWSResponse" + "$ref" : "#/components/schemas/Internal_GetActiveRMAsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get organization features", - "tags" : [ "Org Webservice" ] + "summary" : "Get device uuids for active RMAs", + "tags" : [ "Logistics Webservice" ] } }, - "/api/org/getOrg" : { + "/api/logistics/getRMAs" : { "post" : { - "deprecated" : true, - "description" : "Get details about organization", - "operationId" : "getOrg", + "description" : "Get RMAs", + "operationId" : "getRMAs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25883,7 +27293,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgWSRequest" + "$ref" : "#/components/schemas/Logistics_GetRMAsWSRequest" } } } @@ -25893,22 +27303,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgWSResponse" + "$ref" : "#/components/schemas/Logistics_GetRMAsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get organization details", - "tags" : [ "Org Webservice" ] + "summary" : "Get RMAs", + "tags" : [ "Logistics Webservice" ] } }, - "/api/org/getOrgIntegrations" : { + "/api/logistics/getShipments" : { "post" : { - "deprecated" : true, - "description" : "Use endpoints in Integrations Webservice instead", - "operationId" : "DEPRECATED_getOrgIntegrations", + "description" : "Get shipments", + "operationId" : "getShipments", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25925,7 +27334,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgIntegrationsWSRequest" + "$ref" : "#/components/schemas/Logistics_GetShipmentsWSRequest" } } } @@ -25935,22 +27344,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgIntegrationsWSResponse" + "$ref" : "#/components/schemas/Logistics_GetShipmentsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get organization integrations", - "tags" : [ "Org Webservice" ] + "summary" : "Get shipments", + "tags" : [ "Logistics Webservice" ] } }, - "/api/org/getOrgNotificationTemplate" : { + "/api/logistics/getWarrantyApprovedRMAs" : { "post" : { - "deprecated" : true, - "description" : "This endpoint is no longer in use. Please use getOrgNotificationTemplateV2 instead.", - "operationId" : "getOrgNotificationTemplate", + "description" : "Get warranty approved RMAs", + "operationId" : "getWarrantyApprovedRMAs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -25967,7 +27375,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSRequest" + "$ref" : "#/components/schemas/Internal_GetWarrantyApprovedRMAsWSRequest" } } } @@ -25977,21 +27385,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSResponse" + "$ref" : "#/components/schemas/Internal_GetWarrantyApprovedRMAsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get organization notification template", - "tags" : [ "Org Webservice" ] + "summary" : "Get warranty approved RMAs", + "tags" : [ "Logistics Webservice" ] } }, - "/api/org/getOrgNotificationTemplateV2" : { + "/api/mediadevice/getBulkMediaDeviceDetails" : { "post" : { - "description" : "Get organization's default notification schedule template", - "operationId" : "getOrgNotificationTemplateV2", + "description" : "Get media information of any video-supporting media device", + "operationId" : "getBulkMediaDeviceDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26008,7 +27416,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSRequest" + "$ref" : "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSRequest" } } } @@ -26018,64 +27426,113 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateV2WSResponse" + "$ref" : "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get organization notification template V2", - "tags" : [ "Org Webservice" ] + "summary" : "Get bulk media device details", + "tags" : [ "Media Device Webservice" ] } }, - "/api/org/getOrgV2" : { - "post" : { - "description" : "Get details about organization", - "operationId" : "getOrgV2", + "/api/oauth/authorize" : { + "get" : { + "description" : "User authorizes to share permission and ac settings, receives temporary authorization code", + "operationId" : "authorize", "parameters" : [ { - "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", - "in" : "header", - "name" : "x-auth-scheme", - "required" : true, + "in" : "query", + "name" : "clientId", "schema" : { "type" : "string", - "default" : "api-token", - "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + "nullable" : true } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgV2WSRequest" - } - } + }, { + "in" : "query", + "name" : "redirectUri", + "schema" : { + "type" : "string", + "nullable" : true } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Org_GetOrgV2WSResponse" - } - } - }, - "description" : "OK" + }, { + "in" : "query", + "name" : "responseType", + "schema" : { + "type" : "string", + "nullable" : true } - }, - "summary" : "Get organization details V2", - "tags" : [ "Org Webservice" ] - } - }, - "/api/org/getSAMLSettings" : { - "post" : { - "deprecated" : true, - "description" : "Deprecated. Use getSAMLSettingsV2", - "operationId" : "getSAMLSettings", - "parameters" : [ { + }, { + "in" : "query", + "name" : "state", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "consentGiven", + "schema" : { + "type" : "boolean", + "nullable" : true + } + }, { + "in" : "query", + "name" : "codeChallenge", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "client_id", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "redirect_uri", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "response_type", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "consent_given", + "schema" : { + "type" : "boolean", + "nullable" : true + } + }, { + "in" : "query", + "name" : "code_challenge", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "code_challenge_method", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { + "in" : "query", + "name" : "resource", + "schema" : { + "type" : "string", + "nullable" : true + } + }, { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", "in" : "header", @@ -26087,35 +27544,26 @@ "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Org_GetSAMLSettingsWSRequest" - } - } - } - }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetSAMLSettingsWSResponse" + "$ref" : "#/components/schemas/Response" } } }, "description" : "OK" } }, - "summary" : "Get SAML settings", - "tags" : [ "Org Webservice" ] + "summary" : "Authorize OAuth application", + "tags" : [ "OAuth Webservice" ] } }, - "/api/org/getSAMLSettingsV2" : { + "/api/oauth/deleteApplication" : { "post" : { - "description" : "Get details about organization", - "operationId" : "getSAMLSettingsV2", + "description" : "Delete application", + "operationId" : "deleteApplication", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26132,7 +27580,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetSAMLSettingsV2WSRequest" + "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" } } } @@ -26142,21 +27590,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetSAMLSettingsV2WSResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Get SAML settings V2", - "tags" : [ "Org Webservice" ] + "summary" : "Delete OAuth application", + "tags" : [ "OAuth Webservice" ] } }, - "/api/org/getScimDisplayInfo" : { + "/api/oauth/getAllApplicationsForOrg" : { "post" : { - "description" : "Get SCIM display info for organization", - "operationId" : "getScimDisplayInfo", + "description" : "Get all applications for org", + "operationId" : "getAllApplicationsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26169,26 +27617,35 @@ "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Oauth_GetAllApplicationsForOrgWSRequest" + } + } + } + }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetScimDisplayInfoResponse" + "$ref" : "#/components/schemas/Oauth_GetAllApplicationsForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get SCIM display info", - "tags" : [ "Org Webservice" ] + "summary" : "Get all applications for organization", + "tags" : [ "OAuth Webservice" ] } }, - "/api/org/getTemporaryOrgToken" : { + "/api/oauth/getApplicationByClientId" : { "post" : { - "description" : "Generate a temporary org token for use in OAuth flows", - "operationId" : "getTemporaryOrgToken", + "description" : "Get application by clientId", + "operationId" : "getApplicationByClientId", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26205,7 +27662,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_GetTemporaryOrgTokenWSRequest" + "$ref" : "#/components/schemas/Oauth_GetApplicationByClientIdWSRequest" } } } @@ -26215,21 +27672,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GetTemporaryOrgTokenResponse" + "$ref" : "#/components/schemas/Oauth_GetApplicationByClientIdWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get temporary org token", - "tags" : [ "Org Webservice" ] + "summary" : "Get application by client ID", + "tags" : [ "OAuth Webservice" ] } }, - "/api/org/peekShipmentRegistrationToken" : { + "/api/oauth/submitApplication" : { "post" : { - "description" : "Peek at a shipping registration token for an organization", - "operationId" : "peekShipmentRegistrationToken", + "description" : "Application for client_id and client_secret", + "operationId" : "submitApplication", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26246,7 +27703,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_PeekShipmentRegistrationTokenWSRequest" + "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" } } } @@ -26256,21 +27713,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_PeekShipmentRegistrationTokenWSResponse" + "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Peek shipment registration token", - "tags" : [ "Org Webservice" ] + "summary" : "Submit OAuth application", + "tags" : [ "OAuth Webservice" ] } }, - "/api/org/removePendingRegistration" : { + "/api/oauth/updateApplication" : { "post" : { - "description" : "Remove a pending registration", - "operationId" : "removePendingRegistration", + "description" : "Update application", + "operationId" : "updateApplication", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26287,7 +27744,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_RemovePendingRegistrationRequest" + "$ref" : "#/components/schemas/Oauth_OAuthApplicationWSRequest" } } } @@ -26297,21 +27754,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_RemovePendingRegistrationResponse" + "$ref" : "#/components/schemas/BaseApiResponse" } } }, "description" : "OK" } }, - "summary" : "Remove pending registration", - "tags" : [ "Org Webservice" ] + "summary" : "Update OAuth application", + "tags" : [ "OAuth Webservice" ] } }, - "/api/org/revokeSCIMAccessForOrg" : { + "/api/occupancy/getMinimalOccupancySensorStateList" : { "post" : { - "description" : "Revoke SCIM access for organization", - "operationId" : "revokeSCIMAccessForOrg", + "description" : "Get basic state information about all proximity tags in organization", + "operationId" : "getMinimalOccupancySensorStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26328,7 +27785,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_RevokeSCIMAccessForOrgWSRequest" + "$ref" : "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" } } } @@ -26338,21 +27795,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_RevokeSCIMAccessForOrgWSResponse" + "$ref" : "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Revoke SCIM access for organization", - "tags" : [ "Org Webservice" ] + "summary" : "Get minimal occupancy sensor state list", + "tags" : [ "Occupancy Webservice" ] } }, - "/api/org/setupSCIMAccessForOrg" : { + "/api/occupancy/getOccupancyEventsForSensor" : { "post" : { - "description" : "Initially configure SCIM access for organization", - "operationId" : "setupSCIMAccessForOrg", + "description" : "Get recent events for specified proximity tag", + "operationId" : "getOccupancyEventsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26369,7 +27826,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_SetupSCIMAccessForOrgWSRequest" + "$ref" : "#/components/schemas/Occupancysensor_GetOccupancyEventsForSensorWSRequest" } } } @@ -26379,21 +27836,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_SetupSCIMAccessForOrgWSResponse" + "$ref" : "#/components/schemas/Occupancysensor_GetOccupancyEventsForSensorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Setup SCIM access for organization", - "tags" : [ "Org Webservice" ] + "summary" : "Get occupancy events for sensor", + "tags" : [ "Occupancy Webservice" ] } }, - "/api/org/updateAiTrainingSettings" : { + "/api/occupancy/getOccupancyPresenceWindows" : { "post" : { - "description" : "Update organization AI training settings", - "operationId" : "updateAiTrainingSettings", + "description" : "Get stored video information for sensor", + "operationId" : "getOccupancyPresenceWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26410,7 +27867,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateAiTrainingSettingsWSRequest" + "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSRequest" } } } @@ -26420,21 +27877,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateAiTrainingSettingsWSResponse" + "$ref" : "#/components/schemas/Sensor_GetSensorPresenceWindowsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update AI training settings", - "tags" : [ "Org Webservice" ] + "summary" : "Get occupancy presence windows", + "tags" : [ "Occupancy Webservice" ] } }, - "/api/org/updateCloudArchivingConfig" : { + "/api/occupancy/updateDetails" : { "post" : { - "description" : "Update scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device", - "operationId" : "updateCloudArchivingConfig", + "description" : "Update the details of an occupancy sensor", + "operationId" : "updateOccupancySensorDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26451,7 +27908,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateCloudArchivingConfigWSRequest" + "$ref" : "#/components/schemas/Occupancysensor_UpdateOccupancySensorDetailsWSRequest" } } } @@ -26461,21 +27918,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateCloudArchivingConfigWSResponse" + "$ref" : "#/components/schemas/Occupancysensor_UpdateOccupancySensorDetailsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update cloud archiving config", - "tags" : [ "Org Webservice" ] + "summary" : "Update occupancy sensor details", + "tags" : [ "Occupancy Webservice" ] } }, - "/api/org/updateFirmwareSettings" : { + "/api/org/claimActivationToken" : { "post" : { - "description" : "Update organization firmware schedule settings", - "operationId" : "updateFirmwareSettings", + "description" : "Claim activation token for organization", + "operationId" : "claimActivationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26492,7 +27949,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateFirmwareSettingsWSRequest" + "$ref" : "#/components/schemas/Org_ClaimActivationTokenWSRequest" } } } @@ -26502,21 +27959,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateFirmwareSettingsWSResponse" + "$ref" : "#/components/schemas/Org_ClaimActivationTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update firmware settings", + "summary" : "Claim activation token", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateGeneralSettings" : { + "/api/org/claimShipmentRegistrationToken" : { "post" : { - "description" : "Update organization General settings", - "operationId" : "updateGeneralSettings", + "description" : "Claim shipment registration token for an organization", + "operationId" : "claimShipmentRegistrationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26533,7 +27990,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateGeneralSettingsWSRequest" + "$ref" : "#/components/schemas/Org_ClaimShipmentRegistrationTokenWSRequest" } } } @@ -26543,21 +28000,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateGeneralSettingsWSResponse" + "$ref" : "#/components/schemas/Org_ClaimShipmentRegistrationTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update general settings", + "summary" : "Claim shipment registration token", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateMFASettings" : { + "/api/org/createOrUpdateHealthNotificationRule" : { "post" : { - "description" : "Update organization MFA settings", - "operationId" : "updateMFASettings", + "description" : "Create or update a time/size-based health notification rule. Omit ruleUuid to create a new rule", + "operationId" : "createOrUpdateHealthNotificationRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26574,7 +28031,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateMFASettingsWSRequest" + "$ref" : "#/components/schemas/Org_CreateOrUpdateHealthNotificationRuleWSRequest" } } } @@ -26584,22 +28041,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateMFASettingsWSResponse" + "$ref" : "#/components/schemas/Org_CreateOrUpdateHealthNotificationRuleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update MFA settings", + "summary" : "Create or update health notification rule", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateOrg" : { + "/api/org/createPendingRegistration" : { "post" : { - "deprecated" : true, - "description" : "Update organization details", - "operationId" : "updateOrg", + "description" : "Create a pending registration. Registration will be completed when the hardware establishes connectivity", + "operationId" : "createPendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26616,7 +28072,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgWSRequest" + "$ref" : "#/components/schemas/Org_CreatePendingRegistrationRequest" } } } @@ -26626,21 +28082,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgWSResponse" + "$ref" : "#/components/schemas/Org_CreatePendingRegistrationResponse" } } }, "description" : "OK" } }, - "summary" : "Update organization details", + "summary" : "Create pending registration", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateOrgAudioAnalysisPolicy" : { + "/api/org/deleteCloudArchivingConfig" : { "post" : { - "description" : "Update organization AI audio analysis policy", - "operationId" : "updateOrgAudioAnalysisPolicy", + "description" : "Delete scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device", + "operationId" : "deleteCloudArchivingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26657,7 +28113,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgAudioAnalysisPolicyWSRequest" + "$ref" : "#/components/schemas/Org_DeleteCloudArchivingConfigWSRequest" } } } @@ -26667,21 +28123,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgAudioAnalysisPolicyWSResponse" + "$ref" : "#/components/schemas/Org_DeleteCloudArchivingConfigWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update organization AI audio analysis policy", + "summary" : "Delete cloud archiving config", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateOrgAudioRecordingPolicy" : { + "/api/org/deleteHealthNotificationRule" : { "post" : { - "description" : "Update organization audio recording policy", - "operationId" : "updateOrgAudioRecordingPolicy", + "description" : "Delete a time/size-based health notification rule", + "operationId" : "deleteHealthNotificationRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26698,7 +28154,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgAudioRecordingPolicyWSRequest" + "$ref" : "#/components/schemas/Org_DeleteHealthNotificationRuleWSRequest" } } } @@ -26708,21 +28164,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgAudioRecordingPolicyWSResponse" + "$ref" : "#/components/schemas/Org_DeleteHealthNotificationRuleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update organization audio recording policy", + "summary" : "Delete health notification rule", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateOrgLLMUsagePolicy" : { + "/api/org/deleteKeypadLogo" : { "post" : { - "description" : "Update organization's LLM usage opt-in policy", - "operationId" : "updateOrgLLMUsagePolicy", + "description" : "Delete keypad logo.", + "operationId" : "deleteKeypadLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26739,7 +28195,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgLLMUsagePolicyWSRequest" + "$ref" : "#/components/schemas/Org_DeleteKeypadLogoWSRequest" } } } @@ -26749,22 +28205,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgLLMUsagePolicyWSResponse" + "$ref" : "#/components/schemas/Org_DeleteKeypadLogoWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update organization's LLM usage opt-in policy", + "summary" : "Delete keypad logo", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateOrgNotificationTemplate" : { + "/api/org/deleteRhombusKeyLogo" : { "post" : { - "deprecated" : true, - "description" : "This endpoint is no longer in use. Please use updateOrgNotificationTemplateV2 instead.", - "operationId" : "updateOrgNotificationTemplate", + "description" : "Delete rhombus key logo.", + "operationId" : "deleteRhombusKeyLogo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26781,7 +28236,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateWSRequest" + "$ref" : "#/components/schemas/Org_DeleteRhombusKeyLogoWSRequest" } } } @@ -26791,21 +28246,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateWSResponse" + "$ref" : "#/components/schemas/Org_DeleteRhombusKeyLogoWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update organization notification template", + "summary" : "Delete rhombus key logo", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateOrgNotificationTemplateV2" : { + "/api/org/findAllHardwareWithPendingRegistration" : { "post" : { - "description" : "Update default notification schedule template for newly created Users in Org", - "operationId" : "updateOrgNotificationTemplateV2", + "description" : "Find all hardware for which a pending registrations exists", + "operationId" : "findAllHardwareWithPendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26822,7 +28277,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateV2WSRequest" + "$ref" : "#/components/schemas/Org_FindAllHardwareWithPendingRegistrationRequest" } } } @@ -26832,21 +28287,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateV2WSResponse" + "$ref" : "#/components/schemas/Org_FindAllHardwareWithPendingRegistrationResponse" } } }, "description" : "OK" } }, - "summary" : "Update organization notification template V2", + "summary" : "Find all hardware with pending registration", "tags" : [ "Org Webservice" ] } }, - "/api/org/updatePendingRegistration" : { + "/api/org/findHardwareAvailableForPendingRegistration" : { "post" : { - "description" : "Update pending registration for hardware", - "operationId" : "updatePendingRegistration", + "description" : "Find hardware for which pending registrations can be created", + "operationId" : "findHardwareAvailableForPendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26863,7 +28318,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdatePendingRegistrationRequest" + "$ref" : "#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationRequest" } } } @@ -26873,22 +28328,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdatePendingRegistrationResponse" + "$ref" : "#/components/schemas/Org_FindHardwareAvailableForPendingRegistrationResponse" } } }, "description" : "OK" } }, - "summary" : "Update pending registration", + "summary" : "Find hardware available for pending registration", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateSAMLSettings" : { + "/api/org/findIfTeamNameAvailable" : { "post" : { - "deprecated" : true, - "description" : "Deprecated. Use updateSAMLSettingsV2", - "operationId" : "updateSAMLSettings", + "description" : "Get organization team name if it is available", + "operationId" : "findIfTeamNameAvailable", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26905,7 +28359,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsWSRequest" + "$ref" : "#/components/schemas/Org_FindIfTeamNameAvailableRequest" } } } @@ -26915,21 +28369,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsWSResponse" + "$ref" : "#/components/schemas/Org_FindIfTeamNameAvailableResponse" } } }, "description" : "OK" } }, - "summary" : "Update SAML settings", + "summary" : "Find if team name available", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateSAMLSettingsV2" : { + "/api/org/findSCIMSettingsForOrg" : { "post" : { - "description" : "Update organization SAML settings", - "operationId" : "updateSAMLSettingsV2", + "description" : "Get SCIM configuration for organization", + "operationId" : "findSCIMSettingsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26946,7 +28400,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsV2WSRequest" + "$ref" : "#/components/schemas/Org_FindSCIMSettingsForOrgWSRequest" } } } @@ -26956,21 +28410,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsV2WSResponse" + "$ref" : "#/components/schemas/Org_FindSCIMSettingsForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update SAML settings V2", + "summary" : "Find SCIM settings for organization", "tags" : [ "Org Webservice" ] } }, - "/api/org/updateSCIMSettingsForOrg" : { + "/api/org/generateFederatedSessionToken" : { "post" : { - "description" : "Update SCIM configuration for organization", - "operationId" : "updateSCIMSettingsForOrg", + "description" : "Generate a federated session token login for organization", + "operationId" : "generateFederatedSessionToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -26987,7 +28441,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateSCIMSettingsForOrgWSRequest" + "$ref" : "#/components/schemas/Org_GenerateFederatedSessionTokenRequest" } } } @@ -26997,21 +28451,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_UpdateSCIMSettingsForOrgWSResponse" + "$ref" : "#/components/schemas/Org_GenerateFederatedSessionTokenResponse" } } }, "description" : "OK" } }, - "summary" : "Update SCIM settings for organization", + "summary" : "Generate federated session token", "tags" : [ "Org Webservice" ] } }, - "/api/partner/createPartnerClient" : { + "/api/org/getClientOrg" : { "post" : { - "description" : "Create a client account", - "operationId" : "createPartnerClient", + "description" : "Get details about the client organization", + "operationId" : "getClientOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "partner-api-token", @@ -27028,7 +28482,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_CreatePartnerClientWSRequest" + "$ref" : "#/components/schemas/Org_GetClientOrgWSRequest" } } } @@ -27038,30 +28492,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_CreatePartnerClientWSResponse" + "$ref" : "#/components/schemas/Org_GetClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create partner client", - "tags" : [ "Partner Webservice" ] + "summary" : "Get client organization details", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/customizeClient" : { + "/api/org/getCloudArchivingConfigs" : { "post" : { - "description" : "Customize a client account", - "operationId" : "customizeClient", + "description" : "Get scoped cloud archiving configs. Note that the priority of scoping is Org > Location > Device", + "operationId" : "getCloudArchivingConfigs", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27069,7 +28523,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_CustomizeClientWSRequest" + "$ref" : "#/components/schemas/Org_GetCloudArchivingConfigsWSRequest" } } } @@ -27079,30 +28533,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_CustomizeClientWSResponse" + "$ref" : "#/components/schemas/Org_GetCloudArchivingConfigsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Customize client", - "tags" : [ "Partner Webservice" ] + "summary" : "Get cloud archiving configs", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/customizeClientDevice" : { + "/api/org/getFeatures" : { "post" : { - "description" : "Customize a client device", - "operationId" : "customizeClientDevice", + "description" : "Get organization wide features", + "operationId" : "getFeatures", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27110,7 +28564,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_CustomizeClientDeviceWSRequest" + "$ref" : "#/components/schemas/Org_GetFeaturesWSRequest" } } } @@ -27120,30 +28574,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_CustomizeClientDeviceWSResponse" + "$ref" : "#/components/schemas/Org_GetFeaturesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Customize client device", - "tags" : [ "Partner Webservice" ] + "summary" : "Get organization features", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/deleteClient" : { + "/api/org/getHealthNotificationRules" : { "post" : { - "description" : "Delete a client account", - "operationId" : "deletePartnerClient", + "description" : "Get all time/size-based health notification rules for the organization", + "operationId" : "getHealthNotificationRules", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27151,7 +28605,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_DeleteClientWebRequest" + "$ref" : "#/components/schemas/Org_GetHealthNotificationRulesWSRequest" } } } @@ -27161,31 +28615,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_DeleteClientWebResponse" + "$ref" : "#/components/schemas/Org_GetHealthNotificationRulesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete partner client", - "tags" : [ "Partner Webservice" ] + "summary" : "Get health notification rules", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getApiTokenApplications" : { + "/api/org/getOrg" : { "post" : { "deprecated" : true, - "description" : "Get details of all open api token requests for organization", - "operationId" : "partner_getApiTokenApplications", + "description" : "Get details about organization", + "operationId" : "getOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27193,7 +28647,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSRequest" + "$ref" : "#/components/schemas/Org_GetOrgWSRequest" } } } @@ -27203,30 +28657,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSResponse" + "$ref" : "#/components/schemas/Org_GetOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get API token applications", - "tags" : [ "Partner Webservice" ] + "summary" : "Get organization details", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getApiTokens" : { + "/api/org/getOrgIntegrations" : { "post" : { - "description" : "Get list of all api tokens for a partner", - "operationId" : "partner_getApiTokens", + "deprecated" : true, + "description" : "Use endpoints in Integrations Webservice instead", + "operationId" : "DEPRECATED_getOrgIntegrations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27234,7 +28689,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetPartnerApiTokensWSRequest" + "$ref" : "#/components/schemas/Org_GetOrgIntegrationsWSRequest" } } } @@ -27244,30 +28699,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" + "$ref" : "#/components/schemas/Org_GetOrgIntegrationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get API tokens", - "tags" : [ "Partner Webservice" ] + "summary" : "Get organization integrations", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getClientDevices" : { + "/api/org/getOrgNotificationTemplate" : { "post" : { - "description" : "Retrieve a list of devices for a specific client.", - "operationId" : "getClientDevices", + "deprecated" : true, + "description" : "This endpoint is no longer in use. Please use getOrgNotificationTemplateV2 instead.", + "operationId" : "getOrgNotificationTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27275,7 +28731,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetClientDevicesWSRequest" + "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSRequest" } } } @@ -27285,30 +28741,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetClientDevicesWSResponse" + "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get client devices", - "tags" : [ "Partner Webservice" ] + "summary" : "Get organization notification template", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getClientStatusMap" : { + "/api/org/getOrgNotificationTemplateV2" : { "post" : { - "description" : "Get a map of all client accounts to device and location info", - "operationId" : "getPartnerClientsStatusMap", + "description" : "Get organization's default notification schedule template", + "operationId" : "getOrgNotificationTemplateV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27316,7 +28772,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerClientsStatusMapWSRequest" + "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateWSRequest" } } } @@ -27326,30 +28782,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerClientsStatusMapWSResponse" + "$ref" : "#/components/schemas/Org_GetOrgNotificationTemplateV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get client status map", - "tags" : [ "Partner Webservice" ] + "summary" : "Get organization notification template V2", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getClientSummaryInfo" : { + "/api/org/getOrgV2" : { "post" : { - "description" : "Get information about a client", - "operationId" : "getClientSummaryInfo", + "description" : "Get details about organization", + "operationId" : "getOrgV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27357,7 +28813,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetClientSummaryInfoWSRequest" + "$ref" : "#/components/schemas/Org_GetOrgV2WSRequest" } } } @@ -27367,30 +28823,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetClientSummaryInfoWSResponse" + "$ref" : "#/components/schemas/Org_GetOrgV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get client summary info", - "tags" : [ "Partner Webservice" ] + "summary" : "Get organization details V2", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getClients" : { + "/api/org/getSAMLSettings" : { "post" : { - "description" : "Get a list of all client accounts", - "operationId" : "getPartnerClients", + "deprecated" : true, + "description" : "Deprecated. Use getSAMLSettingsV2", + "operationId" : "getSAMLSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27398,7 +28855,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSRequest" + "$ref" : "#/components/schemas/Org_GetSAMLSettingsWSRequest" } } } @@ -27408,30 +28865,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSResponse" + "$ref" : "#/components/schemas/Org_GetSAMLSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get partner clients", - "tags" : [ "Partner Webservice" ] + "summary" : "Get SAML settings", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getClientsV2" : { + "/api/org/getSAMLSettingsV2" : { "post" : { - "description" : "Get a list of all client accounts. NOTICE: This is the same as getPartnerClients, but only returns the basic info so partners can login to clients quickly. The other info will be returned by getPartnerClientsStatusMap.", - "operationId" : "getPartnerClientsV2", + "description" : "Get details about organization", + "operationId" : "getSAMLSettingsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27439,7 +28896,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSRequest" + "$ref" : "#/components/schemas/Org_GetSAMLSettingsV2WSRequest" } } } @@ -27449,73 +28906,62 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSResponse" + "$ref" : "#/components/schemas/Org_GetSAMLSettingsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get partner clients V2", - "tags" : [ "Partner Webservice" ] + "summary" : "Get SAML settings V2", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getDeviceLicensesForOrg" : { + "/api/org/getScimDisplayInfo" : { "post" : { - "deprecated" : true, - "description" : "Get a list of licenses available for a client organization", - "operationId" : "getDeviceLicensesForOrg", + "description" : "Get SCIM display info for organization", + "operationId" : "getScimDisplayInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest" - } - } - } - }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse" + "$ref" : "#/components/schemas/Org_GetScimDisplayInfoResponse" } } }, "description" : "OK" } }, - "summary" : "Get device licenses for organization", - "tags" : [ "Partner Webservice" ] + "summary" : "Get SCIM display info", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getLicensesForOrg" : { + "/api/org/getTemporaryOrgToken" : { "post" : { - "deprecated" : true, - "description" : "Get a list of licenses available for a client organization", - "operationId" : "getLicensesForOrg", + "description" : "Generate a temporary org token for use in OAuth flows", + "operationId" : "getTemporaryOrgToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27523,7 +28969,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSRequest" + "$ref" : "#/components/schemas/Org_GetTemporaryOrgTokenWSRequest" } } } @@ -27533,30 +28979,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSResponse" + "$ref" : "#/components/schemas/GetTemporaryOrgTokenResponse" } } }, "description" : "OK" } }, - "summary" : "Get licenses for organization", - "tags" : [ "Partner Webservice" ] + "summary" : "Get temporary org token", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getListOfAllClientDevices" : { + "/api/org/peekShipmentRegistrationToken" : { "post" : { - "description" : "Retrieve list of all devices registered across all clients", - "operationId" : "getListOfAllClientDevices", + "description" : "Peek at a shipping registration token for an organization", + "operationId" : "peekShipmentRegistrationToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27564,7 +29010,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetListOfAllClientDevicesRequest" + "$ref" : "#/components/schemas/Org_PeekShipmentRegistrationTokenWSRequest" } } } @@ -27574,30 +29020,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetListOfAllClientDevicesResponse" + "$ref" : "#/components/schemas/Org_PeekShipmentRegistrationTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of all client devices", - "tags" : [ "Partner Webservice" ] + "summary" : "Peek shipment registration token", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getListOfAvailableHardware" : { + "/api/org/removePendingRegistration" : { "post" : { - "description" : "Retrieve a list of hardware available for remote registration. Any hardware originally registered by a Partner is available for re-registration after being removed from an active client account.", - "operationId" : "getListOfControlledHardware", + "description" : "Remove a pending registration", + "operationId" : "removePendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27605,7 +29051,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetListOfControlledHardwareRequest" + "$ref" : "#/components/schemas/Org_RemovePendingRegistrationRequest" } } } @@ -27615,30 +29061,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetListOfControlledHardwareResponse" + "$ref" : "#/components/schemas/Org_RemovePendingRegistrationResponse" } } }, "description" : "OK" } }, - "summary" : "Get list of available hardware", - "tags" : [ "Partner Webservice" ] + "summary" : "Remove pending registration", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/getShipments" : { + "/api/org/revokeSCIMAccessForOrg" : { "post" : { - "description" : "Get client shipments", - "operationId" : "PartnerGetShipments", + "description" : "Revoke SCIM access for organization", + "operationId" : "revokeSCIMAccessForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27646,7 +29092,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetShipmentsWSRequest" + "$ref" : "#/components/schemas/Org_RevokeSCIMAccessForOrgWSRequest" } } } @@ -27656,30 +29102,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetShipmentsWSResponse" + "$ref" : "#/components/schemas/Org_RevokeSCIMAccessForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get client shipments", - "tags" : [ "Partner Webservice" ] + "summary" : "Revoke SCIM access for organization", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/reassignDeviceOrg" : { + "/api/org/setupSCIMAccessForOrg" : { "post" : { - "description" : "Reassign device(s) to a different organization. Only devices which hardware is controlled by the partner can be reassigned", - "operationId" : "reassignDeviceOrg", + "description" : "Initially configure SCIM access for organization", + "operationId" : "setupSCIMAccessForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27687,7 +29133,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_ReassignDeviceOrgWSRequest" + "$ref" : "#/components/schemas/Org_SetupSCIMAccessForOrgWSRequest" } } } @@ -27697,30 +29143,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_ReassignDeviceOrgWSResponse" + "$ref" : "#/components/schemas/Org_SetupSCIMAccessForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Reassign device organization", - "tags" : [ "Partner Webservice" ] + "summary" : "Setup SCIM access for organization", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/registerCameraToClient" : { + "/api/org/updateAiTrainingSettings" : { "post" : { - "description" : "Register a controlled camera to a client", - "operationId" : "registerCameraToClient", + "description" : "Update organization AI training settings", + "operationId" : "updateAiTrainingSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27728,7 +29174,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_CreatePendingRegistrationRequest" + "$ref" : "#/components/schemas/Org_UpdateAiTrainingSettingsWSRequest" } } } @@ -27738,30 +29184,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Org_CreatePendingRegistrationResponse" + "$ref" : "#/components/schemas/Org_UpdateAiTrainingSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Register camera to client", - "tags" : [ "Partner Webservice" ] + "summary" : "Update AI training settings", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/registerDeal" : { + "/api/org/updateCloudArchivingConfig" : { "post" : { - "description" : "Register a deal", - "operationId" : "registerDeal", + "description" : "Update scoped cloud archiving config. Note that the priority of scoping is Org > Location > Device", + "operationId" : "updateCloudArchivingConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27769,7 +29215,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_RegisterDealWSRequest" + "$ref" : "#/components/schemas/Org_UpdateCloudArchivingConfigWSRequest" } } } @@ -27779,30 +29225,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_RegisterDealWSResponse" + "$ref" : "#/components/schemas/Org_UpdateCloudArchivingConfigWSResponse" } } }, "description" : "OK" } }, - "summary" : "Register deal", - "tags" : [ "Partner Webservice" ] + "summary" : "Update cloud archiving config", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/revokeApiToken" : { + "/api/org/updateDataRetentionSettings" : { "post" : { - "description" : "Remove an api token from organization. Note: this is irreversible", - "operationId" : "partner_revokeApiToken", + "description" : "Update org-level retention (in days) for face events and license plate events, covering both the event metadata and the associated image data. Face values must be between 1 and 730 days; license plate values between 1 and 365 days (orgs grandfathered on the legacy 2-year value may resend it unchanged, but cannot return to it once changed). A null value resets that data class to the platform default.", + "operationId" : "updateDataRetentionSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27810,7 +29256,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" + "$ref" : "#/components/schemas/Org_UpdateDataRetentionSettingsWSRequest" } } } @@ -27820,30 +29266,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" + "$ref" : "#/components/schemas/Org_UpdateDataRetentionSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Revoke API token", - "tags" : [ "Partner Webservice" ] + "summary" : "Update organization data retention settings", + "tags" : [ "Org Webservice" ] } }, - "/api/partner/updateSendLicenseExpirationEmail" : { + "/api/org/updateFirmwareSettings" : { "post" : { - "description" : "Update send license expiration email feature flag by org", - "operationId" : "updateManuallySendLicenseExpirationEmail", + "description" : "Update organization firmware schedule settings", + "operationId" : "updateFirmwareSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27851,7 +29297,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSRequest" + "$ref" : "#/components/schemas/Org_UpdateFirmwareSettingsWSRequest" } } } @@ -27861,30 +29307,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSResponse" + "$ref" : "#/components/schemas/Org_UpdateFirmwareSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update send license expiration email", - "tags" : [ "Partner Webservice" ] + "summary" : "Update firmware settings", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/createPartnerPermissionGroup" : { + "/api/org/updateGeneralSettings" : { "post" : { - "description" : "Create a permission group", - "operationId" : "createPartnerPermissionGroup", + "description" : "Update organization General settings", + "operationId" : "updateGeneralSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27892,7 +29338,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_CreatePartnerPermissionGroupWSRequest" + "$ref" : "#/components/schemas/Org_UpdateGeneralSettingsWSRequest" } } } @@ -27902,21 +29348,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_CreatePartnerPermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdateGeneralSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create partner permission group", - "tags" : [ "Permission Webservice" ] + "summary" : "Update general settings", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/createPermissionGroup" : { + "/api/org/updateLoginIpAllowlist" : { "post" : { - "description" : "Create a permission group", - "operationId" : "createPermissionGroup", + "description" : "Update the org-wide login IP allowlist that users flagged with restrictToAllowedLoginIps are limited to", + "operationId" : "updateLoginIpAllowlist", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -27933,7 +29379,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_CreatePermissionGroupWSRequest" + "$ref" : "#/components/schemas/Org_UpdateLoginIpAllowlistWSRequest" } } } @@ -27943,30 +29389,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_CreatePermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdateLoginIpAllowlistWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create permission group", - "tags" : [ "Permission Webservice" ] + "summary" : "Update login IP allowlist", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/deletePartnerPermissionGroup" : { + "/api/org/updateMFASettings" : { "post" : { - "description" : "Delete a permission group", - "operationId" : "deletePartnerPermissionGroup", + "description" : "Update organization MFA settings", + "operationId" : "updateMFASettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -27974,7 +29420,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_DeletePartnerPermissionGroupWSRequest" + "$ref" : "#/components/schemas/Org_UpdateMFASettingsWSRequest" } } } @@ -27984,21 +29430,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_DeletePartnerPermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdateMFASettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete partner permission group", - "tags" : [ "Permission Webservice" ] + "summary" : "Update MFA settings", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/deletePermissionGroup" : { + "/api/org/updateOrg" : { "post" : { - "description" : "Delete a permission group", - "operationId" : "deletePermissionGroup", + "deprecated" : true, + "description" : "Update organization details", + "operationId" : "updateOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28015,7 +29462,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_DeletePermissionGroupWSRequest" + "$ref" : "#/components/schemas/Org_UpdateOrgWSRequest" } } } @@ -28025,21 +29472,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_DeletePermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdateOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete permission group", - "tags" : [ "Permission Webservice" ] + "summary" : "Update organization details", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/getPartnerPermissionGroups" : { + "/api/org/updateOrgAudioAnalysisPolicy" : { "post" : { - "description" : "Get partner permission groups for the organization", - "operationId" : "getPartnerPermissionGroups", + "description" : "Update organization AI audio analysis policy", + "operationId" : "updateOrgAudioAnalysisPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28056,7 +29503,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPartnerPermissionGroupsWSRequest" + "$ref" : "#/components/schemas/Org_UpdateOrgAudioAnalysisPolicyWSRequest" } } } @@ -28066,21 +29513,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPartnerPermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdateOrgAudioAnalysisPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get partner permission groups", - "tags" : [ "Permission Webservice" ] + "summary" : "Update organization AI audio analysis policy", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/getPermissionGroups" : { + "/api/org/updateOrgAudioRecordingPolicy" : { "post" : { - "description" : "Get details about all permission groups in organization", - "operationId" : "getPermissionGroups", + "description" : "Update organization audio recording policy", + "operationId" : "updateOrgAudioRecordingPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28097,7 +29544,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPermissionGroupsWSRequest" + "$ref" : "#/components/schemas/Org_UpdateOrgAudioRecordingPolicyWSRequest" } } } @@ -28107,21 +29554,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPermissionGroupsWSResponse" + "$ref" : "#/components/schemas/Org_UpdateOrgAudioRecordingPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get permission groups", - "tags" : [ "Permission Webservice" ] + "summary" : "Update organization audio recording policy", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/getPermissionsForCurrentPartner" : { + "/api/org/updateOrgLLMUsagePolicy" : { "post" : { - "description" : "Get permissions for the current partner user", - "operationId" : "getPermissionsForCurrentPartner", + "description" : "Update organization's LLM usage opt-in policy", + "operationId" : "updateOrgLLMUsagePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28138,7 +29585,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentPartnerWSRequest" + "$ref" : "#/components/schemas/Org_UpdateOrgLLMUsagePolicyWSRequest" } } } @@ -28148,21 +29595,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentPartnerWSResponse" + "$ref" : "#/components/schemas/Org_UpdateOrgLLMUsagePolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get permissions for current partner", - "tags" : [ "Permission Webservice" ] + "summary" : "Update organization's LLM usage opt-in policy", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/getPermissionsForCurrentUser" : { + "/api/org/updateOrgNotificationTemplate" : { "post" : { - "description" : "Get device and functionality permissions for user or API token", - "operationId" : "getPermissionsForCurrentUser", + "deprecated" : true, + "description" : "This endpoint is no longer in use. Please use updateOrgNotificationTemplateV2 instead.", + "operationId" : "updateOrgNotificationTemplate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28179,7 +29627,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentUserWSRequest" + "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateWSRequest" } } } @@ -28189,21 +29637,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentUserWSResponse" + "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get permissions for current user", - "tags" : [ "Permission Webservice" ] + "summary" : "Update organization notification template", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/updatePartnerPermissionGroup" : { + "/api/org/updateOrgNotificationTemplateV2" : { "post" : { - "description" : "Update a partner permission group", - "operationId" : "updatePartnerPermissionGroup", + "description" : "Update default notification schedule template for newly created Users in Org", + "operationId" : "updateOrgNotificationTemplateV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28220,7 +29668,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_UpdatePartnerPermissionGroupWSRequest" + "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateV2WSRequest" } } } @@ -28230,21 +29678,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_UpdatePartnerPermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdateOrgNotificationTemplateV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Update partner permission group", - "tags" : [ "Permission Webservice" ] + "summary" : "Update organization notification template V2", + "tags" : [ "Org Webservice" ] } }, - "/api/permission/updatePermissionGroup" : { + "/api/org/updatePaneLinks" : { "post" : { - "description" : "Update a permission group", - "operationId" : "updatePermissionGroup", + "description" : "Replace the set of PANE proof-of-concept apps surfaced in this organization's console navigation. Send the complete set; an empty list removes them all.", + "operationId" : "updatePaneLinks", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28261,7 +29709,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_UpdatePermissionGroupWSRequest" + "$ref" : "#/components/schemas/Org_UpdatePaneLinksWSRequest" } } } @@ -28271,21 +29719,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Permission_UpdatePermissionGroupWSResponse" + "$ref" : "#/components/schemas/Org_UpdatePaneLinksWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update permission group", - "tags" : [ "Permission Webservice" ] + "summary" : "Update the PANE apps this org links", + "tags" : [ "Org Webservice" ] } }, - "/api/policy/createAccessControlledDoorPolicy" : { + "/api/org/updatePendingRegistration" : { "post" : { - "description" : "Create a policy to be assigned to a access controlled door", - "operationId" : "createAccessControlledDoorPolicy", + "description" : "Update pending registration for hardware", + "operationId" : "updatePendingRegistration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28302,7 +29750,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateAccessControlledDoorPolicyWSRequest" + "$ref" : "#/components/schemas/Org_UpdatePendingRegistrationRequest" } } } @@ -28312,21 +29760,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateAccessControlledDoorPolicyWSResponse" + "$ref" : "#/components/schemas/Org_UpdatePendingRegistrationResponse" } } }, "description" : "OK" } }, - "summary" : "Create access controlled door policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Update pending registration", + "tags" : [ "Org Webservice" ] } }, - "/api/policy/createAudioPolicy" : { + "/api/org/updateSAMLSettings" : { "post" : { - "description" : "Create a policy to be assigned to audio gateways", - "operationId" : "createAudioPolicy", + "deprecated" : true, + "description" : "Deprecated. Use updateSAMLSettingsV2", + "operationId" : "updateSAMLSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28343,7 +29792,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateAudioPolicyWSRequest" + "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsWSRequest" } } } @@ -28353,21 +29802,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateAudioPolicyWSResponse" + "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create audio policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Update SAML settings", + "tags" : [ "Org Webservice" ] } }, - "/api/policy/createCameraPolicy" : { + "/api/org/updateSAMLSettingsV2" : { "post" : { - "description" : "Create a policy to be assigned to cameras", - "operationId" : "createCameraPolicy", + "description" : "Update organization SAML settings", + "operationId" : "updateSAMLSettingsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28384,7 +29833,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateCameraPolicyWSRequest" + "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsV2WSRequest" } } } @@ -28394,21 +29843,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateCameraPolicyWSResponse" + "$ref" : "#/components/schemas/Org_UpdateSAMLSettingsV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Create camera policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Update SAML settings V2", + "tags" : [ "Org Webservice" ] } }, - "/api/policy/createClimatePolicy" : { + "/api/org/updateSCIMSettingsForOrg" : { "post" : { - "description" : "Create a policy to be assigned to a climate sensor", - "operationId" : "createClimatePolicy", + "description" : "Update SCIM configuration for organization", + "operationId" : "updateSCIMSettingsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -28425,7 +29874,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateClimatePolicyWSRequest" + "$ref" : "#/components/schemas/Org_UpdateSCIMSettingsForOrgWSRequest" } } } @@ -28435,30 +29884,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateClimatePolicyWSResponse" + "$ref" : "#/components/schemas/Org_UpdateSCIMSettingsForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create climate policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Update SCIM settings for organization", + "tags" : [ "Org Webservice" ] } }, - "/api/policy/createDoorPolicy" : { + "/api/partner/createPartnerClient" : { "post" : { - "description" : "Create a policy to be assigned to a door sensor", - "operationId" : "createDoorPolicy", + "description" : "Create a client account", + "operationId" : "createPartnerClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28466,7 +29915,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateDoorPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_CreatePartnerClientWSRequest" } } } @@ -28476,30 +29925,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateDoorPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_CreatePartnerClientWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create door policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Create partner client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/createOccupancyPolicy" : { + "/api/partner/customizeClient" : { "post" : { - "description" : "Create a policy to be assigned to a occupancy sensor", - "operationId" : "createOccupancyPolicy", + "description" : "Customize a client account", + "operationId" : "customizeClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28507,7 +29956,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateOccupancyPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_CustomizeClientWSRequest" } } } @@ -28517,30 +29966,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateOccupancyPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_CustomizeClientWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create occupancy policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Customize client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/createPolicyAddendumForLocation" : { + "/api/partner/customizeClientDevice" : { "post" : { - "description" : "Create policy addendum for location", - "operationId" : "createPolicyAddendumForLocation", + "description" : "Customize a client device", + "operationId" : "customizeClientDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28548,7 +29997,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumForLocationRequest" + "$ref" : "#/components/schemas/Partner_CustomizeClientDeviceWSRequest" } } } @@ -28558,30 +30007,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumForLocationResponse" + "$ref" : "#/components/schemas/Partner_CustomizeClientDeviceWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create policy addendum for location", - "tags" : [ "Policy Webservice" ] + "summary" : "Customize client device", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/createPolicyAddendumsForDevices" : { + "/api/partner/deactivateClient" : { "post" : { - "description" : "Create policy addendums for devices", - "operationId" : "createPolicyAddendumsForDevices", + "description" : "MSP only. Soft-deletes a managed client org after a typed name confirmation. Refused while devices are registered or MSP-owned licenses are assigned; unassigned pooled licenses are reclaimed first; every session in the client org is ended; the MSP's authority row is kept so the org can be restored by Rhombus.", + "operationId" : "deactivateClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28589,7 +30038,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumsForDevicesRequest" + "$ref" : "#/components/schemas/Partner_msp_DeactivateClientWSRequest" } } } @@ -28599,30 +30048,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumsForDevicesResponse" + "$ref" : "#/components/schemas/Partner_msp_DeactivateClientWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create policy addendums for devices", - "tags" : [ "Policy Webservice" ] + "summary" : "Deactivate managed client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/createProximityPolicy" : { + "/api/partner/deleteClient" : { "post" : { - "description" : "Create a policy to be assigned to an asset tag", - "operationId" : "createProximityPolicy", + "description" : "Delete a client account", + "operationId" : "deletePartnerClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28630,7 +30079,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateProximityPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_DeleteClientWebRequest" } } } @@ -28640,30 +30089,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateProximityPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_DeleteClientWebResponse" } } }, "description" : "OK" } }, - "summary" : "Create proximity policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Delete partner client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/createSchedule" : { + "/api/partner/getApiTokenApplications" : { "post" : { - "description" : "Create a schedule to be used for policy creation", - "operationId" : "createSchedule", + "deprecated" : true, + "description" : "Get details of all open api token requests for organization", + "operationId" : "partner_getApiTokenApplications", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28671,7 +30121,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateScheduleWSRequest" + "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSRequest" } } } @@ -28681,30 +30131,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateScheduleWSResponse" + "$ref" : "#/components/schemas/Integration_GetApiTokenApplicationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create schedule", - "tags" : [ "Policy Webservice" ] + "summary" : "Get API token applications", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/createVideoIntercomPolicy" : { + "/api/partner/getApiTokens" : { "post" : { - "description" : "Create a video intercom policy", - "operationId" : "createVideoIntercomPolicy", + "description" : "Get list of all api tokens for a partner", + "operationId" : "partner_getApiTokens", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28712,7 +30162,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateVideoIntercomPolicyWSRequest" + "$ref" : "#/components/schemas/Integration_GetPartnerApiTokensWSRequest" } } } @@ -28722,30 +30172,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_CreateVideoIntercomPolicyWSResponse" + "$ref" : "#/components/schemas/Integration_GetApiTokensWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create video intercom policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get API tokens", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteAccessControlledDoorPolicy" : { + "/api/partner/getClaimKeysForPartnerOrg" : { "post" : { - "description" : "Delete an access controlled door policy", - "operationId" : "deleteAccessControlledDoorPolicy", + "description" : "Get the claim keys associated with the authenticated partner organization", + "operationId" : "getClaimKeysForPartnerOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28753,7 +30203,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteAccessControlledDoorPolicyWSRequest" + "$ref" : "#/components/schemas/License_claimkey_GetClaimKeysForPartnerOrgWSRequest" } } } @@ -28763,30 +30213,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteAccessControlledDoorPolicyWSResponse" + "$ref" : "#/components/schemas/License_claimkey_GetClaimKeysForPartnerOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete access controlled door policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get claim keys for partner organization", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteAudioPolicy" : { + "/api/partner/getClientDevices" : { "post" : { - "description" : "Delete a audio gateway policy", - "operationId" : "deleteAudioPolicy", + "description" : "Retrieve a list of devices for a specific client.", + "operationId" : "getClientDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28794,7 +30244,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteAudioPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_GetClientDevicesWSRequest" } } } @@ -28804,30 +30254,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteAudioPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_GetClientDevicesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete audio policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get client devices", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteCameraPolicy" : { + "/api/partner/getClientStatusMap" : { "post" : { - "description" : "Delete a camera policy", - "operationId" : "deleteCameraPolicy", + "description" : "Get a map of all client accounts to device and location info", + "operationId" : "getPartnerClientsStatusMap", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28835,7 +30285,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteCameraPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_GetPartnerClientsStatusMapWSRequest" } } } @@ -28845,30 +30295,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteCameraPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_GetPartnerClientsStatusMapWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete camera policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get client status map", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteClimatePolicy" : { + "/api/partner/getClientSummaryInfo" : { "post" : { - "description" : "Delete a climate policy", - "operationId" : "deleteClimatePolicy", + "description" : "Get information about a client", + "operationId" : "getClientSummaryInfo", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28876,7 +30326,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteClimatePolicyWSRequest" + "$ref" : "#/components/schemas/Partner_GetClientSummaryInfoWSRequest" } } } @@ -28886,30 +30336,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteClimatePolicyWSResponse" + "$ref" : "#/components/schemas/Partner_GetClientSummaryInfoWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete climate policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get client summary info", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteDevicePolicyAddendums" : { + "/api/partner/getClients" : { "post" : { - "description" : "Delete a policy addendums", - "operationId" : "deleteDevicePolicyAddendums", + "description" : "Get a list of all client accounts", + "operationId" : "getPartnerClients", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28917,7 +30367,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteDevicePolicyAddendumsWSRequest" + "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSRequest" } } } @@ -28927,30 +30377,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteDevicePolicyAddendumsWSResponse" + "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete device policy addendums", - "tags" : [ "Policy Webservice" ] + "summary" : "Get partner clients", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteDoorPolicy" : { + "/api/partner/getClientsV2" : { "post" : { - "description" : "Delete a door sensor policy", - "operationId" : "deleteDoorPolicy", + "description" : "Get a list of all client accounts. NOTICE: This is the same as getPartnerClients, but only returns the basic info so partners can login to clients quickly. The other info will be returned by getPartnerClientsStatusMap.", + "operationId" : "getPartnerClientsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28958,7 +30408,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteDoorPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSRequest" } } } @@ -28968,30 +30418,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteDoorPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_GetPartnerClientsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete door policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get partner clients V2", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteLocationPolicyAddendum" : { + "/api/partner/getDeviceLicensesForOrg" : { "post" : { - "description" : "Delete a policy addendums", - "operationId" : "deleteLocationPolicyAddendum", + "deprecated" : true, + "description" : "Get a list of licenses available for a client organization", + "operationId" : "getDeviceLicensesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -28999,7 +30450,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteLocationPolicyAddendumWSRequest" + "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSRequest" } } } @@ -29009,30 +30460,31 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteLocationPolicyAddendumWSResponse" + "$ref" : "#/components/schemas/License_GetDeviceLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete location policy addendum", - "tags" : [ "Policy Webservice" ] + "summary" : "Get device licenses for organization", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteOccupancyPolicy" : { + "/api/partner/getLicensesForOrg" : { "post" : { - "description" : "Delete an Occupancy policy", - "operationId" : "deleteOccupancyPolicy", + "deprecated" : true, + "description" : "Get a list of licenses available for a client organization", + "operationId" : "getLicensesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29040,7 +30492,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteOccupancyPolicyWSRequest" + "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSRequest" } } } @@ -29050,30 +30502,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteOccupancyPolicyWSResponse" + "$ref" : "#/components/schemas/License_GetLicensesForClientOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete occupancy policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get licenses for organization", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deletePolicyPauseSettingForComponentComposite" : { + "/api/partner/getListOfAllClientDevices" : { "post" : { - "description" : "Delete a policy pause setting for a component composite", - "operationId" : "deletePolicyPauseSettingForComponentComposite", + "description" : "Retrieve list of all devices registered across all clients", + "operationId" : "getListOfAllClientDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29081,7 +30533,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" + "$ref" : "#/components/schemas/Partner_GetListOfAllClientDevicesRequest" } } } @@ -29091,30 +30543,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" + "$ref" : "#/components/schemas/Partner_GetListOfAllClientDevicesResponse" } } }, "description" : "OK" } }, - "summary" : "Delete policy pause setting for component composite", - "tags" : [ "Policy Webservice" ] + "summary" : "Get list of all client devices", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deletePolicyPauseSettingForDevice" : { + "/api/partner/getListOfAvailableHardware" : { "post" : { - "description" : "Delete a policy pause setting for a device", - "operationId" : "deletePolicyPauseSettingForDevice", + "description" : "Retrieve a list of hardware available for remote registration. Any hardware originally registered by a Partner is available for re-registration after being removed from an active client account.", + "operationId" : "getListOfControlledHardware", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29122,7 +30574,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" + "$ref" : "#/components/schemas/Partner_GetListOfControlledHardwareRequest" } } } @@ -29132,30 +30584,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" + "$ref" : "#/components/schemas/Partner_GetListOfControlledHardwareResponse" } } }, "description" : "OK" } }, - "summary" : "Delete policy pause setting for device", - "tags" : [ "Policy Webservice" ] + "summary" : "Get list of available hardware", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deletePolicyPauseSettingForLocation" : { + "/api/partner/getPartnerOrgProfile" : { "post" : { - "description" : "Delete a policy pause setting for a location", - "operationId" : "deletePolicyPauseSettingForLocation", + "description" : "Whether the calling partner is a verified MSP (designation ACTIVE and signature valid), its designation status and the caller's partner functionalities.", + "operationId" : "getPartnerOrgProfile", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29163,7 +30615,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" + "$ref" : "#/components/schemas/Partner_msp_GetPartnerOrgProfileWSRequest" } } } @@ -29173,30 +30625,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" + "$ref" : "#/components/schemas/Partner_msp_GetPartnerOrgProfileWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete policy pause setting for location", - "tags" : [ "Policy Webservice" ] + "summary" : "Get partner org MSP profile", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteProximityPolicy" : { + "/api/partner/getShipments" : { "post" : { - "description" : "Delete an asset tag policy", - "operationId" : "deleteProximityPolicy", + "description" : "Get client shipments", + "operationId" : "PartnerGetShipments", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29204,7 +30656,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteProximityPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_GetShipmentsWSRequest" } } } @@ -29214,30 +30666,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteProximityPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_GetShipmentsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete proximity policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get client shipments", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteSchedule" : { + "/api/partner/hardware/getInventory" : { "post" : { - "description" : "Delete a schedule used for policy creation", - "operationId" : "deleteSchedule", + "description" : "MSP only. Every hardware unit under the MSP's PARTNER control with the org it is currently registered in, its device, license state and whether it is bound to an access-controlled door.", + "operationId" : "getHardwareInventory", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29245,7 +30697,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteScheduleWSRequest" + "$ref" : "#/components/schemas/Partner_msp_GetHardwareInventoryWSRequest" } } } @@ -29255,30 +30707,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteScheduleWSResponse" + "$ref" : "#/components/schemas/Partner_msp_GetHardwareInventoryWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete schedule", - "tags" : [ "Policy Webservice" ] + "summary" : "Get MSP hardware inventory", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/deleteVideoIntercomPolicy" : { + "/api/partner/hardware/moveToClient" : { "post" : { - "description" : "Delete a video intercom policy", - "operationId" : "deleteVideoIntercomPolicy", + "description" : "MSP only. Moves controlled devices from one managed client org to another (soft-delete in the source, pending registration in the target). Door-bound DC20 / DR40 / DR20 units are refused until unbound. Optionally moves an MSP-owned device license along. Per-serial results.", + "operationId" : "moveHardwareToClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29286,7 +30738,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteVideoIntercomPolicyWSRequest" + "$ref" : "#/components/schemas/Partner_msp_MoveHardwareToClientWSRequest" } } } @@ -29296,30 +30748,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteVideoIntercomPolicyWSResponse" + "$ref" : "#/components/schemas/Partner_msp_MoveHardwareToClientWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete video intercom policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Move controlled hardware to another managed client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/findSchedules" : { + "/api/partner/license/assignToClient" : { "post" : { - "description" : "Find all schedules in organization", - "operationId" : "findSchedules", + "description" : "MSP only. Moves N unassigned pool licenses of a product to a managed client org. Term dates are unchanged. Idempotent by requestId.", + "operationId" : "assignLicensesToClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29327,7 +30779,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_FindSchedulesWSRequest" + "$ref" : "#/components/schemas/Partner_msp_AssignLicensesToClientWSRequest" } } } @@ -29337,30 +30789,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_FindSchedulesWSResponse" + "$ref" : "#/components/schemas/Partner_msp_AssignLicensesToClientWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find schedules", - "tags" : [ "Policy Webservice" ] + "summary" : "Assign pool licenses to a managed client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getAccessControlledDoorPolicies" : { + "/api/partner/license/claimToPool" : { "post" : { - "description" : "Get details about all access controlled door policies in organization", - "operationId" : "getAccessControlledDoorPolicies", + "description" : "MSP only. Claims a key into the MSP's own org with the MSP recorded as owner, so the licenses can later be assigned to managed clients.", + "operationId" : "claimLicensesToPool", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29368,7 +30820,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetAccessControlledDoorPoliciesWSRequest" + "$ref" : "#/components/schemas/Partner_msp_ClaimLicensesToPoolWSRequest" } } } @@ -29378,30 +30830,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetAccessControlledDoorPoliciesWSResponse" + "$ref" : "#/components/schemas/Partner_msp_ClaimLicensesToPoolWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get access controlled door policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Claim licenses into the MSP pool", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getAudioPolicies" : { + "/api/partner/license/getClaimKeyByCode" : { "post" : { - "description" : "Get details about all audio gateway policies in organization", - "operationId" : "getAudioPolicies", + "description" : "MSP only. Looks up a claim key by code before claiming it into the pool. Same visibility rule as the customer-console getClaimKeyByCode: an unclaimed key, or one already claimed by the calling MSP org; a key claimed by any other org is refused.", + "operationId" : "getPoolClaimKeyByCode", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29409,7 +30861,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetAudioPoliciesWSRequest" + "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyByCodeWSRequest" } } } @@ -29419,30 +30871,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetAudioPoliciesWSResponse" + "$ref" : "#/components/schemas/License_claimkey_GetClaimKeyByCodeWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get audio policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Preview a claim key for the MSP pool", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getCameraPolicies" : { + "/api/partner/license/getPool" : { "post" : { - "description" : "Get details about all camera policies in organization", - "operationId" : "getCameraPolicies", + "description" : "MSP only. Per product: licenses owned by the MSP, how many sit unassigned in the pool, how many each managed client holds, and unclaimed keys.", + "operationId" : "getLicensePool", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29450,7 +30902,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetCameraPoliciesWSRequest" + "$ref" : "#/components/schemas/Partner_msp_GetLicensePoolWSRequest" } } } @@ -29460,30 +30912,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetCameraPoliciesWSResponse" + "$ref" : "#/components/schemas/Partner_msp_GetLicensePoolWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get camera policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Get MSP license pool", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getClimatePolicies" : { + "/api/partner/license/reclaimFromClient" : { "post" : { - "description" : "Get details about all climate policies in organization", - "operationId" : "getClimatePolicies", + "description" : "MSP only. Moves MSP-owned licenses held by a managed client back to the pool, optionally unassigning them from devices first. Idempotent by requestId.", + "operationId" : "reclaimLicensesFromClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29491,7 +30943,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetClimatePoliciesWSRequest" + "$ref" : "#/components/schemas/Partner_msp_ReclaimLicensesFromClientWSRequest" } } } @@ -29501,30 +30953,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetClimatePoliciesWSResponse" + "$ref" : "#/components/schemas/Partner_msp_ReclaimLicensesFromClientWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get climate policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Reclaim pool licenses from a managed client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getDoorPolicies" : { + "/api/partner/reassignDeviceOrg" : { "post" : { - "description" : "Get details about all door sensor policies in organization", - "operationId" : "getDoorPolicies", + "description" : "Reassign device(s) to a different organization. Only devices which hardware is controlled by the partner can be reassigned", + "operationId" : "reassignDeviceOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29532,7 +30984,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetDoorPoliciesWSRequest" + "$ref" : "#/components/schemas/Partner_ReassignDeviceOrgWSRequest" } } } @@ -29542,30 +30994,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetDoorPoliciesWSResponse" + "$ref" : "#/components/schemas/Partner_ReassignDeviceOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get door policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Reassign device organization", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getOccupancyPolicies" : { + "/api/partner/registerCameraToClient" : { "post" : { - "description" : "Get details about all occupancy policies in organization", - "operationId" : "getOccupancyPolicies", + "description" : "Register a controlled camera to a client", + "operationId" : "registerCameraToClient", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29573,7 +31025,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetOccupancyPoliciesWSRequest" + "$ref" : "#/components/schemas/Org_CreatePendingRegistrationRequest" } } } @@ -29583,30 +31035,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetOccupancyPoliciesWSResponse" + "$ref" : "#/components/schemas/Org_CreatePendingRegistrationResponse" } } }, "description" : "OK" } }, - "summary" : "Get occupancy policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Register camera to client", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getPoliciesUsingSchedule" : { + "/api/partner/registerDeal" : { "post" : { - "description" : "Get details about all climate policies in organization", - "operationId" : "getPoliciesUsingSchedule", + "description" : "Register a deal", + "operationId" : "registerDeal", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29614,7 +31066,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetPoliciesUsingScheduleWSRequest" + "$ref" : "#/components/schemas/Partner_RegisterDealWSRequest" } } } @@ -29624,30 +31076,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetPoliciesUsingScheduleWSResponse" + "$ref" : "#/components/schemas/Partner_RegisterDealWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get policies using schedule", - "tags" : [ "Policy Webservice" ] + "summary" : "Register deal", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getPolicyAddendums" : { + "/api/partner/revokeApiToken" : { "post" : { - "description" : "Get the current and planned policy alert addendums", - "operationId" : "getPolicyAddendums", + "description" : "Remove an api token from organization. Note: this is irreversible", + "operationId" : "partner_revokeApiToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29655,7 +31107,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetPolicyAddendumsWSRequest" + "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSRequest" } } } @@ -29665,30 +31117,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetPolicyAddendumsWSResponse" + "$ref" : "#/components/schemas/Integration_RevokeApiTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get policy addendums", - "tags" : [ "Policy Webservice" ] + "summary" : "Revoke API token", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getPolicyPauseSettings" : { + "/api/partner/updateManagedClientPolicy" : { "post" : { - "description" : "Get the current and planned policy alert pause details", - "operationId" : "getPolicyPauseSettings", + "description" : "MSP only. Sets the per-client policy on a managed org, currently whether client-org users may assign the Super Admin role.", + "operationId" : "updateManagedClientPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29696,7 +31148,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetPolicyPauseSettingsWSRequest" + "$ref" : "#/components/schemas/Partner_msp_UpdateManagedClientPolicyWSRequest" } } } @@ -29706,30 +31158,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetPolicyPauseSettingsWSResponse" + "$ref" : "#/components/schemas/Partner_msp_UpdateManagedClientPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get policy pause settings", - "tags" : [ "Policy Webservice" ] + "summary" : "Update managed client policy", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getProximityPolicies" : { + "/api/partner/updateSendLicenseExpirationEmail" : { "post" : { - "description" : "Get details about all asset tag policies in organization", - "operationId" : "getProximityPolicies", + "description" : "Update send license expiration email feature flag by org", + "operationId" : "updateManuallySendLicenseExpirationEmail", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29737,7 +31189,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetProximityPoliciesWSRequest" + "$ref" : "#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSRequest" } } } @@ -29747,30 +31199,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetProximityPoliciesWSResponse" + "$ref" : "#/components/schemas/Partner_UpdateManuallySendLicenseExpirationEmailWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get proximity policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Update send license expiration email", + "tags" : [ "Partner Webservice" ] } }, - "/api/policy/getVideoIntercomPolicies" : { + "/api/permission/createPartnerPermissionGroup" : { "post" : { - "description" : "Get details about all video intercom policies in organization", - "operationId" : "getVideoIntercomPolicies", + "description" : "Create a permission group", + "operationId" : "createPartnerPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29778,7 +31230,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetVideoIntercomPoliciesWSRequest" + "$ref" : "#/components/schemas/Permission_CreatePartnerPermissionGroupWSRequest" } } } @@ -29788,21 +31240,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_GetVideoIntercomPoliciesWSResponse" + "$ref" : "#/components/schemas/Permission_CreatePartnerPermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get video intercom policies", - "tags" : [ "Policy Webservice" ] + "summary" : "Create partner permission group", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/pauseAlertPolicyForComponentComposite" : { + "/api/permission/createPermissionGroup" : { "post" : { - "description" : "Pause alert policy for component composite", - "operationId" : "pauseAlertPolicyForComponentComposite", + "description" : "Create a permission group", + "operationId" : "createPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -29819,7 +31271,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_CreatePermissionGroupWSRequest" } } } @@ -29829,30 +31281,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_CreatePermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Pause alert policy for component composite", - "tags" : [ "Policy Webservice" ] + "summary" : "Create permission group", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/pauseAlertPolicyForDevice" : { + "/api/permission/deletePartnerPermissionGroup" : { "post" : { - "description" : "Pause alert policy for device", - "operationId" : "pauseAlertPolicyForDevice", + "description" : "Delete a permission group", + "operationId" : "deletePartnerPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "api-token", + "example" : "partner-api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "api-token", + "default" : "partner-api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -29860,7 +31312,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_DeletePartnerPermissionGroupWSRequest" } } } @@ -29870,21 +31322,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_DeletePartnerPermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Pause alert policy for device", - "tags" : [ "Policy Webservice" ] + "summary" : "Delete partner permission group", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/pauseAlertPolicyForLocation" : { + "/api/permission/deletePermissionGroup" : { "post" : { - "description" : "Pause alert policy for location", - "operationId" : "pauseAlertPolicyForLocation", + "description" : "Delete a permission group", + "operationId" : "deletePermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -29901,7 +31353,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_DeletePermissionGroupWSRequest" } } } @@ -29911,21 +31363,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_DeletePermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Pause alert policy for location", - "tags" : [ "Policy Webservice" ] + "summary" : "Delete permission group", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateAccessControlledDoorPolicy" : { + "/api/permission/getPartnerPermissionGroups" : { "post" : { - "description" : "Update an access controlled door policy", - "operationId" : "updateAccessControlledDoorPolicy", + "description" : "Get partner permission groups for the organization", + "operationId" : "getPartnerPermissionGroups", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -29942,7 +31394,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateAccessControlledDoorPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_GetPartnerPermissionGroupsWSRequest" } } } @@ -29952,21 +31404,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateAccessControlledDoorPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_GetPartnerPermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update access controlled door policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get partner permission groups", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateAudioPolicy" : { + "/api/permission/getPermissionGroups" : { "post" : { - "description" : "Update a audio gateway policy", - "operationId" : "updateAudioPolicy", + "description" : "Get details about all permission groups in organization", + "operationId" : "getPermissionGroups", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -29983,7 +31435,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateAudioPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_GetPermissionGroupsWSRequest" } } } @@ -29993,21 +31445,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateAudioPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_GetPermissionGroupsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update audio policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get permission groups", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateCameraPolicy" : { + "/api/permission/getPermissionsForCurrentPartner" : { "post" : { - "description" : "Update a camera policy", - "operationId" : "updateCameraPolicy", + "description" : "Get permissions for the current partner user", + "operationId" : "getPermissionsForCurrentPartner", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30024,7 +31476,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateCameraPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentPartnerWSRequest" } } } @@ -30034,21 +31486,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateCameraPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentPartnerWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update camera policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get permissions for current partner", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateClimatePolicy" : { + "/api/permission/getPermissionsForCurrentUser" : { "post" : { - "description" : "Update a climate policy", - "operationId" : "updateClimatePolicy", + "description" : "Get device and functionality permissions for user or API token", + "operationId" : "getPermissionsForCurrentUser", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30065,7 +31517,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateClimatePolicyWSRequest" + "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentUserWSRequest" } } } @@ -30075,21 +31527,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateClimatePolicyWSResponse" + "$ref" : "#/components/schemas/Permission_GetPermissionsForCurrentUserWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update climate policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Get permissions for current user", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateDoorPolicy" : { + "/api/permission/updatePartnerPermissionGroup" : { "post" : { - "description" : "Update a door sensor policy", - "operationId" : "updateDoorPolicy", + "description" : "Update a partner permission group", + "operationId" : "updatePartnerPermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30106,7 +31558,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateDoorPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_UpdatePartnerPermissionGroupWSRequest" } } } @@ -30116,21 +31568,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateDoorPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_UpdatePartnerPermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update door policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Update partner permission group", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateOccupancyPolicy" : { + "/api/permission/updatePermissionGroup" : { "post" : { - "description" : "Update an occupancy policy", - "operationId" : "updateOccupancyPolicy", + "description" : "Update a permission group", + "operationId" : "updatePermissionGroup", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30147,7 +31599,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateOccupancyPolicyWSRequest" + "$ref" : "#/components/schemas/Permission_UpdatePermissionGroupWSRequest" } } } @@ -30157,21 +31609,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateOccupancyPolicyWSResponse" + "$ref" : "#/components/schemas/Permission_UpdatePermissionGroupWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update occupancy policy", - "tags" : [ "Policy Webservice" ] + "summary" : "Update permission group", + "tags" : [ "Permission Webservice" ] } }, - "/api/policy/updateProximityPolicy" : { + "/api/policy/createAccessControlledDoorPolicy" : { "post" : { - "description" : "Update an asset tag policy", - "operationId" : "updateProximityPolicy", + "description" : "Create a policy to be assigned to a access controlled door", + "operationId" : "createAccessControlledDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30188,7 +31640,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateProximityPolicyWSRequest" + "$ref" : "#/components/schemas/Policy_CreateAccessControlledDoorPolicyWSRequest" } } } @@ -30198,21 +31650,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateProximityPolicyWSResponse" + "$ref" : "#/components/schemas/Policy_CreateAccessControlledDoorPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update proximity policy", + "summary" : "Create access controlled door policy", "tags" : [ "Policy Webservice" ] } }, - "/api/policy/updateSchedule" : { + "/api/policy/createAudioPolicy" : { "post" : { - "description" : "Update a schedule to be used for policy creation", - "operationId" : "updateSchedule", + "description" : "Create a policy to be assigned to audio gateways", + "operationId" : "createAudioPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30229,7 +31681,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateScheduleWSRequest" + "$ref" : "#/components/schemas/Policy_CreateAudioPolicyWSRequest" } } } @@ -30239,21 +31691,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateScheduleWSResponse" + "$ref" : "#/components/schemas/Policy_CreateAudioPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update schedule", + "summary" : "Create audio policy", "tags" : [ "Policy Webservice" ] } }, - "/api/policy/updateVideoIntercomPolicy" : { + "/api/policy/createCameraPolicy" : { "post" : { - "description" : "Update video intercom policy", - "operationId" : "updateVideoIntercomPolicy", + "description" : "Create a policy to be assigned to cameras", + "operationId" : "createCameraPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30270,7 +31722,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateVideoIntercomPolicyWSRequest" + "$ref" : "#/components/schemas/Policy_CreateCameraPolicyWSRequest" } } } @@ -30280,21 +31732,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_UpdateVideoIntercomPolicyWSResponse" + "$ref" : "#/components/schemas/Policy_CreateCameraPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update video intercom policy", + "summary" : "Create camera policy", "tags" : [ "Policy Webservice" ] } }, - "/api/proximity/getLocomotionEventsForTag" : { + "/api/policy/createClimatePolicy" : { "post" : { - "description" : "Get locomotion events for specified proximity tag", - "operationId" : "getLocomotionEventsForTag", + "description" : "Create a policy to be assigned to a climate sensor", + "operationId" : "createClimatePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30311,7 +31763,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_GetLocomotionEventsForTagWSRequest" + "$ref" : "#/components/schemas/Policy_CreateClimatePolicyWSRequest" } } } @@ -30321,21 +31773,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_GetLocomotionEventsForTagWSResponse" + "$ref" : "#/components/schemas/Policy_CreateClimatePolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get locomotion events for tag", - "tags" : [ "Proximity Webservice" ] + "summary" : "Create climate policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/proximity/getMinimalProximityStateList" : { + "/api/policy/createDoorPolicy" : { "post" : { - "description" : "Get basic state information about all proximity tags in organization", - "operationId" : "getMinimalProximityStateList", + "description" : "Create a policy to be assigned to a door sensor", + "operationId" : "createDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30352,7 +31804,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_GetMinimalProximityStatesWSRequest" + "$ref" : "#/components/schemas/Policy_CreateDoorPolicyWSRequest" } } } @@ -30362,21 +31814,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_GetMinimalProximityStatesWSResponse" + "$ref" : "#/components/schemas/Policy_CreateDoorPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get minimal proximity state list", - "tags" : [ "Proximity Webservice" ] + "summary" : "Create door policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/proximity/getProximityEventsForTag" : { + "/api/policy/createOccupancyPolicy" : { "post" : { - "description" : "Get recent events for specified proximity tag", - "operationId" : "getProximityEventsForTags", + "description" : "Create a policy to be assigned to a occupancy sensor", + "operationId" : "createOccupancyPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30393,7 +31845,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_GetProximityEventsForTagWSRequest" + "$ref" : "#/components/schemas/Policy_CreateOccupancyPolicyWSRequest" } } } @@ -30403,21 +31855,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_GetProximityEventsForTagWSResponse" + "$ref" : "#/components/schemas/Policy_CreateOccupancyPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get proximity events for tag", - "tags" : [ "Proximity Webservice" ] + "summary" : "Create occupancy policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/proximity/updateDetails" : { + "/api/policy/createPolicyAddendumForLocation" : { "post" : { - "description" : "Update details for a proximity tag", - "operationId" : "updateProximitySensorDetails", + "description" : "Create policy addendum for location", + "operationId" : "createPolicyAddendumForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30434,7 +31886,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_UpdateProximitySensorDetailsWSRequest" + "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumForLocationRequest" } } } @@ -30444,21 +31896,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Proximity_UpdateProximitySensorDetailsWSResponse" + "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumForLocationResponse" } } }, "description" : "OK" } }, - "summary" : "Update proximity sensor details", - "tags" : [ "Proximity Webservice" ] + "summary" : "Create policy addendum for location", + "tags" : [ "Policy Webservice" ] } }, - "/api/rapidsos/getNearbyFeeds" : { + "/api/policy/createPolicyAddendumsForDevices" : { "post" : { - "description" : "Get closest 10 feeds by lat and long", - "operationId" : "getNearbyFeeds", + "description" : "Create policy addendums for devices", + "operationId" : "createPolicyAddendumsForDevices", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30475,7 +31927,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rapidsos_GetNearbyFeedsRequest" + "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumsForDevicesRequest" } } } @@ -30485,21 +31937,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rapidsos_GetNearbyFeedsResponse" + "$ref" : "#/components/schemas/Policy_CreatePolicyAddendumsForDevicesResponse" } } }, "description" : "OK" } }, - "summary" : "Get nearby feeds", - "tags" : [ "RapidSOS Webservice" ] + "summary" : "Create policy addendums for devices", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/assignThirdPartyCameraToNVR" : { + "/api/policy/createProximityPolicy" : { "post" : { - "description" : "Assign a third party camera to an NVR", - "operationId" : "assignThirdPartyCameraToNVR", + "description" : "Create a policy to be assigned to an asset tag", + "operationId" : "createProximityPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30516,7 +31968,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSRequest" + "$ref" : "#/components/schemas/Policy_CreateProximityPolicyWSRequest" } } } @@ -30526,21 +31978,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSResponse" + "$ref" : "#/components/schemas/Policy_CreateProximityPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Assign third party camera to NVR", - "tags" : [ "Relay Webservice" ] + "summary" : "Create proximity policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/assignThirdPartyCameraToRelayCamera" : { + "/api/policy/createSchedule" : { "post" : { - "description" : "Assign a third party camera to a relay Camera", - "operationId" : "assignThirdPartyCameraToRelayCamera", + "description" : "Create a schedule to be used for policy creation", + "operationId" : "createSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30557,7 +32009,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSRequest" + "$ref" : "#/components/schemas/Policy_CreateScheduleWSRequest" } } } @@ -30567,21 +32019,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSResponse" + "$ref" : "#/components/schemas/Policy_CreateScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Assign third party camera to relay camera", - "tags" : [ "Relay Webservice" ] + "summary" : "Create schedule", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/authenticateThirdPartyCamera" : { + "/api/policy/createVideoIntercomPolicy" : { "post" : { - "description" : "Authenticate a third party camera, effectively validating the credentials specified to be used for it.", - "operationId" : "authenticateThirdPartyCamera", + "description" : "Create a video intercom policy", + "operationId" : "createVideoIntercomPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30598,7 +32050,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_AuthenticateThirdPartyCameraWSRequest" + "$ref" : "#/components/schemas/Policy_CreateVideoIntercomPolicyWSRequest" } } } @@ -30608,21 +32060,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_AuthenticateThirdPartyCameraWSResponse" + "$ref" : "#/components/schemas/Policy_CreateVideoIntercomPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Authenticate third party camera", - "tags" : [ "Relay Webservice" ] + "summary" : "Create video intercom policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/createThirdPartyCameraPassword" : { + "/api/policy/deleteAccessControlledDoorPolicy" : { "post" : { - "description" : "Create a third party camera password", - "operationId" : "createThirdPartyCameraPassword", + "description" : "Delete an access controlled door policy", + "operationId" : "deleteAccessControlledDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30639,7 +32091,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteAccessControlledDoorPolicyWSRequest" } } } @@ -30649,21 +32101,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteAccessControlledDoorPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create third party camera password", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete access controlled door policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/deleteThirdPartyCameraDiscovery" : { + "/api/policy/deleteAudioPolicy" : { "post" : { - "description" : "Delete third party camera discovery if it has no assignments.", - "operationId" : "deleteThirdPartyCameraDiscovery", + "description" : "Delete a audio gateway policy", + "operationId" : "deleteAudioPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30680,7 +32132,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteAudioPolicyWSRequest" } } } @@ -30690,21 +32142,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteAudioPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete third party camera discovery", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete audio policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/deleteThirdPartyCameraPassword" : { + "/api/policy/deleteCameraPolicy" : { "post" : { - "description" : "Delete a third party camera password", - "operationId" : "deleteThirdPartyCameraPassword", + "description" : "Delete a camera policy", + "operationId" : "deleteCameraPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30721,7 +32173,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteCameraPolicyWSRequest" } } } @@ -30731,21 +32183,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteCameraPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete third party camera password", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete camera policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/executeThirdPartyCameraDiscovery" : { + "/api/policy/deleteClimatePolicy" : { "post" : { - "description" : "Trigger a discovery of cameras on the local LANs", - "operationId" : "executeThirdPartyCameraDiscovery", + "description" : "Delete a climate policy", + "operationId" : "deleteClimatePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30762,7 +32214,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteClimatePolicyWSRequest" } } } @@ -30772,21 +32224,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteClimatePolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Execute third party camera discovery", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete climate policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/findDiscoveriesWithUnassignedRtspEndpoints" : { + "/api/policy/deleteDevicePolicyAddendums" : { "post" : { - "description" : "Finds discoveries that have unassigned RTSP endpoints. Only discoveries containing at least one endpoint are returned.", - "operationId" : "findDiscoveriesWithUnassignedRtspEndpoints", + "description" : "Delete a policy addendums", + "operationId" : "deleteDevicePolicyAddendums", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30803,7 +32255,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteDevicePolicyAddendumsWSRequest" } } } @@ -30813,21 +32265,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteDevicePolicyAddendumsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find discoveries with unassigned RTSP endpoints", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete device policy addendums", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getAssignedThirdPartyCameras" : { + "/api/policy/deleteDoorPolicy" : { "post" : { - "description" : "Get a list of the third party cameras assigned to an NVR", - "operationId" : "getAssignedThirdPartyCameras", + "description" : "Delete a door sensor policy", + "operationId" : "deleteDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30844,7 +32296,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteDoorPolicyWSRequest" } } } @@ -30854,21 +32306,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteDoorPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get assigned third party cameras", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete door policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getDetails" : { + "/api/policy/deleteLocationPolicyAddendum" : { "post" : { - "description" : "Get hardware details of multiple NVRs", - "operationId" : "getNVRDetails", + "description" : "Delete a policy addendums", + "operationId" : "deleteLocationPolicyAddendum", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30885,7 +32337,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetNVRDetailsWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteLocationPolicyAddendumWSRequest" } } } @@ -30895,21 +32347,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetNVRDetailsWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteLocationPolicyAddendumWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get NVR details", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete location policy addendum", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getFullNVRState" : { + "/api/policy/deleteOccupancyPolicy" : { "post" : { - "description" : "Get detailed information about state of specified NVR", - "operationId" : "getFullNVRState", + "description" : "Delete an Occupancy policy", + "operationId" : "deleteOccupancyPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30926,7 +32378,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetFullNVRStateWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteOccupancyPolicyWSRequest" } } } @@ -30936,21 +32388,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetFullNVRStateWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteOccupancyPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get full NVR state", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete occupancy policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getMinimalNVRStateList" : { + "/api/policy/deletePolicyPauseSettingForComponentComposite" : { "post" : { - "description" : "Get basic state information about all NVRs in organization", - "operationId" : "getMinimalNVRStateList", + "description" : "Delete a policy pause setting for a component composite", + "operationId" : "deletePolicyPauseSettingForComponentComposite", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -30967,7 +32419,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetMinimalNVRStateListWSRequest" + "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" } } } @@ -30977,21 +32429,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetMinimalNVRStateListWSResponse" + "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get minimal NVR state list", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete policy pause setting for component composite", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getMinimalThirdPartyCameraStateList" : { + "/api/policy/deletePolicyPauseSettingForDevice" : { "post" : { - "description" : "Get basic state information about all third party cameras in the organization", - "operationId" : "getMinimalThirdPartyCameraStateList", + "description" : "Delete a policy pause setting for a device", + "operationId" : "deletePolicyPauseSettingForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31008,7 +32460,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSRequest" + "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" } } } @@ -31018,21 +32470,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSResponse" + "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get minimal third party camera state list", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete policy pause setting for device", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getRtspEndpoints" : { + "/api/policy/deletePolicyPauseSettingForLocation" : { "post" : { - "description" : "Gets rtsp endpoints for device with the specified mac address.", - "operationId" : "getRtspEndpoints", + "description" : "Delete a policy pause setting for a location", + "operationId" : "deletePolicyPauseSettingForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31049,7 +32501,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetRtspEndpointsWSRequest" + "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSRequest" } } } @@ -31059,21 +32511,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetRtspEndpointsWSResponse" + "$ref" : "#/components/schemas/Policy_DeletePolicyPauseSettingWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get RTSP endpoints", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete policy pause setting for location", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getThirdPartyCameraPasswords" : { + "/api/policy/deleteProximityPolicy" : { "post" : { - "description" : "Get a list of the third party camera passwords", - "operationId" : "getThirdPartyCameraPasswords", + "description" : "Delete an asset tag policy", + "operationId" : "deleteProximityPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31090,7 +32542,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteProximityPolicyWSRequest" } } } @@ -31100,21 +32552,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteProximityPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get third party camera passwords", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete proximity policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/getUptimeWindows" : { + "/api/policy/deleteSchedule" : { "post" : { - "description" : "Get uptime information for an NVR.", - "operationId" : "getRelayUptimeWindows", + "description" : "Delete a schedule used for policy creation", + "operationId" : "deleteSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31131,7 +32583,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteScheduleWSRequest" } } } @@ -31141,21 +32593,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get uptime information for an NVR.", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete schedule", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/manualDiscoverCamera" : { + "/api/policy/deleteVideoIntercomPolicy" : { "post" : { - "description" : "Manually identify a camera on the network", - "operationId" : "manualDiscoverCamera", + "description" : "Delete a video intercom policy", + "operationId" : "deleteVideoIntercomPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31172,7 +32624,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSRequest" + "$ref" : "#/components/schemas/Policy_DeleteVideoIntercomPolicyWSRequest" } } } @@ -31182,21 +32634,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSResponse" + "$ref" : "#/components/schemas/Policy_DeleteVideoIntercomPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Manual discover camera", - "tags" : [ "Relay Webservice" ] + "summary" : "Delete video intercom policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/ptzMove" : { + "/api/policy/findSchedules" : { "post" : { - "description" : "Trigger a pan, tilt, or zoom", - "operationId" : "ptzMove", + "description" : "Find all schedules in organization", + "operationId" : "findSchedules", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31213,7 +32665,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_PTZMoveWSRequest" + "$ref" : "#/components/schemas/Policy_FindSchedulesWSRequest" } } } @@ -31223,21 +32675,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_PTZMoveWSResponse" + "$ref" : "#/components/schemas/Policy_FindSchedulesWSResponse" } } }, "description" : "OK" } }, - "summary" : "PTZ move", - "tags" : [ "Relay Webservice" ] + "summary" : "Find schedules", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/ptzStatus" : { + "/api/policy/getAccessControlledDoorPolicies" : { "post" : { - "description" : "Returns ptz status", - "operationId" : "ptz", + "description" : "Get details about all access controlled door policies in organization", + "operationId" : "getAccessControlledDoorPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31254,7 +32706,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_PTZStatusWSRequest" + "$ref" : "#/components/schemas/Policy_GetAccessControlledDoorPoliciesWSRequest" } } } @@ -31264,21 +32716,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_PTZStatusWSResponse" + "$ref" : "#/components/schemas/Policy_GetAccessControlledDoorPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "PTZ status", - "tags" : [ "Relay Webservice" ] + "summary" : "Get access controlled door policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/reboot" : { + "/api/policy/getAudioPolicies" : { "post" : { - "description" : "Reboot an NVR", - "operationId" : "rebootNVR", + "description" : "Get details about all audio gateway policies in organization", + "operationId" : "getAudioPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31295,7 +32747,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_RebootNVRVWSRequest" + "$ref" : "#/components/schemas/Policy_GetAudioPoliciesWSRequest" } } } @@ -31305,21 +32757,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_RebootNVRVWSResponse" + "$ref" : "#/components/schemas/Policy_GetAudioPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Reboot NVR", - "tags" : [ "Relay Webservice" ] + "summary" : "Get audio policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/unassignThirdPartyCamera" : { + "/api/policy/getCameraPolicies" : { "post" : { - "description" : "Unassign a third party camera from an NVR", - "operationId" : "unassignThirdPartyCamera", + "description" : "Get details about all camera policies in organization", + "operationId" : "getCameraPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31336,7 +32788,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UnassignThirdPartyCameraWSRequest" + "$ref" : "#/components/schemas/Policy_GetCameraPoliciesWSRequest" } } } @@ -31346,21 +32798,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UnassignThirdPartyCameraWSResponse" + "$ref" : "#/components/schemas/Policy_GetCameraPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Unassign third party camera", - "tags" : [ "Relay Webservice" ] + "summary" : "Get camera policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/unregister" : { + "/api/policy/getClimatePolicies" : { "post" : { - "description" : "Remove an NVR from organization", - "operationId" : "unregisterNVR", + "description" : "Get details about all climate policies in organization", + "operationId" : "getClimatePolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31377,7 +32829,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UnregisterNVRWSRequest" + "$ref" : "#/components/schemas/Policy_GetClimatePoliciesWSRequest" } } } @@ -31387,21 +32839,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UnregisterNVRWSResponse" + "$ref" : "#/components/schemas/Policy_GetClimatePoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Unregister NVR", - "tags" : [ "Relay Webservice" ] + "summary" : "Get climate policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/updateDetailsV2" : { + "/api/policy/getDoorPolicies" : { "post" : { - "description" : "Update hardware details of NVR.", - "operationId" : "updateNVRDetailsV2", + "description" : "Get details about all door sensor policies in organization", + "operationId" : "getDoorPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31418,7 +32870,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UpdateNVRWSRequest" + "$ref" : "#/components/schemas/Policy_GetDoorPoliciesWSRequest" } } } @@ -31428,21 +32880,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UpdateNVRWSResponse" + "$ref" : "#/components/schemas/Policy_GetDoorPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update NVR details V2", - "tags" : [ "Relay Webservice" ] + "summary" : "Get door policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/relay/updateFirmware" : { + "/api/policy/getOccupancyPolicies" : { "post" : { - "description" : "Send command to update firmware to NVR", - "operationId" : "updateNVRFirmware", + "description" : "Get details about all occupancy policies in organization", + "operationId" : "getOccupancyPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31459,7 +32911,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UpdateNVRFirmwareWSRequest" + "$ref" : "#/components/schemas/Policy_GetOccupancyPoliciesWSRequest" } } } @@ -31469,21 +32921,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Relay_UpdateNVRFirmwareWSResponse" + "$ref" : "#/components/schemas/Policy_GetOccupancyPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update NVR firmware", - "tags" : [ "Relay Webservice" ] + "summary" : "Get occupancy policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getAuditFeed" : { + "/api/policy/getPoliciesUsingSchedule" : { "post" : { - "description" : "Get the latest audit logs for organization", - "operationId" : "getAuditFeed", + "description" : "Get details about all climate policies in organization", + "operationId" : "getPoliciesUsingSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31500,7 +32952,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetAuditFeedWSRequest" + "$ref" : "#/components/schemas/Policy_GetPoliciesUsingScheduleWSRequest" } } } @@ -31510,21 +32962,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetAuditFeedWSResponse" + "$ref" : "#/components/schemas/Policy_GetPoliciesUsingScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get audit feed", - "tags" : [ "Report Webservice" ] + "summary" : "Get policies using schedule", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getBatchThresholdCrossingCountReport" : { + "/api/policy/getPolicyAddendums" : { "post" : { - "description" : "Get batch threshold crossing count report", - "operationId" : "getBatchThresholdCrossingCountReport", + "description" : "Get the current and planned policy alert addendums", + "operationId" : "getPolicyAddendums", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31541,7 +32993,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetBatchThresholdCrossingCountReportWSRequest" + "$ref" : "#/components/schemas/Policy_GetPolicyAddendumsWSRequest" } } } @@ -31551,22 +33003,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" + "$ref" : "#/components/schemas/Policy_GetPolicyAddendumsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get batch threshold crossing count report", - "tags" : [ "Report Webservice" ] + "summary" : "Get policy addendums", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCountReport" : { + "/api/policy/getPolicyPauseSettings" : { "post" : { - "deprecated" : true, - "description" : "Use /getCountReportV2 instead", - "operationId" : "getCountReport", + "description" : "Get the current and planned policy alert pause details", + "operationId" : "getPolicyPauseSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31583,7 +33034,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportWSRequest" + "$ref" : "#/components/schemas/Policy_GetPolicyPauseSettingsWSRequest" } } } @@ -31593,21 +33044,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportWSResponse" + "$ref" : "#/components/schemas/Policy_GetPolicyPauseSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get count report", - "tags" : [ "Report Webservice" ] + "summary" : "Get policy pause settings", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCountReportV2" : { + "/api/policy/getProximityPolicies" : { "post" : { - "description" : "Get the specified count reports", - "operationId" : "getCountReportV2", + "description" : "Get details about all asset tag policies in organization", + "operationId" : "getProximityPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31624,7 +33075,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportV2WSRequest" + "$ref" : "#/components/schemas/Policy_GetProximityPoliciesWSRequest" } } } @@ -31634,21 +33085,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportWSResponse" + "$ref" : "#/components/schemas/Policy_GetProximityPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get count report V2", - "tags" : [ "Report Webservice" ] + "summary" : "Get proximity policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCountReports" : { + "/api/policy/getTrackPauseSettings" : { "post" : { - "description" : "Get multiple specified count reports", - "operationId" : "getCountReports", + "description" : "List active and scheduled per-track alert snoozes across devices and locations", + "operationId" : "getTrackPauseSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31665,7 +33116,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportsWSRequest" + "$ref" : "#/components/schemas/Policy_GetTrackPauseSettingsWSRequest" } } } @@ -31675,21 +33126,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportsWSResponse" + "$ref" : "#/components/schemas/Policy_GetTrackPauseSettingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get count reports", - "tags" : [ "Report Webservice" ] + "summary" : "Get track pause settings", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCountReportsForDevicesAtLocation" : { + "/api/policy/getVideoIntercomPolicies" : { "post" : { - "description" : "Get count reports by device for a specified location", - "operationId" : "getCountReportsForDevicesAtLocation", + "description" : "Get details about all video intercom policies in organization", + "operationId" : "getVideoIntercomPolicies", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31706,7 +33157,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportsForDevicesAtLocationWSRequest" + "$ref" : "#/components/schemas/Policy_GetVideoIntercomPoliciesWSRequest" } } } @@ -31716,21 +33167,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCountReportsWSResponse" + "$ref" : "#/components/schemas/Policy_GetVideoIntercomPoliciesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get count reports for devices at location", - "tags" : [ "Report Webservice" ] + "summary" : "Get video intercom policies", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCustomEventsBinaryCounts" : { + "/api/policy/pauseAlertPolicyForComponentComposite" : { "post" : { - "description" : "Retrieves aggregated counts of boolean event values (true/false) produced by a selected prompt over a specified time window.\n\nScope & filters:\n\t•\tpromptUuid – The prompt to aggregate (required).\n\nTime window & interval:\n\t•\tA time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.\n\t•\tIf an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.\n\t•\tAggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.\n\nResponse:\n\t•\tPer interval bucket, returns a BinaryAggregationValue with counts for true and false.\n\t•\tIncludes minValueTimestampMs and maxValueTimestampMs (if available) and the bucket timestamp from BaseReportValue.\n\nNotes:\n\t•\tOnly binary/boolean prompt types are valid for this endpoint.\n", - "operationId" : "getCustomEventsBinaryCounts", + "description" : "Pause alert policy for component composite", + "operationId" : "pauseAlertPolicyForComponentComposite", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31747,7 +33198,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCustomLLMWSRequest" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" } } } @@ -31757,21 +33208,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCustomLLMWBinaryWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get custom events aggregation binary counts", - "tags" : [ "Report Webservice" ] + "summary" : "Pause alert policy for component composite", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCustomEventsNumericCounts" : { + "/api/policy/pauseAlertPolicyForDevice" : { "post" : { - "description" : "Retrieves aggregated statistics for numeric events event values produced by a selected prompt over a specified time window.\nScope & filters:\n\t•\tpromptUuid – The prompt to aggregate (required).\n\nTime window & interval:\n\t•\tA time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.\n\t•\tIf an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.\n\t•\tAggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.\n\nResponse:\n\t•\tPer interval bucket, returns numeric aggregates derived from raw values: count, sum, min, max, average.\n\t•\tIncludes minValueTimestampMs and maxValueTimestampMs indicating when min/max occurred within the bucket (if available).\n\t•\tBucket timestamps are returned as epoch ms.\n\nNotes:\n\t•\tOnly numeric prompt types are valid for this endpoint.\n", - "operationId" : "getCustomEventsNumericCounts", + "description" : "Pause alert policy for device", + "operationId" : "pauseAlertPolicyForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31788,7 +33239,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCustomLLMWSRequest" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" } } } @@ -31798,21 +33249,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCustomLLMNumericWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get custom events aggregation numeric counts", - "tags" : [ "Report Webservice" ] + "summary" : "Pause alert policy for device", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getCustomEventsReport" : { + "/api/policy/pauseAlertPolicyForLocation" : { "post" : { - "description" : "Retrieves a custom events report containing raw time-series event values recorded by selected prompts and devices within the specified time window.\nThe report can be filtered by:\n\t•\tpromptUuid – The specific prompt to query.\n\t•\tdeviceFacetUuids – A set of devices to include.\n\t•\tlocationUuid – The location context for the query.\nFor example, a request may specify a promptUuid to fetch results from a certain LLM prompt, and additionally restrict results to only devices in a given locationUuid.\nThe time range (startTimeMs → endTimeMs) is required and determines the interval of events returned.\nThe response includes, per device and prompt, the raw event values (numeric or boolean as string) along with timestamps, check-condition results (if selected), and prompt type.", - "operationId" : "getCustomEventsReport", + "description" : "Pause alert policy for location", + "operationId" : "pauseAlertPolicyForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31829,7 +33280,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCustomLLMReportWSRequest" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSRequest" } } } @@ -31839,21 +33290,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetCustomLLMReportWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get custom events report", - "tags" : [ "Report Webservice" ] + "summary" : "Pause alert policy for location", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getDiagnosticFeed" : { + "/api/policy/pauseTrackAlerts" : { "post" : { - "description" : "Get the latest diagnostic logs for organization", - "operationId" : "getDiagnosticFeed", + "description" : "Pause track alerts for a single reID stableTrackId on a device until duration elapses", + "operationId" : "pauseTrackAlerts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31870,7 +33321,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetDiagnosticFeedWSRequest" + "$ref" : "#/components/schemas/Policy_PauseTrackAlertsWSRequest" } } } @@ -31880,21 +33331,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetDiagnosticFeedWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get diagnostic feed", - "tags" : [ "Report Webservice" ] + "summary" : "Pause track alerts for a stable track id", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getEnvoyDeliveries" : { + "/api/policy/pauseTrackAlertsForLocation" : { "post" : { - "description" : "Get a list of deliveries from Envoy to populate reporting logs", - "operationId" : "getEnvoyDeliveries", + "description" : "Pause track alerts for a single reID stableTrackId across a whole location until duration elapses", + "operationId" : "pauseTrackAlertsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31911,7 +33362,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyDeliveriesWSRequest" + "$ref" : "#/components/schemas/Policy_PauseTrackAlertsForLocationWSRequest" } } } @@ -31921,21 +33372,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyDeliveriesWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Envoy deliveries", - "tags" : [ "Integrations Webservice", "Report Webservice" ] + "summary" : "Pause track alerts for a stable track id across a location", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getEnvoyEmployees" : { + "/api/policy/resumeTrackAlerts" : { "post" : { - "description" : "Get a list of employees from Envoy", - "operationId" : "getEnvoyEmployees", + "description" : "Cancel a previously set per-track alert pause", + "operationId" : "resumeTrackAlerts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31952,7 +33403,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyEmployeesWSRequest" + "$ref" : "#/components/schemas/Policy_PauseTrackAlertsWSRequest" } } } @@ -31962,21 +33413,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyEmployeesWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Envoy employees", - "tags" : [ "Integrations Webservice", "Report Webservice" ] + "summary" : "Resume track alerts for a stable track id", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getEnvoyLocations" : { + "/api/policy/resumeTrackAlertsForLocation" : { "post" : { - "description" : "Get list of Envoy locations", - "operationId" : "getEnvoyLocations", + "description" : "Cancel a previously set per-track location alert pause", + "operationId" : "resumeTrackAlertsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -31993,7 +33444,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyLocationsWSRequest" + "$ref" : "#/components/schemas/Policy_PauseTrackAlertsForLocationWSRequest" } } } @@ -32003,21 +33454,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyLocationsWSResponse" + "$ref" : "#/components/schemas/Policy_PauseAlertPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Envoy locations", - "tags" : [ "Integrations Webservice", "Report Webservice" ] + "summary" : "Resume track alerts for a stable track id across a location", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getEnvoyVisitors" : { + "/api/policy/updateAccessControlledDoorPolicy" : { "post" : { - "description" : "Get a list of visitors from Envoy to populate reporting logs", - "operationId" : "getEnvoyVisitors", + "description" : "Update an access controlled door policy", + "operationId" : "updateAccessControlledDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32034,7 +33485,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyVisitorsWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateAccessControlledDoorPolicyWSRequest" } } } @@ -32044,21 +33495,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetEnvoyVisitorsWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateAccessControlledDoorPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Envoy visitors", - "tags" : [ "Integrations Webservice", "Report Webservice" ] + "summary" : "Update access controlled door policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getIntegrationDiagnosticEvents" : { + "/api/policy/updateAudioPolicy" : { "post" : { - "description" : "Get the diagnostic logs of supported third-party devices for organization", - "operationId" : "getIntegrationDiagnosticEvents", + "description" : "Update a audio gateway policy", + "operationId" : "updateAudioPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32075,7 +33526,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetIntegrationDiagnosticEventsWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateAudioPolicyWSRequest" } } } @@ -32085,21 +33536,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetIntegrationDiagnosticEventsWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateAudioPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get integration diagnostic events", - "tags" : [ "Report Webservice" ] + "summary" : "Update audio policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getLicensePlatesByDevice" : { + "/api/policy/updateCameraPolicy" : { "post" : { - "description" : "Get license plate counting events for a specified camera", - "operationId" : "getLicensePlatesByDevice", + "description" : "Update a camera policy", + "operationId" : "updateCameraPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32116,7 +33567,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetLicensePlatesByDeviceWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateCameraPolicyWSRequest" } } } @@ -32126,21 +33577,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetLicensePlatesByDeviceWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateCameraPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get license plates by device", - "tags" : [ "Report Webservice" ] + "summary" : "Update camera policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getMostRecentPeopleCountEvents" : { + "/api/policy/updateClimatePolicy" : { "post" : { - "description" : "Get the X most recent people counting events for a specified device", - "operationId" : "getMostRecentPeopleCountEvents", + "description" : "Update a climate policy", + "operationId" : "updateClimatePolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32157,7 +33608,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetMostRecentPeopleCountWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateClimatePolicyWSRequest" } } } @@ -32167,21 +33618,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetMostRecentPeopleCountWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateClimatePolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get most recent people count events", - "tags" : [ "Report Webservice" ] + "summary" : "Update climate policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getOccupancyCounts" : { + "/api/policy/updateDoorPolicy" : { "post" : { - "description" : "Returns the estimated occupancy count for a specified room or area within a given time range. This endpoint allows you to monitor occupancy trends over time or retrieve a single count for a defined interval.\nImportant: An occupancy region must be defined in the Rhombus Console before using this endpoint.\nYou can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY ...) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime.\nIf no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.", - "operationId" : "getOccupancyCounts", + "description" : "Update a door sensor policy", + "operationId" : "updateDoorPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32198,7 +33649,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateDoorPolicyWSRequest" } } } @@ -32208,21 +33659,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateDoorPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get occupancy counts", - "tags" : [ "Report Webservice" ] + "summary" : "Update door policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getOccupancyCountsV2" : { + "/api/policy/updateOccupancyPolicy" : { "post" : { - "description" : "Returns the estimated occupancy count for a specified room or area within a given time range using person reidentification data.\nImportant: An occupancy region must be defined in the Rhombus Console before using this endpoint.\nYou can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY ...) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime.\nIf no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.", - "operationId" : "getOccupancyCountsV2", + "description" : "Update an occupancy policy", + "operationId" : "updateOccupancyPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32239,7 +33690,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateOccupancyPolicyWSRequest" } } } @@ -32249,21 +33700,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateOccupancyPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get occupancy counts V2", - "tags" : [ "Report Webservice" ] + "summary" : "Update occupancy policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getProximityTagLocationsByDate" : { + "/api/policy/updateProximityPolicy" : { "post" : { - "description" : "Get proximity tag locations by date", - "operationId" : "getProximityTagLocationsByDate", + "description" : "Update an asset tag policy", + "operationId" : "updateProximityPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32280,7 +33731,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetProximityTagLocationsByDateWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateProximityPolicyWSRequest" } } } @@ -32290,21 +33741,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetProximityTagLocationsByDateWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateProximityPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get proximity tag locations by date", - "tags" : [ "Report Webservice" ] + "summary" : "Update proximity policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getRunningAverage" : { + "/api/policy/updateSchedule" : { "post" : { - "description" : "Get the running average for the specified count report if it is available, based on recent data", - "operationId" : "getRunningAverage", + "description" : "Update a schedule to be used for policy creation", + "operationId" : "updateSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32321,7 +33772,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetRunningAverageWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateScheduleWSRequest" } } } @@ -32331,21 +33782,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetRunningAverageWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get running average", - "tags" : [ "Report Webservice" ] + "summary" : "Update schedule", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getSummaryCountReport" : { + "/api/policy/updateVideoIntercomPolicy" : { "post" : { - "description" : "Get a summary report for a camera, location, or organization", - "operationId" : "getSummaryCountReport", + "description" : "Update video intercom policy", + "operationId" : "updateVideoIntercomPolicy", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32362,7 +33813,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetSummaryCountReportWSRequest" + "$ref" : "#/components/schemas/Policy_UpdateVideoIntercomPolicyWSRequest" } } } @@ -32372,21 +33823,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetSummaryCountReportWSResponse" + "$ref" : "#/components/schemas/Policy_UpdateVideoIntercomPolicyWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get summary count report", - "tags" : [ "Report Webservice" ] + "summary" : "Update video intercom policy", + "tags" : [ "Policy Webservice" ] } }, - "/api/report/getThresholdCrossingCountReport" : { + "/api/proximity/getLocomotionEventsForTag" : { "post" : { - "description" : "Get threshold crossing count report for device", - "operationId" : "getThresholdCrossingCountReport", + "description" : "Get locomotion events for specified proximity tag", + "operationId" : "getLocomotionEventsForTag", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32403,7 +33854,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSRequest" + "$ref" : "#/components/schemas/Proximity_GetLocomotionEventsForTagWSRequest" } } } @@ -32413,21 +33864,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" + "$ref" : "#/components/schemas/Proximity_GetLocomotionEventsForTagWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get threshold crossing count report for device", - "tags" : [ "Report Webservice" ] + "summary" : "Get locomotion events for tag", + "tags" : [ "Proximity Webservice" ] } }, - "/api/report/getThresholdCrossingCountReportForOrg" : { + "/api/proximity/getMinimalProximityStateList" : { "post" : { - "description" : "Get org wide batch threshold crossing count report", - "operationId" : "getThresholdCrossingCountReportForOrg", + "description" : "Get basic state information about all proximity tags in organization", + "operationId" : "getMinimalProximityStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32444,7 +33895,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportForOrgWSRequest" + "$ref" : "#/components/schemas/Proximity_GetMinimalProximityStatesWSRequest" } } } @@ -32454,22 +33905,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" + "$ref" : "#/components/schemas/Proximity_GetMinimalProximityStatesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get org wide batch threshold crossing count report", - "tags" : [ "Report Webservice" ] + "summary" : "Get minimal proximity state list", + "tags" : [ "Proximity Webservice" ] } }, - "/api/report/getThresholdCrossingCounts" : { + "/api/proximity/getProximityEventsForTag" : { "post" : { - "deprecated" : true, - "description" : "Get the occupancy counts from threshold crossing for a group of cameras over a period of time", - "operationId" : "getThresholdCrossingCounts", + "description" : "Get recent events for specified proximity tag", + "operationId" : "getProximityEventsForTags", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32486,7 +33936,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSRequest" + "$ref" : "#/components/schemas/Proximity_GetProximityEventsForTagWSRequest" } } } @@ -32496,21 +33946,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSResponse" + "$ref" : "#/components/schemas/Proximity_GetProximityEventsForTagWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get threshold crossing counts", - "tags" : [ "Report Webservice" ] + "summary" : "Get proximity events for tag", + "tags" : [ "Proximity Webservice" ] } }, - "/api/report/getThresholdCrossingEvents" : { + "/api/proximity/updateDetails" : { "post" : { - "description" : "Get the raw threshold crossing events for a group of cameras over a period of time", - "operationId" : "getThresholdCrossingEvents", + "description" : "Update details for a proximity tag", + "operationId" : "updateProximitySensorDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32527,7 +33977,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsWSRequest" + "$ref" : "#/components/schemas/Proximity_UpdateProximitySensorDetailsWSRequest" } } } @@ -32537,21 +33987,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsWSResponse" + "$ref" : "#/components/schemas/Proximity_UpdateProximitySensorDetailsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get threshold crossing events", - "tags" : [ "Report Webservice" ] + "summary" : "Update proximity sensor details", + "tags" : [ "Proximity Webservice" ] } }, - "/api/report/getThresholdCrossingEventsForDevice" : { + "/api/rapidsos/getNearbyFeeds" : { "post" : { - "description" : "Get threshold crossing events for device", - "operationId" : "getThresholdCrossingEventsForDevice", + "description" : "Get closest 10 feeds by lat and long", + "operationId" : "getNearbyFeeds", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32568,7 +34018,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsForDeviceWSRequest" + "$ref" : "#/components/schemas/Rapidsos_GetNearbyFeedsRequest" } } } @@ -32578,21 +34028,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsForDeviceWSResponse" + "$ref" : "#/components/schemas/Rapidsos_GetNearbyFeedsResponse" } } }, "description" : "OK" } }, - "summary" : "Get threshold crossing events for device", - "tags" : [ "Report Webservice" ] + "summary" : "Get nearby feeds", + "tags" : [ "RapidSOS Webservice" ] } }, - "/api/report/getToastEventsTable" : { + "/api/relay/addThirdPartyCameraViaOnvif" : { "post" : { - "description" : "Get list of Toast orders to populate events table", - "operationId" : "getToastEventsTable", + "description" : "Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials.", + "operationId" : "addThirdPartyCameraViaOnvif", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32609,7 +34059,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSRequest" + "$ref" : "#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSRequest" } } } @@ -32619,21 +34069,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse" + "$ref" : "#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Toast events table", - "tags" : [ "Report Webservice" ] + "summary" : "Add third party camera via ONVIF", + "tags" : [ "Relay Webservice" ] } }, - "/api/report/getToastEventsTableAllLocations" : { + "/api/relay/assignThirdPartyCameraToNVR" : { "post" : { - "description" : "Get list of Toast orders from all restaurants to populate events table", - "operationId" : "getToastEventsTableAllLocations", + "description" : "Assign a third party camera to an NVR", + "operationId" : "assignThirdPartyCameraToNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32650,7 +34100,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetToastEventsTableAllLocationsWSRequest" + "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSRequest" } } } @@ -32660,21 +34110,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Integration_GetToastEventsTableAllLocationsWSResponse" + "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToNVRWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get Toast events table all locations", - "tags" : [ "Report Webservice" ] + "summary" : "Assign third party camera to NVR", + "tags" : [ "Relay Webservice" ] } }, - "/api/report/resetRunningAverage" : { + "/api/relay/assignThirdPartyCameraToRelayCamera" : { "post" : { - "description" : "Reset the running average for the specified count report", - "operationId" : "resetRunningAverage", + "description" : "Assign a third party camera to a relay Camera", + "operationId" : "assignThirdPartyCameraToRelayCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32691,7 +34141,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_ResetRunningAverageWSRequest" + "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSRequest" } } } @@ -32701,21 +34151,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Report_ResetRunningAverageWSResponse" + "$ref" : "#/components/schemas/Relay_AssignThirdPartyCameraToRelayCameraWSResponse" } } }, "description" : "OK" } }, - "summary" : "Reset running average", - "tags" : [ "Report Webservice" ] + "summary" : "Assign third party camera to relay camera", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/createRule" : { + "/api/relay/assignThirdPartyMultiFacetCameraToNVR" : { "post" : { - "description" : "Create a rule", - "operationId" : "createRule", + "description" : "Assign a multi-sensor third party camera to an NVR as one camera with multiple video facets (gated on the multiFacetThirdPartyCameraEnabled org flag)", + "operationId" : "assignThirdPartyMultiFacetCameraToNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32732,7 +34182,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_CreateRuleWSRequest" + "$ref" : "#/components/schemas/Relay_AssignThirdPartyMultiFacetCameraToNVRWSRequest" } } } @@ -32742,21 +34192,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_CreateRuleWSResponse" + "$ref" : "#/components/schemas/Relay_AssignThirdPartyMultiFacetCameraToNVRWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create rule", - "tags" : [ "Rules Webservice" ] + "summary" : "Assign multi-facet third party camera to NVR", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/deleteRule" : { + "/api/relay/authenticateThirdPartyCamera" : { "post" : { - "description" : "Delete a rule", - "operationId" : "deleteRule", + "description" : "Authenticate a third party camera, effectively validating the credentials specified to be used for it.", + "operationId" : "authenticateThirdPartyCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32773,7 +34223,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_DeleteRuleWSRequest" + "$ref" : "#/components/schemas/Relay_AuthenticateThirdPartyCameraWSRequest" } } } @@ -32783,21 +34233,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_DeleteRuleWSResponse" + "$ref" : "#/components/schemas/Relay_AuthenticateThirdPartyCameraWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete rule", - "tags" : [ "Rules Webservice" ] + "summary" : "Authenticate third party camera", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/deleteRulePauseSetting" : { + "/api/relay/createThirdPartyCameraPassword" : { "post" : { - "description" : "Delete a rule pause setting", - "operationId" : "deleteRulePauseSetting", + "description" : "Create a third party camera password", + "operationId" : "createThirdPartyCameraPassword", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32814,7 +34264,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_DeleteRulePauseSettingWSRequest" + "$ref" : "#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSRequest" } } } @@ -32824,21 +34274,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_DeleteRulePauseSettingWSResponse" + "$ref" : "#/components/schemas/Relay_CreateThirdPartyCameraPasswordWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete rule pause setting", - "tags" : [ "Rules Webservice" ] + "summary" : "Create third party camera password", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/getRulePauseSettings" : { + "/api/relay/deleteThirdPartyCameraDiscovery" : { "post" : { - "description" : "Get the current and planned rule pause details", - "operationId" : "getRulePauseSettings", + "description" : "Delete third party camera discovery if it has no assignments.", + "operationId" : "deleteThirdPartyCameraDiscovery", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32855,7 +34305,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_GetRulePauseSettingsWSRequest" + "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSRequest" } } } @@ -32865,21 +34315,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_GetRulePauseSettingsResponse" + "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraDiscoveryWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get rule pause settings", - "tags" : [ "Rules Webservice" ] + "summary" : "Delete third party camera discovery", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/getRulesFiltered" : { + "/api/relay/deleteThirdPartyCameraPassword" : { "post" : { - "description" : "Get rules with Uuid and Type filtering", - "operationId" : "getRulesFiltered", + "description" : "Delete a third party camera password", + "operationId" : "deleteThirdPartyCameraPassword", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32896,7 +34346,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_GetRulesFilteredWSRequest" + "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSRequest" } } } @@ -32906,21 +34356,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSResponse" + "$ref" : "#/components/schemas/Relay_DeleteThirdPartyCameraPasswordWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get rules filtered", - "tags" : [ "Rules Webservice" ] + "summary" : "Delete third party camera password", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/getRulesForOrg" : { + "/api/relay/executeThirdPartyCameraDiscovery" : { "post" : { - "description" : "List rules for org", - "operationId" : "getRulesForOrg", + "description" : "Trigger a discovery of cameras on the local LANs", + "operationId" : "executeThirdPartyCameraDiscovery", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32937,7 +34387,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSRequest" + "$ref" : "#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSRequest" } } } @@ -32947,21 +34397,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSResponse" + "$ref" : "#/components/schemas/Relay_ExecuteThirdPartyCameraDiscoveryWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get rules for org", - "tags" : [ "Rules Webservice" ] + "summary" : "Execute third party camera discovery", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/pauseRule" : { + "/api/relay/findDiscoveriesWithUnassignedRtspEndpoints" : { "post" : { - "description" : "Pause rule", - "operationId" : "pauseRule", + "description" : "Finds discoveries that have unassigned RTSP endpoints. Only discoveries containing at least one endpoint are returned.", + "operationId" : "findDiscoveriesWithUnassignedRtspEndpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -32978,7 +34428,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_PauseRuleWSRequest" + "$ref" : "#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest" } } } @@ -32988,21 +34438,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_PauseRuleWSResponse" + "$ref" : "#/components/schemas/Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Pause rule", - "tags" : [ "Rules Webservice" ] + "summary" : "Find discoveries with unassigned RTSP endpoints", + "tags" : [ "Relay Webservice" ] } }, - "/api/rules/updateRule" : { + "/api/relay/getAssignedThirdPartyCameras" : { "post" : { - "description" : "Update a rule", - "operationId" : "updateRule", + "description" : "Get a list of the third party cameras assigned to an NVR", + "operationId" : "getAssignedThirdPartyCameras", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33019,7 +34469,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_UpdateRuleWSRequest" + "$ref" : "#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSRequest" } } } @@ -33029,21 +34479,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_UpdateRuleWSResponse" + "$ref" : "#/components/schemas/Relay_GetAssignedThirdPartyCamerasWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update rule", - "tags" : [ "Rules Webservice" ] + "summary" : "Get assigned third party cameras", + "tags" : [ "Relay Webservice" ] } }, - "/api/rulesRecords/deleteRulesEventRecord" : { + "/api/relay/getDetails" : { "post" : { - "description" : "Delete a rules event historical record", - "operationId" : "deleteRulesEventRecord", + "description" : "Get hardware details of multiple NVRs", + "operationId" : "getNVRDetails", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33060,7 +34510,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_DeleteRulesEventRecordWSRequest" + "$ref" : "#/components/schemas/Relay_GetNVRDetailsWSRequest" } } } @@ -33070,21 +34520,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_DeleteRulesEventRecordWSResponse" + "$ref" : "#/components/schemas/Relay_GetNVRDetailsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete rules event record", - "tags" : [ "Rules Records Webservice" ] + "summary" : "Get NVR details", + "tags" : [ "Relay Webservice" ] } }, - "/api/rulesRecords/getLatestRulesEventRecords" : { + "/api/relay/getFullNVRState" : { "post" : { - "description" : "Get N latest rules event historical records", - "operationId" : "getLatestRulesEventRecords", + "description" : "Get detailed information about state of specified NVR", + "operationId" : "getFullNVRState", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33101,7 +34551,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_GetLatestRulesEventRecordsWSRequest" + "$ref" : "#/components/schemas/Relay_GetFullNVRStateWSRequest" } } } @@ -33111,21 +34561,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_GetLatestRulesEventRecordsWSResponse" + "$ref" : "#/components/schemas/Relay_GetFullNVRStateWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get latest rules event records", - "tags" : [ "Rules Records Webservice" ] + "summary" : "Get full NVR state", + "tags" : [ "Relay Webservice" ] } }, - "/api/rulesRecords/getRulesEventRecords" : { + "/api/relay/getMinimalNVRStateList" : { "post" : { - "description" : "Find rules event historical records", - "operationId" : "getRulesEventRecords", + "description" : "Get basic state information about all NVRs in organization", + "operationId" : "getMinimalNVRStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33142,7 +34592,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_GetRulesEventRecordsWSRequest" + "$ref" : "#/components/schemas/Relay_GetMinimalNVRStateListWSRequest" } } } @@ -33152,21 +34602,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Rules_records_GetRulesEventRecordsWSResponse" + "$ref" : "#/components/schemas/Relay_GetMinimalNVRStateListWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get rules event records", - "tags" : [ "Rules Records Webservice" ] + "summary" : "Get minimal NVR state list", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/adHocPrompt" : { + "/api/relay/getMinimalThirdPartyCameraStateList" : { "post" : { - "description" : "Exectue an existing prompt, ad-hoc", - "operationId" : "adHocPrompt", + "description" : "Get basic state information about all third party cameras in the organization", + "operationId" : "getMinimalThirdPartyCameraStateList", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33183,7 +34633,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_AdHocPromptWSRequest" + "$ref" : "#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSRequest" } } } @@ -33193,21 +34643,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_AdHocPromptWSResponse" + "$ref" : "#/components/schemas/Relay_GetMinimalThirdPartyCameraStateListWSResponse" } } }, "description" : "OK" } }, - "summary" : "Execute a prompt, ad-hoc", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Get minimal third party camera state list", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/createPromptConfiguration" : { + "/api/relay/getRtspEndpoints" : { "post" : { - "description" : "Create scene query configuration", - "operationId" : "createPromptConfiguration", + "description" : "Gets rtsp endpoints for device with the specified mac address.", + "operationId" : "getRtspEndpoints", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33224,7 +34674,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_CreatePromptConfigurationWSRequest" + "$ref" : "#/components/schemas/Relay_GetRtspEndpointsWSRequest" } } } @@ -33234,21 +34684,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_CreatePromptConfigurationWSResponse" + "$ref" : "#/components/schemas/Relay_GetRtspEndpointsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create prompt configuration", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Get RTSP endpoints", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/deletePromptConfiguration" : { + "/api/relay/getThirdPartyCameraDiscoveryScanStatus" : { "post" : { - "description" : "Delete scene query configuration", - "operationId" : "deletePromptConfiguration", + "description" : "Returns the progress of the current/most-recent third-party camera discovery run in the org, so clients can show progress and distinguish not-started, in-progress, and complete (including complete-with-zero-cameras).", + "operationId" : "getThirdPartyCameraDiscoveryScanStatus", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33265,7 +34715,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_DeletePromptConfigurationWSRequest" + "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraDiscoveryScanStatusWSRequest" } } } @@ -33275,21 +34725,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_DeletePromptConfigurationWSResponse" + "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraDiscoveryScanStatusWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete prompt configuration", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Get third party camera discovery scan status", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/findPromptConfigurations" : { + "/api/relay/getThirdPartyCameraPasswords" : { "post" : { - "description" : "Find all scene query configurations", - "operationId" : "findAllPromptConfigurations", + "description" : "Get a list of the third party camera passwords", + "operationId" : "getThirdPartyCameraPasswords", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33306,7 +34756,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_FindAllPromptConfigurationsWSRequest" + "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSRequest" } } } @@ -33316,21 +34766,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_FindAllPromptConfigurationsWSResponse" + "$ref" : "#/components/schemas/Relay_GetThirdPartyCameraPasswordsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find all prompt configurations", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Get third party camera passwords", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/getPromptConfiguration" : { + "/api/relay/getUptimeWindows" : { "post" : { - "description" : "Get scene query configuration", - "operationId" : "getPromptConfiguration", + "description" : "Get uptime information for an NVR.", + "operationId" : "getRelayUptimeWindows", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33347,7 +34797,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_GetPromptConfigurationWSRequest" + "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSRequest" } } } @@ -33357,21 +34807,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_GetPromptConfigurationWSResponse" + "$ref" : "#/components/schemas/Common_devices_GetUptimeWindowsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get prompt configuration", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Get uptime information for an NVR.", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/optimizePromptChat" : { + "/api/relay/manualDiscoverCamera" : { "post" : { - "description" : "Optimize a scene query prompt through an interactive chat with Gemini", - "operationId" : "optimizePromptChat", + "description" : "Manually identify a camera on the network", + "operationId" : "manualDiscoverCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33388,7 +34838,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_PromptOptimizationChatWSRequest" + "$ref" : "#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSRequest" } } } @@ -33398,21 +34848,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_PromptOptimizationChatWSResponse" + "$ref" : "#/components/schemas/Relay_ManualDiscoverThirdPartyCameraWSResponse" } } }, "description" : "OK" } }, - "summary" : "Optimize prompt via chat", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Manual discover camera", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/selectiveUpdatePromptConfiguration" : { + "/api/relay/ptzMove" : { "post" : { - "description" : "Selectively update a scene query configuration", - "operationId" : "selectiveUpdatePromptConfiguration", + "description" : "Trigger a pan, tilt, or zoom", + "operationId" : "ptzMove", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33429,7 +34879,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_SelectiveUpdatePromptConfigurationWSRequest" + "$ref" : "#/components/schemas/Relay_PTZMoveWSRequest" } } } @@ -33439,21 +34889,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_SelectiveUpdatePromptConfigurationWSResponse" + "$ref" : "#/components/schemas/Relay_PTZMoveWSResponse" } } }, "description" : "OK" } }, - "summary" : "Selective update prompt configuration", - "tags" : [ "Scene Query Webservice" ] + "summary" : "PTZ move", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/triggerPrompt" : { + "/api/relay/ptzStatus" : { "post" : { - "description" : "Trigger scene query with a custom prompt", - "operationId" : "triggerPrompt", + "description" : "Returns ptz status", + "operationId" : "ptz", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33470,7 +34920,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_TriggerPromptWSRequest" + "$ref" : "#/components/schemas/Relay_PTZStatusWSRequest" } } } @@ -33480,21 +34930,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_TriggerPromptWSResponse" + "$ref" : "#/components/schemas/Relay_PTZStatusWSResponse" } } }, "description" : "OK" } }, - "summary" : "Trigger prompt", - "tags" : [ "Scene Query Webservice" ] + "summary" : "PTZ status", + "tags" : [ "Relay Webservice" ] } }, - "/api/scenequery/updatePromptConfiguration" : { + "/api/relay/reboot" : { "post" : { - "description" : "Update scene query configuration", - "operationId" : "updatePromptConfiguration", + "description" : "Reboot an NVR", + "operationId" : "rebootNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33511,7 +34961,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_UpdatePromptConfigurationWSRequest" + "$ref" : "#/components/schemas/Relay_RebootNVRVWSRequest" } } } @@ -33521,21 +34971,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scenequery_UpdatePromptConfigurationWSResponse" + "$ref" : "#/components/schemas/Relay_RebootNVRVWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update prompt configuration", - "tags" : [ "Scene Query Webservice" ] + "summary" : "Reboot NVR", + "tags" : [ "Relay Webservice" ] } }, - "/api/schedule/createAbsoluteSchedule" : { + "/api/relay/unassignThirdPartyCamera" : { "post" : { - "description" : "Create a absolute schedule", - "operationId" : "createAbsoluteSchedule", + "description" : "Unassign a third party camera from an NVR", + "operationId" : "unassignThirdPartyCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33552,7 +35002,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateAbsoluteScheduleWSRequest" + "$ref" : "#/components/schemas/Relay_UnassignThirdPartyCameraWSRequest" } } } @@ -33562,21 +35012,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateAbsoluteScheduleWSResponse" + "$ref" : "#/components/schemas/Relay_UnassignThirdPartyCameraWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create absolute schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Unassign third party camera", + "tags" : [ "Relay Webservice" ] } }, - "/api/schedule/createRelativeDateTimeIntervalsSchedule" : { + "/api/relay/unregister" : { "post" : { - "description" : "Create a one-time relative datetime schedule", - "operationId" : "createRelativeDateTimeIntervalsSchedule", + "description" : "Remove an NVR from organization", + "operationId" : "unregisterNVR", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33593,7 +35043,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateRelativeDateTimeIntervalsScheduleWSRequest" + "$ref" : "#/components/schemas/Relay_UnregisterNVRWSRequest" } } } @@ -33603,21 +35053,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateRelativeDateTimeIntervalsScheduleWSResponse" + "$ref" : "#/components/schemas/Relay_UnregisterNVRWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create relative datetime intervals schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Unregister NVR", + "tags" : [ "Relay Webservice" ] } }, - "/api/schedule/createRelativeSchedule" : { + "/api/relay/updateDetailsV2" : { "post" : { - "description" : "Create a realtime relative schedule", - "operationId" : "createRelativeSchedule", + "description" : "Update hardware details of NVR.", + "operationId" : "updateNVRDetailsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33634,7 +35084,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateRelativeScheduleWSRequest" + "$ref" : "#/components/schemas/Relay_UpdateNVRWSRequest" } } } @@ -33644,21 +35094,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateRelativeScheduleWSResponse" + "$ref" : "#/components/schemas/Relay_UpdateNVRWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create relative schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Update NVR details V2", + "tags" : [ "Relay Webservice" ] } }, - "/api/schedule/createWeeklySchedule" : { + "/api/relay/updateFirmware" : { "post" : { - "description" : "Create a weekly schedule", - "operationId" : "createWeeklySchedule", + "description" : "Send command to update firmware to NVR", + "operationId" : "updateNVRFirmware", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33675,7 +35125,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateWeeklyScheduleWSRequest" + "$ref" : "#/components/schemas/Relay_UpdateNVRFirmwareWSRequest" } } } @@ -33685,21 +35135,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_CreateWeeklyScheduleWSResponse" + "$ref" : "#/components/schemas/Relay_UpdateNVRFirmwareWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create weekly schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Update NVR firmware", + "tags" : [ "Relay Webservice" ] } }, - "/api/schedule/deleteSchedule" : { + "/api/report/getAuditFeed" : { "post" : { - "description" : "Delete a schedule", - "operationId" : "deleteScheduleV2", + "description" : "Get the latest audit logs for organization", + "operationId" : "getAuditFeed", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33716,7 +35166,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteScheduleWSRequest" + "$ref" : "#/components/schemas/Report_GetAuditFeedWSRequest" } } } @@ -33726,21 +35176,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Policy_DeleteScheduleWSResponse" + "$ref" : "#/components/schemas/Report_GetAuditFeedWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get audit feed", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/findAbsoluteSchedule" : { + "/api/report/getBatchThresholdCrossingCountReport" : { "post" : { - "description" : "Find an absolute schedule", - "operationId" : "findAbsoluteSchedule", + "description" : "Get batch threshold crossing count report", + "operationId" : "getBatchThresholdCrossingCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33757,7 +35207,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindAbsoluteScheduleWSRequest" + "$ref" : "#/components/schemas/Report_GetBatchThresholdCrossingCountReportWSRequest" } } } @@ -33767,21 +35217,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindAbsoluteScheduleWSResponse" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find absolute schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get batch threshold crossing count report", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/findRelativeDateTimeIntervalsSchedule" : { + "/api/report/getCountReport" : { "post" : { - "description" : "Find a one-time relative datetime schedule", - "operationId" : "findRelativeDateTimeIntervalsSchedule", + "deprecated" : true, + "description" : "Use /getCountReportV2 instead", + "operationId" : "getCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33798,7 +35249,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindRelativeDateTimeIntervalsScheduleWSRequest" + "$ref" : "#/components/schemas/Report_GetCountReportWSRequest" } } } @@ -33808,21 +35259,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindRelativeDateTimeIntervalsScheduleWSResponse" + "$ref" : "#/components/schemas/Report_GetCountReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find relative datetime intervals schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get count report", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/findRelativeSchedule" : { + "/api/report/getCountReportV2" : { "post" : { - "description" : "Find a relative schedule", - "operationId" : "findRelativeSchedule", + "description" : "Get the specified count reports", + "operationId" : "getCountReportV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33839,7 +35290,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindRelativeScheduleWSRequest" + "$ref" : "#/components/schemas/Report_GetCountReportV2WSRequest" } } } @@ -33849,21 +35300,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindRelativeScheduleWSResponse" + "$ref" : "#/components/schemas/Report_GetCountReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find relative schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get count report V2", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/findWeeklySchedule" : { + "/api/report/getCountReports" : { "post" : { - "description" : "Find a weekly schedule", - "operationId" : "findWeeklySchedule", + "description" : "Get multiple specified count reports", + "operationId" : "getCountReports", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33880,7 +35331,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindWeeklyScheduleWSRequest" + "$ref" : "#/components/schemas/Report_GetCountReportsWSRequest" } } } @@ -33890,21 +35341,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_FindWeeklyScheduleWSResponse" + "$ref" : "#/components/schemas/Report_GetCountReportsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find weekly schedule", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get count reports", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/getScheduleData" : { + "/api/report/getCountReportsForDevicesAtLocation" : { "post" : { - "description" : "Get weekly schedules in org with usage data", - "operationId" : "getScheduleData", + "description" : "Get count reports by device for a specified location", + "operationId" : "getCountReportsForDevicesAtLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33921,7 +35372,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_GetSchedulesWSRequest" + "$ref" : "#/components/schemas/Report_GetCountReportsForDevicesAtLocationWSRequest" } } } @@ -33931,21 +35382,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_GetScheduleDataWSResponse" + "$ref" : "#/components/schemas/Report_GetCountReportsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get schedule data", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get count reports for devices at location", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/getScheduleDataV2" : { + "/api/report/getCustomEventsBinaryCounts" : { "post" : { - "description" : "Get weekly schedules in org with usage data", - "operationId" : "getScheduleDataV2", + "description" : "Retrieves aggregated counts of boolean event values (true/false) produced by a selected prompt over a specified time window.\n\nScope & filters:\n\t•\tpromptUuid – The prompt to aggregate (required).\n\nTime window & interval:\n\t•\tA time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.\n\t•\tIf an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.\n\t•\tAggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.\n\nResponse:\n\t•\tPer interval bucket, returns a BinaryAggregationValue with counts for true and false.\n\t•\tIncludes minValueTimestampMs and maxValueTimestampMs (if available) and the bucket timestamp from BaseReportValue.\n\nNotes:\n\t•\tOnly binary/boolean prompt types are valid for this endpoint.\n", + "operationId" : "getCustomEventsBinaryCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -33962,7 +35413,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_GetScheduleDataV2WSRequest" + "$ref" : "#/components/schemas/Report_GetCustomLLMWSRequest" } } } @@ -33972,21 +35423,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_GetScheduleDataV2WSResponse" + "$ref" : "#/components/schemas/Report_GetCustomLLMWBinaryWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get schedule data V2", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get custom events aggregation binary counts", + "tags" : [ "Report Webservice" ] } }, - "/api/schedule/getSchedules" : { + "/api/report/getCustomEventsNumericCounts" : { "post" : { - "description" : "Get schedules in org", - "operationId" : "getSchedules", + "description" : "Retrieves aggregated statistics for numeric events event values produced by a selected prompt over a specified time window.\nScope & filters:\n\t•\tpromptUuid – The prompt to aggregate (required).\n\nTime window & interval:\n\t•\tA time range (startTimeMs → endTimeMs, epoch ms) is required and is used exactly as provided.\n\t•\tIf an interval is supplied (e.g., MINUTELY, QUARTERHOURLY, HOURLY), events are bucketed at that granularity.\n\t•\tAggregation is always performed in the device’s local timezone. Buckets are computed relative to each device’s timezone, then evaluated within the exact provided window.\n\nResponse:\n\t•\tPer interval bucket, returns numeric aggregates derived from raw values: count, sum, min, max, average.\n\t•\tIncludes minValueTimestampMs and maxValueTimestampMs indicating when min/max occurred within the bucket (if available).\n\t•\tBucket timestamps are returned as epoch ms.\n\nNotes:\n\t•\tOnly numeric prompt types are valid for this endpoint.\n", + "operationId" : "getCustomEventsNumericCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34003,7 +35454,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_GetSchedulesWSRequest" + "$ref" : "#/components/schemas/Report_GetCustomLLMWSRequest" } } } @@ -34013,22 +35464,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Schedule_GetSchedulesWSResponse" + "$ref" : "#/components/schemas/Report_GetCustomLLMNumericWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get schedules", - "tags" : [ "Schedule Webservice" ] + "summary" : "Get custom events aggregation numeric counts", + "tags" : [ "Report Webservice" ] } }, - "/api/search/searchLicensePlates" : { + "/api/report/getCustomEventsReport" : { "post" : { - "deprecated" : true, - "description" : "Fuzzy search for license plate sightings based on a partial or full plate number. Use /vehicle/getVehicleEvents instead.", - "operationId" : "searchLicensePlates", + "description" : "Retrieves a custom events report containing raw time-series event values recorded by selected prompts and devices within the specified time window.\nThe report can be filtered by:\n\t•\tpromptUuid – The specific prompt to query.\n\t•\tdeviceFacetUuids – A set of devices to include.\n\t•\tlocationUuid – The location context for the query.\nFor example, a request may specify a promptUuid to fetch results from a certain LLM prompt, and additionally restrict results to only devices in a given locationUuid.\nThe time range (startTimeMs → endTimeMs) is required and determines the interval of events returned.\nThe response includes, per device and prompt, the raw event values (numeric or boolean as string) along with timestamps, check-condition results (if selected), and prompt type.", + "operationId" : "getCustomEventsReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34045,7 +35495,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchLicensePlatesWSRequest" + "$ref" : "#/components/schemas/Report_GetCustomLLMReportWSRequest" } } } @@ -34055,21 +35505,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchLicensePlatesWSResponse" + "$ref" : "#/components/schemas/Report_GetCustomLLMReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Search license plates", - "tags" : [ "Search Webservice" ] + "summary" : "Get custom events report", + "tags" : [ "Report Webservice" ] } }, - "/api/search/searchObjectsByColor" : { + "/api/report/getDiagnosticFeed" : { "post" : { - "description" : "Search for objects by color", - "operationId" : "searchObjectsByColor", + "description" : "Get the latest diagnostic logs for organization", + "operationId" : "getDiagnosticFeed", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34086,7 +35536,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchObjectsByColorWSRequest" + "$ref" : "#/components/schemas/Report_GetDiagnosticFeedWSRequest" } } } @@ -34096,21 +35546,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchObjectsByColorWSResponse" + "$ref" : "#/components/schemas/Report_GetDiagnosticFeedWSResponse" } } }, "description" : "OK" } }, - "summary" : "Search objects by color", - "tags" : [ "Search Webservice" ] + "summary" : "Get diagnostic feed", + "tags" : [ "Report Webservice" ] } }, - "/api/search/searchSimilarObjectEmbeddings" : { + "/api/report/getEnvoyDeliveries" : { "post" : { - "description" : "Search for similar objects by embedding", - "operationId" : "searchSimilarObjectEmbeddings", + "description" : "Get a list of deliveries from Envoy to populate reporting logs", + "operationId" : "getEnvoyDeliveries", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34127,7 +35577,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSRequest" + "$ref" : "#/components/schemas/Integration_GetEnvoyDeliveriesWSRequest" } } } @@ -34137,21 +35587,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSResponse" + "$ref" : "#/components/schemas/Integration_GetEnvoyDeliveriesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Search similar object embeddings", - "tags" : [ "Search Webservice" ] + "summary" : "Get Envoy deliveries", + "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, - "/api/search/searchSimilarObjectEmbeddingsByText" : { + "/api/report/getEnvoyEmployees" : { "post" : { - "description" : "Search for similar objects by text", - "operationId" : "searchSimilarObjectEmbeddingsByText", + "description" : "Get a list of employees from Envoy", + "operationId" : "getEnvoyEmployees", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34168,7 +35618,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsByTextWSRequest" + "$ref" : "#/components/schemas/Integration_GetEnvoyEmployeesWSRequest" } } } @@ -34178,21 +35628,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSResponse" + "$ref" : "#/components/schemas/Integration_GetEnvoyEmployeesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Search similar object embeddings by text", - "tags" : [ "Search Webservice" ] + "summary" : "Get Envoy employees", + "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, - "/api/sensors/getFootageSensorSeekpointsForCamera" : { + "/api/report/getEnvoyLocations" : { "post" : { - "description" : "Retrieves sensor activity seekpoints for a specific camera within a given time range. Returns footage seekpoints that correspond to sensor events detected by the camera.", - "operationId" : "getSensorFootageSensorSeekpointsForCamera", + "description" : "Get list of Envoy locations", + "operationId" : "getEnvoyLocations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34209,7 +35659,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForCameraWSRequest" + "$ref" : "#/components/schemas/Integration_GetEnvoyLocationsWSRequest" } } } @@ -34219,21 +35669,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForCameraWSResponse" + "$ref" : "#/components/schemas/Integration_GetEnvoyLocationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get sensor activity seekpoints for camera", - "tags" : [ "Sensor Webservice" ] + "summary" : "Get Envoy locations", + "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, - "/api/sensors/getFootageSensorSeekpointsForLocation" : { + "/api/report/getEnvoyVisitors" : { "post" : { - "description" : "Retrieves sensor activity seekpoints for a specific location within a given time range. Returns footage seekpoints that correspond to sensor events detected at the specified location.", - "operationId" : "getFootageSensorSeekpointsForLocation", + "description" : "Get a list of visitors from Envoy to populate reporting logs", + "operationId" : "getEnvoyVisitors", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34250,7 +35700,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForLocationWSRequest" + "$ref" : "#/components/schemas/Integration_GetEnvoyVisitorsWSRequest" } } } @@ -34260,21 +35710,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForLocationWSResponse" + "$ref" : "#/components/schemas/Integration_GetEnvoyVisitorsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get sensor activity seekpoints for location", - "tags" : [ "Sensor Webservice" ] + "summary" : "Get Envoy visitors", + "tags" : [ "Integrations Webservice", "Report Webservice" ] } }, - "/api/sensors/getFootageSensorSeekpointsForSensor" : { + "/api/report/getIntegrationDiagnosticEvents" : { "post" : { - "description" : "Retrieves sensor activity seekpoints for a specific sensor within a given time range. Returns footage seekpoints that correspond to events detected by the specified sensor device.", - "operationId" : "getFootageSensorSeekpointsForSensor", + "description" : "Get the diagnostic logs of supported third-party devices for organization", + "operationId" : "getIntegrationDiagnosticEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34291,7 +35741,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForSensorWSRequest" + "$ref" : "#/components/schemas/Integration_GetIntegrationDiagnosticEventsWSRequest" } } } @@ -34301,21 +35751,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForSensorWSResponse" + "$ref" : "#/components/schemas/Integration_GetIntegrationDiagnosticEventsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get sensor activity seekpoints for sensor", - "tags" : [ "Sensor Webservice" ] + "summary" : "Get integration diagnostic events", + "tags" : [ "Report Webservice" ] } }, - "/api/tvos/getTvOsConfig" : { + "/api/report/getLicensePlatesByDevice" : { "post" : { - "description" : "Retrieves a specific tvOs configuration by UUID, returning the detailed settings and parameters for a particular Apple TV client.", - "operationId" : "getTvOsConfig", + "description" : "Get license plate counting events for a specified camera", + "operationId" : "getLicensePlatesByDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34332,7 +35782,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Tvos_GetTvOsConfigWsRequest" + "$ref" : "#/components/schemas/Report_GetLicensePlatesByDeviceWSRequest" } } } @@ -34342,21 +35792,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Tvos_GetTvOsConfigWsResponse" + "$ref" : "#/components/schemas/Report_GetLicensePlatesByDeviceWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get specific tvOs config", - "tags" : [ "TvOs Config Webservice" ] + "summary" : "Get license plates by device", + "tags" : [ "Report Webservice" ] } }, - "/api/tvos/getTvOsConfigsForOrg" : { + "/api/report/getOccupancyCounts" : { "post" : { - "description" : "Retrieves all tvOs configurations for the organization, providing a list of all Apple TV client configurations and their settings.", - "operationId" : "getTvOsConfigsForOrg", + "description" : "Returns the estimated occupancy count for a specified room or area within a given time range. This endpoint allows you to monitor occupancy trends over time or retrieve a single count for a defined interval.\nImportant: An occupancy region must be defined in the Rhombus Console before using this endpoint.\nYou can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY ...) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime.\nIf no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.", + "operationId" : "getOccupancyCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34373,7 +35823,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Tvos_GetTvOsConfigsForOrgWsRequest" + "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSRequest" } } } @@ -34383,21 +35833,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Tvos_GetTvOsConfigsForOrgWsResponse" + "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get tvOs configs for organization", - "tags" : [ "TvOs Config Webservice" ] + "summary" : "Get occupancy counts", + "tags" : [ "Report Webservice" ] } }, - "/api/tvos/updateTvOsConfig" : { + "/api/report/getOccupancyCountsV2" : { "post" : { - "description" : "Updates the configuration for a tvOs client, allowing modification of settings and parameters for Apple TV applications.", - "operationId" : "updateTvOsConfig", + "description" : "Returns the estimated occupancy count for a specified room or area within a given time range using person reidentification data.\nImportant: An occupancy region must be defined in the Rhombus Console before using this endpoint.\nYou can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HOURLY ...) to retrieve occupancy counts broken down by sub-intervals between startTime and endTime.\nIf no interval is provided, a single occupancy count is returned for the entire duration between startTime and endTime.", + "operationId" : "getOccupancyCountsV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34414,7 +35864,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Tvos_UpdateTvOsConfigWsRequest" + "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSRequest" } } } @@ -34424,21 +35874,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Tvos_UpdateTvOsConfigWsResponse" + "$ref" : "#/components/schemas/Report_GetOccupancyCountsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update tvOs config", - "tags" : [ "TvOs Config Webservice" ] + "summary" : "Get occupancy counts V2", + "tags" : [ "Report Webservice" ] } }, - "/api/upload/badgeTemplate/images" : { + "/api/report/getProximityTagLocationsByDate" : { "post" : { - "description" : "Uploads images for badge templates with associated metadata, supporting JPEG and PNG formats with size validation and automatic S3 storage.", - "operationId" : "uploadBadgeTemplateImages", + "description" : "Get proximity tag locations by date", + "operationId" : "getProximityTagLocationsByDate", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34453,9 +35903,9 @@ } ], "requestBody" : { "content" : { - "multipart/form-data" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/FormDataMultiPart" + "$ref" : "#/components/schemas/Report_GetProximityTagLocationsByDateWSRequest" } } } @@ -34465,21 +35915,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/Report_GetProximityTagLocationsByDateWSResponse" } } }, "description" : "OK" } }, - "summary" : "Upload badge template images", - "tags" : [ "Upload Webservice" ] + "summary" : "Get proximity tag locations by date", + "tags" : [ "Report Webservice" ] } }, - "/api/upload/bulkUploadUserProfilePhotos" : { + "/api/report/getRunningAverage" : { "post" : { - "description" : "Uploads multiple user profile pictures in a single request, supporting up to 100 photos with automatic user matching based on filename or metadata. Each photo must be <= 5MB.", - "operationId" : "bulkUploadUserProfilePhotos", + "description" : "Get the running average for the specified count report if it is available, based on recent data", + "operationId" : "getRunningAverage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34494,9 +35944,9 @@ } ], "requestBody" : { "content" : { - "multipart/form-data" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/FormDataMultiPart" + "$ref" : "#/components/schemas/Report_GetRunningAverageWSRequest" } } } @@ -34506,21 +35956,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/Report_GetRunningAverageWSResponse" } } }, "description" : "OK" } }, - "summary" : "Bulk upload user profile pictures", - "tags" : [ "Upload Webservice" ] + "summary" : "Get running average", + "tags" : [ "Report Webservice" ] } }, - "/api/upload/companyLogo" : { + "/api/report/getSummaryCountReport" : { "post" : { - "description" : "Uploads a company logo image, supporting various formats including JPEG, PNG, BMP, GIF, WebP, and PSD, and updates the organization's logo URL.", - "operationId" : "uploadCompanyLogo", + "description" : "Get a summary report for a camera, location, or organization", + "operationId" : "getSummaryCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34535,9 +35985,9 @@ } ], "requestBody" : { "content" : { - "multipart/form-data" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/FormDataMultiPart" + "$ref" : "#/components/schemas/Report_GetSummaryCountReportWSRequest" } } } @@ -34547,21 +35997,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/Report_GetSummaryCountReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Upload company logo", - "tags" : [ "Upload Webservice" ] + "summary" : "Get summary count report", + "tags" : [ "Report Webservice" ] } }, - "/api/upload/floorplan" : { + "/api/report/getThresholdCrossingCountReport" : { "post" : { - "description" : "Uploads a new floorplan image for a location, supporting multiple formats including JPEG, PNG, PDF, WebP, and SVG with automatic conversion to JPEG for SVG files.", - "operationId" : "uploadNewFloorPlan", + "description" : "Get threshold crossing count report for device", + "operationId" : "getThresholdCrossingCountReport", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34576,9 +36026,9 @@ } ], "requestBody" : { "content" : { - "multipart/form-data" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/FormDataMultiPart" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSRequest" } } } @@ -34588,21 +36038,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Upload new floorplan for location", - "tags" : [ "Upload Webservice" ] + "summary" : "Get threshold crossing count report for device", + "tags" : [ "Report Webservice" ] } }, - "/api/upload/keypadLogo" : { + "/api/report/getThresholdCrossingCountReportForOrg" : { "post" : { - "description" : "Uploads a logo image for keypad devices, generating a unique UUID and storing the image with proper metadata and organization association.", - "operationId" : "uploadKeypadLogo", + "description" : "Get org wide batch threshold crossing count report", + "operationId" : "getThresholdCrossingCountReportForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34617,9 +36067,9 @@ } ], "requestBody" : { "content" : { - "multipart/form-data" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/FormDataMultiPart" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportForOrgWSRequest" } } } @@ -34629,21 +36079,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountReportWSResponse" } } }, "description" : "OK" } }, - "summary" : "Upload keypad logo", - "tags" : [ "Upload Webservice" ] + "summary" : "Get org wide batch threshold crossing count report", + "tags" : [ "Report Webservice" ] } }, - "/api/upload/rhombusKeyLogo" : { + "/api/report/getThresholdCrossingCounts" : { "post" : { - "description" : "Uploads a logo image for Rhombus key devices, generating a unique UUID and storing the image with proper metadata and organization association.", - "operationId" : "uploadRhombusKeyLogo", + "deprecated" : true, + "description" : "Get the occupancy counts from threshold crossing for a group of cameras over a period of time", + "operationId" : "getThresholdCrossingCounts", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34658,9 +36109,9 @@ } ], "requestBody" : { "content" : { - "multipart/form-data" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/FormDataMultiPart" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSRequest" } } } @@ -34670,21 +36121,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Response" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Upload Rhombus key logo", - "tags" : [ "Upload Webservice" ] + "summary" : "Get threshold crossing counts", + "tags" : [ "Report Webservice" ] } }, - "/api/user/assignEmailToUser" : { + "/api/report/getThresholdCrossingEvents" : { "post" : { - "description" : "Assign a user to an email as long as the user is not currently assigned to one, with validation to prevent duplicate email associations.", - "operationId" : "assignEmailToUser", + "description" : "Get the raw threshold crossing events for a group of cameras over a period of time", + "operationId" : "getThresholdCrossingEvents", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34701,7 +36152,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_AssignEmailToUserWSRequest" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsWSRequest" } } } @@ -34711,21 +36162,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_AssignEmailToUserWSResponse" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Assign email to user", - "tags" : [ "User Webservice" ] + "summary" : "Get threshold crossing events", + "tags" : [ "Report Webservice" ] } }, - "/api/user/createUser" : { + "/api/report/getThresholdCrossingEventsForDevice" : { "post" : { - "description" : "Create a user for organization with specified name, email, and role permissions, supporting both client and partner user types with proper validation and audit logging.", - "operationId" : "createUser", + "description" : "Get threshold crossing events for device", + "operationId" : "getThresholdCrossingEventsForDevice", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34742,7 +36193,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_CreateUserWSRequest" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsForDeviceWSRequest" } } } @@ -34752,21 +36203,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_CreateUserWSResponse" + "$ref" : "#/components/schemas/Report_GetThresholdCrossingEventsForDeviceWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create user for organization", - "tags" : [ "User Webservice" ] + "summary" : "Get threshold crossing events for device", + "tags" : [ "Report Webservice" ] } }, - "/api/user/deleteUser" : { + "/api/report/getToastEventsTable" : { "post" : { - "description" : "Delete a user from the organization with proper validation to prevent deletion of the last super admin and current user.", - "operationId" : "deleteUser", + "description" : "Get list of Toast orders to populate events table", + "operationId" : "getToastEventsTable", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34783,7 +36234,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_DeleteUserWSRequest" + "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSRequest" } } } @@ -34793,30 +36244,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_DeleteUserWSResponse" + "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete user", - "tags" : [ "User Webservice" ] + "summary" : "Get Toast events table", + "tags" : [ "Report Webservice" ] } }, - "/api/user/getPartnerUsersInOrg" : { + "/api/report/getToastEventsTableAllLocations" : { "post" : { - "description" : "Get list of all partners in organization with partner-specific user details and permissions.", - "operationId" : "getPartnerUsersInOrg", + "description" : "Get list of Toast orders from all restaurants to populate events table", + "operationId" : "getToastEventsTableAllLocations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -34824,7 +36275,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerUsersInOrgWSRequest" + "$ref" : "#/components/schemas/Integration_GetToastEventsTableAllLocationsWSRequest" } } } @@ -34834,21 +36285,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Partner_GetPartnerUsersInOrgWSResponse" + "$ref" : "#/components/schemas/Integration_GetToastEventsTableAllLocationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get partner users in organization", - "tags" : [ "User Webservice" ] + "summary" : "Get Toast events table all locations", + "tags" : [ "Report Webservice" ] } }, - "/api/user/getUsersInOrg" : { + "/api/report/resetRunningAverage" : { "post" : { - "description" : "Get list of all users in organization with complete user details, permissions, notification settings, and partner information.", - "operationId" : "getUsersInOrg", + "description" : "Reset the running average for the specified count report", + "operationId" : "resetRunningAverage", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34865,7 +36316,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_GetUsersInOrgWSRequest" + "$ref" : "#/components/schemas/Report_ResetRunningAverageWSRequest" } } } @@ -34875,21 +36326,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_GetUsersInOrgWSResponse" + "$ref" : "#/components/schemas/Report_ResetRunningAverageWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get users in organization", - "tags" : [ "User Webservice" ] + "summary" : "Reset running average", + "tags" : [ "Report Webservice" ] } }, - "/api/user/metadata/createUserMetadataFieldTemplate" : { + "/api/rules/createRule" : { "post" : { - "description" : "Create a new template user metadata field that will be applicable to all users in the organization, allowing custom field definitions for user data.", - "operationId" : "createUserMetadataFieldTemplate", + "description" : "Create a rule", + "operationId" : "createRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34906,7 +36357,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_CreateUserMetadataFieldTemplateWSRequest" + "$ref" : "#/components/schemas/Rules_CreateRuleWSRequest" } } } @@ -34916,21 +36367,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_CreateUserMetadataFieldTemplateWSResponse" + "$ref" : "#/components/schemas/Rules_CreateRuleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create user metadata field template", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Create rule", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/metadata/deleteUserMetadataField" : { + "/api/rules/deleteIncomingWebhookToken" : { "post" : { - "description" : "Deletes the specified user's value stored for the specified template, removing the custom field value while preserving the template definition.", - "operationId" : "deleteUserMetadataField", + "description" : "Delete an incoming webhook trigger token so its URL no longer fires rules", + "operationId" : "deleteIncomingWebhookToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34947,7 +36398,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldWSRequest" + "$ref" : "#/components/schemas/Rules_DeleteIncomingWebhookTokenWSRequest" } } } @@ -34957,21 +36408,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldWSResponse" + "$ref" : "#/components/schemas/Rules_DeleteIncomingWebhookTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete user metadata field", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Delete incoming webhook trigger token", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/metadata/deleteUserMetadataFieldTemplate" : { + "/api/rules/deleteRule" : { "post" : { - "description" : "Delete a template user metadata field. THIS WILL DELETE THE CUSTOM FIELD AND USER DATA FOR THIS FIELD, permanently removing the field definition and all associated user values.", - "operationId" : "deleteUserMetadataFieldTemplate", + "description" : "Delete a rule", + "operationId" : "deleteRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -34988,7 +36439,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldTemplateWSRequest" + "$ref" : "#/components/schemas/Rules_DeleteRuleWSRequest" } } } @@ -34998,21 +36449,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldTemplateWSResponse" + "$ref" : "#/components/schemas/Rules_DeleteRuleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete user metadata field template", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Delete rule", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/metadata/findUserMetadataFieldTemplates" : { + "/api/rules/deleteRulePauseSetting" : { "post" : { - "description" : "Find all template user metadata fields for the organization, returning the complete list of custom field definitions available for users.", - "operationId" : "findUserMetadataFieldTemplates", + "description" : "Delete a rule pause setting", + "operationId" : "deleteRulePauseSetting", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35029,7 +36480,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldTemplatesWSRequest" + "$ref" : "#/components/schemas/Rules_DeleteRulePauseSettingWSRequest" } } } @@ -35039,21 +36490,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldTemplatesWSResponse" + "$ref" : "#/components/schemas/Rules_DeleteRulePauseSettingWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find user metadata field templates", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Delete rule pause setting", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/metadata/findUserMetadataFields" : { + "/api/rules/generateIncomingWebhookToken" : { "post" : { - "description" : "Returns the org template metadata fields and the queried users stored values for those fields if they've been set, providing complete metadata information for a specific user.", - "operationId" : "findUserMetadataFields", + "description" : "Generate a token and public URL that fires INCOMING_WEBHOOK_EVENT rule triggers when requested", + "operationId" : "generateIncomingWebhookToken", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35070,7 +36521,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldsWSRequest" + "$ref" : "#/components/schemas/Rules_GenerateIncomingWebhookTokenWSRequest" } } } @@ -35080,21 +36531,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldsWSResponse" + "$ref" : "#/components/schemas/Rules_GenerateIncomingWebhookTokenWSResponse" } } }, "description" : "OK" } }, - "summary" : "Find user metadata fields", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Generate incoming webhook trigger token", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/metadata/saveUserMetadataFields" : { + "/api/rules/getRulePauseSettings" : { "post" : { - "description" : "Saves custom metadata values for the user specified. Template IDs that do not map to an actual org metadata template are ignored and values for omitted Template IDs are left as-is.", - "operationId" : "saveUserMetadataFields", + "description" : "Get the current and planned rule pause details", + "operationId" : "getRulePauseSettings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35111,7 +36562,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_SaveUserMetadataFieldsWSRequest" + "$ref" : "#/components/schemas/Rules_GetRulePauseSettingsWSRequest" } } } @@ -35121,21 +36572,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_SaveUserMetadataFieldsWSResponse" + "$ref" : "#/components/schemas/Rules_GetRulePauseSettingsResponse" } } }, "description" : "OK" } }, - "summary" : "Save user metadata fields", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Get rule pause settings", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/metadata/updateUserMetadataFieldTemplate" : { + "/api/rules/getRulesFiltered" : { "post" : { - "description" : "Update a template user metadata field that will be applicable to all users, allowing modification of existing custom field definitions.", - "operationId" : "updateUserMetadataFieldTemplate", + "description" : "Get rules with Uuid and Type filtering", + "operationId" : "getRulesFiltered", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35152,7 +36603,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_UpdateUserMetadataFieldTemplateWSRequest" + "$ref" : "#/components/schemas/Rules_records_GetRulesFilteredWSRequest" } } } @@ -35162,30 +36613,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_metadata_UpdateUserMetadataFieldTemplateWSResponse" + "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update user metadata field template", - "tags" : [ "User Metadata Webservice" ] + "summary" : "Get rules filtered", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/updatePartnerUser" : { + "/api/rules/getRulesForOrg" : { "post" : { - "description" : "Update a partner's details with partner-specific validation and audit logging.", - "operationId" : "updatePartnerUser", + "description" : "List rules for org", + "operationId" : "getRulesForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -35193,7 +36644,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdatePartnerWSRequest" + "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSRequest" } } } @@ -35203,30 +36654,30 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdatePartnerWSResponse" + "$ref" : "#/components/schemas/Rules_GetRulesForOrgWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update partner user details", - "tags" : [ "User Webservice" ] + "summary" : "Get rules for org", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/updatePartnerUserNotificationSettings" : { + "/api/rules/pauseRule" : { "post" : { - "description" : "Update notification settings for partner user with partner-specific notification configurations.", - "operationId" : "updatePartnerUserNotificationSettings", + "description" : "Pause rule", + "operationId" : "pauseRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", - "example" : "partner-api-token", + "example" : "api-token", "in" : "header", "name" : "x-auth-scheme", "required" : true, "schema" : { "type" : "string", - "default" : "partner-api-token", + "default" : "api-token", "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], @@ -35234,7 +36685,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSRequest" + "$ref" : "#/components/schemas/Rules_PauseRuleWSRequest" } } } @@ -35244,21 +36695,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSResponse" + "$ref" : "#/components/schemas/Rules_PauseRuleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update partner user notification settings", - "tags" : [ "User Webservice" ] + "summary" : "Pause rule", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/updateRhombusKeySettingsForUser" : { + "/api/rules/updateRule" : { "post" : { - "description" : "Update the RhombusKey mobile app settings for the user, including access permissions and app configuration.", - "operationId" : "updateRhombusKeySettingsForUser", + "description" : "Update a rule", + "operationId" : "updateRule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35275,7 +36726,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateRhombusKeySettingsForUserWSRequest" + "$ref" : "#/components/schemas/Rules_UpdateRuleWSRequest" } } } @@ -35285,22 +36736,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateRhombusKeySettingsForUserWSResponse" + "$ref" : "#/components/schemas/Rules_UpdateRuleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update Rhombus key settings for user", - "tags" : [ "User Webservice" ] + "summary" : "Update rule", + "tags" : [ "Rules Webservice" ] } }, - "/api/user/updateUser" : { + "/api/rulesRecords/deleteRulesEventRecord" : { "post" : { - "deprecated" : true, - "description" : "Update a user's details, DEPRECATED[4/28/2025]: use updateUserSelective for better field-level control.", - "operationId" : "updateUser", + "description" : "Delete a rules event historical record", + "operationId" : "deleteRulesEventRecord", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35317,7 +36767,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateUserWSRequest" + "$ref" : "#/components/schemas/Rules_records_DeleteRulesEventRecordWSRequest" } } } @@ -35327,21 +36777,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateUserWSResponse" + "$ref" : "#/components/schemas/Rules_records_DeleteRulesEventRecordWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update user details", - "tags" : [ "User Webservice" ] + "summary" : "Delete rules event record", + "tags" : [ "Rules Records Webservice" ] } }, - "/api/user/updateUserNotificationSettings" : { + "/api/rulesRecords/getLatestRulesEventRecords" : { "post" : { - "description" : "Update notification settings for user with various notification channels and preferences.", - "operationId" : "updateUserNotificationSettings", + "description" : "Get N latest rules event historical records", + "operationId" : "getLatestRulesEventRecords", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35358,7 +36808,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSRequest" + "$ref" : "#/components/schemas/Rules_records_GetLatestRulesEventRecordsWSRequest" } } } @@ -35368,21 +36818,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSResponse" + "$ref" : "#/components/schemas/Rules_records_GetLatestRulesEventRecordsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update user notification settings", - "tags" : [ "User Webservice" ] + "summary" : "Get latest rules event records", + "tags" : [ "Rules Records Webservice" ] } }, - "/api/user/updateUserSelective" : { + "/api/rulesRecords/getRulesEventRecords" : { "post" : { - "description" : "Selectively updates a user's details. Omitted fields are ignored but fields with null will unset a value, providing granular control over user updates.", - "operationId" : "updateUserSelective", + "description" : "Find rules event historical records", + "operationId" : "getRulesEventRecords", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35399,7 +36849,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateUserSelectiveWSRequest" + "$ref" : "#/components/schemas/Rules_records_GetRulesEventRecordsWSRequest" } } } @@ -35409,21 +36859,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/User_UpdateUserSelectiveWSResponse" + "$ref" : "#/components/schemas/Rules_records_GetRulesEventRecordsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Update user details selectively", - "tags" : [ "User Webservice" ] + "summary" : "Get rules event records", + "tags" : [ "Rules Records Webservice" ] } }, - "/api/vehicle/addVehicleLabel" : { + "/api/scenequery/adHocPrompt" : { "post" : { - "description" : "Add a label to a vehicle", - "operationId" : "addVehicleLabel", + "description" : "Exectue an existing prompt, ad-hoc", + "operationId" : "adHocPrompt", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35440,7 +36890,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_AddVehicleLabelWSRequest" + "$ref" : "#/components/schemas/Scenequery_AdHocPromptWSRequest" } } } @@ -35450,21 +36900,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_AddVehicleLabelWSResponse" + "$ref" : "#/components/schemas/Scenequery_AdHocPromptWSResponse" } } }, "description" : "OK" } }, - "summary" : "Add vehicle label", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Execute a prompt, ad-hoc", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/associateEventsToVehicle" : { + "/api/scenequery/createPromptConfiguration" : { "post" : { - "description" : "Associate vehicle events to a saved vehicle", - "operationId" : "associateEventsToVehicle", + "description" : "Create scene query configuration", + "operationId" : "createPromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35481,7 +36931,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_AssociateEventsToVehicleWSRequest" + "$ref" : "#/components/schemas/Scenequery_CreatePromptConfigurationWSRequest" } } } @@ -35491,21 +36941,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_AssociateEventsToVehicleWSResponse" + "$ref" : "#/components/schemas/Scenequery_CreatePromptConfigurationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Associate events to vehicle", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Create prompt configuration", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/deleteVehicle" : { + "/api/scenequery/deletePromptConfiguration" : { "post" : { - "description" : "Delete a saved vehicle", - "operationId" : "deleteVehicle", + "description" : "Delete scene query configuration", + "operationId" : "deletePromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35522,7 +36972,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_DeleteVehicleWSRequest" + "$ref" : "#/components/schemas/Scenequery_DeletePromptConfigurationWSRequest" } } } @@ -35532,22 +36982,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_DeleteVehicleWSResponse" + "$ref" : "#/components/schemas/Scenequery_DeletePromptConfigurationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete vehicle", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Delete prompt configuration", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/getRecentVehicleEvents" : { + "/api/scenequery/findPromptConfigurations" : { "post" : { - "deprecated" : true, - "description" : "Get recent vehicle events for organization. Use /vehicle/getVehicleEvents instead.", - "operationId" : "getRecentVehicleEvents", + "description" : "Find all scene query configurations", + "operationId" : "findAllPromptConfigurations", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35564,7 +37013,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsWSRequest" + "$ref" : "#/components/schemas/Scenequery_FindAllPromptConfigurationsWSRequest" } } } @@ -35574,22 +37023,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsWSResponse" + "$ref" : "#/components/schemas/Scenequery_FindAllPromptConfigurationsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get recent vehicle events", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Find all prompt configurations", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/getRecentVehicleEventsByLocation" : { + "/api/scenequery/getPromptConfiguration" : { "post" : { - "deprecated" : true, - "description" : "Get recent vehicle events for a location. Use /vehicle/getVehicleEvents instead.", - "operationId" : "getRecentVehicleEventsByLocation", + "description" : "Get scene query configuration", + "operationId" : "getPromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35606,7 +37054,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsByLocationWSRequest" + "$ref" : "#/components/schemas/Scenequery_GetPromptConfigurationWSRequest" } } } @@ -35616,22 +37064,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsByLocationWSResponse" + "$ref" : "#/components/schemas/Scenequery_GetPromptConfigurationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get recent vehicle events by location", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Get prompt configuration", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/getRecentVehicleEventsForVehicle" : { + "/api/scenequery/optimizePromptChat" : { "post" : { - "deprecated" : true, - "description" : "Get recent vehicle events for specified vehicle. Use /vehicle/getVehicleEvents instead.", - "operationId" : "getRecentVehicleEventsForVehicle", + "description" : "Optimize a scene query prompt through an interactive chat with Gemini", + "operationId" : "optimizePromptChat", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35648,7 +37095,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsForVehicleWSRequest" + "$ref" : "#/components/schemas/Scenequery_PromptOptimizationChatWSRequest" } } } @@ -35658,21 +37105,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsForVehicleWSResponse" + "$ref" : "#/components/schemas/Scenequery_PromptOptimizationChatWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get recent vehicle events for vehicle", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Optimize prompt via chat", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/getVehicleEvents" : { + "/api/scenequery/selectiveUpdatePromptConfiguration" : { "post" : { - "description" : "Get vehicle events with filters and additive queries", - "operationId" : "getVehicleEvents", + "description" : "Selectively update a scene query configuration", + "operationId" : "selectiveUpdatePromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35689,7 +37136,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSRequest" + "$ref" : "#/components/schemas/Scenequery_SelectiveUpdatePromptConfigurationWSRequest" } } } @@ -35699,21 +37146,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSResponse" + "$ref" : "#/components/schemas/Scenequery_SelectiveUpdatePromptConfigurationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get vehicle events", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Selective update prompt configuration", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/getVehicleLabelsForOrg" : { + "/api/scenequery/triggerPrompt" : { "post" : { - "description" : "Get all vehicle labels for organization", - "operationId" : "getVehicleLabelsForOrg", + "description" : "Trigger scene query with a custom prompt", + "operationId" : "triggerPrompt", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35730,7 +37177,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetVehicleLabelsForOrgWSRequest" + "$ref" : "#/components/schemas/Scenequery_TriggerPromptWSRequest" } } } @@ -35740,21 +37187,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetVehicleLabelsForOrgWSResponse" + "$ref" : "#/components/schemas/Scenequery_TriggerPromptWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get vehicle labels for organization", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Trigger prompt", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/getVehicles" : { + "/api/scenequery/updatePromptConfiguration" : { "post" : { - "description" : "Get details of all saved vehicles in organization", - "operationId" : "getVehicles", + "description" : "Update scene query configuration", + "operationId" : "updatePromptConfiguration", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35771,7 +37218,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetVehiclesWSRequest" + "$ref" : "#/components/schemas/Scenequery_UpdatePromptConfigurationWSRequest" } } } @@ -35781,21 +37228,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_GetVehiclesWSResponse" + "$ref" : "#/components/schemas/Scenequery_UpdatePromptConfigurationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get vehicles", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Update prompt configuration", + "tags" : [ "Scene Query Webservice" ] } }, - "/api/vehicle/removeVehicleLabel" : { + "/api/schedule/createAbsoluteSchedule" : { "post" : { - "description" : "Remove a label to a vehicle", - "operationId" : "removeVehicleLabel", + "description" : "Create a absolute schedule", + "operationId" : "createAbsoluteSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35812,7 +37259,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_RemoveVehicleLabelWSRequest" + "$ref" : "#/components/schemas/Schedule_CreateAbsoluteScheduleWSRequest" } } } @@ -35822,21 +37269,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_RemoveVehicleLabelWSResponse" + "$ref" : "#/components/schemas/Schedule_CreateAbsoluteScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Remove vehicle label", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Create absolute schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/vehicle/reportVehicleEvent" : { + "/api/schedule/createRelativeDateTimeIntervalsSchedule" : { "post" : { - "description" : "Report a mis-detected license plate event. This sends the image/clip to Rhombus to better train AI models and removes the event", - "operationId" : "reportVehicleEvent", + "description" : "Create a one-time relative datetime schedule", + "operationId" : "createRelativeDateTimeIntervalsSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35853,7 +37300,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_ReportVehicleEventRequest" + "$ref" : "#/components/schemas/Schedule_CreateRelativeDateTimeIntervalsScheduleWSRequest" } } } @@ -35863,21 +37310,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_ReportVehicleEventResponse" + "$ref" : "#/components/schemas/Schedule_CreateRelativeDateTimeIntervalsScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Report vehicle event", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Create relative datetime intervals schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/vehicle/saveVehicle" : { + "/api/schedule/createRelativeSchedule" : { "post" : { - "description" : "Name and save a vehicle based on license plate number", - "operationId" : "saveVehicle", + "description" : "Create a realtime relative schedule", + "operationId" : "createRelativeSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35894,7 +37341,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_SaveVehicleWSRequest" + "$ref" : "#/components/schemas/Schedule_CreateRelativeScheduleWSRequest" } } } @@ -35904,22 +37351,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Vehicle_SaveVehicleWSResponse" + "$ref" : "#/components/schemas/Schedule_CreateRelativeScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Save vehicle", - "tags" : [ "Vehicle Webservice" ] + "summary" : "Create relative schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/cancelSplice" : { + "/api/schedule/createWeeklySchedule" : { "post" : { - "deprecated" : true, - "description" : "Use /cancelSpliceV2 instead", - "operationId" : "cancelSplice", + "description" : "Create a weekly schedule", + "operationId" : "createWeeklySchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35936,7 +37382,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_CancelSpliceWSRequest" + "$ref" : "#/components/schemas/Schedule_CreateWeeklyScheduleWSRequest" } } } @@ -35946,21 +37392,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_CancelSpliceWSResponse" + "$ref" : "#/components/schemas/Schedule_CreateWeeklyScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Cancel splice", - "tags" : [ "Video Webservice" ] + "summary" : "Create weekly schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/cancelSpliceV2" : { + "/api/schedule/deleteSchedule" : { "post" : { - "description" : "Cancel a spliced clip request", - "operationId" : "cancelSpliceV2", + "description" : "Delete a schedule", + "operationId" : "deleteScheduleV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -35977,7 +37423,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_CancelSpliceV2WSRequest" + "$ref" : "#/components/schemas/Policy_DeleteScheduleWSRequest" } } } @@ -35987,21 +37433,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_CancelSpliceV2WSResponse" + "$ref" : "#/components/schemas/Policy_DeleteScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Cancel splice V2", - "tags" : [ "Video Webservice" ] + "summary" : "Delete schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/createSharedTimelapseGroup" : { + "/api/schedule/findAbsoluteSchedule" : { "post" : { - "description" : "Share multiple timelapses in one link", - "operationId" : "createSharedTimelapseGroup", + "description" : "Find an absolute schedule", + "operationId" : "findAbsoluteSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36018,7 +37464,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_CreateSharedTimelapseGroupWSRequest" + "$ref" : "#/components/schemas/Schedule_FindAbsoluteScheduleWSRequest" } } } @@ -36028,21 +37474,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_CreateSharedTimelapseGroupWSResponse" + "$ref" : "#/components/schemas/Schedule_FindAbsoluteScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Create shared timelapse group", - "tags" : [ "Video Webservice" ] + "summary" : "Find absolute schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/deleteSharedTimelapseGroup" : { + "/api/schedule/findRelativeDateTimeIntervalsSchedule" : { "post" : { - "description" : "Delete a shared timelapse link", - "operationId" : "deleteSharedTimelapseGroup", + "description" : "Find a one-time relative datetime schedule", + "operationId" : "findRelativeDateTimeIntervalsSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36059,7 +37505,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_DeleteSharedTimelapseGroupWSRequest" + "$ref" : "#/components/schemas/Schedule_FindRelativeDateTimeIntervalsScheduleWSRequest" } } } @@ -36069,21 +37515,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_DeleteSharedTimelapseGroupWSResponse" + "$ref" : "#/components/schemas/Schedule_FindRelativeDateTimeIntervalsScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete shared timelapse group", - "tags" : [ "Video Webservice" ] + "summary" : "Find relative datetime intervals schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/deleteTimelapseClips" : { + "/api/schedule/findRelativeSchedule" : { "post" : { - "description" : "Delete a timelapse", - "operationId" : "deleteTimelapseClips", + "description" : "Find a relative schedule", + "operationId" : "findRelativeSchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36100,7 +37546,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_DeleteTimelapseClipsWSRequest" + "$ref" : "#/components/schemas/Schedule_FindRelativeScheduleWSRequest" } } } @@ -36110,21 +37556,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_DeleteTimelapseClipsWSResponse" + "$ref" : "#/components/schemas/Schedule_FindRelativeScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Delete timelapse clips", - "tags" : [ "Video Webservice" ] + "summary" : "Find relative schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/generateTimelapseClip" : { + "/api/schedule/findWeeklySchedule" : { "post" : { - "description" : "Generate a timelapse", - "operationId" : "generateTimelapseClip", + "description" : "Find a weekly schedule", + "operationId" : "findWeeklySchedule", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36141,7 +37587,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GenerateTimelapseClipWSRequest" + "$ref" : "#/components/schemas/Schedule_FindWeeklyScheduleWSRequest" } } } @@ -36151,21 +37597,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GenerateTimelapseClipWSResponse" + "$ref" : "#/components/schemas/Schedule_FindWeeklyScheduleWSResponse" } } }, "description" : "OK" } }, - "summary" : "Generate timelapse clip", - "tags" : [ "Video Webservice" ] + "summary" : "Find weekly schedule", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/getExactFrameUri" : { + "/api/schedule/getScheduleData" : { "post" : { - "description" : "Generate URL to get an exact frame with optional crop from a camera", - "operationId" : "getExactFrameUri", + "description" : "Get weekly schedules in org with usage data", + "operationId" : "getScheduleData", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36182,7 +37628,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetExactFrameUriWSRequest" + "$ref" : "#/components/schemas/Schedule_GetSchedulesWSRequest" } } } @@ -36192,21 +37638,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetExactFrameUriWSResponse" + "$ref" : "#/components/schemas/Schedule_GetScheduleDataWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get exact frame URI", - "tags" : [ "Video Webservice" ] + "summary" : "Get schedule data", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/getMaxSpliceDuration" : { + "/api/schedule/getScheduleDataV2" : { "post" : { - "description" : "Get the max splice duration an organization can set", - "operationId" : "getMaxSpliceDuration", + "description" : "Get weekly schedules in org with usage data", + "operationId" : "getScheduleDataV2", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36223,7 +37669,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetMaxSpliceDurationWSRequest" + "$ref" : "#/components/schemas/Schedule_GetScheduleDataV2WSRequest" } } } @@ -36233,21 +37679,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetMaxSpliceDurationWSResponse" + "$ref" : "#/components/schemas/Schedule_GetScheduleDataV2WSResponse" } } }, "description" : "OK" } }, - "summary" : "Get max splice duration", - "tags" : [ "Video Webservice" ] + "summary" : "Get schedule data V2", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/getSharedTimelapseGroups" : { + "/api/schedule/getSchedules" : { "post" : { - "description" : "Get details of all shared timelapse links for organization", - "operationId" : "getSharedTimelapseGroups", + "description" : "Get schedules in org", + "operationId" : "getSchedules", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36264,7 +37710,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetSharedTimelapseGroupsWSRequest" + "$ref" : "#/components/schemas/Schedule_GetSchedulesWSRequest" } } } @@ -36274,21 +37720,22 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetSharedTimelapseGroupsWSResponse" + "$ref" : "#/components/schemas/Schedule_GetSchedulesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get shared timelapse groups", - "tags" : [ "Video Webservice" ] + "summary" : "Get schedules", + "tags" : [ "Schedule Webservice" ] } }, - "/api/video/getSplicedClipsInProgress" : { + "/api/search/searchLicensePlates" : { "post" : { - "description" : "Get all spliced clips in progress", - "operationId" : "getSplicedClipsInProgress", + "deprecated" : true, + "description" : "Fuzzy search for license plate sightings based on a partial or full plate number. Use /vehicle/getVehicleEvents instead.", + "operationId" : "searchLicensePlates", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36305,7 +37752,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetSplicedClipsInProgressWSRequest" + "$ref" : "#/components/schemas/Search_SearchLicensePlatesWSRequest" } } } @@ -36315,21 +37762,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetSplicedClipsInProgressWSResponse" + "$ref" : "#/components/schemas/Search_SearchLicensePlatesWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get spliced clips in progress", - "tags" : [ "Video Webservice" ] + "summary" : "Search license plates", + "tags" : [ "Search Webservice" ] } }, - "/api/video/getTimelapseClips" : { + "/api/search/searchObjectsByColor" : { "post" : { - "description" : "Get all timelapse clips for organization", - "operationId" : "getTimelapseClips", + "description" : "Search for objects by color", + "operationId" : "searchObjectsByColor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36346,7 +37793,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetTimelapseClipsWSRequest" + "$ref" : "#/components/schemas/Search_SearchObjectsByColorWSRequest" } } } @@ -36356,21 +37803,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetTimelapseClipsWSResponse" + "$ref" : "#/components/schemas/Search_SearchObjectsByColorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get timelapse clips", - "tags" : [ "Video Webservice" ] + "summary" : "Search objects by color", + "tags" : [ "Search Webservice" ] } }, - "/api/video/getTimelapseMetadata" : { + "/api/search/searchSimilarObjectEmbeddings" : { "post" : { - "description" : "Get information about earliest available timelapse images for cameras", - "operationId" : "getTimelapseMetadata", + "description" : "Search for similar objects by embedding", + "operationId" : "searchSimilarObjectEmbeddings", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36387,7 +37834,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetTimelapseMetadataWSRequest" + "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSRequest" } } } @@ -36397,21 +37844,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_GetTimelapseMetadataWSResponse" + "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Get timelapse metadata", - "tags" : [ "Video Webservice" ] + "summary" : "Search similar object embeddings", + "tags" : [ "Search Webservice" ] } }, - "/api/video/retrySplice" : { + "/api/search/searchSimilarObjectEmbeddingsByText" : { "post" : { - "description" : "Send a request to retry splicing a clip", - "operationId" : "retrySplice", + "description" : "Search for similar objects by text", + "operationId" : "searchSimilarObjectEmbeddingsByText", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36428,7 +37875,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_RetrySpliceWSRequest" + "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsByTextWSRequest" } } } @@ -36438,22 +37885,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_RetrySpliceWSResponse" + "$ref" : "#/components/schemas/Search_SearchSimilarObjectEmbeddingsWSResponse" } } }, "description" : "OK" } }, - "summary" : "Retry splice", - "tags" : [ "Video Webservice" ] + "summary" : "Search similar object embeddings by text", + "tags" : [ "Search Webservice" ] } }, - "/api/video/shareTimelapseClips" : { + "/api/sensors/getFootageSensorSeekpointsForCamera" : { "post" : { - "deprecated" : true, - "description" : "Use /CreateSharedTimelapseGroup instead", - "operationId" : "shareTimelapseClips", + "description" : "Retrieves sensor activity seekpoints for a specific camera within a given time range. Returns footage seekpoints that correspond to sensor events detected by the camera.", + "operationId" : "getSensorFootageSensorSeekpointsForCamera", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36470,7 +37916,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_ShareTimelapseClipsWSRequest" + "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForCameraWSRequest" } } } @@ -36480,22 +37926,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_ShareTimelapseClipsWSResponse" + "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForCameraWSResponse" } } }, "description" : "OK" } }, - "summary" : "Share timelapse clips", - "tags" : [ "Video Webservice" ] + "summary" : "Get sensor activity seekpoints for camera", + "tags" : [ "Sensor Webservice" ] } }, - "/api/video/splice" : { + "/api/sensors/getFootageSensorSeekpointsForLocation" : { "post" : { - "deprecated" : true, - "description" : "Use /spliceV3 instead", - "operationId" : "splice", + "description" : "Retrieves sensor activity seekpoints for a specific location within a given time range. Returns footage seekpoints that correspond to sensor events detected at the specified location.", + "operationId" : "getFootageSensorSeekpointsForLocation", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36512,7 +37957,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceWSRequest" + "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForLocationWSRequest" } } } @@ -36522,21 +37967,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceWSResponse" + "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForLocationWSResponse" } } }, "description" : "OK" } }, - "summary" : "Splice", - "tags" : [ "Video Webservice" ] + "summary" : "Get sensor activity seekpoints for location", + "tags" : [ "Sensor Webservice" ] } }, - "/api/video/spliceFrame" : { + "/api/sensors/getFootageSensorSeekpointsForSensor" : { "post" : { - "description" : "Send a request to create a single image from a point in time", - "operationId" : "spliceFrame", + "description" : "Retrieves sensor activity seekpoints for a specific sensor within a given time range. Returns footage seekpoints that correspond to events detected by the specified sensor device.", + "operationId" : "getFootageSensorSeekpointsForSensor", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36553,7 +37998,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceFrameWSRequest" + "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForSensorWSRequest" } } } @@ -36563,22 +38008,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceFrameWSResponse" + "$ref" : "#/components/schemas/Sensor_GetFootageSensorSeekpointsForSensorWSResponse" } } }, "description" : "OK" } }, - "summary" : "Splice frame", - "tags" : [ "Video Webservice" ] + "summary" : "Get sensor activity seekpoints for sensor", + "tags" : [ "Sensor Webservice" ] } }, - "/api/video/spliceV2" : { + "/api/tvos/getTvOsConfig" : { "post" : { - "deprecated" : true, - "description" : "Use /spliceV3 instead", - "operationId" : "spliceV2", + "description" : "Retrieves a specific tvOs configuration by UUID, returning the detailed settings and parameters for a particular Apple TV client.", + "operationId" : "getTvOsConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36595,7 +38039,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceV2WSRequest" + "$ref" : "#/components/schemas/Tvos_GetTvOsConfigWsRequest" } } } @@ -36605,21 +38049,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceV2WSResponse" + "$ref" : "#/components/schemas/Tvos_GetTvOsConfigWsResponse" } } }, "description" : "OK" } }, - "summary" : "Splice V2", - "tags" : [ "Video Webservice" ] + "summary" : "Get specific tvOs config", + "tags" : [ "TvOs Config Webservice" ] } }, - "/api/video/spliceV3" : { + "/api/tvos/getTvOsConfigsForOrg" : { "post" : { - "description" : "Send a request to create an arbitrary clip for multiple cameras", - "operationId" : "spliceV3", + "description" : "Retrieves all tvOs configurations for the organization, providing a list of all Apple TV client configurations and their settings.", + "operationId" : "getTvOsConfigsForOrg", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36636,7 +38080,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceV3WSRequest" + "$ref" : "#/components/schemas/Tvos_GetTvOsConfigsForOrgWsRequest" } } } @@ -36646,21 +38090,21 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_SpliceV3WSResponse" + "$ref" : "#/components/schemas/Tvos_GetTvOsConfigsForOrgWsResponse" } } }, "description" : "OK" } }, - "summary" : "Splice V3", - "tags" : [ "Video Webservice" ] + "summary" : "Get tvOs configs for organization", + "tags" : [ "TvOs Config Webservice" ] } }, - "/api/video/updateSharedTimelapseGroup" : { + "/api/tvos/updateTvOsConfig" : { "post" : { - "description" : "Update title, description, or expiration on a shared timelapse link", - "operationId" : "updateSharedTimelapseGroup", + "description" : "Updates the configuration for a tvOs client, allowing modification of settings and parameters for Apple TV applications.", + "operationId" : "updateTvOsConfig", "parameters" : [ { "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", "example" : "api-token", @@ -36677,7 +38121,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_UpdateSharedTimelapseGroupWSRequest" + "$ref" : "#/components/schemas/Tvos_UpdateTvOsConfigWsRequest" } } } @@ -36687,3077 +38131,2580 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Video_UpdateSharedTimelapseGroupWSResponse" + "$ref" : "#/components/schemas/Tvos_UpdateTvOsConfigWsResponse" } } }, "description" : "OK" } }, - "summary" : "Update shared timelapse group", - "tags" : [ "Video Webservice" ] + "summary" : "Update tvOs config", + "tags" : [ "TvOs Config Webservice" ] } - } - }, - "components" : { - "schemas" : { - "ACUDoorCatalogItem" : { - "type" : "object", - "allOf" : [ ], - "nullable" : true, - "properties" : { - "durationMonths" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "productCode" : { + }, + "/api/upload/badgeTemplate/images" : { + "post" : { + "description" : "Uploads images for badge templates with associated metadata, supporting JPEG and PNG formats with size validation and automatic S3 storage.", + "operationId" : "uploadBadgeTemplateImages", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "ACUDoorLicenseType" : { - "type" : "object", - "description" : "List of access controlled door licenses available for the client organization", - "properties" : { - "claimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "doorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "firstAssignedDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "licenseToUnassignEmailState" : { - "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" - }, - "maxDeleteDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "priorClaimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "productCode" : { - "type" : "string", - "nullable" : true - }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - }, - "state" : { - "$ref" : "#/components/schemas/LicenseStateEnum" - }, - "trial" : { - "type" : "boolean", - "nullable" : true - }, - "updatedOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } } - } - }, - "AIReport" : { - "type" : "object", - "description" : "The AI report to update", - "properties" : { - "completedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "groupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "params" : { - "$ref" : "#/components/schemas/AIReportGenerateParams" - }, - "principalUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "privacy" : { - "$ref" : "#/components/schemas/ChatPrivacy" - }, - "scheduleUuid" : { - "type" : "string", - "nullable" : true - }, - "scheduledAiReportUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "startedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "structureJson" : { - "type" : "string", - "nullable" : true - }, - "timeline" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/QueryTimelineEvent" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } }, - "nullable" : true - }, - "title" : { + "description" : "OK" + } + }, + "summary" : "Upload badge template images", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/upload/bulkUploadUserProfilePhotos" : { + "post" : { + "description" : "Uploads multiple user profile pictures in a single request, supporting up to 100 photos with automatic user matching based on filename or metadata. Each photo must be <= 5MB.", + "operationId" : "bulkUploadUserProfilePhotos", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "toolingTimeline" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/QueryTool" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } }, - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "description" : "OK" } - } - }, - "AIReportGenerateParams" : { - "type" : "object", - "properties" : { - "additionalPrompt" : { + }, + "summary" : "Bulk upload user profile pictures", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/upload/companyLogo" : { + "post" : { + "description" : "Uploads a company logo image, supporting various formats including JPEG, PNG, BMP, GIF, WebP, and PSD, and updates the organization's logo URL.", + "operationId" : "uploadCompanyLogo", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "dataSources" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DataSourceEnum" - }, - "nullable" : true - }, - "deviceUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "rangeEndMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "rangeStartMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AIReportGroup" : { - "type" : "object", - "description" : "List of AI reports", - "properties" : { - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastModifiedMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "latestStatus" : { - "$ref" : "#/components/schemas/QueryStatusEnum" - }, - "numReports" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "principalUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "privacy" : { - "$ref" : "#/components/schemas/ChatPrivacy" - }, - "scheduledAiReportUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "title" : { - "type" : "string", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } } - } - }, - "AITShipmentInfoType" : { - "type" : "object", - "nullable" : true, - "properties" : { - "aitTrackingNumber" : { - "type" : "string", - "nullable" : true - }, - "carrierTrackingNumber" : { - "type" : "string", - "nullable" : true - }, - "depositorOrderNumber" : { - "type" : "string", - "nullable" : true - }, - "destinationAddress" : { - "type" : "string", - "nullable" : true - }, - "isIngramDistributorShipment" : { - "type" : "boolean", - "nullable" : true - }, - "shipmentDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "shippedItems" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ShippedItemType" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } }, - "nullable" : true + "description" : "OK" } - } - }, - "ALMActionEnum" : { - "type" : "string", - "description" : "The ALM-related action that occurred.", - "enum" : [ "LOCATION_CONFIG_CREATED", "LOCATION_CONFIG_UPDATED", "LOCATION_CONFIG_DELETED", "ZONE_CONFIG_CREATED", "ZONE_CONFIG_UPDATED", "ZONE_CONFIG_DELETED", "MONITORING_ENABLED", "MONITORING_DISABLED", "MONITORING_MANUALLY_ARMED", "MONITORING_MANUAL_ARM_CANCELED", "MONITORING_MANUALLY_PAUSED", "MONITORING_MANUAL_PAUSE_CANCELED", "MARK_LOCATION_FOR_CLEANUP", "UNMARK_LOCATION_FOR_CLEANUP", "LOCATION_CLEANED_UP", "UNKNOWN" ] - }, - "ALMConfig" : { - "type" : "object", - "description" : "A snapshot of the ALM config after this event succeeded.", - "discriminator" : { - "propertyName" : "type" }, - "properties" : { - "deleted" : { - "type" : "boolean", - "description" : "Indication of whether this config was deleted.", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/TypeEnum" - }, - "versionInfo" : { - "$ref" : "#/components/schemas/ALMModificationMetadata" - }, - "zoneId" : { + "summary" : "Upload company logo", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/upload/floorplan" : { + "post" : { + "description" : "Uploads a new floorplan image for a location, supporting multiple formats including JPEG, PNG, PDF, WebP, and SVG with automatic conversion to JPEG for SVG files.", + "operationId" : "uploadNewFloorPlan", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } } }, - "required" : [ "locationUuid" ] - }, - "ALMEvent" : { - "type" : "object", - "description" : "List of modification events showing who made changes", - "properties" : { - "action" : { - "$ref" : "#/components/schemas/ALMActionEnum" - }, - "auditInfo" : { - "$ref" : "#/components/schemas/ALMModificationMetadata" - }, - "config" : { - "$ref" : "#/components/schemas/ALMConfig" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "monitoringState" : { - "$ref" : "#/components/schemas/ALMMonitoringState" - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "outcome" : { - "$ref" : "#/components/schemas/DaoOutcomeEnum" - }, - "reason" : { - "type" : "string", - "description" : "Optional underlying reason for the result of the ALM-related action.", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "zoneId" : { - "type" : "string", - "description" : "ID of the ALM zone this event occurred with.", - "nullable" : true + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } + }, + "description" : "OK" } - } - }, - "ALMManualPolicySummary" : { - "type" : "object", - "description" : "Status of the ALM zone when operating in manual monitoring mode.", - "properties" : { - "armed" : { - "type" : "boolean", - "description" : "Indicates whether the ALM zone is currently armed in manual monitoring mode.", - "nullable" : true - }, - "summary" : { + }, + "summary" : "Upload new floorplan for location", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/upload/guestManagement/document" : { + "post" : { + "description" : "Uploads a PDF or DOCX document for guest management (e.g. for e-signature via SignatureAPI), storing it in S3 and recording it on the org's guest management settings.", + "operationId" : "uploadGuestManagementDocument", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "description" : "Explanation of the current manual monitoring state.", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "ALMModificationMetadata" : { - "type" : "object", - "description" : "Info regarding when and by whom this status was modified.", - "properties" : { - "modifiedAtMs" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX timestamp (in milliseconds) when the ALM config or state was modified.", - "nullable" : true - }, - "modifiedBy" : { - "type" : "string", - "description" : "The user/principal/entity that made the modification.", - "nullable" : true - }, - "modifiedByIntegration" : { - "type" : "boolean", - "description" : "Indication of whether the modification was due to an integration.", - "nullable" : true - }, - "modifiedByMetadata" : { - "type" : "string", - "description" : "Metadata describing when and under what conditions these modifications occurred.", - "nullable" : true - }, - "modifiedByUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } } - } - }, - "ALMMonitoringState" : { - "type" : "object", - "description" : "A snapshot of the ALM state after this event succeeded.", - "properties" : { - "armingRule" : { - "$ref" : "#/components/schemas/ArmMonitoringRule" - }, - "auditInfo" : { - "$ref" : "#/components/schemas/ALMModificationMetadata" - }, - "disarmingRule" : { - "$ref" : "#/components/schemas/DisarmMonitoringRule" - }, - "enabledSinceMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX timestamp (in milliseconds) when manual monitoring was enabled.", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "manualMonitoringEnabled" : { - "type" : "boolean", - "description" : "Indication of whether monitoring is enabled for manual monitoring mode.", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } + }, + "description" : "OK" } - } - }, - "ALMScheduledPolicySummary" : { - "type" : "object", - "description" : "Status of the ALM zone under each configured scheduled monitoring policy.", - "properties" : { - "alarmPolicyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "armed" : { - "type" : "boolean", - "description" : "Indicates whether the ALM zone is currently armed under this scheduled policy.", - "nullable" : true - }, - "armedEndMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX epoch timestamp (in milliseconds) at which the current or next scheduled armed window ends (exclusive).\n", - "nullable" : true - }, - "armedStartMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX epoch timestamp (in milliseconds) at which the current or next scheduled armed window begins (inclusive).\n", - "nullable" : true - }, - "summary" : { + }, + "summary" : "Upload guest management document", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/upload/keypadLogo" : { + "post" : { + "description" : "Uploads a logo image for keypad devices, generating a unique UUID and storing the image with proper metadata and organization association.", + "operationId" : "uploadKeypadLogo", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "description" : "Explanation of the scheduled monitoring state for this policy.", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "ALMSirenSettings" : { - "type" : "object", - "description" : "Optional siren configuration to play when a threat has been verified by the monitoring agent.\n", - "nullable" : true, - "properties" : { - "clipUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "durationSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The duration (in seconds) to loop the clip audio for the siren.", - "nullable" : true - }, - "playCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times to play the clip audio for the siren.", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } } }, - "required" : [ "clipUuid" ] - }, - "ALMZoneContext" : { - "type" : "object", - "description" : "List of the latest ALM zone contexts in the org.", - "properties" : { - "locationConfig" : { - "$ref" : "#/components/schemas/LocationALMConfig" - }, - "monitoringState" : { - "$ref" : "#/components/schemas/ALMMonitoringState" - }, - "zoneConfig" : { - "$ref" : "#/components/schemas/ZoneALMConfig" - } - } - }, - "ALMZoneSummary" : { - "type" : "object", - "description" : "List of summaries of the ALM zone statuses in the org.", - "properties" : { - "deviceLastPlayedAudioAtMs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "description" : "Per device, the last confirmed UNIX epoch timestamp (in milliseconds) at which audio was successfully played.\n", - "nullable" : true - }, - "description" : "Per device, the last confirmed UNIX epoch timestamp (in milliseconds) at which audio was successfully played.\n", - "nullable" : true - }, - "deviceSirenActivatedAtMs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "description" : "Per device, the UNIX epoch timestamp (in milliseconds) when the siren was most recently activated.\n", - "nullable" : true + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } }, - "description" : "Per device, the UNIX epoch timestamp (in milliseconds) when the siren was most recently activated.\n", - "nullable" : true - }, - "fullyConfigured" : { - "type" : "boolean", - "description" : "Indicates whether the ALM zone is fully configured and capable of producing a valid monitoring summary.\n", - "nullable" : true - }, - "manualPolicySummary" : { - "$ref" : "#/components/schemas/ALMManualPolicySummary" - }, - "mode" : { + "description" : "OK" + } + }, + "summary" : "Upload keypad logo", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/upload/rhombusKeyLogo" : { + "post" : { + "description" : "Uploads a logo image for Rhombus key devices, generating a unique UUID and storing the image with proper metadata and organization association.", + "operationId" : "uploadRhombusKeyLogo", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "description" : "The current monitoring mode for the ALM zone (e.g., MANUAL or SCHEDULED).", - "nullable" : true - }, - "scheduledPolicySummaries" : { - "type" : "array", - "description" : "Status of the ALM zone under each configured scheduled monitoring policy.", - "items" : { - "$ref" : "#/components/schemas/ALMScheduledPolicySummary" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/FormDataMultiPart" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Response" + } + } }, - "nullable" : true + "description" : "OK" } - } - }, - "AMSirenSettingsType" : { - "type" : "object", - "properties" : { - "clipUuid" : { + }, + "summary" : "Upload Rhombus key logo", + "tags" : [ "Upload Webservice" ] + } + }, + "/api/user/assignEmailToUser" : { + "post" : { + "description" : "Assign a user to an email as long as the user is not currently assigned to one, with validation to prevent duplicate email associations.", + "operationId" : "assignEmailToUser", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "durationSeconds" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "playCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - }, - "AbsoluteSecondsIntervalType" : { - "type" : "object", - "nullable" : true, - "properties" : { - "b" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "e" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AbsoluteSecondsScheduleType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "intervalList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" - }, - "nullable" : true + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_AssignEmailToUserWSRequest" + } } } - } ], - "nullable" : true, - "properties" : { - "mutable" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "oneTimeUse" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "strategy" : { - "$ref" : "#/components/schemas/ScheduleStrategyEnum" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_AssignEmailToUserWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "AccessControlAuthenticationResultEnumType" : { - "type" : "string", - "enum" : [ "ACCEPTED", "REJECTED", "ERROR", "NA" ] - }, - "AccessControlAuthorizationResultEnumType" : { - "type" : "string", - "enum" : [ "ALLOWED", "DENIED", "DISABLED", "ERROR", "NA" ] - }, - "AccessControlCredentialEnumType" : { - "type" : "string", - "enum" : [ "STANDARD_CSN", "RHOMBUS_SECURE_CSN", "RHOMBUS_SECURE_MOBILE", "PIN_CODE", "WIEGAND_H10301", "WIEGAND_H10304", "WIEGAND_D10202", "WIEGAND_64BIT_RAW", "HID_CORP1000_STD_35", "HID_CORP1000_STD_48", "CUSTOM" ] - }, - "AccessControlCredentialType" : { - "type" : "object", - "description" : "Updated Wiegand credential details", - "discriminator" : { - "propertyName" : "type" }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StandardCsnType" - }, { - "$ref" : "#/components/schemas/RhombusSecureCsnType" - }, { - "$ref" : "#/components/schemas/RhombusSecureMobileType" - }, { - "$ref" : "#/components/schemas/PinCredential" - }, { - "$ref" : "#/components/schemas/WiegandH10301CredentialType" - }, { - "$ref" : "#/components/schemas/WiegandH10304Credential" - }, { - "$ref" : "#/components/schemas/WiegandD10202Credential" - }, { - "$ref" : "#/components/schemas/Wiegand64BitRawCredentialType" - }, { - "$ref" : "#/components/schemas/CustomCredential" - } ], - "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastUsedAccessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "lastUsedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastUsedLocationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "lowercaseHexValue" : { - "type" : "string", - "nullable" : true, - "readOnly" : true - }, - "managedCredUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "note" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "value" : { + "summary" : "Assign email to user", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/createUser" : { + "post" : { + "description" : "Create a user for organization with specified name, email, and role permissions, supporting both client and partner user types with proper validation and audit logging.", + "operationId" : "createUser", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "workflowStatus" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlCredentialWorkflowStatusEnumType" : { - "type" : "string", - "enum" : [ "ACTIVE", "UNASSIGNED", "SUSPENDED", "REVOKED" ] - }, - "AccessControlUnitBatteryStateChangeEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "batteryFound" : { - "type" : "boolean", - "nullable" : true - }, - "batteryMa" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "batteryMv" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "onBackupPower" : { - "type" : "boolean", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_CreateUserWSRequest" + } } } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_CreateUserWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Create user for organization", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/deleteUser" : { + "post" : { + "description" : "Delete a user from the organization with proper validation to prevent deletion of the last super admin and current user.", + "operationId" : "deleteUser", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlUnitDoorFirstInStateEvent" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "doorAuthFirstInEventReference" : { - "$ref" : "#/components/schemas/DoorFirstInStateChangeEventReference" - }, - "doorScheduleFirstInEventReference" : { - "$ref" : "#/components/schemas/DoorFirstInStateChangeEventReference" - }, - "settingsUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_DeleteUserWSRequest" + } } } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_DeleteUserWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Delete user", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/getPartnerUsersInOrg" : { + "post" : { + "description" : "Get list of all partners in organization with partner-specific user details and permissions.", + "operationId" : "getPartnerUsersInOrg", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "partner-api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "correlationId" : { + "default" : "partner-api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Partner_GetPartnerUsersInOrgWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Partner_GetPartnerUsersInOrgWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get partner users in organization", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/getUsersInOrg" : { + "post" : { + "description" : "Get list of all users in organization with complete user details, permissions, notification settings, and partner information.", + "operationId" : "getUsersInOrg", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlUnitLocationLockdownStateEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "activatedLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - }, - "activeLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - }, - "deactivatedLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - }, - "doorEventReferenceMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DoorLockdownStateEventReference" - }, - "nullable" : true - }, - "followingTestPlan" : { - "type" : "boolean", - "nullable" : true - }, - "locationLockdownStateChangedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_GetUsersInOrgWSRequest" + } } } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_GetUsersInOrgWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get users in organization", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/metadata/createUserMetadataFieldTemplate" : { + "post" : { + "description" : "Create a new template user metadata field that will be applicable to all users in the organization, allowing custom field definitions for user data.", + "operationId" : "createUserMetadataFieldTemplate", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlUnitTamperEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "source" : { - "$ref" : "#/components/schemas/AccessControlUnitTamperSourceEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_CreateUserMetadataFieldTemplateWSRequest" + } } } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_CreateUserMetadataFieldTemplateWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Create user metadata field template", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/deleteUserMetadataField" : { + "post" : { + "description" : "Deletes the specified user's value stored for the specified template, removing the custom field value while preserving the template definition.", + "operationId" : "deleteUserMetadataField", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlUnitTamperSourceEnumType" : { - "type" : "string", - "enum" : [ "PROX", "ACCEL", "SWITCH", "NA" ] - }, - "AccessControlledDoorPolicyAlertType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "accessControlUnitUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "accessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "initiatingUsername" : { - "type" : "string", - "nullable" : true - }, - "originatorEntityName" : { - "type" : "string", - "nullable" : true - }, - "originatorEntityUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "originatorType" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldWSRequest" + } } } - } ], - "nullable" : true, - "properties" : { - "alertMonitoringThreatCaseUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "alertMonitoringVerified" : { - "type" : "boolean", - "nullable" : true - }, - "clipLocationMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "nullable" : true - }, - "clipLocationMapV2" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldWSResponse" + } + } }, - "nullable" : true - }, - "delayedProcessing" : { - "type" : "boolean", - "nullable" : true - }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "finalized" : { - "type" : "boolean", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "notificationSent" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { + "description" : "OK" + } + }, + "summary" : "Delete user metadata field", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/deleteUserMetadataFieldTemplate" : { + "post" : { + "description" : "Delete a template user metadata field. THIS WILL DELETE THE CUSTOM FIELD AND USER DATA FOR THIS FIELD, permanently removing the field definition and all associated user values.", + "operationId" : "deleteUserMetadataFieldTemplate", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "policyAlertTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldTemplateWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_DeleteUserMetadataFieldTemplateWSResponse" + } + } }, - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "saved" : { - "type" : "boolean", - "nullable" : true - }, - "shared" : { - "type" : "boolean", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "textDescription" : { - "type" : "string", - "description" : "Natural language description of the alert", - "nullable" : true - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "thumbnailLocationV2" : { - "type" : "string", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/PolicyAlertEnumType" - }, - "uuid" : { + "description" : "OK" + } + }, + "summary" : "Delete user metadata field template", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/findAllUserMetadataFieldsByOrg" : { + "post" : { + "description" : "Returns the org template metadata fields and every user's stored values for those fields, keyed by user uuid and then by template uuid. For callers that need the whole org at once, such as a user report, rather than one user at a time.", + "operationId" : "findAllUserMetadataFieldsByOrg", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlledDoorPolicyType" : { - "type" : "object", - "description" : "List of access controlled door policies using the schedule", - "properties" : { - "description" : { + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_FindAllUserMetadataFieldsByOrgWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_FindAllUserMetadataFieldsByOrgWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Find all user metadata fields in the org", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/findUserMetadataFieldTemplates" : { + "post" : { + "description" : "Find all template user metadata fields for the organization, returning the complete list of custom field definitions available for users.", + "operationId" : "findUserMetadataFieldTemplates", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "name" : { + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldTemplatesWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldTemplatesWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Find user metadata field templates", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/findUserMetadataFields" : { + "post" : { + "description" : "Returns the org template metadata fields and the queried users stored values for those fields if they've been set, providing complete metadata information for a specific user.", + "operationId" : "findUserMetadataFields", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_FindUserMetadataFieldsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Find user metadata fields", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/saveUserMetadataFields" : { + "post" : { + "description" : "Saves custom metadata values for the user specified. Template IDs that do not map to an actual org metadata template are ignored and values for omitted Template IDs are left as-is.", + "operationId" : "saveUserMetadataFields", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorScheduledTriggerType" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_SaveUserMetadataFieldsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_SaveUserMetadataFieldsWSResponse" + } + } }, - "nullable" : true - }, - "uuid" : { + "description" : "OK" + } + }, + "summary" : "Save user metadata fields", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/metadata/updateUserMetadataFieldTemplate" : { + "post" : { + "description" : "Update a template user metadata field that will be applicable to all users, allowing modification of existing custom field definitions.", + "operationId" : "updateUserMetadataFieldTemplate", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlledDoorScheduledTriggerType" : { - "type" : "object", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_UpdateUserMetadataFieldTemplateWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_metadata_UpdateUserMetadataFieldTemplateWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true + "description" : "OK" } - } - }, - "AccessControlledDoorShadow" : { - "type" : "object", - "properties" : { - "authFirstIn" : { - "$ref" : "#/components/schemas/FirstInShadow" - }, - "componentCompositeUuid" : { + }, + "summary" : "Update user metadata field template", + "tags" : [ "User Metadata Webservice" ] + } + }, + "/api/user/updatePartnerUser" : { + "post" : { + "description" : "Update a partner's details with partner-specific validation and audit logging.", + "operationId" : "updatePartnerUser", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "partner-api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "orgUuid" : { + "default" : "partner-api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdatePartnerWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdatePartnerWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update partner user details", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/updatePartnerUserNotificationSettings" : { + "post" : { + "description" : "Update notification settings for partner user with partner-specific notification configurations.", + "operationId" : "updatePartnerUserNotificationSettings", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "partner-api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { + "default" : "partner-api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdatePartnerUserNotificationSettingsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update partner user notification settings", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/updateRhombusKeySettingsForUser" : { + "post" : { + "description" : "Update the RhombusKey mobile app settings for the user, including access permissions and app configuration.", + "operationId" : "updateRhombusKeySettingsForUser", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "scheduleFirstIn" : { - "$ref" : "#/components/schemas/FirstInShadow" - }, - "state" : { - "$ref" : "#/components/schemas/AccessStateShadow" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentCompositeShadowEnum" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlledDoorStateEnumType" : { - "type" : "string", - "enum" : [ "UNLOCKED", "ACCESS_CONTROLLED" ] - }, - "AccessControlledDoorSubTypeEnum" : { - "type" : "string", - "enum" : [ "RHOMBUS", "APERIO" ] - }, - "AccessControlledDoorSubTypeEnum_Minimal" : { - "type" : "string", - "enum" : [ "RHOMBUS", "APERIO" ] - }, - "AccessControlledDoorType" : { - "type" : "object", - "properties" : { - "ajarTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "aperioDoorExtensionComponent" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "aperioDoorId" : { + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateRhombusKeySettingsForUserWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateRhombusKeySettingsForUserWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update Rhombus key settings for user", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/updateUser" : { + "post" : { + "deprecated" : true, + "description" : "Update a user's details, DEPRECATED[4/28/2025]: use updateUserSelective for better field-level control.", + "operationId" : "updateUser", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "aperioGatewayComponent" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateUserWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateUserWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "associatedFaceDetectionCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "description" : "OK" + } + }, + "summary" : "Update user details", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/updateUserNotificationSettings" : { + "post" : { + "description" : "Update notification settings for user with various notification channels and preferences.", + "operationId" : "updateUserNotificationSettings", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateUserNotificationSettingsWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "defaultState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "doorAuthFirstInStateOverride" : { - "$ref" : "#/components/schemas/FirstInState" - }, - "doorScheduleFirstInStateOverride" : { - "$ref" : "#/components/schemas/FirstInState" - }, - "doorStateOverride" : { - "$ref" : "#/components/schemas/BaseAccessStateOverride" - }, - "doorStateToScheduleUuidMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "dpiComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forcedOpenEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forcedOpenTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "geofenceEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "geofenceRadius" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "nfcSecureDowngradeEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "policyUuid" : { + "description" : "OK" + } + }, + "summary" : "Update user notification settings", + "tags" : [ "User Webservice" ] + } + }, + "/api/user/updateUserSelective" : { + "post" : { + "description" : "Selectively updates a user's details. Omitted fields are ignored but fields with null will unset a value, providing granular control over user updates.", + "operationId" : "updateUserSelective", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "privacyModeSupportEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "proximityUnlockSettings" : { - "$ref" : "#/components/schemas/ProximityUnlockSettingsType" - }, - "readerComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "relayComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "relockAfterOpenTimeMs" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "remoteUnlockEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "rexComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateUserSelectiveWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User_UpdateUserSelectiveWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "sendExpiredIntentEvents" : { - "type" : "boolean", - "nullable" : true - }, - "subType" : { - "$ref" : "#/components/schemas/AccessControlledDoorSubTypeEnum" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentCompositeEnumType" - }, - "unlockTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "unlockTimeSecRex" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "waveToUnlockSettings" : { - "$ref" : "#/components/schemas/WaveToUnlockSettingsType" + "description" : "OK" } - } - }, - "AccessControlledDoorType_Minimal" : { - "type" : "object", - "description" : "List of access controlled doors", - "properties" : { - "aperioDoorExtensionComponent" : { - "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" - }, - "aperioDoorId" : { + }, + "summary" : "Update user details selectively", + "tags" : [ "User Webservice" ] + } + }, + "/api/vehicle/addVehicleLabel" : { + "post" : { + "description" : "Add a label to a vehicle", + "operationId" : "addVehicleLabel", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "nullable" : true - }, - "aperioGatewayComponent" : { - "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" - }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "doorAuthFirstInStateOverride" : { - "$ref" : "#/components/schemas/FirstInState_Minimal" - }, - "doorScheduleFirstInStateOverride" : { - "$ref" : "#/components/schemas/FirstInState_Minimal" - }, - "doorStateOverride" : { - "$ref" : "#/components/schemas/BaseAccessStateOverride_Minimal" - }, - "dpiComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_AddVehicleLabelWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_AddVehicleLabelWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "geofenceEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "geofenceRadius" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "nfcSecureDowngradeEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { + "description" : "OK" + } + }, + "summary" : "Add vehicle label", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/associateEventsToVehicle" : { + "post" : { + "description" : "Associate vehicle events to a saved vehicle", + "operationId" : "associateEventsToVehicle", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "privacyModeSupportEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "proximityUnlockSettings" : { - "$ref" : "#/components/schemas/ProximityUnlockSettingsType_Minimal" - }, - "readerComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" - }, - "nullable" : true, - "uniqueItems" : true - }, - "relayComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" - }, - "nullable" : true, - "uniqueItems" : true - }, - "remoteUnlockEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "rexComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_AssociateEventsToVehicleWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_AssociateEventsToVehicleWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "subType" : { - "$ref" : "#/components/schemas/AccessControlledDoorSubTypeEnum_Minimal" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" - }, - "unlockTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "uuid" : { + "description" : "OK" + } + }, + "summary" : "Associate events to vehicle", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/deleteVehicle" : { + "post" : { + "description" : "Delete a saved vehicle", + "operationId" : "deleteVehicle", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "waveToUnlockSettings" : { - "$ref" : "#/components/schemas/WaveToUnlockSettingsType_Minimal" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlledElevator" : { - "type" : "object", - "properties" : { - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "associatedFaceDetectionCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "elevatorLandingReferences" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ElevatorLandingReference" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_DeleteVehicleWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_DeleteVehicleWSResponse" + } + } }, - "nullable" : true - }, - "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "geofenceEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "geofenceRadius" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "nfcSecureDowngradeEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "policyUuid" : { + "description" : "OK" + } + }, + "summary" : "Delete vehicle", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/getRecentVehicleEvents" : { + "post" : { + "deprecated" : true, + "description" : "Get recent vehicle events for organization. Use /vehicle/getVehicleEvents instead.", + "operationId" : "getRecentVehicleEvents", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "proximityUnlockSettings" : { - "$ref" : "#/components/schemas/ProximityUnlockSettingsType" - }, - "readerComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "remoteUnlockEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "sendExpiredIntentEvents" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentCompositeEnumType" - }, - "unlockTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "uuid" : { + "description" : "OK" + } + }, + "summary" : "Get recent vehicle events", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/getRecentVehicleEventsByLocation" : { + "post" : { + "deprecated" : true, + "description" : "Get recent vehicle events for a location. Use /vehicle/getVehicleEvents instead.", + "operationId" : "getRecentVehicleEventsByLocation", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "waveToUnlockSettings" : { - "$ref" : "#/components/schemas/WaveToUnlockSettingsType" + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessControlledElevatorLanding" : { - "type" : "object", - "description" : "The updated elevator landing after applying the first-in state.", - "properties" : { - "accessScheduleFirstInStateOverride" : { - "$ref" : "#/components/schemas/FirstInState" - }, - "accessStateOverride" : { - "$ref" : "#/components/schemas/BaseAccessStateOverride" - }, - "accessStateToScheduleUuidMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "associatedFaceDetectionCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsByLocationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsByLocationWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "authFirstInStateOverride" : { - "$ref" : "#/components/schemas/FirstInState" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "defaultAccessState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "geofenceEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "geofenceRadius" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "remoteUnlockEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentCompositeEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "description" : "OK" } - } - }, - "AccessControlledElevatorLandingShadow" : { - "type" : "object", - "properties" : { - "authFirstIn" : { - "$ref" : "#/components/schemas/FirstInShadow" - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "orgUuid" : { + }, + "summary" : "Get recent vehicle events by location", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/getRecentVehicleEventsForVehicle" : { + "post" : { + "deprecated" : true, + "description" : "Get recent vehicle events for specified vehicle. Use /vehicle/getVehicleEvents instead.", + "operationId" : "getRecentVehicleEventsForVehicle", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "scheduleFirstIn" : { - "$ref" : "#/components/schemas/FirstInShadow" - }, - "state" : { - "$ref" : "#/components/schemas/AccessStateShadow" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentCompositeShadowEnum" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "AccessStateOverride" : { - "type" : "object", - "nullable" : true, - "properties" : { - "expireEarlyMode" : { - "$ref" : "#/components/schemas/EarlyExpireModeEnum" - }, - "expiresAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "followFirstInRules" : { - "type" : "boolean", - "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "requestedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "startDelaySeconds" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "state" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "type" : { - "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsForVehicleWSRequest" + } + } } - } - }, - "AccessStateOverrideExpirationStrategyEnum" : { - "type" : "string", - "enum" : [ "TIME_DELAY", "TIME_OF_DAY_LOCAL", "NONE" ] - }, - "AccessStateShadow" : { - "type" : "object", - "properties" : { - "source" : { - "$ref" : "#/components/schemas/AccessStateSourceEnum" - }, - "state" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "stateUpdateEventTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetRecentVehicleEventsForVehicleWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "AccessStateSourceEnum" : { - "type" : "string", - "enum" : [ "DEFAULT_STATE", "SCHEDULE", "SCHEDULE_EXCEPTION", "FIRST_IN", "DOOR_STATE_OVERRIDE", "LOCKDOWN", "PRIVACY", "UNKNOWN" ] - }, - "Accesscontrol_BaseSendUserPresenceForCurrentUserWsResponse" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserSuccessWsResponse" - }, { - "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserErrorWsResponse" + "summary" : "Get recent vehicle events for vehicle", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/getVehicleEvents" : { + "post" : { + "description" : "Get vehicle events with filters and additive queries", + "operationId" : "getVehicleEvents", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSRequest" + } + } } - } - }, - "Accesscontrol_Create35BitCorp1000StdCredentialWSRequest" : { - "type" : "object", - "description" : "Request to create an HID Corp1000 Standard 35 Bit credential.", - "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int64", - "description" : "Card number", - "example" : 456789, - "nullable" : true - }, - "companyId" : { - "type" : "integer", - "format" : "int32", - "description" : "Company Id", - "example" : 123, - "nullable" : true - }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, - "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, - "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Accesscontrol_Create35BitCorp1000StdCredentialWSResponse" : { - "type" : "object", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetVehicleEventsWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "Accesscontrol_Create48BitCorp1000StdCredentialWSRequest" : { - "type" : "object", - "description" : "Request to create an HID Corp1000 Standard 48 Bit credential.", - "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int64", - "description" : "Card number", - "example" : 456789, - "nullable" : true - }, - "companyId" : { - "type" : "integer", - "format" : "int32", - "description" : "Company Id", - "example" : 123, - "nullable" : true - }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, - "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, - "nullable" : true - }, - "userUuid" : { + }, + "summary" : "Get vehicle events", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/getVehicleLabelsForOrg" : { + "post" : { + "description" : "Get all vehicle labels for organization", + "operationId" : "getVehicleLabelsForOrg", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_Create48BitCorp1000StdWSResponse" : { - "type" : "object", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetVehicleLabelsForOrgWSRequest" + } + } } - } - }, - "Accesscontrol_DeviceUnlockableAccessControlledDoorType" : { - "type" : "object", - "description" : "Represents an access controlled door that can be unlocked by a device.", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the access controlled door.", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetVehicleLabelsForOrgWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "Accesscontrol_FindUnlockableAccessControlledDoorsByDeviceWSRequest" : { - "type" : "object", - "description" : "Request to find unlockable access controlled doors by device.", - "properties" : { - "deviceUuid" : { + }, + "summary" : "Get vehicle labels for organization", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/getVehicles" : { + "post" : { + "description" : "Get details of all saved vehicles in organization", + "operationId" : "getVehicles", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_FindUnlockableAccessControlledDoorsByDeviceWSResponse" : { - "type" : "object", - "description" : "Response containing unlockable access controlled doors for a device.", - "properties" : { - "accessControlledDoors" : { - "type" : "array", - "description" : "List of unlockable access controlled doors", - "items" : { - "$ref" : "#/components/schemas/Accesscontrol_DeviceUnlockableAccessControlledDoorType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetVehiclesWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_GetVehiclesWSResponse" + } + } }, - "nullable" : true + "description" : "OK" } - } - }, - "Accesscontrol_ForceRefreshAccessControlUnitConfigWSRequest" : { - "type" : "object", - "description" : "Request to force refresh an access control unit configuration.", - "properties" : { - "accessControlUnitUuid" : { + }, + "summary" : "Get vehicles", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/removeVehicleLabel" : { + "post" : { + "description" : "Remove a label to a vehicle", + "operationId" : "removeVehicleLabel", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_ForceRefreshAccessControlUnitConfigWSResponse" : { - "type" : "object", - "description" : "Response for force refresh access control unit configuration operation." - }, - "Accesscontrol_GetMinimalAccessControlledDoorsByLocationForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to get minimal access controlled doors by location for current user.", - "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_RemoveVehicleLabelWSRequest" + } + } } - } - }, - "Accesscontrol_GetMinimalAccessControlledDoorsByLocationForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response containing minimal access controlled doors by location for current user.", - "properties" : { - "accessControlledDoors" : { - "type" : "array", - "description" : "List of access controlled doors", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType_Minimal" - }, - "nullable" : true - }, - "accessGrants" : { - "type" : "array", - "description" : "List of user access grants", - "items" : { - "$ref" : "#/components/schemas/Accesscontrol_UserAccessGrant" - }, - "nullable" : true - }, - "accessRevocations" : { - "type" : "array", - "description" : "List of user access revocations", - "items" : { - "$ref" : "#/components/schemas/Accesscontrol_UserAccessRevocation" - }, - "nullable" : true - }, - "schedules" : { - "type" : "array", - "description" : "List of schedules", - "items" : { - "$ref" : "#/components/schemas/BaseSavedScheduleType_Minimal" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_RemoveVehicleLabelWSResponse" + } + } }, - "nullable" : true + "description" : "OK" } - } - }, - "Accesscontrol_SendUserPresenceForCurrentUserErrorWsResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Error response for send user presence for current user operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + }, + "summary" : "Remove vehicle label", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/reportVehicleEvent" : { + "post" : { + "description" : "Report a mis-detected license plate event. This sends the image/clip to Rhombus to better train AI models and removes the event", + "operationId" : "reportVehicleEvent", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_SendUserPresenceForCurrentUserSuccessWsResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Success response for send user presence for current user operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_ReportVehicleEventRequest" + } + } } - } - }, - "Accesscontrol_SendUserPresenceForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to send user presence information for the current user.", - "properties" : { - "cmdVersion" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "credentialValue" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "destinations" : { - "type" : "array", - "description" : "List of destinations for user presence", - "items" : { - "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserWSRequest_Destination" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_ReportVehicleEventResponse" + } + } }, - "nullable" : true + "description" : "OK" } - } - }, - "Accesscontrol_SendUserPresenceForCurrentUserWSRequest_Destination" : { - "type" : "object", - "description" : "Destination information for user presence.", - "properties" : { - "accessControlUnitUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "beaconIdentifier" : { - "type" : "array", - "description" : "Beacon identifier", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Beacon identifier", - "nullable" : true - }, - "nullable" : true - }, - "readerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "rssi" : { + }, + "summary" : "Report vehicle event", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/vehicle/saveVehicle" : { + "post" : { + "description" : "Name and save a vehicle based on license plate number", + "operationId" : "saveVehicle", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "byte", - "description" : "RSSI value of the reader as observed from the mobile device", - "example" : "LTY1", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_UnlockAccessControlledDoorEnumType" : { - "type" : "string", - "description" : "Enumeration of possible errors when unlocking an access controlled door.", - "enum" : [ "FAILED_SENDING_ACU_UNLOCK_REQUEST", "DOOR_NOT_CONFIGURED_WITH_LOCK", "ACD_LICENSE_UNASSIGNED_OR_EXPIRED" ] - }, - "Accesscontrol_UnlockAccessControlledDoorErrorWSResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "errorType" : { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_SaveVehicleWSRequest" + } } } - } ], - "description" : "Error response for unlock access controlled door operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Vehicle_SaveVehicleWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "Accesscontrol_UnlockAccessControlledDoorForCurrentUserEnumType" : { - "type" : "string", - "description" : "Enumeration of possible errors when unlocking an access controlled door for the current user.", - "enum" : [ "INACTIVE_CREDENTIAL", "FAILED_SENDING_ACU_UNLOCK_REQUEST", "GEOFENCE_RESTRICTED", "DOOR_NOT_CONFIGURED_WITH_LOCK", "USER_REMOTE_UNLOCK_DISABLED", "USER_RHOMBUS_KEY_DISABLED" ] - }, - "Accesscontrol_UnlockAccessControlledDoorForCurrentUserErrorWSResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "errorType" : { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserEnumType" - } + }, + "summary" : "Save vehicle", + "tags" : [ "Vehicle Webservice" ] + } + }, + "/api/video/cancelSplice" : { + "post" : { + "deprecated" : true, + "description" : "Use /cancelSpliceV2 instead", + "operationId" : "cancelSplice", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], - "description" : "Error response for unlock access controlled door for current user operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_CancelSpliceWSRequest" + } + } } - } - }, - "Accesscontrol_UnlockAccessControlledDoorForCurrentUserSuccessWSResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Success response for unlock access controlled door for current user operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_CancelSpliceWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "Accesscontrol_UnlockAccessControlledDoorForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to unlock an access controlled door for the current user.", - "properties" : { - "accessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "cmdVersion" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "credentialValue" : { + }, + "summary" : "Cancel splice", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/cancelSpliceV2" : { + "post" : { + "description" : "Cancel a spliced clip request", + "operationId" : "cancelSpliceV2", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "description" : "Credential value for authentication", - "example" : "credential123", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude of the mobile device for geofencing", - "example" : 37.7749, - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude of the mobile device for geofencing", - "example" : -122.4194, - "nullable" : true - }, - "requestTimeMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Request time in milliseconds", - "example" : 1640995200000, - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_UnlockAccessControlledDoorSuccessWSResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Success response for unlock access controlled door operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_CancelSpliceV2WSRequest" + } + } } - } - }, - "Accesscontrol_UnlockAccessControlledDoorWSRequest" : { - "type" : "object", - "description" : "Request to unlock an access controlled door.", - "properties" : { - "accessControlledDoorUuid" : { + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_CancelSpliceV2WSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Cancel splice V2", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/createSharedTimelapseGroup" : { + "post" : { + "description" : "Share multiple timelapses in one link", + "operationId" : "createSharedTimelapseGroup", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_UnlockAccessControlledElevatorEnumType" : { - "type" : "string", - "description" : "Enumeration of possible errors when unlocking an access controlled elevator.", - "enum" : [ "FAILED_SENDING_ACU_UNLOCK_REQUEST", "ELEVATOR_NOT_CONFIGURED_WITH_LANDING" ] - }, - "Accesscontrol_UnlockAccessControlledElevatorErrorWSResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "errorType" : { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_CreateSharedTimelapseGroupWSRequest" + } } } - } ], - "description" : "Error response for unlock access controlled elevator operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_CreateSharedTimelapseGroupWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserEnumType" : { - "type" : "string", - "description" : "Enumeration of possible errors when unlocking an access controlled elevator for the current user.", - "enum" : [ "INACTIVE_CREDENTIAL", "FAILED_SENDING_ACU_UNLOCK_REQUEST", "GEOFENCE_RESTRICTED", "ELEVATOR_NOT_CONFIGURED_WITH_LANDINGS", "INVALID_LANDINGS", "USER_REMOTE_UNLOCK_DISABLED", "USER_RHOMBUS_KEY_DISABLED" ] - }, - "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserErrorWSResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "errorType" : { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserEnumType" - } + }, + "summary" : "Create shared timelapse group", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/deleteSharedTimelapseGroup" : { + "post" : { + "description" : "Delete a shared timelapse link", + "operationId" : "deleteSharedTimelapseGroup", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } } ], - "description" : "Error response for unlock access controlled elevator for current user operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" - } - } - }, - "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserSuccessWSResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Success response for unlock access controlled elevator for current user operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_DeleteSharedTimelapseGroupWSRequest" + } + } } - } - }, - "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to unlock an access controlled elevator for the current user.", - "properties" : { - "accessControlledElevatorLandingUuids" : { - "type" : "array", - "description" : "UUIDs of specific access controlled elevator landings", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_DeleteSharedTimelapseGroupWSResponse" + } + } }, - "nullable" : true - }, - "accessControlledElevatorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "cmdVersion" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "credentialValue" : { + "description" : "OK" + } + }, + "summary" : "Delete shared timelapse group", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/deleteTimelapseClips" : { + "post" : { + "description" : "Delete a timelapse", + "operationId" : "deleteTimelapseClips", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "description" : "Credential value for authentication", - "example" : "credential123", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude of the mobile device for geofencing", - "example" : 37.7749, - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude of the mobile device for geofencing", - "example" : -122.4194, - "nullable" : true - }, - "requestTimeMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Request time in milliseconds", - "example" : 1640995200000, - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_UnlockAccessControlledElevatorSuccessWSResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Success response for unlock access controlled elevator operation.", - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_DeleteTimelapseClipsWSRequest" + } + } } - } - }, - "Accesscontrol_UnlockAccessControlledElevatorWSRequest" : { - "type" : "object", - "description" : "Request to unlock an access controlled elevator, and optionally specific landings on that elevator.", - "properties" : { - "accessControlledElevatorLandingUuids" : { - "type" : "array", - "description" : "UUIDs of specific access controlled elevator landings", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_DeleteTimelapseClipsWSResponse" + } + } }, - "nullable" : true - }, - "accessControlledElevatorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "description" : "OK" } - } - }, - "Accesscontrol_UserAccessGrant" : { - "type" : "object", - "description" : "Access grant information for a user containing schedule and door access permissions.", - "properties" : { - "accessControlledDoorUuids" : { - "type" : "array", - "description" : "Set of access controlled door UUIDs that this grant provides access to.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "scheduleUuid" : { + }, + "summary" : "Delete timelapse clips", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/generateRangedTimelapseClip" : { + "post" : { + "description" : "Generate a timelapse where each device facet contributes footage only during its own time ranges.", + "operationId" : "generateRangedTimelapseClip", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_UserAccessRevocation" : { - "type" : "object", - "description" : "Access revocation information for a user containing schedule and door access restrictions.", - "properties" : { - "accessControlledDoorUuids" : { - "type" : "array", - "description" : "Set of access controlled door UUIDs that this revocation restricts access to.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GenerateRangedTimelapseClipWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GenerateRangedTimelapseClipWSResponse" + } + } }, - "nullable" : true, - "uniqueItems" : true - }, - "scheduleUuid" : { + "description" : "OK" + } + }, + "summary" : "Generate ranged timelapse clip", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/generateTimelapseClip" : { + "post" : { + "description" : "Generate a timelapse", + "operationId" : "generateTimelapseClip", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] } - } - }, - "Accesscontrol_accessgrant_CreateAccessGrantWSRequest" : { - "type" : "object", - "description" : "Request to create a location access grant.", - "properties" : { - "accessGrant" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GenerateTimelapseClipWSRequest" + } + } } - } - }, - "Accesscontrol_accessgrant_CreateAccessGrantWSResponse" : { - "type" : "object", - "description" : "Response containing the created location access grant.", - "properties" : { - "accessGrant" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GenerateTimelapseClipWSResponse" + } + } + }, + "description" : "OK" } - } - }, - "Accesscontrol_accessgrant_DeleteLocationAccessGrantWSRequest" : { + }, + "summary" : "Generate timelapse clip", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getExactFrameData" : { + "post" : { + "description" : "Fetches and returns the bytes, base64 encoded, of the frame at the given timestamp for a device. Use this instead of getExactFrameUri if, for whatever reason, either the URI is not useful or the client is unable to hit the media servers. The response always has HTTP status 200; check the status field, frameData is only set when it is AVAILABLE.", + "operationId" : "getExactFrameData", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetExactFrameDataWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetExactFrameDataWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get exact frame data", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getExactFrameUri" : { + "post" : { + "description" : "Generate URL to get an exact frame with optional crop from a camera. The URL is served by the media relay the camera is connected to right now, so use it promptly. The response always has HTTP status 200; check the status field, and only treat the frame as retrievable when it is AVAILABLE.", + "operationId" : "getExactFrameUri", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetExactFrameUriWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetExactFrameUriWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get exact frame URI", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getLiveImage" : { + "post" : { + "description" : "Returns the most recent snapshot image the camera has captured, as a jpeg. Unlike getExactFrame this is not taken from recorded footage, so it only succeeds while the camera is online and actively capturing. Last-Modified carries the moment the camera captured the image.", + "operationId" : "getLiveImage", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetLiveImageWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "image/jpeg" : { } + }, + "description" : "OK" + } + }, + "summary" : "Get live image", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getMaxSpliceDuration" : { + "post" : { + "description" : "Get the max splice duration an organization can set", + "operationId" : "getMaxSpliceDuration", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetMaxSpliceDurationWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetMaxSpliceDurationWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get max splice duration", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getSharedTimelapseGroups" : { + "post" : { + "description" : "Get details of all shared timelapse links for organization", + "operationId" : "getSharedTimelapseGroups", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetSharedTimelapseGroupsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetSharedTimelapseGroupsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get shared timelapse groups", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getSplicedClipsInProgress" : { + "post" : { + "description" : "Get all spliced clips in progress", + "operationId" : "getSplicedClipsInProgress", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetSplicedClipsInProgressWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetSplicedClipsInProgressWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get spliced clips in progress", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getTimelapseClips" : { + "post" : { + "description" : "Get all timelapse clips for organization", + "operationId" : "getTimelapseClips", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetTimelapseClipsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetTimelapseClipsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get timelapse clips", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/getTimelapseMetadata" : { + "post" : { + "description" : "Get information about earliest available timelapse images for cameras", + "operationId" : "getTimelapseMetadata", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetTimelapseMetadataWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_GetTimelapseMetadataWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get timelapse metadata", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/retrySplice" : { + "post" : { + "description" : "Send a request to retry splicing a clip", + "operationId" : "retrySplice", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_RetrySpliceWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_RetrySpliceWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Retry splice", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/shareTimelapseClips" : { + "post" : { + "deprecated" : true, + "description" : "Use /CreateSharedTimelapseGroup instead", + "operationId" : "shareTimelapseClips", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_ShareTimelapseClipsWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_ShareTimelapseClipsWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Share timelapse clips", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/splice" : { + "post" : { + "deprecated" : true, + "description" : "Use /spliceV3 instead", + "operationId" : "splice", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Splice", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/spliceFrame" : { + "post" : { + "description" : "Send a request to create a single image from a point in time", + "operationId" : "spliceFrame", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceFrameWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceFrameWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Splice frame", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/spliceV2" : { + "post" : { + "deprecated" : true, + "description" : "Use /spliceV3 instead", + "operationId" : "spliceV2", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceV2WSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceV2WSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Splice V2", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/spliceV3" : { + "post" : { + "description" : "Send a request to create an arbitrary clip for multiple cameras", + "operationId" : "spliceV3", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceV3WSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_SpliceV3WSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Splice V3", + "tags" : [ "Video Webservice" ] + } + }, + "/api/video/updateSharedTimelapseGroup" : { + "post" : { + "description" : "Update title, description, or expiration on a shared timelapse link", + "operationId" : "updateSharedTimelapseGroup", + "parameters" : [ { + "description" : "Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.", + "example" : "api-token", + "in" : "header", + "name" : "x-auth-scheme", + "required" : true, + "schema" : { + "type" : "string", + "default" : "api-token", + "enum" : [ "api-token", "api", "partner-api-token", "partner-api" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_UpdateSharedTimelapseGroupWSRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Video_UpdateSharedTimelapseGroupWSResponse" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Update shared timelapse group", + "tags" : [ "Video Webservice" ] + } + } + }, + "components" : { + "schemas" : { + "ACUDoorCatalogItem" : { "type" : "object", - "description" : "Request to delete a location access grant.", + "allOf" : [ ], + "nullable" : true, "properties" : { - "accessGrantUuid" : { + "durationMonths" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "productCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" } } }, - "Accesscontrol_accessgrant_DeleteLocationAccessGrantWSResponse" : { - "type" : "object", - "description" : "Response for location access grant deletion." - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSRequest" : { + "ACUDoorLicenseType" : { "type" : "object", - "description" : "Request to find location access grants by access controlled door.", + "description" : "List of access controlled door licenses available for the client organization", "properties" : { - "accessControlledDoorUuid" : { + "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for an access controlled door.", - "nullable" : true, - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, + }, + "createdOn" : { + "type" : "string", + "format" : "date-time", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by access controlled elevator landing.", - "properties" : { - "accessControlledElevatorLandingUuid" : { + }, + "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for an access controlled elevator landing.", - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, - "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by door label.", - "properties" : { - "doorLabelId" : { + }, + "firstAssignedDate" : { "type" : "string", - "description" : "Door label identifier", - "example" : "door_label_123", + "format" : "date-time", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for a door label.", - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, + }, + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "maxDeleteDate" : { + "type" : "string", + "format" : "date-time", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by group.", - "properties" : { - "groupUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for a group.", - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, - "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by location and user.", - "properties" : { - "locationUuid" : { + }, + "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for a location and user.", - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, + }, + "productCode" : { + "type" : "string", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by location.", - "properties" : { - "locationUuid" : { + }, + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -39766,126 +40713,81 @@ } } }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSResponse" : { + "AIReport" : { "type" : "object", - "description" : "Response containing location access grants for a location.", + "description" : "The AI report to update", "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, + "completedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by organization." - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for an organization.", - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, + }, + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSRequest" : { - "type" : "object", - "description" : "Request to find location access grants by user.", - "properties" : { - "userUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSResponse" : { - "type" : "object", - "description" : "Response containing location access grants for a user.", - "properties" : { - "accessGrants" : { - "type" : "array", - "description" : "List of location access grants", - "items" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, + }, + "params" : { + "$ref" : "#/components/schemas/AIReportGenerateParams" + }, + "principalUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_GetLocationAccessGrantWSRequest" : { - "type" : "object", - "description" : "Request to get a location access grant by UUID.", - "properties" : { - "accessGrantUuid" : { + }, + "privacy" : { + "$ref" : "#/components/schemas/ChatPrivacy" + }, + "scheduleUuid" : { + "type" : "string", + "nullable" : true + }, + "scheduledAiReportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_GetLocationAccessGrantWSResponse" : { - "type" : "object", - "description" : "Response containing a location access grant.", - "properties" : { - "accessGrant" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - } - } - }, - "Accesscontrol_accessgrant_GetLocationsByAccessGrantForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to get locations by access grant for current user." - }, - "Accesscontrol_accessgrant_GetLocationsByAccessGrantForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response for getting locations by access grant for current user.", - "properties" : { - "locationLockdownStates" : { - "type" : "array", - "description" : "List of location lockdown states", - "items" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - }, + }, + "startedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "locations" : { + "structureJson" : { + "type" : "string", + "nullable" : true + }, + "timeline" : { "type" : "array", - "description" : "List of locations accessible to the current user", "items" : { - "$ref" : "#/components/schemas/LocationType" + "$ref" : "#/components/schemas/QueryTimelineEvent" }, "nullable" : true }, - "lockdownPlans" : { + "title" : { + "type" : "string", + "nullable" : true + }, + "toolingTimeline" : { "type" : "array", - "description" : "List of lockdown plans for the locations", "items" : { - "$ref" : "#/components/schemas/BaseLockdownPlanType" + "$ref" : "#/components/schemas/QueryTool" }, "nullable" : true - } - } - }, - "Accesscontrol_accessgrant_GetRhombusKeyLocationLockdownDetailsForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to get Rhombus Key location lockdown details for current user.", - "properties" : { - "locationUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -39894,55 +40796,22 @@ } } }, - "Accesscontrol_accessgrant_GetRhombusKeyLocationLockdownDetailsForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response for getting Rhombus Key location lockdown details for current user.", - "properties" : { - "locationLockdownState" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - } - } - }, - "Accesscontrol_accessgrant_UpdateAccessGrantWSRequest" : { - "type" : "object", - "description" : "Request to update a location access grant.", - "properties" : { - "accessGrant" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - } - } - }, - "Accesscontrol_accessgrant_UpdateAccessGrantWSResponse" : { + "AIReportGenerateParams" : { "type" : "object", - "description" : "Response for location access grant update.", "properties" : { - "accessGrant" : { - "$ref" : "#/components/schemas/LocationAccessGrantType" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "additionalPrompt" : { "type" : "string", "nullable" : true }, - "expiredACDLicensesDoorUuids" : { + "dataSources" : { "type" : "array", - "description" : "Set of expired ACD license door UUIDs", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/DataSourceEnum" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "unassignedACDLicensesDoorUuids" : { + "deviceUuids" : { "type" : "array", - "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", @@ -39950,135 +40819,71 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "rangeEndMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "rangeStartMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Accesscontrol_accessrevocation_CreateAccessRevocationWSRequest" : { - "type" : "object", - "description" : "Request to create a location access revocation.", - "properties" : { - "accessRevocation" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - } - } - }, - "Accesscontrol_accessrevocation_CreateAccessRevocationWSResponse" : { + "AIReportGroup" : { "type" : "object", - "description" : "Response for location access revocation creation.", + "description" : "List of AI reports", "properties" : { - "accessRevocation" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - } - } - }, - "Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSRequest" : { - "type" : "object", - "description" : "Request to delete a location access revocation.", - "properties" : { - "accessRevocationUuid" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastModifiedMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "latestStatus" : { + "$ref" : "#/components/schemas/QueryStatusEnum" + }, + "numReports" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSResponse" : { - "type" : "object", - "description" : "Response for location access revocation deletion." - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSRequest" : { - "type" : "object", - "description" : "Request to find location access revocations by access controlled door.", - "properties" : { - "accessControlledDoorUuid" : { + }, + "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSResponse" : { - "type" : "object", - "description" : "Response containing location access revocations for an access controlled door.", - "properties" : { - "accessRevocations" : { - "type" : "array", - "description" : "List of location access revocations", - "items" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - }, - "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSRequest" : { - "type" : "object", - "description" : "Request to find location access revocations by access controlled elevator landing.", - "properties" : { - "accessControlledElevatorLandingUuid" : { + }, + "privacy" : { + "$ref" : "#/components/schemas/ChatPrivacy" + }, + "scheduledAiReportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSResponse" : { - "type" : "object", - "description" : "Response containing location access revocations for an access controlled elevator landing.", - "properties" : { - "accessRevocations" : { - "type" : "array", - "description" : "List of location access revocations", - "items" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - }, - "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSRequest" : { - "type" : "object", - "description" : "Request to find location access revocations by door label.", - "properties" : { - "doorLabelId" : { + }, + "title" : { "type" : "string", - "description" : "Door label identifier", - "example" : "door_label_123", - "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSResponse" : { - "type" : "object", - "description" : "Response containing location access revocations for a door label.", - "properties" : { - "accessRevocations" : { - "type" : "array", - "description" : "List of location access revocations", - "items" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - }, "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSRequest" : { - "type" : "object", - "description" : "Request to find location access revocations by group.", - "properties" : { - "groupUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -40087,256 +40892,229 @@ } } }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSResponse" : { + "AITShipmentInfoType" : { "type" : "object", - "description" : "Response containing location access revocations for a group.", + "nullable" : true, "properties" : { - "accessRevocations" : { + "aitTrackingNumber" : { + "type" : "string", + "nullable" : true + }, + "carrierTrackingNumber" : { + "type" : "string", + "nullable" : true + }, + "depositorOrderNumber" : { + "type" : "string", + "nullable" : true + }, + "destinationAddress" : { + "type" : "string", + "nullable" : true + }, + "isIngramDistributorShipment" : { + "type" : "boolean", + "nullable" : true + }, + "shipmentDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "shippedItems" : { "type" : "array", - "description" : "List of location access revocations", "items" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" + "$ref" : "#/components/schemas/ShippedItemType" }, "nullable" : true } } }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSRequest" : { - "type" : "object", - "description" : "Request to find location access revocations by organization." + "ALMActionEnum" : { + "type" : "string", + "description" : "The ALM-related action that occurred.", + "enum" : [ "LOCATION_CONFIG_CREATED", "LOCATION_CONFIG_UPDATED", "LOCATION_CONFIG_DELETED", "ZONE_CONFIG_CREATED", "ZONE_CONFIG_UPDATED", "ZONE_CONFIG_DELETED", "MONITORING_ENABLED", "MONITORING_DISABLED", "MONITORING_MANUALLY_ARMED", "MONITORING_MANUAL_ARM_CANCELED", "MONITORING_MANUALLY_PAUSED", "MONITORING_MANUAL_PAUSE_CANCELED", "MONITORING_SCHEDULE_UPDATE", "MARK_LOCATION_FOR_CLEANUP", "UNMARK_LOCATION_FOR_CLEANUP", "LOCATION_CLEANED_UP", "UNKNOWN" ] }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSResponse" : { + "ALMConfig" : { "type" : "object", - "description" : "Response containing location access revocations for an organization.", + "description" : "A snapshot of the ALM config after this event succeeded.", + "discriminator" : { + "propertyName" : "type" + }, "properties" : { - "accessRevocations" : { - "type" : "array", - "description" : "List of location access revocations", - "items" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - }, + "deleted" : { + "type" : "boolean", + "description" : "Indication of whether this config was deleted.", "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSRequest" : { - "type" : "object", - "description" : "Request to find location access revocations by user.", - "properties" : { - "userUuid" : { + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSResponse" : { - "type" : "object", - "description" : "Response containing location access revocations for a user.", - "properties" : { - "accessRevocations" : { - "type" : "array", - "description" : "List of location access revocations", - "items" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - }, - "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_GetLocationAccessRevocationWSRequest" : { - "type" : "object", - "description" : "Request to get a location access revocation by UUID.", - "properties" : { - "accessRevocationUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_accessrevocation_GetLocationAccessRevocationWSResponse" : { - "type" : "object", - "description" : "Response containing a location access revocation.", - "properties" : { - "accessRevocation" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - } - } - }, - "Accesscontrol_accessrevocation_UpdateAccessRevocationWSRequest" : { - "type" : "object", - "description" : "Request to update a location access revocation.", - "properties" : { - "accessRevocation" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" - } - } - }, - "Accesscontrol_accessrevocation_UpdateAccessRevocationWSResponse" : { - "type" : "object", - "description" : "Response for location access revocation update operation.", - "properties" : { - "accessRevocation" : { - "$ref" : "#/components/schemas/LocationAccessRevocationType" }, - "error" : { - "type" : "boolean", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/TypeEnum" }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "versionInfo" : { + "$ref" : "#/components/schemas/ALMModificationMetadata" }, - "warningMsg" : { + "zoneId" : { "type" : "string", "nullable" : true } - } - }, - "Accesscontrol_badgetemplate_CreateBadgeTemplateWSRequest" : { - "type" : "object", - "description" : "Request to create a new badge template.", - "properties" : { - "template" : { - "$ref" : "#/components/schemas/BadgeTemplate" - } - } - }, - "Accesscontrol_badgetemplate_CreateBadgeTemplateWSResponse" : { - "type" : "object", - "description" : "Response containing the created badge template.", - "properties" : { - "template" : { - "$ref" : "#/components/schemas/BadgeTemplate" - } - } + }, + "required" : [ "locationUuid" ] }, - "Accesscontrol_badgetemplate_DeleteBadgeTemplateImageWSRequest" : { + "ALMEvent" : { "type" : "object", - "description" : "Request to delete a specific badge template image by UUID.", + "description" : "List of modification events showing who made changes", "properties" : { - "imageUuid" : { + "action" : { + "$ref" : "#/components/schemas/ALMActionEnum" + }, + "auditInfo" : { + "$ref" : "#/components/schemas/ALMModificationMetadata" + }, + "config" : { + "$ref" : "#/components/schemas/ALMConfig" + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_badgetemplate_DeleteBadgeTemplateImageWSResponse" : { - "type" : "object", - "description" : "Response containing the deleted badge template image metadata.", - "properties" : { - "image" : { - "$ref" : "#/components/schemas/BadgeTemplateImage" - } - } - }, - "Accesscontrol_badgetemplate_DeleteBadgeTemplateWSRequest" : { - "type" : "object", - "description" : "Request to delete a specific badge template by UUID.", - "properties" : { - "templateUuid" : { + }, + "monitoringState" : { + "$ref" : "#/components/schemas/ALMMonitoringState" + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_badgetemplate_DeleteBadgeTemplateWSResponse" : { - "type" : "object", - "description" : "Response containing the deleted badge template.", - "properties" : { - "template" : { - "$ref" : "#/components/schemas/BadgeTemplate" - } - } - }, - "Accesscontrol_badgetemplate_FindBadgeTemplateImagesWSRequest" : { - "type" : "object", - "description" : "Request to search for badge template images with pagination support.", - "properties" : { - "lastEvaluatedKey" : { + }, + "outcome" : { + "$ref" : "#/components/schemas/DaoOutcomeEnum" + }, + "reason" : { "type" : "string", - "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", + "description" : "Optional underlying reason for the result of the ALM-related action.", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", - "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "zoneId" : { + "type" : "string", + "description" : "ID of the ALM zone this event occurred with.", "nullable" : true } } }, - "Accesscontrol_badgetemplate_FindBadgeTemplateImagesWSResponse" : { + "ALMEventFilter" : { "type" : "object", - "description" : "Response containing a list of badge template images with pagination information.", + "description" : "Optional filter to narrow results by timestamp, action, and/or outcome.", "properties" : { - "images" : { + "actions" : { "type" : "array", - "description" : "List of badge template images found in the search.", + "description" : "If specified, retrieves results matching these actions.", "items" : { - "$ref" : "#/components/schemas/BadgeTemplateImage" + "$ref" : "#/components/schemas/ALMActionEnum" }, + "nullable" : true, + "uniqueItems" : true + }, + "afterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Retrieve events occurring at or after this timestamp (ms).", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", + "beforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Retrieve events occurring at or before this timestamp (ms).", "nullable" : true + }, + "outcomes" : { + "type" : "array", + "description" : "If specified, retrieves results matching these outcomes.", + "items" : { + "$ref" : "#/components/schemas/DaoOutcomeEnum" + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Accesscontrol_badgetemplate_FindBadgeTemplatesWSRequest" : { + "ALMManualPolicySummary" : { "type" : "object", - "description" : "Request to search for badge templates with pagination support.", + "description" : "Status of the ALM zone when operating in manual monitoring mode.", "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", + "armable" : { + "type" : "boolean", + "description" : "Indicates whether this policy is armable. If the policy is not properly configured, it cannot be armed/disarmed.\n", "nullable" : true }, - "maxPageSize" : { + "armed" : { + "type" : "boolean", + "description" : "Indicates whether the ALM zone is currently armed in manual monitoring mode.", + "nullable" : true + }, + "rearmedAfterMs" : { "type" : "integer", - "format" : "int32", - "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "format" : "int64", + "description" : "The UNIX epoch timestamp (in milliseconds) when the ALM zone re-arms.", + "nullable" : true + }, + "summary" : { + "type" : "string", + "description" : "Explanation of the current manual monitoring state.", "nullable" : true } } }, - "Accesscontrol_badgetemplate_FindBadgeTemplatesWSResponse" : { + "ALMModificationMetadata" : { "type" : "object", - "description" : "Response containing a list of badge templates with pagination information.", + "description" : "Info regarding when and by whom this status was modified.", "properties" : { - "lastEvaluatedKey" : { + "modifiedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX timestamp (in milliseconds) when the ALM config or state was modified.", + "nullable" : true + }, + "modifiedBy" : { "type" : "string", - "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", + "description" : "The user/principal/entity that made the modification.", "nullable" : true }, - "templates" : { - "type" : "array", - "description" : "List of badge templates found in the search.", - "items" : { - "$ref" : "#/components/schemas/BadgeTemplate" - }, + "modifiedByIntegration" : { + "type" : "boolean", + "description" : "Indication of whether the modification was due to an integration.", "nullable" : true - } - } - }, - "Accesscontrol_badgetemplate_GetBadgeTemplateImageWSRequest" : { - "type" : "object", - "description" : "Request to retrieve metadata for a specific badge template image by UUID.", - "properties" : { - "imageUuid" : { + }, + "modifiedByMetadata" : { + "type" : "string", + "description" : "Metadata describing when and under what conditions these modifications occurred.", + "nullable" : true + }, + "modifiedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -40345,278 +41123,194 @@ } } }, - "Accesscontrol_badgetemplate_GetBadgeTemplateImageWSResponse" : { - "type" : "object", - "description" : "Response containing the requested badge template image metadata.", - "properties" : { - "image" : { - "$ref" : "#/components/schemas/BadgeTemplateImage" - } - } - }, - "Accesscontrol_badgetemplate_GetBadgeTemplateWSRequest" : { + "ALMMonitoringState" : { "type" : "object", - "description" : "Request to retrieve a specific badge template by UUID.", + "description" : "A snapshot of the ALM state after this event succeeded.", "properties" : { - "templateUuid" : { + "armingRule" : { + "$ref" : "#/components/schemas/ArmMonitoringRule" + }, + "auditInfo" : { + "$ref" : "#/components/schemas/ALMModificationMetadata" + }, + "disarmingRule" : { + "$ref" : "#/components/schemas/DisarmMonitoringRule" + }, + "enabledSinceMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The UNIX timestamp (in milliseconds) when manual monitoring was enabled.", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_badgetemplate_GetBadgeTemplateWSResponse" : { - "type" : "object", - "description" : "Response containing the requested badge template.", - "properties" : { - "template" : { - "$ref" : "#/components/schemas/BadgeTemplate" - } - } - }, - "Accesscontrol_badgetemplate_UpdateBadgeTemplateImageWSRequest" : { - "type" : "object", - "description" : "Request to update metadata for a badge template image with selective field updates.", - "properties" : { - "selectiveUpdate" : { - "$ref" : "#/components/schemas/BadgeTemplateImageSelectiveUpdate" - } - } - }, - "Accesscontrol_badgetemplate_UpdateBadgeTemplateImageWSResponse" : { - "type" : "object", - "description" : "Response containing the updated badge template image metadata.", - "properties" : { - "image" : { - "$ref" : "#/components/schemas/BadgeTemplateImage" - } - } - }, - "Accesscontrol_badgetemplate_UpdateBadgeTemplateWSRequest" : { - "type" : "object", - "description" : "Request to update an existing badge template with selective field updates.", - "properties" : { - "selectiveUpdate" : { - "$ref" : "#/components/schemas/BadgeTemplateSelectiveUpdate" - } - } - }, - "Accesscontrol_badgetemplate_UpdateBadgeTemplateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated badge template.", - "properties" : { - "template" : { - "$ref" : "#/components/schemas/BadgeTemplate" - } - } - }, - "Accesscontrol_credentials_AssignAccessControlCredentialWSRequest" : { - "type" : "object", - "description" : "Request to assign an access control credential to a user.", - "properties" : { - "credentialHexValue" : { - "type" : "string", - "description" : "Hex value of the credential", - "example" : "1234567890ABCDEF", + }, + "manualMonitoringEnabled" : { + "type" : "boolean", + "description" : "Indication of whether monitoring is enabled for manual monitoring mode.", "nullable" : true }, - "userUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_AssignAccessControlCredentialWSResponse" : { - "type" : "object", - "description" : "Response for assigning an access control credential to a user.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_BaseProvisionMobileAccessControlCredentialForCurrentUserWSResponse" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "ERROR" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse", - "SUCCESS" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" - }, { - "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" - } - } - }, - "Accesscontrol_credentials_BaseUnlockAccessControlledDoorForCurrentUserWSResponse" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "nullable" : true, - "oneOf" : [ { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserSuccessWSResponse" - }, { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserErrorWSResponse" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" - } - } - }, - "Accesscontrol_credentials_BaseUnlockAccessControlledDoorWSResponse" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "nullable" : true, - "oneOf" : [ { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorSuccessWSResponse" - }, { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorErrorWSResponse" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" - } - } - }, - "Accesscontrol_credentials_BaseUnlockAccessControlledElevatorForCurrentUserWSResponse" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserSuccessWSResponse" - }, { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserErrorWSResponse" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" - } - } - }, - "Accesscontrol_credentials_BaseUnlockAccessControlledElevatorWSResponse" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorSuccessWSResponse" - }, { - "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorErrorWSResponse" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + "rearmingRule" : { + "$ref" : "#/components/schemas/RearmMonitoringRule" + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, - "Accesscontrol_credentials_BulkProvisionPinCredentialsWSRequest" : { + "ALMScheduledPolicySummary" : { "type" : "object", - "description" : "Request to bulk provision PIN credentials for multiple users.", + "description" : "Status of the ALM zone under each configured scheduled monitoring policy.", "properties" : { - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds when these credentials expire. Credentials never expire if this value is left null.", - "example" : 1672531200, - "minimum" : 0, + "alarmPolicyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "notifyUsers" : { + "armable" : { "type" : "boolean", - "description" : "Whether to notify users about their new PIN credentials.", - "example" : true, + "description" : "Indicates whether this policy is armable. If the policy is not properly configured, it cannot be armed/disarmed.\n", "nullable" : true }, - "pinLength" : { + "armed" : { + "type" : "boolean", + "description" : "Indicates whether the ALM zone is currently armed under this scheduled policy.", + "nullable" : true + }, + "armedEndMs" : { "type" : "integer", - "format" : "int32", - "default" : 5, - "description" : "Length of PINs to be generated. Accepts length between 4 and 16. Default length is 5.", - "example" : 5, - "maximum" : 16, - "minimum" : 4, + "format" : "int64", + "description" : "The UNIX epoch timestamp (in milliseconds) at which the current or next scheduled armed window ends (exclusive).\n", "nullable" : true }, - "startDateEpochSecInclusive" : { + "armedStartMs" : { "type" : "integer", "format" : "int64", - "description" : "Start date in epoch seconds when these credentials become active. Credentials activate immediately if this value is left null.", - "example" : 1640995200, - "minimum" : 0, + "description" : "The UNIX epoch timestamp (in milliseconds) at which the current or next scheduled armed window begins (inclusive).\n", "nullable" : true }, - "userUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "59OcXLkFShWyHK3O2Fh2Ag", - "nullable" : true - }, + "summary" : { + "type" : "string", + "description" : "Explanation of the scheduled monitoring state for this policy.", "nullable" : true } } }, - "Accesscontrol_credentials_BulkProvisionPinCredentialsWSResponse" : { + "ALMZoneContext" : { "type" : "object", - "description" : "Response containing the bulk provisioned PIN credentials and any failed users.", + "description" : "List of the latest ALM zone contexts in the org.", "properties" : { - "credentials" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, - "nullable" : true + "locationConfig" : { + "$ref" : "#/components/schemas/LocationALMConfig" }, - "error" : { - "type" : "boolean", + "monitoringState" : { + "$ref" : "#/components/schemas/ALMMonitoringState" + }, + "zoneConfig" : { + "$ref" : "#/components/schemas/ZoneALMConfig" + } + } + }, + "ALMZoneSummary" : { + "type" : "object", + "description" : "List of summaries of the ALM zone statuses in the org.", + "properties" : { + "deviceLastPlayedAudioAtMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "Per device, the last confirmed UNIX epoch timestamp (in milliseconds) at which audio was successfully played.\n", + "nullable" : true + }, + "description" : "Per device, the last confirmed UNIX epoch timestamp (in milliseconds) at which audio was successfully played.\n", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "deviceSirenActivatedAtMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "Per device, the UNIX epoch timestamp (in milliseconds) when the siren was most recently activated.\n", + "nullable" : true + }, + "description" : "Per device, the UNIX epoch timestamp (in milliseconds) when the siren was most recently activated.\n", "nullable" : true }, - "failedUsers" : { - "type" : "array", - "description" : "List of user UUIDs for which PIN credential creation failed", - "items" : { + "deviceSirenTriggeredByRule" : { + "type" : "object", + "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "description" : "Per device, the UUID of the alarm rule that triggered the siren.", "nullable" : true }, - "warningMsg" : { + "fullyConfigured" : { + "type" : "boolean", + "description" : "Indicates whether this ALM zone is capable of producing a summary. True if a location config, zone config, and monitoring state exist for this zone.\n", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "manualPolicySummary" : { + "$ref" : "#/components/schemas/ALMManualPolicySummary" + }, + "mode" : { "type" : "string", + "description" : "The current monitoring mode for the ALM zone (e.g., MANUAL or SCHEDULED).", + "nullable" : true + }, + "scheduledPolicySummaries" : { + "type" : "array", + "description" : "Status of the ALM zone under each configured scheduled monitoring policy.", + "items" : { + "$ref" : "#/components/schemas/ALMScheduledPolicySummary" + }, "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, - "Accesscontrol_credentials_BulkRotatePinCredentialsWSRequest" : { + "AMSirenSettingsType" : { "type" : "object", - "description" : "Request to bulk rotate PIN credentials for multiple users.", "properties" : { - "credentialUuids" : { + "audioGateways" : { "type" : "array", - "description" : "Set of credential uuids designated for PIN rotation.", + "description" : "UUIDs of audio gateways used to play this siren.", "items" : { "type" : "string", "format" : "RUUID", @@ -40627,106 +41321,86 @@ "nullable" : true, "uniqueItems" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds when these credentials expire. Credentials never expire if this value is left null.", - "example" : 1672531200, - "minimum" : 0, - "nullable" : true - }, - "notifyUsers" : { - "type" : "boolean", - "description" : "Whether to notify users about their rotated PIN credentials.", - "example" : true, + "clipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pinLength" : { + "durationSeconds" : { "type" : "integer", "format" : "int32", - "default" : 5, - "description" : "Length of PIN to be generated. Accepts length between 4 and 16. Default is 5.", - "example" : 5, - "maximum" : 16, - "minimum" : 4, + "description" : "The duration (in seconds) to loop the clip audio for the siren.", "nullable" : true }, - "startDateEpochSecInclusive" : { + "playCount" : { "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds when these credentials become active. Credentials activate immediately if this value is left null.", - "example" : 1640995200, - "minimum" : 0, + "format" : "int32", + "description" : "The number of times to play the clip audio for the siren.", "nullable" : true } }, - "required" : [ "credentialUuids" ] + "required" : [ "audioGateways", "clipUuid" ] }, - "Accesscontrol_credentials_BulkRotatePinCredentialsWSResponse" : { + "AbsoluteSecondsIntervalType" : { "type" : "object", - "description" : "Response containing the bulk rotated PIN credentials and any failed credentials.", "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of successfully rotated PIN credentials", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", + "b" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "e" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSRequest" : { + "AbsoluteSecondsScheduleType" : { "type" : "object", - "description" : "Request to create an access control credential by hex value and type.", + "allOf" : [ { + "type" : "object", + "properties" : { + "intervalList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" + }, + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "credentialType" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + "internalWriteOnly" : { + "type" : "boolean", + "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, + "mutable" : { + "type" : "boolean", "nullable" : true }, - "hexValue" : { + "name" : { "type" : "string", - "description" : "Hex value of the credential", - "example" : "1234567890ABCDEF", "nullable" : true }, - "littleEndian" : { + "oneTimeUse" : { "type" : "boolean", - "description" : "Only needed when creating Wiegand credentials", "nullable" : true }, - "numValueBits" : { - "type" : "integer", - "format" : "int32", - "description" : "Only needed when creating Wiegand credentials", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, - "nullable" : true + "strategy" : { + "$ref" : "#/components/schemas/ScheduleStrategyEnum" }, - "userUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -40735,129 +41409,129 @@ } } }, - "Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSResponse" : { - "type" : "object", - "description" : "Response for access control credential creation by hex value and type.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } + "AccessControlAuthenticationResultEnumType" : { + "type" : "string", + "enum" : [ "ACCEPTED", "REJECTED", "ERROR", "NA" ] }, - "Accesscontrol_credentials_CreateAppleWalletPassWSRequest" : { + "AccessControlAuthorizationResultEnumType" : { + "type" : "string", + "enum" : [ "ALLOWED", "DENIED", "DISABLED", "ERROR", "NA" ] + }, + "AccessControlCredentialAssigneeTypeEnum" : { + "type" : "string", + "enum" : [ "USER", "GUEST_PASS" ] + }, + "AccessControlCredentialEnumType" : { + "type" : "string", + "enum" : [ "STANDARD_CSN", "RHOMBUS_SECURE_CSN", "RHOMBUS_SECURE_MOBILE", "APPLE_WALLET_DESFIRE", "PIN_CODE", "WIEGAND_H10301", "WIEGAND_H10304", "WIEGAND_H10302", "WIEGAND_D10202", "WIEGAND_64BIT_RAW", "HID_CORP1000_STD_35", "HID_CORP1000_STD_48", "QR_CODE_STATIC", "CUSTOM" ] + }, + "AccessControlCredentialType" : { "type" : "object", - "description" : "Request to create an Apple Wallet pass.", + "description" : "Credentials assigned to the pass.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StandardCsnType" + }, { + "$ref" : "#/components/schemas/RhombusSecureCsnType" + }, { + "$ref" : "#/components/schemas/RhombusSecureMobileType" + }, { + "$ref" : "#/components/schemas/PinCredential" + }, { + "$ref" : "#/components/schemas/WiegandH10301CredentialType" + }, { + "$ref" : "#/components/schemas/WiegandH10304Credential" + }, { + "$ref" : "#/components/schemas/WiegandH10302Credential" + }, { + "$ref" : "#/components/schemas/WiegandD10202Credential" + }, { + "$ref" : "#/components/schemas/Wiegand64BitRawCredentialType" + }, { + "$ref" : "#/components/schemas/Wiegand35BitCorp1000Credential" + }, { + "$ref" : "#/components/schemas/Wiegand48BitCorp1000Credential" + }, { + "$ref" : "#/components/schemas/QrCodeStaticCredential" + }, { + "$ref" : "#/components/schemas/CustomCredential" + } ], "properties" : { - "credUuid" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_CreateAppleWalletPassWSResponse" : { - "type" : "object", - "description" : "Response containing Apple Wallet pass data as a streaming output." - }, - "Accesscontrol_credentials_CreatePinCredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a PIN credential for a user.", - "properties" : { - "endDateEpochSecExclusive" : { + }, + "createdAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "End date in epoch seconds when this credential expires. Credentials never expire if this value is left null.", - "example" : 1672531200, - "minimum" : 0, "nullable" : true }, - "notifyUser" : { - "type" : "boolean", - "description" : "Whether to notify the user about the new PIN credential.", - "example" : true, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "pinCode" : { + "lastUsedAccessControlledDoorUuid" : { "type" : "string", - "description" : "PIN code (4 to 16 digits), will be generated automatically if one is not provided.", - "example" : "12345", - "maxLength" : 16, - "minLength" : 4, - "nullable" : true - }, - "pinLength" : { - "type" : "integer", - "format" : "int32", - "default" : 5, - "description" : "Length of PIN to be generated if a PIN code is not provided. Accepts length between 4 and 16. Default length is 5.", - "example" : 5, - "maximum" : 16, - "minimum" : 4, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateEpochSecInclusive" : { + "lastUsedAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Start date in epoch seconds when this credential becomes active. Credentials activate immediately if this value is left null.", - "example" : 1640995200, - "minimum" : 0, "nullable" : true }, - "userUuid" : { + "lastUsedLocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "userUuid" ] - }, - "Accesscontrol_credentials_CreatePinCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the created PIN credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" }, - "error" : { - "type" : "boolean", - "nullable" : true + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true }, - "errorMsg" : { + "managedCredUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "note" : { "type" : "string", "nullable" : true - } - } - }, - "Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a Rhombus Secure CSN credential.", - "properties" : { - "credentialValue" : { + }, + "orgUuid" : { "type" : "string", - "description" : "Credential value", - "example" : "123456789", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { + "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, "nullable" : true }, - "startDateEpochSecInclusive" : { + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, "nullable" : true }, "userUuid" : { @@ -40866,208 +41540,192 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSResponse" : { - "type" : "object", - "description" : "Response for Rhombus Secure CSN credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_CreateStandardCsnCredentialWSRequest" : { + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "AccessControlCredentialWorkflowStatusEnumType" : { + "type" : "string", + "enum" : [ "ACTIVE", "UNASSIGNED", "SUSPENDED", "REVOKED" ] + }, + "AccessControlUnitBatteryStateChangeEventType" : { "type" : "object", - "description" : "Request to create a standard CSN credential.", + "allOf" : [ { + "type" : "object", + "properties" : { + "batteryFound" : { + "type" : "boolean", + "nullable" : true + }, + "batteryMa" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "batteryMv" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "onBackupPower" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "credentialValue" : { + "componentUuid" : { "type" : "string", - "description" : "Credential value", - "example" : "123456789", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, + "correlationId" : { + "type" : "string", "nullable" : true }, - "startDateEpochSecInclusive" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, "nullable" : true }, - "userUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_CreateStandardCsnCredentialWSResponse" : { - "type" : "object", - "description" : "Response for standard CSN credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a 64-bit raw Wiegand credential.", - "properties" : { - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, - "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "value" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Credential value", - "example" : "1234567890123456", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSResponse" : { + "AccessControlUnitDoorFirstInStateEvent" : { "type" : "object", - "description" : "Response for 64-bit raw Wiegand credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + "allOf" : [ { + "type" : "object", + "properties" : { + "doorAuthFirstInEventReference" : { + "$ref" : "#/components/schemas/DoorFirstInStateChangeEventReference" + }, + "doorScheduleFirstInEventReference" : { + "$ref" : "#/components/schemas/DoorFirstInStateChangeEventReference" + }, + "settingsUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } } - } - }, - "Accesscontrol_credentials_CreateWiegandCredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a Wiegand credential.", + } ], + "nullable" : true, "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Card number for the credential", - "example" : 456, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "companyId" : { - "type" : "integer", - "format" : "int32", - "description" : "Company ID used by HID CORP 1000", - "example" : 1000, + "correlationId" : { + "type" : "string", "nullable" : true }, - "endDateEpochSecExclusive" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, - "nullable" : true - }, - "facilityCode" : { - "type" : "integer", - "format" : "int32", - "description" : "Facility code for the credential", - "example" : 123, - "nullable" : true - }, - "siteCode" : { - "type" : "integer", - "format" : "int32", - "description" : "Site code for the credential", - "example" : 789, "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "value" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Final credential value used in RAW formats", - "example" : "123456789", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wiegandFormat" : { - "$ref" : "#/components/schemas/WiegandFormatEnumType" - } - } - }, - "Accesscontrol_credentials_CreateWiegandCredentialWSResponse" : { - "type" : "object", - "description" : "Response for Wiegand credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_CreateWiegandD10202CredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a D10202 Wiegand credential.", - "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Card number", - "example" : 456789, - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "endDateEpochSecExclusive" : { + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, - "nullable" : true - }, - "facilityCode" : { - "type" : "integer", - "format" : "int32", - "description" : "Facility code", - "example" : 123, "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "userUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -41076,98 +41734,112 @@ } } }, - "Accesscontrol_credentials_CreateWiegandD10202CredentialWSResponse" : { + "AccessControlUnitLocationLockdownStateEventType" : { "type" : "object", - "description" : "Response for D10202 Wiegand credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + "allOf" : [ { + "type" : "object", + "properties" : { + "activatedLockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "nullable" : true + }, + "activeLockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "nullable" : true + }, + "deactivatedLockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "nullable" : true + }, + "doorEventReferenceMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DoorLockdownStateEventReference" + }, + "nullable" : true + }, + "followingTestPlan" : { + "type" : "boolean", + "nullable" : true + }, + "locationLockdownStateChangedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateEnumType" + } } - } - }, - "Accesscontrol_credentials_CreateWiegandH10301CredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a H10301 Wiegand credential.", + } ], + "nullable" : true, "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Card number", - "example" : 456789, - "nullable" : true - }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "facilityCode" : { - "type" : "integer", - "format" : "int32", - "description" : "Facility code", - "example" : 123, + "correlationId" : { + "type" : "string", "nullable" : true }, - "startDateEpochSecInclusive" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, "nullable" : true }, - "userUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_CreateWiegandH10301CredentialWSResponse" : { - "type" : "object", - "description" : "Response for H10301 Wiegand credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_CreateWiegandH10304CredentialWSRequest" : { - "type" : "object", - "description" : "Request to create a H10304 Wiegand credential.", - "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Card number", - "example" : 456789, - "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds (exclusive)", - "example" : 1672531200, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "facilityCode" : { - "type" : "integer", - "format" : "int32", - "description" : "Facility code", - "example" : 123, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateEpochSecInclusive" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Start date in epoch seconds (inclusive)", - "example" : 1640995200, "nullable" : true }, - "userUuid" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -41176,111 +41848,79 @@ } } }, - "Accesscontrol_credentials_CreateWiegandH10304CredentialWSResponse" : { + "AccessControlUnitTamperEventType" : { "type" : "object", - "description" : "Response for H10304 Wiegand credential creation.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "source" : { + "$ref" : "#/components/schemas/AccessControlUnitTamperSourceEnumType" + } } - } - }, - "Accesscontrol_credentials_DeleteAccessControlCredentialWSRequest" : { - "type" : "object", - "description" : "Request to delete an access control credential.", + } ], + "nullable" : true, "properties" : { - "credentialUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_DeleteAccessControlCredentialWSResponse" : { - "type" : "object", - "description" : "Response indicating successful deletion of an access control credential." - }, - "Accesscontrol_credentials_DeletePinCredentialWSRequest" : { - "type" : "object", - "description" : "Request to delete a PIN credential permanently from the system.", - "properties" : { - "credentialUuid" : { + }, + "correlationId" : { + "type" : "string", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "credentialUuid" ] - }, - "Accesscontrol_credentials_DeletePinCredentialWSResponse" : { - "type" : "object", - "description" : "Response indicating successful deletion of a PIN credential.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSRequest" : { - "type" : "object", - "description" : "Request to delete an unassigned access control credential.", - "properties" : { - "credentialHexValue" : { + }, + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Hex value of the credential to delete", - "example" : "1234567890ABCDEF", - "nullable" : true - } - } - }, - "Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSResponse" : { - "type" : "object", - "description" : "Response indicating successful deletion of an unassigned access control credential." - }, - "Accesscontrol_credentials_FindAccessControlCredentialByOrgWSRequest" : { - "type" : "object", - "description" : "Request to find access control credentials by organization.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" - } - } - }, - "Accesscontrol_credentials_FindAccessControlCredentialByOrgWSResponse" : { - "type" : "object", - "description" : "Response containing access control credentials found for an organization.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of access control credentials", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindAccessControlCredentialByUserWSRequest" : { - "type" : "object", - "description" : "Request to find access control credentials by user.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" }, - "userUuid" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -41289,340 +41929,224 @@ } } }, - "Accesscontrol_credentials_FindAccessControlCredentialByUserWSResponse" : { - "type" : "object", - "description" : "Response containing access control credentials found for a specific user.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of access control credentials", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, - "nullable" : true - } - } + "AccessControlUnitTamperSourceEnumType" : { + "type" : "string", + "enum" : [ "PROX", "ACCEL", "SWITCH", "NA" ] }, - "Accesscontrol_credentials_FindAccessControlCredentialByUsersWSRequest" : { + "AccessControlledDoorPolicyAlertType" : { "type" : "object", - "description" : "Request to find access control credentials by multiple users.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" - }, - "userUuids" : { - "type" : "array", - "description" : "Set of user UUIDs to search for", - "items" : { + "allOf" : [ { + "type" : "object", + "properties" : { + "accessControlUnitUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "initiatingUsername" : { + "type" : "string", + "nullable" : true + }, + "originatorEntityName" : { + "type" : "string", + "nullable" : true + }, + "originatorEntityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "originatorType" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" + } } - } - }, - "Accesscontrol_credentials_FindAccessControlCredentialByUsersWSResponse" : { - "type" : "object", - "description" : "Response containing access control credentials mapped by user UUIDs.", + } ], + "nullable" : true, "properties" : { - "userCredentialsMap" : { + "alertMonitoringThreatCaseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "alertMonitoringVerified" : { + "type" : "boolean", + "nullable" : true + }, + "archived" : { + "type" : "boolean", + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" + }, + "clipLocationMap" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "description" : "Map of user UUIDs to their associated access control credentials", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "nullable" : true + }, + "clipLocationMapV2" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", "nullable" : true }, - "description" : "Map of user UUIDs to their associated access control credentials", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSRequest" : { - "type" : "object", - "description" : "Request to find credential history by credential hex value.", - "properties" : { - "credentialHexValue" : { - "type" : "string", - "description" : "Hex value of the credential to search for", - "example" : "1234567890ABCDEF", + }, + "delayedProcessing" : { + "type" : "boolean", "nullable" : true }, - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSResponse" : { - "type" : "object", - "description" : "Response containing credential history found by credential hex value.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of credential history records", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + "deleted" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSRequest" : { - "type" : "object", - "description" : "Request to find credential history by credential value.", - "properties" : { - "credentialType" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, - "credentialValue" : { - "type" : "string", - "description" : "Credential value to search for", - "example" : "123456789", + "durationSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSResponse" : { - "type" : "object", - "description" : "Response containing credential history found by credential value.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of credential history records", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + "finalized" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryByUserWSRequest" : { - "type" : "object", - "description" : "Request to find credential history by user.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" }, - "userUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryByUserWSResponse" : { - "type" : "object", - "description" : "Response containing credential history found for a specific user.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of credential history records", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + }, + "notificationSent" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryWSRequest" : { - "type" : "object", - "description" : "Request to find credential history.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" - } - } - }, - "Accesscontrol_credentials_FindCredentialHistoryWSResponse" : { - "type" : "object", - "description" : "Response containing credential history.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of credential history records", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindPinCredentialsByOrgWSRequest" : { - "type" : "object", - "description" : "Request to find PIN credentials in the organization with optional filtering.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/CredentialQueryFilter" - } - } - }, - "Accesscontrol_credentials_FindPinCredentialsByOrgWSResponse" : { - "type" : "object", - "description" : "Response containing a list of PIN credentials found in the organization.", - "properties" : { - "credentials" : { + }, + "policyAlertTriggers" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "policyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ruleUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_FindRhombusSecureMobileCredentialsForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to find Rhombus Secure mobile credentials for current user." - }, - "Accesscontrol_credentials_FindRhombusSecureMobileCredentialsForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response for finding Rhombus Secure mobile credentials for current user.", - "properties" : { - "credentials" : { - "type" : "array", - "description" : "List of Rhombus Secure mobile credentials", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, + }, + "saved" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Accesscontrol_credentials_GetAvailablePinCodeWSRequest" : { - "type" : "object", - "description" : "Request to get an available PIN code for creating a PIN credential.", - "properties" : { - "pinLength" : { + }, + "serverReceivedAtMs" : { "type" : "integer", - "format" : "int32", - "description" : "Length of PIN to be generated.", - "example" : 5, + "format" : "int64", "nullable" : true - } - }, - "required" : [ "pinLength" ] - }, - "Accesscontrol_credentials_GetAvailablePinCodeWSResponse" : { - "type" : "object", - "description" : "Response containing an available PIN code for credential creation.", - "properties" : { - "error" : { + }, + "shared" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "pinCode" : { + "textDescription" : { "type" : "string", - "description" : "The generated PIN code", - "example" : "12345", + "description" : "Natural language description of the alert", "nullable" : true }, - "warningMsg" : { + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "thumbnailLocationV2" : { "type" : "string", "nullable" : true - } - } - }, - "Accesscontrol_credentials_GetPinCredentialDetailsWSRequest" : { - "type" : "object", - "description" : "Request to get detailed information about a PIN credential including sensitive data.", - "properties" : { - "credentialUuid" : { + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/PolicyAlertEnumType" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "credentialUuid" ] + } }, - "Accesscontrol_credentials_GetPinCredentialDetailsWSResponse" : { + "AccessControlledDoorPolicyType" : { "type" : "object", - "description" : "Response containing detailed PIN credential information including sensitive data.", + "description" : "List of access controlled door policies using the schedule", "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "description" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "name" : { "type" : "string", "nullable" : true - } - } - }, - "Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSRequest" : { - "type" : "object", - "description" : "Request to get Rhombus Secure CSN credential details.", - "properties" : { - "credentialUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSResponse" : { - "type" : "object", - "description" : "Response containing Rhombus Secure CSN credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_GetRhombusSecureMobileAppStateStatsForOrgWSRequest" : { - "type" : "object", - "description" : "Request to get Rhombus Secure mobile app state stats for organization." - }, - "Accesscontrol_credentials_GetRhombusSecureMobileAppStateStatsForOrgWSResponse" : { - "type" : "object", - "description" : "Response for getting Rhombus Secure mobile app state stats for organization.", - "properties" : { - "appStateStats" : { - "$ref" : "#/components/schemas/RhombusSecureMobileAppStateStats" - } - } - }, - "Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSRequest" : { - "type" : "object", - "description" : "Request to get standard CSN credential details.", - "properties" : { - "credentialUuid" : { + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -41631,996 +42155,864 @@ } } }, - "Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSResponse" : { - "type" : "object", - "description" : "Response containing standard CSN credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialErrorEnumType" : { - "type" : "string", - "description" : "Enumeration of possible errors when provisioning mobile access control credentials.", - "enum" : [ "USER_HAS_MAX_ALLOWED_CREDENTIALS" ] - }, - "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse" : { + "AccessControlledDoorScheduledTriggerType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "errorType" : { - "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialErrorEnumType" - } - } - } ], - "nullable" : true, "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" - } - } - }, - "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "encodedPrivateKey" : { - "type" : "string", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BasicResponseEnumType" + "nullable" : true, + "uniqueItems" : true } } }, - "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserWSRequest" : { + "AccessControlledDoorShadow" : { "type" : "object", - "description" : "Request to provision mobile access control credential for current user.", "properties" : { - "appName" : { + "authFirstIn" : { + "$ref" : "#/components/schemas/FirstInShadow" + }, + "componentCompositeUuid" : { "type" : "string", - "description" : "Name of the mobile app", - "example" : "Rhombus Key", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "appNotifications" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" - }, - "appOS" : { - "type" : "string", - "description" : "Operating system of the mobile device", - "example" : "iOS 15.0", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "appVersion" : { + "orgUuid" : { "type" : "string", - "description" : "Version of the mobile app", - "example" : "1.2.3", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "clientType" : { - "$ref" : "#/components/schemas/MobileTokenOSEnum" - }, - "deviceModel" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Model of the mobile device", - "example" : "iPhone 13", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "installationId" : { - "type" : "string", - "description" : "Installation ID of the mobile app", - "example" : "abc123def456", - "nullable" : true + "scheduleFirstIn" : { + "$ref" : "#/components/schemas/FirstInShadow" }, - "tapToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + "state" : { + "$ref" : "#/components/schemas/AccessStateShadow" }, - "waveToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" - } - } - }, - "Accesscontrol_credentials_RevokeAccessControlCredentialWSRequest" : { - "type" : "object", - "description" : "Request to revoke an access control credential.", - "properties" : { - "credentialUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeShadowEnum" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Accesscontrol_credentials_RevokeAccessControlCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the revoked access control credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } + "AccessControlledDoorStateEnumType" : { + "type" : "string", + "enum" : [ "UNLOCKED", "ACCESS_CONTROLLED" ] }, - "Accesscontrol_credentials_RevokePinCredentialWSRequest" : { - "type" : "object", - "description" : "Request to revoke a PIN credential, making it inactive.", - "properties" : { - "credentialUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "credentialUuid" ] + "AccessControlledDoorSubTypeEnum" : { + "type" : "string", + "enum" : [ "RHOMBUS", "APERIO", "APERIO_RS485", "SCHLAGE_R485" ] }, - "Accesscontrol_credentials_RevokePinCredentialWSResponse" : { + "AccessControlledDoorSubTypeEnum_Minimal" : { + "type" : "string", + "enum" : [ "RHOMBUS", "APERIO", "APERIO_RS485", "SCHLAGE_R485" ] + }, + "AccessControlledDoorType" : { "type" : "object", - "description" : "Response indicating successful revocation of a PIN credential.", "properties" : { - "error" : { - "type" : "boolean", + "ajarTimeSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "apbMode" : { + "$ref" : "#/components/schemas/AntiPassbackModeEnum" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Accesscontrol_credentials_RevokeRhombusSecureMobileCredentialForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to revoke Rhombus Secure mobile credential for current user.", - "properties" : { - "credentialUuid" : { + "apbZoneId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_RevokeRhombusSecureMobileCredentialForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response for revoking Rhombus Secure mobile credential for current user." - }, - "Accesscontrol_credentials_RotatePinCredentialWSRequest" : { - "type" : "object", - "description" : "Request to rotate a PIN credential with a new value.", - "properties" : { - "credentialUuid" : { + }, + "aperioDoorExtensionComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "aperioDoorId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { + "aperioGatewayComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "associatedFaceDetectionCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "buttonComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "createdAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "End date in epoch seconds when this credential expires. If left null, copies the end date from the previous PIN.", - "example" : 1672531200, - "minimum" : 0, "nullable" : true }, - "notifyUser" : { - "type" : "boolean", - "description" : "Whether to notify the user about their rotated PIN credential.", - "example" : true, + "defaultAccessStateOriginator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "defaultAccessStateRequestedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "pinCode" : { - "type" : "string", - "description" : "PIN code (4 to 16 digits), will be generated automatically if one is not provided.", - "example" : "12345", - "maxLength" : 16, - "minLength" : 4, + "defaultState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "pinLength" : { + "doorAuthFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState" + }, + "doorScheduleFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState" + }, + "doorStateOverride" : { + "$ref" : "#/components/schemas/BaseAccessStateOverride" + }, + "doorStateToScheduleUuidMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "dpiComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Length of PIN to be generated if a PIN code is not provided. Accepts length between 4 and 16. If left null, the generated PIN will have the same length as the previous PIN.", - "example" : 5, - "maximum" : 16, - "minimum" : 4, "nullable" : true }, - "startDateEpochSecInclusive" : { + "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "forcedOpenEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "forcedOpenTimeSec" : { "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds when this credential becomes active. If left null, copies the start date from the previous PIN.", - "example" : 1640995200, - "minimum" : 0, + "format" : "int32", "nullable" : true - } - }, - "required" : [ "credentialUuid" ] - }, - "Accesscontrol_credentials_RotatePinCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the rotated PIN credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" }, - "error" : { + "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "geofenceRadius" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Accesscontrol_credentials_SuspendAccessControlCredentialWSRequest" : { - "type" : "object", - "description" : "Request to suspend an access control credential.", - "properties" : { - "credentialUuid" : { + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_SuspendAccessControlCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the suspended access control credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_UnsuspendAccessControlCredentialWSRequest" : { - "type" : "object", - "description" : "Request to unsuspend an access control credential.", - "properties" : { - "credentialUuid" : { + }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "nfcSecureDowngradeEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_credentials_UnsuspendAccessControlCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the unsuspended access control credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_UpdateAccessControlCredentialNoteWSRequest" : { - "type" : "object", - "description" : "Request to update the note field of an access control credential.", - "properties" : { - "credentialUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "note" : { - "type" : "string", - "description" : "Note to be associated with the credential. Max length is 250 characters.", - "example" : "Employee badge", - "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdateAccessControlCredentialNoteWSResponse" : { - "type" : "object", - "description" : "Response for updating the note field of an access control credential.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_UpdatePinCredentialWSRequest" : { - "type" : "object", - "description" : "Request to update a PIN credential with new start and end dates.", - "properties" : { - "credentialUuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", + "privacyModeSupportEnabled" : { + "type" : "boolean", "nullable" : true }, - "startDateEpochSecInclusive" : { + "proximityUnlockSettings" : { + "$ref" : "#/components/schemas/ProximityUnlockSettingsType" + }, + "readerComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "relayComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "relockAfterOpenTimeMs" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdatePinCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the updated PIN credential details.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" }, - "error" : { + "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "rexComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdateRhombusKeyMobileAppStateForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to update Rhombus Key mobile app state for current user.", - "properties" : { - "appName" : { - "type" : "string", - "description" : "Name of the mobile app", - "example" : "Rhombus Key", - "nullable" : true + "schlageDoorExtensionComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType" }, - "appNotifications" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + "schlageGatewayComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType" }, - "appOS" : { - "type" : "string", - "description" : "Operating system of the mobile device", - "example" : "iOS 15.0", + "schlageGatewayRs485Address" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "appVersion" : { - "type" : "string", - "description" : "Version of the mobile app", - "example" : "1.2.3", + "schlageRs485Address" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "clientType" : { - "$ref" : "#/components/schemas/MobileTokenOSEnum" - }, - "credentialUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "sendExpiredIntentEvents" : { + "type" : "boolean", "nullable" : true }, - "deviceModel" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Model of the mobile device", - "example" : "iPhone 13", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "tapToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + "subType" : { + "$ref" : "#/components/schemas/AccessControlledDoorSubTypeEnum" }, - "waveToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" - } - } - }, - "Accesscontrol_credentials_UpdateRhombusKeyMobileAppStateForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response for updating Rhombus Key mobile app state for current user.", - "properties" : { - "appState" : { - "$ref" : "#/components/schemas/RhombusSecureMobileAppState" - } - } - }, - "Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSRequest" : { - "type" : "object", - "description" : "Request to update a Rhombus Secure CSN credential.", - "properties" : { - "credentialUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeEnumType" + }, + "unlockTimeSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "endDateEpochSecExclusive" : { + "unlockTimeSecRex" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "startDateEpochSecInclusive" : { + "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the updated Rhombus Secure CSN credential.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSRequest" : { - "type" : "object", - "description" : "Request to update a Rhombus Secure mobile credential.", - "properties" : { - "credentialUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the updated Rhombus Secure mobile credential.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" + "waveToUnlockSettings" : { + "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, - "Accesscontrol_credentials_UpdateStandardCsnCredentialWSRequest" : { + "AccessControlledDoorType_Minimal" : { "type" : "object", - "description" : "Request to update a standard CSN credential.", + "description" : "List of access controlled doors", "properties" : { - "credentialUuid" : { + "apbMode" : { + "$ref" : "#/components/schemas/AntiPassbackModeEnum_Minimal" + }, + "apbZoneId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "aperioDoorExtensionComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdateStandardCsnCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the updated standard CSN credential.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_credentials_UpdateWiegandCredentialWSRequest" : { - "type" : "object", - "description" : "Request to update a Wiegand credential.", - "properties" : { - "credentialUuid" : { + "aperioDoorId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", + "aperioGatewayComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "buttonComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "nullable" : true, + "uniqueItems" : true + }, + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "startDateEpochSecInclusive" : { + "doorAuthFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState_Minimal" + }, + "doorScheduleFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState_Minimal" + }, + "doorStateOverride" : { + "$ref" : "#/components/schemas/BaseAccessStateOverride_Minimal" + }, + "dpiComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "nullable" : true, + "uniqueItems" : true + }, + "floorNumber" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true - } - } - }, - "Accesscontrol_credentials_UpdateWiegandCredentialWSResponse" : { - "type" : "object", - "description" : "Response containing the updated Wiegand credential.", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/AccessControlCredentialType" - } - } - }, - "Accesscontrol_doorexception_CreateDoorScheduleExceptionWSRequest" : { - "type" : "object", - "description" : "Request to create a new door schedule exception.", - "properties" : { - "exception" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" - } - } - }, - "Accesscontrol_doorexception_CreateDoorScheduleExceptionWSResponse" : { - "type" : "object", - "description" : "Response containing the created door schedule exception.", - "properties" : { - "error" : { + }, + "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "geofenceRadius" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "exception" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" - }, - "warningMsg" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_DeleteDoorScheduleExceptionWSRequest" : { - "type" : "object", - "description" : "Request to delete a specific door schedule exception by UUID.", - "properties" : { - "exceptionUuid" : { + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_DeleteDoorScheduleExceptionWSResponse" : { - "type" : "object", - "description" : "Response confirming the deletion of a door schedule exception.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "nfcSecureDowngradeEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_FindDoorScheduleExceptionsForDoorWSRequest" : { - "type" : "object", - "description" : "Request to search for door schedule exceptions for a specific door with optional date range filtering.", - "properties" : { - "dateRangeFilter" : { - "$ref" : "#/components/schemas/DateRangeFilter" }, - "doorUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_FindDoorScheduleExceptionsForDoorWSResponse" : { - "type" : "object", - "description" : "Response containing a list of door schedule exceptions found for a specific door.", - "properties" : { - "error" : { + }, + "privacyModeSupportEnabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "proximityUnlockSettings" : { + "$ref" : "#/components/schemas/ProximityUnlockSettingsType_Minimal" + }, + "readerComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "nullable" : true, + "uniqueItems" : true + }, + "relayComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "nullable" : true, + "uniqueItems" : true + }, + "remoteUnlockEnabled" : { + "type" : "boolean", "nullable" : true }, - "exceptions" : { + "rexComponents" : { "type" : "array", - "description" : "List of door schedule exceptions found for the specified door.", "items" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, + "nullable" : true, + "uniqueItems" : true + }, + "schlageDoorExtensionComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "schlageGatewayComponent" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "schlageGatewayRs485Address" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { + "schlageRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subType" : { + "$ref" : "#/components/schemas/AccessControlledDoorSubTypeEnum_Minimal" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" + }, + "unlockTimeSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_FindDoorScheduleExceptionsForLocationWSRequest" : { - "type" : "object", - "description" : "Request to search for door schedule exceptions for a specific location with optional date range filtering.", - "properties" : { - "dateRangeFilter" : { - "$ref" : "#/components/schemas/DateRangeFilter" }, - "locationUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "waveToUnlockSettings" : { + "$ref" : "#/components/schemas/WaveToUnlockSettingsType_Minimal" } } }, - "Accesscontrol_doorexception_FindDoorScheduleExceptionsForLocationWSResponse" : { + "AccessControlledElevator" : { "type" : "object", - "description" : "Response containing a list of door schedule exceptions found for a specific location.", "properties" : { - "error" : { - "type" : "boolean", + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "associatedFaceDetectionCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "exceptions" : { - "type" : "array", - "description" : "List of door schedule exceptions found for the specified location.", - "items" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" + "elevatorLandingReferences" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ElevatorLandingReference" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_FindDoorScheduleExceptionsWSRequest" : { - "type" : "object", - "description" : "Request to search for door schedule exceptions with optional date range filtering.", - "properties" : { - "dateRangeFilter" : { - "$ref" : "#/components/schemas/DateRangeFilter" - } - } - }, - "Accesscontrol_doorexception_FindDoorScheduleExceptionsWSResponse" : { - "type" : "object", - "description" : "Response containing a list of door schedule exceptions found in the search.", - "properties" : { - "error" : { + }, + "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "geofenceEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "geofenceRadius" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "exceptions" : { - "type" : "array", - "description" : "List of door schedule exceptions found in the search.", - "items" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" - }, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "warningMsg" : { + "name" : { "type" : "string", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_GetDoorScheduleExceptionWSRequest" : { - "type" : "object", - "description" : "Request to retrieve a specific door schedule exception by UUID.", - "properties" : { - "exceptionUuid" : { + }, + "nfcSecureDowngradeEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_doorexception_GetDoorScheduleExceptionWSResponse" : { - "type" : "object", - "description" : "Response containing the requested door schedule exception.", - "properties" : { - "error" : { + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "proximityUnlockSettings" : { + "$ref" : "#/components/schemas/ProximityUnlockSettingsType" + }, + "readerComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "sendExpiredIntentEvents" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeEnumType" + }, + "unlockTimeSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "exception" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "waveToUnlockSettings" : { + "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, - "Accesscontrol_doorexception_UpdateDoorScheduleExceptionWSRequest" : { - "type" : "object", - "description" : "Request to update an existing door schedule exception.", - "properties" : { - "exception" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" - } - } - }, - "Accesscontrol_doorexception_UpdateDoorScheduleExceptionWSResponse" : { + "AccessControlledElevatorLanding" : { "type" : "object", - "description" : "Response containing the updated door schedule exception and license information.", + "description" : "The updated elevator landing after applying the first-in state.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "accessScheduleFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState" }, - "exception" : { - "$ref" : "#/components/schemas/DoorScheduleExceptionType" + "accessStateOverride" : { + "$ref" : "#/components/schemas/BaseAccessStateOverride" }, - "expiredACDLicensesDoorUuids" : { - "type" : "array", - "description" : "Set of door UUIDs with expired access control licenses.", - "items" : { + "accessStateToScheduleUuidMap" : { + "type" : "object", + "additionalProperties" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "nullable" : true + }, + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true, "uniqueItems" : true }, - "unassignedACDLicensesDoorUuids" : { + "associatedFaceDetectionCameras" : { "type" : "array", - "description" : "Set of door UUIDs with unassigned access control licenses.", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", + "authFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Accesscontrol_firstin_ApplyDoorAuthFirstInGroupStateWSRequest" : { - "type" : "object", - "description" : "Request to apply door auth first-in state to all doors in a first-in settings group.", - "properties" : { - "settingsUuid" : { + }, + "defaultAccessState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "defaultAccessStateOriginator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "defaultAccessStateRequestedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "geofenceEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "geofenceRadius" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - } - } - }, - "Accesscontrol_firstin_ApplyDoorAuthFirstInGroupStateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated location first-in settings after applying door auth first-in group state.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_ApplyDoorAuthFirstInStateWSRequest" : { - "type" : "object", - "description" : "Request to apply door auth first-in state to a specific door.", - "properties" : { - "doorUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - } - } - }, - "Accesscontrol_firstin_ApplyDoorAuthFirstInStateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated door after applying door auth first-in state.", - "properties" : { - "door" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - } - } - }, - "Accesscontrol_firstin_ApplyDoorScheduleFirstInGroupStateWSRequest" : { - "type" : "object", - "description" : "Request to apply door schedule first-in state to all doors in a first-in settings group.", - "properties" : { - "settingsUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - } - } - }, - "Accesscontrol_firstin_ApplyDoorScheduleFirstInGroupStateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated location first-in settings after applying door schedule first-in group state.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_ApplyDoorScheduleFirstInStateWSRequest" : { - "type" : "object", - "description" : "Request to apply door schedule first-in state to a specific door.", - "properties" : { - "doorUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - } - } - }, - "Accesscontrol_firstin_ApplyDoorScheduleFirstInStateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated door after applying door schedule first-in state.", - "properties" : { - "door" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - } - } - }, - "Accesscontrol_firstin_ApplyElevatorLandingAccessScheduleFirstInStateWSRequest" : { - "type" : "object", - "description" : "Request to apply access schedule first-in state to a specific elevator landing.", - "properties" : { - "elevatorLandingUuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - } - } - }, - "Accesscontrol_firstin_ApplyElevatorLandingAccessScheduleFirstInStateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated elevator landing after applying access schedule first-in state.", - "properties" : { - "elevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - } - } - }, - "Accesscontrol_firstin_ApplyElevatorLandingAuthFirstInStateWSRequest" : { - "type" : "object", - "description" : "Request to apply auth first-in state to a specific elevator landing.", - "properties" : { - "elevatorLandingUuid" : { + "remoteUnlockEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - } - } - }, - "Accesscontrol_firstin_ApplyElevatorLandingAuthFirstInStateWSResponse" : { - "type" : "object", - "description" : "Response containing the updated elevator landing after applying auth first-in state.", - "properties" : { - "elevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - } - } - }, - "Accesscontrol_firstin_CreateLocationFirstInSettingsWSRequest" : { - "type" : "object", - "description" : "Request to create new location first-in settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_CreateLocationFirstInSettingsWSResponse" : { - "type" : "object", - "description" : "Response containing the created location first-in settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_DeleteLocationFirstInSettingsWSRequest" : { - "type" : "object", - "description" : "Request to delete specific location first-in settings by UUID.", - "properties" : { - "settingsUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -42629,165 +43021,115 @@ } } }, - "Accesscontrol_firstin_DeleteLocationFirstInSettingsWSResponse" : { - "type" : "object", - "description" : "Response containing the deleted location first-in settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_FindLocationFirstInSettingsByLocationWSRequest" : { + "AccessControlledElevatorLandingShadow" : { "type" : "object", - "description" : "Request to search for location first-in settings for a specific location with pagination support.", "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", - "nullable" : true + "authFirstIn" : { + "$ref" : "#/components/schemas/FirstInShadow" }, - "locationUuid" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { + "createdAtMillis" : { "type" : "integer", - "format" : "int32", - "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "format" : "int64", "nullable" : true - } - } - }, - "Accesscontrol_firstin_FindLocationFirstInSettingsByLocationWSResponse" : { - "type" : "object", - "description" : "Response containing a list of location first-in settings found for the specified location with pagination information.", - "properties" : { - "lastEvaluatedKey" : { + }, + "orgUuid" : { "type" : "string", - "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "settingsList" : { - "type" : "array", - "description" : "List of location first-in settings found for the specified location.", - "items" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - }, + "scheduleFirstIn" : { + "$ref" : "#/components/schemas/FirstInShadow" + }, + "state" : { + "$ref" : "#/components/schemas/AccessStateShadow" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeShadowEnum" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Accesscontrol_firstin_FindLocationFirstInSettingsByOrgWSRequest" : { + "AccessControlledElevatorLanding_Minimal" : { "type" : "object", - "description" : "Request to search for location first-in settings across the organization with pagination support.", + "description" : "List of access controlled elevator landings", "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", - "nullable" : true + "accessScheduleFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState_Minimal" }, - "maxPageSize" : { + "accessStateOverride" : { + "$ref" : "#/components/schemas/BaseAccessStateOverride_Minimal" + }, + "authFirstInStateOverride" : { + "$ref" : "#/components/schemas/FirstInState_Minimal" + }, + "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true - } - } - }, - "Accesscontrol_firstin_FindLocationFirstInSettingsByOrgWSResponse" : { - "type" : "object", - "description" : "Response containing a list of location first-in settings found in the organization with pagination information.", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", + }, + "geofenceEnabled" : { + "type" : "boolean", "nullable" : true }, - "settingsList" : { - "type" : "array", - "description" : "List of location first-in settings found in the organization.", - "items" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - }, + "geofenceRadius" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Accesscontrol_firstin_GetLocationFirstInSettingsForDoorWSRequest" : { - "type" : "object", - "description" : "Request to retrieve location first-in settings for a specific door.", - "properties" : { - "doorUuid" : { + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_firstin_GetLocationFirstInSettingsForDoorWSResponse" : { - "type" : "object", - "description" : "Response containing the location first-in settings for the specified door.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_GetLocationFirstInSettingsWSRequest" : { - "type" : "object", - "description" : "Request to retrieve specific location first-in settings by UUID.", - "properties" : { - "settingsUuid" : { + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_firstin_GetLocationFirstInSettingsWSResponse" : { - "type" : "object", - "description" : "Response containing the requested location first-in settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_RemoveDoorLocationFirstInSettingsWSRequest" : { - "type" : "object", - "description" : "Request to remove a door from its assigned location first-in settings.", - "properties" : { - "doorUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Accesscontrol_firstin_RemoveDoorLocationFirstInSettingsWSResponse" : { - "type" : "object", - "description" : "Response containing the updated location first-in settings after removing the door.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_RemoveElevatorLandingLocationFirstInSettingsWSRequest" : { - "type" : "object", - "description" : "Request to remove an elevator landing from its assigned location first-in settings.", - "properties" : { - "elevatorLandingUuid" : { + }, + "remoteUnlockEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -42796,443 +43138,430 @@ } } }, - "Accesscontrol_firstin_RemoveElevatorLandingLocationFirstInSettingsWSResponse" : { - "type" : "object", - "description" : "Response containing the updated location first-in settings after removing the elevator landing.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_firstin_UpdateLocationFirstInSettingsWSRequest" : { + "AccessControlledElevator_Minimal" : { "type" : "object", - "description" : "Request to update existing location first-in settings with selective field updates.", + "description" : "List of access controlled elevators owning the returned landings", "properties" : { - "description" : { - "type" : "string", - "description" : "Optional description for the first-in settings.", + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "doorAuthRequirementEnabled" : { + "elevatorLandingReferences" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ElevatorLandingReference_Minimal" + }, + "nullable" : true + }, + "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", - "description" : "Optional flag to enable/disable door auth requirement.", "nullable" : true }, - "doorScheduleRequirementEnabled" : { + "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { "type" : "boolean", - "description" : "Optional flag to enable/disable door schedule requirement.", "nullable" : true }, - "doorUuids" : { - "type" : "array", - "description" : "Optional sorted set of door UUIDs to assign to these settings.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true }, - "elevatorLandingUuids" : { - "type" : "array", - "description" : "Optional sorted set of elevator landing UUIDs to assign to these settings.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true }, - "groupUuids" : { - "type" : "array", - "description" : "Optional sorted set of group UUIDs to assign to these settings.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "geofenceEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "geofenceRadius" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true }, "name" : { "type" : "string", - "description" : "Optional name for the first-in settings.", "nullable" : true }, - "resets" : { - "type" : "array", - "description" : "Optional list of first-in reset configurations.", - "items" : { - "$ref" : "#/components/schemas/BaseFirstInReset" - }, + "nfcSecureDowngradeEnabled" : { + "type" : "boolean", "nullable" : true }, - "settingsUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuids" : { - "type" : "array", - "description" : "Optional sorted set of user UUIDs to assign to these settings.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Accesscontrol_firstin_UpdateLocationFirstInSettingsWSResponse" : { - "type" : "object", - "description" : "Response containing the updated location first-in settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/LocationFirstInSettings" - } - } - }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationViaRhombusKeyWSRequest" : { - "type" : "object", - "description" : "Request to activate lockdown for a specific location via Rhombus Key with optional optimistic locking.", - "properties" : { - "locationUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lockdownPlanUuids" : { + "proximityUnlockSettings" : { + "$ref" : "#/components/schemas/ProximityUnlockSettingsType_Minimal" + }, + "readerComponents" : { "type" : "array", - "description" : "Set of lockdown plan UUIDs to activate for the location.", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" }, "nullable" : true, "uniqueItems" : true }, - "stateUpdatedAtMillis" : { + "remoteUnlockEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "sendExpiredIntentEvents" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentCompositeEnumType_Minimal" + }, + "unlockTimeSec" : { "type" : "integer", - "format" : "int64", - "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", + "format" : "int32", "nullable" : true - } - } - }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationViaRhombusKeyWSResponse" : { - "type" : "object", - "description" : "Response containing the result of activating lockdown for a location via Rhombus Key.", - "properties" : { - "result" : { - "$ref" : "#/components/schemas/LockdownActivationResultEnumType" }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waveToUnlockSettings" : { + "$ref" : "#/components/schemas/WaveToUnlockSettingsType_Minimal" } } }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationWSRequest" : { + "AccessGrantModeEnum" : { + "type" : "string", + "enum" : [ "GUEST_PASS_INDIVIDUAL", "DEFAULT" ] + }, + "AccessStateAndSource" : { "type" : "object", - "description" : "Request to activate lockdown for a specific location with optional optimistic locking.", "properties" : { - "locationUuid" : { + "exceptionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lockdownPlanUuids" : { - "type" : "array", - "description" : "Set of lockdown plan UUIDs to activate for the location.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "lockdownPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "stateUpdatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", + "lockedDown" : { + "type" : "boolean", + "nullable" : true + }, + "scheduleName" : { + "type" : "string", + "description" : "Name of the schedule if derived from a shared schedule", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "source" : { + "$ref" : "#/components/schemas/AccessStatefulComponentCompositeStateSourceEnum" + }, + "sourceId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "sourceName" : { + "type" : "string", + "description" : "Name of the source", + "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" } } }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationWSResponse" : { + "AccessStateBlock" : { "type" : "object", - "description" : "Response containing the result of activating lockdown for a location.", "properties" : { - "result" : { - "$ref" : "#/components/schemas/LockdownActivationResultEnumType" + "active" : { + "$ref" : "#/components/schemas/AccessStateAndSource" }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" + "default" : { + "$ref" : "#/components/schemas/AccessStateAndSource" + }, + "firstInRequirementSatisfied" : { + "type" : "boolean", + "nullable" : true + }, + "ifFirstInRequired" : { + "$ref" : "#/components/schemas/AccessStateAndSource" + }, + "ifFirstInSatisfied" : { + "$ref" : "#/components/schemas/AccessStateAndSource" + }, + "ifOverrideRemoved" : { + "$ref" : "#/components/schemas/AccessStateAndSource" } } }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSRequest" : { + "AccessStateChange" : { "type" : "object", - "description" : "Request to activate lockdown for multiple locations via Rhombus Key with optional optimistic locking.\n", "properties" : { - "lockdownPlansByLocation" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Mapping of lockdown plan UUIDs by location UUID. Indicates which lockdown plans to activate for\neach location.\n", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "causes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessStateChangeCauseEnum" }, - "description" : "Mapping of lockdown plan UUIDs by location UUID. Indicates which lockdown plans to activate for\neach location.\n", "nullable" : true }, - "stateUpdatedAtMillis" : { + "newState" : { + "$ref" : "#/components/schemas/AccessStateAndSource" + }, + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Optional timestamp used for optimistic locking. It ensures that a user can update only the most\nrecent record for a given location. The lockdown state is updated only if the provided timestamp\nmatches the timestamp of the most recent update.\n", - "nullable" : true - } - }, - "required" : [ "lockdownPlansByLocation" ] - }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse" : { - "type" : "object", - "description" : "Response containing the results of activating lockdown for multiple locations via Rhombus key.\n", - "properties" : { - "lockdownResults" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownActivationResult" - }, - "description" : "The results of the lockdown activation attempt per location.", "nullable" : true } } }, - "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownActivationResult" : { + "AccessStateChangeCauseEnum" : { + "type" : "string", + "enum" : [ "SCHEDULE_START", "SCHEDULE_END", "DSE_START", "DSE_END", "DSE_SCHEDULE_START", "DSE_SCHEDULE_END", "FIRST_IN_RESET", "OVERRIDE_BEGIN", "OVERRIDE_EXPIRE", "OVERRIDE_EXPIRE_EARLY", "UNKNOWN" ] + }, + "AccessStateOverride" : { "type" : "object", - "description" : "The results of the lockdown activation attempt per location.", + "nullable" : true, "properties" : { - "info" : { - "type" : "string", - "description" : "Additional info regarding the outcome of the activation attempt.", + "expireEarlyMode" : { + "$ref" : "#/components/schemas/EarlyExpireModeEnum" + }, + "expiresAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "result" : { - "$ref" : "#/components/schemas/LockdownActivationResultEnumType" + "followFirstInRules" : { + "type" : "boolean", + "nullable" : true + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "requestedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startDelaySeconds" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "type" : { + "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" } } }, - "Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSRequest" : { - "type" : "object", - "description" : "Request to create a new location lockdown plan.", - "properties" : { - "lockdownPlan" : { - "$ref" : "#/components/schemas/LocationLockdownPlanType" - } - } + "AccessStateOverrideExpirationStrategyEnum" : { + "type" : "string", + "enum" : [ "TIME_DELAY", "TIME_OF_DAY_LOCAL", "NONE" ] }, - "Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSResponse" : { + "AccessStateShadow" : { "type" : "object", - "description" : "Response containing the created location lockdown plan.", "properties" : { - "lockdownPlan" : { - "$ref" : "#/components/schemas/LocationLockdownPlanType" + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "source" : { + "$ref" : "#/components/schemas/AccessStateSourceEnum" + }, + "state" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSRequest" : { + "AccessStateSourceEnum" : { + "type" : "string", + "enum" : [ "DEFAULT_STATE", "SCHEDULE", "SCHEDULE_EXCEPTION", "FIRST_IN", "DOOR_STATE_OVERRIDE", "LOCKDOWN", "PRIVACY", "UNKNOWN" ] + }, + "AccessStatefulComponentCompositeStateSourceEnum" : { + "type" : "string", + "enum" : [ "DEFAULT_STATE", "DOOR_SCHEDULE", "DSE_DEFAULT_STATE", "DSE_SCHEDULE", "DOOR_STATE_OVERRIDE", "LOCKDOWN" ] + }, + "Accesscontrol_BaseSendUserPresenceForCurrentUserWsResponse" : { "type" : "object", - "description" : "Request to create a new lockdown rule for a specific location.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserSuccessWsResponse" + }, { + "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserErrorWsResponse" + } ], "properties" : { - "rule" : { - "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSResponse" : { + "Accesscontrol_Create35BitCorp1000StdCredentialWSRequest" : { "type" : "object", - "description" : "Response containing the UUID of the created lockdown rule.", + "description" : "Request to create an HID Corp1000 Standard 35 Bit credential.", "properties" : { - "error" : { - "type" : "boolean", + "cardNumber" : { + "type" : "integer", + "format" : "int64", + "description" : "Card number", + "example" : 456789, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "companyId" : { + "type" : "integer", + "format" : "int32", + "description" : "Company Id", + "example" : 123, "nullable" : true }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, "nullable" : true - } - } - }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationViaRhombusKeyWSRequest" : { - "type" : "object", - "description" : "Request to deactivate lockdown for a specific location via Rhombus Key with optional optimistic locking.", - "properties" : { - "locationUuid" : { + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "stateUpdatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", - "nullable" : true } } }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationViaRhombusKeyWSResponse" : { + "Accesscontrol_Create35BitCorp1000StdCredentialWSResponse" : { "type" : "object", - "description" : "Response containing the result of deactivating lockdown for a location via Rhombus Key.", "properties" : { - "result" : { - "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" - }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSRequest" : { + "Accesscontrol_Create48BitCorp1000StdCredentialWSRequest" : { "type" : "object", - "description" : "Request to deactivate lockdown for a specific location with optional optimistic locking.", + "description" : "Request to create an HID Corp1000 Standard 48 Bit credential.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "cardNumber" : { + "type" : "integer", + "format" : "int64", + "description" : "Card number", + "example" : 456789, "nullable" : true }, - "stateUpdatedAtMillis" : { + "companyId" : { "type" : "integer", - "format" : "int64", - "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", + "format" : "int32", + "description" : "Company Id", + "example" : 123, "nullable" : true - } - } - }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSResponse" : { - "type" : "object", - "description" : "Response containing the result of deactivating lockdown for a location.", - "properties" : { - "result" : { - "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - } - } - }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSRequest" : { - "type" : "object", - "description" : "Request to deactivate lockdown for multiple locations via Rhombus Key with optional optimistic locking.\n", - "properties" : { - "locationUuids" : { - "type" : "array", - "description" : "Set of location UUIDs to deactivate lockdown for.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, + "nullable" : true }, - "stateUpdatedAtMillis" : { + "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", - "description" : "Optional timestamp used for optimistic locking. It ensures that a user can update only the most\nrecent record for a given location. The lockdown state is updated only if the provided timestamp\nmatches the timestamp of the most recent update.\n", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuids" ] + } }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse" : { + "Accesscontrol_Create48BitCorp1000StdWSResponse" : { "type" : "object", - "description" : "Response containing the results of deactivating lockdown for multiple locations via Rhombus key.\n", "properties" : { - "lockdownResults" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownDeactivationResult" - }, - "description" : "The results of the lockdown activation attempt per location.", - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, - "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownDeactivationResult" : { + "Accesscontrol_DeviceUnlockableAccessControlledDoorType" : { "type" : "object", - "description" : "The results of the lockdown activation attempt per location.", + "description" : "Represents an access controlled door that can be unlocked by a device.", "properties" : { - "info" : { + "name" : { "type" : "string", - "description" : "Additional info regarding the outcome of the deactivation attempt.", + "description" : "The name of the access controlled door.", "nullable" : true }, - "result" : { - "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" - }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - } - } - }, - "Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSRequest" : { - "type" : "object", - "description" : "Request to delete the lockdown state tracking for a specific location.", - "properties" : { - "locationUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43241,15 +43570,11 @@ } } }, - "Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSResponse" : { - "type" : "object", - "description" : "Response indicating successful deletion of location lockdown state." - }, - "Accesscontrol_lockdownplan_DeleteLockdownPlanWSRequest" : { + "Accesscontrol_FindUnlockableAccessControlledDoorsByDeviceWSRequest" : { "type" : "object", - "description" : "Request to delete a specific lockdown plan by UUID.", + "description" : "Request to find unlockable access controlled doors by device.", "properties" : { - "lockdownPlanUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43258,18 +43583,25 @@ } } }, - "Accesscontrol_lockdownplan_DeleteLockdownPlanWSResponse" : { + "Accesscontrol_FindUnlockableAccessControlledDoorsByDeviceWSResponse" : { "type" : "object", - "description" : "Response confirming the deletion of a lockdown plan.", + "description" : "Response containing unlockable access controlled doors for a device.", "properties" : { - "lockdownPlanUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "accessControlledDoors" : { + "type" : "array", + "description" : "List of unlockable access controlled doors", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_DeviceUnlockableAccessControlledDoorType" + }, "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Accesscontrol_ForceRefreshAccessControlUnitConfigWSRequest" : { + "type" : "object", + "description" : "Request to force refresh an access control unit configuration.", + "properties" : { + "accessControlUnitUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43278,9 +43610,13 @@ } } }, - "Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSRequest" : { + "Accesscontrol_ForceRefreshAccessControlUnitConfigWSResponse" : { "type" : "object", - "description" : "Request to delete a specific lockdown rule for a location.", + "description" : "Response for force refresh access control unit configuration operation." + }, + "Accesscontrol_GetMinimalAccessControlledDoorsByLocationForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request to get minimal access controlled doors by location for current user.", "properties" : { "locationUuid" : { "type" : "string", @@ -43288,236 +43624,417 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true } } }, - "Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSResponse" : { + "Accesscontrol_GetMinimalAccessControlledDoorsByLocationForCurrentUserWSResponse" : { "type" : "object", - "description" : "Response indicating successful deletion of a lockdown rule.", + "description" : "Response containing minimal access controlled doors by location for current user.", "properties" : { - "error" : { - "type" : "boolean", + "accessControlledDoors" : { + "type" : "array", + "description" : "List of access controlled doors", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType_Minimal" + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "accessControlledElevatorLandings" : { + "type" : "array", + "description" : "List of access controlled elevator landings", + "items" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding_Minimal" + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "accessControlledElevators" : { + "type" : "array", + "description" : "List of access controlled elevators owning the returned landings", + "items" : { + "$ref" : "#/components/schemas/AccessControlledElevator_Minimal" + }, + "nullable" : true + }, + "accessGrants" : { + "type" : "array", + "description" : "List of user access grants", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_UserAccessGrant" + }, + "nullable" : true + }, + "accessRevocations" : { + "type" : "array", + "description" : "List of user access revocations", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_UserAccessRevocation" + }, + "nullable" : true + }, + "schedules" : { + "type" : "array", + "description" : "List of schedules", + "items" : { + "$ref" : "#/components/schemas/BaseSavedScheduleType_Minimal" + }, "nullable" : true } } }, - "Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSRequest" : { + "Accesscontrol_SendUserPresenceForCurrentUserErrorWsResponse" : { "type" : "object", - "description" : "Request to disable test mode for lockdown at a specific location.", + "allOf" : [ ], + "description" : "Error response for send user presence for current user operation.", + "nullable" : true, "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSResponse" : { + "Accesscontrol_SendUserPresenceForCurrentUserSuccessWsResponse" : { "type" : "object", - "description" : "Response containing the updated lockdown state after disabling test mode.", + "allOf" : [ ], + "description" : "Success response for send user presence for current user operation.", + "nullable" : true, "properties" : { - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSRequest" : { + "Accesscontrol_SendUserPresenceForCurrentUserWSRequest" : { "type" : "object", - "description" : "Request to enable test mode for lockdown at a specific location.", + "description" : "Request to send user presence information for the current user.", "properties" : { - "locationUuid" : { + "cmdVersion" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "credentialValue" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "destinations" : { + "type" : "array", + "description" : "List of destinations for user presence", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_SendUserPresenceForCurrentUserWSRequest_Destination" + }, + "nullable" : true } } }, - "Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSResponse" : { + "Accesscontrol_SendUserPresenceForCurrentUserWSRequest_Destination" : { "type" : "object", - "description" : "Response containing the updated lockdown state after enabling test mode.", + "description" : "Destination information for user presence.", "properties" : { - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - } - } - }, - "Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" : { - "type" : "object", - "description" : "External representation of a lockdown plan rule configuration.", - "properties" : { - "action" : { - "$ref" : "#/components/schemas/RuleActionType" - }, - "locationUuid" : { + "accessControlUnitUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ruleFilters" : { - "$ref" : "#/components/schemas/RuleFilterType" - }, - "ruleName" : { - "type" : "string", - "description" : "The name of the lockdown rule.", + "beaconIdentifier" : { + "type" : "array", + "description" : "Beacon identifier", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Beacon identifier", + "nullable" : true + }, "nullable" : true }, - "ruleUuid" : { + "readerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "triggerActivity" : { - "$ref" : "#/components/schemas/ActivityEnum" + "rssi" : { + "type" : "string", + "format" : "byte", + "description" : "RSSI value of the reader as observed from the mobile device", + "example" : "LTY1", + "nullable" : true } } }, - "Accesscontrol_lockdownplan_FindLocationLockdownEventsWSRequest" : { + "Accesscontrol_UnlockAccessControlledDoorEnumType" : { + "type" : "string", + "description" : "Enumeration of possible errors when unlocking an access controlled door.", + "enum" : [ "FAILED_SENDING_ACU_UNLOCK_REQUEST", "DOOR_NOT_CONFIGURED_WITH_LOCK", "ACD_LICENSE_UNASSIGNED_OR_EXPIRED" ] + }, + "Accesscontrol_UnlockAccessControlledDoorErrorWSResponse" : { "type" : "object", - "description" : "Request to find lockdown events for a specific location with optional time filtering.", + "allOf" : [ { + "type" : "object", + "properties" : { + "errorType" : { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorEnumType" + } + } + } ], + "description" : "Error response for unlock access controlled door operation.", + "nullable" : true, "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Returns events created after (exclusive) the specified millisecond epoch timestamp", + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_UnlockAccessControlledDoorForCurrentUserEnumType" : { + "type" : "string", + "description" : "Enumeration of possible errors when unlocking an access controlled door for the current user.", + "enum" : [ "INACTIVE_CREDENTIAL", "FAILED_SENDING_ACU_UNLOCK_REQUEST", "GEOFENCE_RESTRICTED", "DOOR_NOT_CONFIGURED_WITH_LOCK", "USER_REMOTE_UNLOCK_DISABLED", "USER_RHOMBUS_KEY_DISABLED" ] + }, + "Accesscontrol_UnlockAccessControlledDoorForCurrentUserErrorWSResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "errorType" : { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserEnumType" + } + } + } ], + "description" : "Error response for unlock access controlled door for current user operation.", + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_UnlockAccessControlledDoorForCurrentUserSuccessWSResponse" : { + "type" : "object", + "allOf" : [ ], + "description" : "Success response for unlock access controlled door for current user operation.", + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_UnlockAccessControlledDoorForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request to unlock an access controlled door for the current user.", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Returns events created before (exclusive) the specified millisecond epoch timestamp", + "cmdVersion" : { + "type" : "string", + "format" : "byte", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", - "description" : "Limits the number of returned events to the latest LIMIT events", + "credentialValue" : { + "type" : "string", + "description" : "Credential value for authentication", + "example" : "credential123", "nullable" : true }, - "locationUuid" : { + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude of the mobile device for geofencing", + "example" : 37.7749, + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude of the mobile device for geofencing", + "example" : -122.4194, + "nullable" : true + }, + "requestTimeMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Request time in milliseconds", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Accesscontrol_UnlockAccessControlledDoorSuccessWSResponse" : { + "type" : "object", + "allOf" : [ ], + "description" : "Success response for unlock access controlled door operation.", + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_UnlockAccessControlledDoorWSRequest" : { + "type" : "object", + "description" : "Request to unlock an access controlled door.", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Accesscontrol_lockdownplan_FindLocationLockdownEventsWSResponse" : { + "Accesscontrol_UnlockAccessControlledElevatorEnumType" : { + "type" : "string", + "description" : "Enumeration of possible errors when unlocking an access controlled elevator.", + "enum" : [ "FAILED_SENDING_ACU_UNLOCK_REQUEST", "ELEVATOR_NOT_CONFIGURED_WITH_LANDING" ] + }, + "Accesscontrol_UnlockAccessControlledElevatorErrorWSResponse" : { "type" : "object", - "description" : "Response containing a list of lockdown events for a specific location.", + "allOf" : [ { + "type" : "object", + "properties" : { + "errorType" : { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorEnumType" + } + } + } ], + "description" : "Error response for unlock access controlled elevator operation.", + "nullable" : true, "properties" : { - "events" : { - "type" : "array", - "description" : "List of lockdown events found for the specified location.", - "items" : { - "$ref" : "#/components/schemas/BaseLockdownStateEventType" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_FindLocationLockdownStatesWSRequest" : { + "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserEnumType" : { + "type" : "string", + "description" : "Enumeration of possible errors when unlocking an access controlled elevator for the current user.", + "enum" : [ "INACTIVE_CREDENTIAL", "FAILED_SENDING_ACU_UNLOCK_REQUEST", "GEOFENCE_RESTRICTED", "ELEVATOR_NOT_CONFIGURED_WITH_LANDINGS", "INVALID_LANDINGS", "USER_REMOTE_UNLOCK_DISABLED", "USER_RHOMBUS_KEY_DISABLED" ] + }, + "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserErrorWSResponse" : { "type" : "object", - "description" : "Request to find location lockdown states with optional filtering.", + "allOf" : [ { + "type" : "object", + "properties" : { + "errorType" : { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserEnumType" + } + } + } ], + "description" : "Error response for unlock access controlled elevator for current user operation.", + "nullable" : true, "properties" : { - "stateFilter" : { - "type" : "array", - "description" : "Optional filter to limit results to specific lockdown states.", - "items" : { - "$ref" : "#/components/schemas/LocationLockdownStateEnumType" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_FindLocationLockdownStatesWSResponse" : { + "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserSuccessWSResponse" : { "type" : "object", - "description" : "Response containing a list of location lockdown states.", + "allOf" : [ ], + "description" : "Success response for unlock access controlled elevator for current user operation.", + "nullable" : true, "properties" : { - "states" : { - "type" : "array", - "description" : "List of location lockdown states found for the organization.", - "items" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSRequest" : { + "Accesscontrol_UnlockAccessControlledElevatorForCurrentUserWSRequest" : { "type" : "object", - "description" : "Request to search for lockdown plans for a specific location.", + "description" : "Request to unlock an access controlled elevator for the current user.", "properties" : { - "locationUuid" : { + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "description" : "UUIDs of specific access controlled elevator landings", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "cmdVersion" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "credentialValue" : { + "type" : "string", + "description" : "Credential value for authentication", + "example" : "credential123", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude of the mobile device for geofencing", + "example" : 37.7749, + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude of the mobile device for geofencing", + "example" : -122.4194, + "nullable" : true + }, + "requestTimeMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Request time in milliseconds", + "example" : 1640995200000, + "nullable" : true } } }, - "Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSResponse" : { + "Accesscontrol_UnlockAccessControlledElevatorSuccessWSResponse" : { "type" : "object", - "description" : "Response containing a list of lockdown plans found for the specified location.", + "allOf" : [ ], + "description" : "Success response for unlock access controlled elevator operation.", + "nullable" : true, "properties" : { - "lockdownPlans" : { - "type" : "array", - "description" : "List of lockdown plans found for the specified location.", - "items" : { - "$ref" : "#/components/schemas/BaseLockdownPlanType" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Accesscontrol_lockdownplan_FindLockdownPlansWSRequest" : { - "type" : "object", - "description" : "Request to search for lockdown plans across the organization." - }, - "Accesscontrol_lockdownplan_FindLockdownPlansWSResponse" : { + "Accesscontrol_UnlockAccessControlledElevatorWSRequest" : { "type" : "object", - "description" : "Response containing a list of lockdown plans found in the organization.", + "description" : "Request to unlock an access controlled elevator, and optionally specific landings on that elevator.", "properties" : { - "lockdownPlans" : { + "accessControlledElevatorLandingUuids" : { "type" : "array", - "description" : "List of lockdown plans found in the organization.", + "description" : "UUIDs of specific access controlled elevator landings", "items" : { - "$ref" : "#/components/schemas/BaseLockdownPlanType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true - } - } - }, - "Accesscontrol_lockdownplan_GetLockdownPlanWSRequest" : { - "type" : "object", - "description" : "Request to retrieve a specific lockdown plan by UUID.", - "properties" : { - "lockdownPlanUuid" : { + }, + "accessControlledElevatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43526,20 +44043,76 @@ } } }, - "Accesscontrol_lockdownplan_GetLockdownPlanWSResponse" : { + "Accesscontrol_UserAccessGrant" : { "type" : "object", - "description" : "Response containing the requested lockdown plan.", + "description" : "Access grant information for a user containing schedule and door access permissions.", "properties" : { - "lockdownPlan" : { - "$ref" : "#/components/schemas/BaseLockdownPlanType" + "accessControlledDoorUuids" : { + "type" : "array", + "description" : "Set of access controlled door UUIDs that this grant provides access to.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "description" : "Set of access controlled elevator landing UUIDs that this grant provides access to.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSRequest" : { + "Accesscontrol_UserAccessRevocation" : { "type" : "object", - "description" : "Request to retrieve all lockdown rules for a specific location.", + "description" : "Access revocation information for a user containing schedule and door access restrictions.", "properties" : { - "locationUuid" : { + "accessControlledDoorUuids" : { + "type" : "array", + "description" : "Set of access controlled door UUIDs that this revocation restricts access to.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "description" : "Set of access controlled elevator landing UUIDs that this revocation restricts access to.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43548,10 +44121,22 @@ } } }, - "Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSResponse" : { + "Accesscontrol_accessgrant_CreateAccessGrantWSRequest" : { "type" : "object", - "description" : "Response containing a list of lockdown rules for a specific location.", + "description" : "Request to create a location access grant.", + "properties" : { + "accessGrant" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + } + } + }, + "Accesscontrol_accessgrant_CreateAccessGrantWSResponse" : { + "type" : "object", + "description" : "Response containing the created location access grant.", "properties" : { + "accessGrant" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, "error" : { "type" : "boolean", "nullable" : true @@ -43560,13 +44145,31 @@ "type" : "string", "nullable" : true }, - "rules" : { + "expiredACDLicensesDoorUuids" : { "type" : "array", - "description" : "List of lockdown rules configured for the specified location.", + "description" : "Set of expired ACD license door UUIDs", "items" : { - "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true + }, + "unassignedACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of unassigned ACD license door UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, "warningMsg" : { "type" : "string", @@ -43574,11 +44177,11 @@ } } }, - "Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSRequest" : { + "Accesscontrol_accessgrant_DeleteLocationAccessGrantWSRequest" : { "type" : "object", - "description" : "Request to retrieve an existing lockdown state or create one for a specific location.", + "description" : "Request to delete a location access grant.", "properties" : { - "locationUuid" : { + "accessGrantUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43587,162 +44190,155 @@ } } }, - "Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSResponse" : { + "Accesscontrol_accessgrant_DeleteLocationAccessGrantWSResponse" : { "type" : "object", - "description" : "Response containing the lockdown state for the specified location.", - "properties" : { - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateType" - } - } + "description" : "Response for location access grant deletion." }, - "Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSRequest" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSRequest" : { "type" : "object", - "description" : "Request to update an existing location lockdown plan with selective field updates.", + "description" : "Request to find location access grants by access controlled door.", "properties" : { - "activationPlan" : { - "$ref" : "#/components/schemas/LockdownActivationPlanType" - }, - "deactivationPlan" : { - "$ref" : "#/components/schemas/LockdownDeactivationPlanType" - }, - "defaultLockdownState" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" - }, - "doorLockdownStateMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" - }, - "nullable" : true - }, - "lockdownPlanUuid" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "physicalAccess" : { - "$ref" : "#/components/schemas/LockdownPhysicalAccessType" - }, - "testPlan" : { - "$ref" : "#/components/schemas/LockdownTestPlanType" } } }, - "Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSResponse" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledDoorWSResponse" : { "type" : "object", - "description" : "Response containing the updated location lockdown plan.", + "description" : "Response containing location access grants for an access controlled door.", + "nullable" : true, "properties" : { - "lockdownPlan" : { - "$ref" : "#/components/schemas/LocationLockdownPlanType" + "accessGrants" : { + "type" : "array", + "description" : "List of location access grants", + "items" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, + "nullable" : true } } }, - "Accesscontrol_qr_GenerateQRAccessCodeWSRequest" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSRequest" : { "type" : "object", - "description" : "Request to generate a QR access code.", + "description" : "Request to find location access grants by access controlled elevator landing.", "properties" : { - "accessControlledDoorUuid" : { + "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "auditPrincipal" : { - "type" : "string", - "nullable" : true - }, - "validDurationSec" : { - "type" : "integer", - "format" : "int32", - "description" : "Valid duration in seconds", - "example" : 300, + } + } + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByAccessControlledElevatorLandingWSResponse" : { + "type" : "object", + "description" : "Response containing location access grants for an access controlled elevator landing.", + "properties" : { + "accessGrants" : { + "type" : "array", + "description" : "List of location access grants", + "items" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, "nullable" : true } } }, - "Accesscontrol_qr_GenerateQRAccessCodeWSResponse" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSRequest" : { "type" : "object", - "description" : "Response for QR access code generation.", + "description" : "Request to find location access grants by door label.", "properties" : { - "accessTokenUuid" : { + "doorLabelId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Door label identifier", + "example" : "door_label_123", "nullable" : true - }, - "qrCode" : { + } + } + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByDoorLabelWSResponse" : { + "type" : "object", + "description" : "Response containing location access grants for a door label.", + "properties" : { + "accessGrants" : { "type" : "array", - "description" : "QR code as PNG byte array", + "description" : "List of location access grants", "items" : { - "type" : "string", - "format" : "byte", - "description" : "QR code as PNG byte array", - "nullable" : true + "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, - "Accesscontrol_qr_GetQRAccessCodesWSRequest" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSRequest" : { "type" : "object", - "description" : "Request to get QR access codes." + "description" : "Request to find location access grants by group.", + "properties" : { + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } }, - "Accesscontrol_qr_GetQRAccessCodesWSResponse" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByGroupWSResponse" : { "type" : "object", - "description" : "Response for getting QR access codes.", + "description" : "Response containing location access grants for a group.", "properties" : { - "qrAccessCodes" : { + "accessGrants" : { "type" : "array", - "description" : "List of QR access codes", + "description" : "List of location access grants", "items" : { - "$ref" : "#/components/schemas/Accesscontrol_qr_QRAccessCodeType" + "$ref" : "#/components/schemas/LocationAccessGrantType" }, "nullable" : true } } }, - "Accesscontrol_qr_QRAccessCodeType" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSRequest" : { "type" : "object", - "description" : "QR code access configuration for a specific door.", + "description" : "Request to find location access grants by location and user.", "properties" : { - "accesTokenUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "auditPrincipal" : { - "type" : "string", - "description" : "Information about the user of the QR code so that audit events can be tracked.", - "nullable" : true - }, - "doorUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "expirationTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "The expiration time of this QR code in seconds since epoch.", + } + } + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationAndUserWSResponse" : { + "type" : "object", + "description" : "Response containing location access grants for a location and user.", + "properties" : { + "accessGrants" : { + "type" : "array", + "description" : "List of location access grants", + "items" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, "nullable" : true } } }, - "ActivateLocationLockdownActionRecordType" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSRequest" : { "type" : "object", + "description" : "Request to find location access grants by location.", "properties" : { "locationUuid" : { "type" : "string", @@ -43750,31 +44346,73 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "lockdownPlanUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + } + } + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByLocationWSResponse" : { + "type" : "object", + "description" : "Response containing location access grants for a location.", + "properties" : { + "accessGrants" : { + "type" : "array", + "description" : "List of location access grants", + "items" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, "nullable" : true - }, - "succeeded" : { - "type" : "boolean", + } + } + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSRequest" : { + "type" : "object", + "description" : "Request to find location access grants by organization." + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing location access grants for an organization.", + "properties" : { + "accessGrants" : { + "type" : "array", + "description" : "List of location access grants", + "items" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, "nullable" : true } } }, - "ActivateLocationLockdownActionType" : { + "Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSRequest" : { "type" : "object", + "description" : "Request to find location access grants by user.", "properties" : { - "locationLockdownPlanUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "locationUuid" : { + } + } + }, + "Accesscontrol_accessgrant_FindLocationAccessGrantsByUserWSResponse" : { + "type" : "object", + "description" : "Response containing location access grants for a user.", + "properties" : { + "accessGrants" : { + "type" : "array", + "description" : "List of location access grants", + "items" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + }, + "nullable" : true + } + } + }, + "Accesscontrol_accessgrant_GetLocationAccessGrantWSRequest" : { + "type" : "object", + "description" : "Request to get a location access grant by UUID.", + "properties" : { + "accessGrantUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -43783,172 +44421,154 @@ } } }, - "ActivityEnum" : { - "type" : "string", - "description" : "Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.", - "enum" : [ "SOUND_LOUD", "SOUND_GUN_SHOT", "TAMPER", "VISUAL_TAMPER", "MOTION_TAMPER", "MOTION", "MOTION_HUMAN", "MOTION_CAR", "MOTION_ANIMAL", "FACE", "FACE_IDENTIFIED", "FACE_UNIDENTIFIED", "FACE_BLACKLISTED", "FACE_ALERT", "POSE_ANOMALOUS", "POSE_FALL", "LICENSEPLATE", "LICENSEPLATE_IDENTIFIED", "LICENSEPLATE_UNIDENTIFIED", "LICENSEPLATE_ALERT", "LICENSEPLATE_BLACKLISTED", "LICENSEPLATE_TRUSTED", "PEOPLECOUNT_HIGH", "PEOPLECOUNT_HIGH_RESET", "PEOPLECOUNT_LOW", "PEOPLECOUNT_LOW_RESET", "HUMAN_ENTER", "HUMAN_EXIT", "CAR_ENTER", "CAR_EXIT", "TEMPERATURE_EXCEEDED_HIGH", "TEMPERATURE_EXCEEDED_LOW", "HUMIDITY_EXCEEDED_HIGH", "HUMIDITY_EXCEEDED_LOW", "PM25_EXCEEDED_HIGH", "TVOC_EXCEEDED_HIGH", "ETOH_EXCEEDED_HIGH", "IAQ_EXCEEDED_HIGH", "CO2_EXCEEDED_HIGH", "CO2_EXCEEDED_LOW", "PROBE_TEMPERATURE_EXCEEDED_HIGH", "PROBE_TEMPERATURE_EXCEEDED_LOW", "PROBE_DISCONNECTED", "PROBE_CONNECTED", "HEAT_INDEX_EXCEEDED_HIGH", "PRESSURE_EXCEEDED_HIGH", "PRESSURE_EXCEEDED_LOW", "PM10_EXCEEDED_HIGH", "PM40_EXCEEDED_HIGH", "PM100_EXCEEDED_HIGH", "VOC_IDX_EXCEEDED_HIGH", "NOX_IDX_EXCEEDED_HIGH", "FORMALDEHYDE_EXCEEDED_HIGH", "CARBON_MONOXIDE_EXCEEDED_HIGH", "AQI_EXCEEDED_HIGH", "DOOR_AJAR", "DOOR_OPENED", "DOOR_CLOSED", "BUTTON_SINGLE_PRESSED", "BUTTON_DOUBLE_PRESSED", "BUTTON_LONG_PRESSED", "TAG_ARRIVED", "TAG_DEPARTED", "TAG_MOVED", "TAG_POSITIONING_CHANGED", "TAG_BOUNDARY_INGRESS", "TAG_BOUNDARY_EGRESS", "TAG_PANIC", "BADGE_AUTHORIZED", "BADGE_UNAUTHORIZED", "BADGE_UNAUTHORIZED_V2", "BADGE_AJAR", "BADGE_MANUAL", "BADGE_FORCED_OPEN", "BADGE_LOCKDOWN", "BADGE_REQUEST_TO_EXIT", "BADGE_DURESS", "BADGE_SECURITY_BREACH", "BADGE_TAMPER", "BADGE_FACE_MISMATCH", "POS_ORDER", "GUN_DETECT_EVENT", "IOT_SOUND_AGGRESSION", "IOT_SOUND_HELP", "IOT_AIR_CO", "IOT_AIR_CO2", "IOT_AIR_MASKING", "IOT_AIR_THC", "IOT_AIR_VAPE", "IOT_AIR_VOC", "IOT_AIR_TEMP", "IOT_TAMPER", "IOT_GUNSHOT", "IOT_BUTTON_SINGLE_CLICK", "IOT_BUTTON_DOUBLE_CLICK", "IOT_BUTTON_HOLD", "IOT_PANIC_BUTTON_TRIGGERED", "AUDIO_SOUND_SIGNIFICANT", "AUDIO_SOUND_LOUD", "AUDIO_SOUND_ABUSIVE", "AUDIO_SOUND_GREETING", "AUDIO_SOUND_HELP", "AUDIO_SOUND_GUN", "AUDIO_SOUND_GLASS_BREAK", "AUDIO_SOUND_ALARM_SMOKE_FIRE", "AUDIO_SOUND_ALARM_CARBON_MONOXIDE", "AUDIO_SOUND_SIREN", "CLIMATE_VOC", "CLIMATE_VAPE", "CLIMATE_SMOKE", "CLIMATE_THC", "CLIMATE_CO2", "CLIMATE_ETOH", "CLIMATE_PM25", "CLIMATE_IAQ", "CLIMATE_LEAK", "SOUND_AGGRESSION", "SOUND_HELP", "AIR_CO", "AIR_CO2", "AIR_MASKING", "AIR_THC", "AIR_VAPE", "AIR_VOC", "MASK_MISSING", "HELMET_MISSING", "GLOVES_MISSING", "PIR_OCCUPIED", "PIR_MOVEMENT", "PIR_VACANT", "CUSTOM", "VISITOR_ARRIVED", "VISITOR_DEPARTED", "AC_DR_CONNECTED", "AC_DR_DISCONNECTED", "AC_DPI_DOOR_OPEN", "AC_DPI_DOOR_CLOSED", "AC_DPI_DOOR_AJAR", "AC_DPI_DOOR_FORCED_OPEN", "AC_DSR_UNLOCKED", "AC_DSR_LOCKED", "AC_DB_TRIGGERED", "AC_PANIC_BUTTON_TRIGGERED", "AC_REMOTE_UNLOCK", "AC_BADGE_AUTHORIZED", "AC_BADGE_UNAUTHORIZED", "AC_BADGE_FACE_MISMATCH", "AC_LOCKDOWN_ACTIVATED", "AC_LOCKDOWN_DEACTIVATED", "AC_TAMPER_PROX", "AC_TAMPER_ACCEL", "AC_TAMPER_SWITCH", "AC_GR_ACTIVE", "AC_GR_INACTIVE", "AC_GI_ACTIVE", "AC_GI_INACTIVE", "AC_REX_ACTIVE", "AC_REX_INACTIVE", "AC_APERIO_DEVICE_DISCONNECTED", "AC_APERIO_DEVICE_CONNECTED", "AC_APERIO_DEVICE_REBOOT", "AC_APERIO_DEVICE_TAMPER", "AC_APERIO_LOW_BATTERY", "AC_APERIO_FLAT_BATTERY", "AC_APERIO_OK_BATTERY", "POWER_SWITCH_BATTERY", "POWER_SWITCH_PRIMARY", "CUSTOM_LLM_BOOLEAN_TRUE", "CUSTOM_LLM_BOOLEAN_FALSE", "CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW", "CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH", "ALM_AUTHORITIES_CONTACTED", "ALM_MONITORING_ENABLED", "ALM_MONITORING_DISABLED", "ALM_MONITORING_SETTINGS_CHANGE", "ALM_THREAT_CASE_CLOSED", "ALM_THREAT_DETECTED", "ALM_MONITORING_EVENT_DETECTED", "ROBOT_DOG_DETECTED", "ROBOT_WAITING_AT_POSE", "LOITER_HUMAN", "UNKNOWN" ] + "Accesscontrol_accessgrant_GetLocationAccessGrantWSResponse" : { + "type" : "object", + "description" : "Response containing a location access grant.", + "properties" : { + "accessGrant" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + } + } }, - "ActivityEventData" : { + "Accesscontrol_accessgrant_GetLocationsByAccessGrantForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request to get locations by access grant for current user." + }, + "Accesscontrol_accessgrant_GetLocationsByAccessGrantForCurrentUserWSResponse" : { "type" : "object", + "description" : "Response for getting locations by access grant for current user.", "properties" : { - "activities" : { + "locationLockdownStates" : { "type" : "array", + "description" : "List of location lockdown states", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/LocationLockdownStateType" }, "nullable" : true }, - "boundingBoxes" : { + "locations" : { "type" : "array", + "description" : "List of locations accessible to the current user", "items" : { - "$ref" : "#/components/schemas/ClipBoundingBoxType" + "$ref" : "#/components/schemas/LocationType" }, "nullable" : true }, - "durationSec" : { - "type" : "integer", - "format" : "int32", + "lockdownPlans" : { + "type" : "array", + "description" : "List of lockdown plans for the locations", + "items" : { + "$ref" : "#/components/schemas/BaseLockdownPlanType" + }, "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Accesscontrol_accessgrant_GetRhombusKeyLocationLockdownDetailsForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request to get Rhombus Key location lockdown details for current user.", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "AddOnLicenseEnum" : { - "type" : "string", - "enum" : [ "CLOUD_ARCHIVING", "PERCEPTION", "POSE", "BEHAVIOR", "VEHICLE", "PEOPLE", "PPE", "PEOPLE_ANALYTICS", "UNKNOWN" ] + "Accesscontrol_accessgrant_GetRhombusKeyLocationLockdownDetailsForCurrentUserWSResponse" : { + "type" : "object", + "description" : "Response for getting Rhombus Key location lockdown details for current user.", + "properties" : { + "locationLockdownState" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } }, - "AddOnLicenseInvoiceType" : { + "Accesscontrol_accessgrant_UpdateAccessGrantWSRequest" : { "type" : "object", + "description" : "Request to update a location access grant.", "properties" : { - "cloudArchiveDays" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "accessGrant" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" + } + } + }, + "Accesscontrol_accessgrant_UpdateAccessGrantWSResponse" : { + "type" : "object", + "description" : "Response for location access grant update.", + "properties" : { + "accessGrant" : { + "$ref" : "#/components/schemas/LocationAccessGrantType" }, - "count" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "description" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "license" : { - "$ref" : "#/components/schemas/AddOnLicenseEnum" + "expiredACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of expired ACD license door UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "perceptionTypes" : { + "unassignedACDLicensesDoorUuids" : { "type" : "array", + "description" : "Set of unassigned ACD license door UUIDs", "items" : { - "$ref" : "#/components/schemas/PerceptionTypeEnum" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "price" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "AddOnLicenseStats" : { + "Accesscontrol_accessrevocation_CreateAccessRevocationWSRequest" : { "type" : "object", + "description" : "Request to create a location access revocation.", "properties" : { - "addOnLicenseType" : { - "$ref" : "#/components/schemas/AddOnLicenseEnum" - }, - "assignedCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "deviceLicenseFamilyStats" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyStats" - }, - "nullable" : true - }, - "lastEndDate" : { - "type" : "string", - "format" : "date-time", - "description" : "The closest past date on which licenses belonging to the group expired.", - "nullable" : true - }, - "nearExpirationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently close to expiration.", - "nullable" : true - }, - "nextEndDate" : { - "type" : "string", - "format" : "date-time", - "description" : "The closest future date on which licenses belonging to the group will expire.", - "nullable" : true - }, - "stateStats" : { - "$ref" : "#/components/schemas/LicenseStateStats" - }, - "totalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group.", - "nullable" : true + "accessRevocation" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" } } }, - "AdvancedRMAType" : { + "Accesscontrol_accessrevocation_CreateAccessRevocationWSResponse" : { "type" : "object", + "description" : "Response for location access revocation creation.", "properties" : { - "falseReport" : { - "type" : "boolean", - "nullable" : true - }, - "invoiceNeeded" : { - "type" : "boolean", - "nullable" : true - }, - "knownIssue" : { - "type" : "boolean", - "nullable" : true - }, - "managerialApproved" : { - "type" : "boolean", - "nullable" : true + "accessRevocation" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" }, - "rctpPartnerRequested" : { + "error" : { "type" : "boolean", "nullable" : true }, - "rctpPartnerUuid" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "rectified" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "AirQualityIndexPollutantEnum" : { - "type" : "string", - "description" : "Primary pollutant affecting air quality index", - "enum" : [ "OZONE", "PM2P5", "PM10P0", "CO", "NO2", "SO2", "UNKNOWN" ] - }, - "AlarmRule" : { - "type" : "object", - "description" : "The rules governing threat detection and subsequent actions.", - "nullable" : true, - "properties" : { - "audioGateways" : { + "expiredACDLicensesDoorUuids" : { "type" : "array", - "description" : "The UUIDs of the audio gateways used to play siren audio. If not specified, all gateways associated\nwith the monitored devices will be used.\n", + "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", @@ -43959,296 +44579,243 @@ "nullable" : true, "uniqueItems" : true }, - "monitoredDevices" : { + "unassignedACDLicensesDoorUuids" : { "type" : "array", - "description" : "The UUIDs of devices monitored for the specified activities. If any monitored device reports a\nmatching activity, a threat case will be created.\n", + "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "sirenSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ALMSirenSettings" - }, - "description" : "Optional per-activity siren configuration. When a monitored activity occurs, the corresponding\nsiren settings (if provided) determine how the siren should play.\n", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "threatQualifier" : { - "$ref" : "#/components/schemas/ThreatQualifier" - }, - "triggers" : { - "type" : "array", - "description" : "The activity types that can trigger an alarm when reported by a monitored device.", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "tripwire" : { - "$ref" : "#/components/schemas/TripwireSettings" - }, - "uuid" : { + } + } + }, + "Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSRequest" : { + "type" : "object", + "description" : "Request to delete a location access revocation.", + "properties" : { + "accessRevocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "verifiedThreatSiren" : { - "$ref" : "#/components/schemas/ALMSirenSettings" } - }, - "required" : [ "monitoredDevices", "threatQualifier", "triggers" ] + } }, - "AlertActionRecordType" : { + "Accesscontrol_accessrevocation_DeleteLocationAccessRevocationWSResponse" : { + "type" : "object", + "description" : "Response for location access revocation deletion." + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSRequest" : { "type" : "object", + "description" : "Request to find location access revocations by access controlled door.", "properties" : { - "policyAlertUuid" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "status" : { - "$ref" : "#/components/schemas/AlertActionStatusEnum" } } }, - "AlertActionStatusEnum" : { - "type" : "string", - "enum" : [ "SUCCESS", "ERROR", "PAUSED", "IGNORED", "MUTED", "BACKOFF", "UNKNOWN" ] - }, - "AlertMonitoringCatalogItem" : { + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledDoorWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "monthlyVerificationLimit" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Response containing location access revocations for an access controlled door.", "properties" : { - "durationMonths" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "productCode" : { - "type" : "string", + "accessRevocations" : { + "type" : "array", + "description" : "List of location access revocations", + "items" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + }, "nullable" : true - }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" } } }, - "AlertMonitoringEventRecordType" : { + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSRequest" : { "type" : "object", + "description" : "Request to find location access revocations by access controlled elevator landing.", "properties" : { - "alertMonitoringEventType" : { - "$ref" : "#/components/schemas/AlertMonitoringRulesEventTypeEnum" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "threatCaseUuid" : { + "accessControlledElevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "AlertMonitoringLicenseType" : { + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByAccessControlledElevatorLandingWSResponse" : { "type" : "object", - "description" : "List of alert monitoring licenses available for the client organization", + "description" : "Response containing location access revocations for an access controlled elevator landing.", "properties" : { - "allowedDeviceCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "claimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "deviceUuids" : { + "accessRevocations" : { "type" : "array", + "description" : "List of location access revocations", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/LocationAccessRevocationType" }, - "nullable" : true, - "uniqueItems" : true - }, - "firstAssignedDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "licenseToUnassignEmailState" : { - "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" - }, - "licenseType" : { - "$ref" : "#/components/schemas/LicenseEnum" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "maxDeleteDate" : { + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSRequest" : { + "type" : "object", + "description" : "Request to find location access revocations by door label.", + "properties" : { + "doorLabelId" : { "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "monthlyFallbackVerificationLimit" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "monthlyVerificationLimit" : { - "type" : "integer", - "format" : "int32", + "description" : "Door label identifier", + "example" : "door_label_123", "nullable" : true - }, - "monthsReset" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByDoorLabelWSResponse" : { + "type" : "object", + "description" : "Response containing location access revocations for a door label.", + "properties" : { + "accessRevocations" : { + "type" : "array", + "description" : "List of location access revocations", + "items" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + }, "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSRequest" : { + "type" : "object", + "description" : "Request to find location access revocations by group.", + "properties" : { + "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "percentUsage" : { - "type" : "number", - "format" : "double", + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByGroupWSResponse" : { + "type" : "object", + "description" : "Response containing location access revocations for a group.", + "properties" : { + "accessRevocations" : { + "type" : "array", + "description" : "List of location access revocations", + "items" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + }, "nullable" : true - }, - "priorClaimKeyUuid" : { + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSRequest" : { + "type" : "object", + "description" : "Request to find location access revocations by organization." + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing location access revocations for an organization.", + "properties" : { + "accessRevocations" : { + "type" : "array", + "description" : "List of location access revocations", + "items" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + }, + "nullable" : true + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSRequest" : { + "type" : "object", + "description" : "Request to find location access revocations by user.", + "properties" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "productCode" : { - "type" : "string", - "nullable" : true - }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - }, - "remainingAlarms" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "remainingFallbackVerifications" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "remainingVerifications" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "state" : { - "$ref" : "#/components/schemas/LicenseStateEnum" - }, - "trial" : { - "type" : "boolean", - "nullable" : true - }, - "updatedOn" : { - "type" : "string", - "format" : "date-time", + } + } + }, + "Accesscontrol_accessrevocation_FindLocationAccessRevocationsByUserWSResponse" : { + "type" : "object", + "description" : "Response containing location access revocations for a user.", + "properties" : { + "accessRevocations" : { + "type" : "array", + "description" : "List of location access revocations", + "items" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + }, "nullable" : true - }, - "uuid" : { + } + } + }, + "Accesscontrol_accessrevocation_GetLocationAccessRevocationWSRequest" : { + "type" : "object", + "description" : "Request to get a location access revocation by UUID.", + "properties" : { + "accessRevocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "warningStage" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } } }, - "AlertMonitoringPIN" : { + "Accesscontrol_accessrevocation_GetLocationAccessRevocationWSResponse" : { "type" : "object", - "description" : "Alert monitoring PIN to update.", + "description" : "Response containing a location access revocation.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in epoch ms when this PIN was created.", - "nullable" : true, - "readOnly" : true + "accessRevocation" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + } + } + }, + "Accesscontrol_accessrevocation_UpdateAccessRevocationWSRequest" : { + "type" : "object", + "description" : "Request to update a location access revocation.", + "properties" : { + "accessRevocation" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" + } + } + }, + "Accesscontrol_accessrevocation_UpdateAccessRevocationWSResponse" : { + "type" : "object", + "description" : "Response for location access revocation update operation.", + "properties" : { + "accessRevocation" : { + "$ref" : "#/components/schemas/LocationAccessRevocationType" }, - "description" : { - "type" : "string", - "description" : "PIN description.", - "maxLength" : 255, + "error" : { + "type" : "boolean", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds when this PIN expires.", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "locationUuids" : { + "expiredACDLicensesDoorUuids" : { "type" : "array", - "description" : "Set of location uuids associated with this PIN.", + "description" : "Set of expired ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", @@ -44259,54 +44826,9 @@ "nullable" : true, "uniqueItems" : true }, - "name" : { - "type" : "string", - "description" : "PIN name.", - "maxLength" : 64, - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "rotatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in epoch ms when this PIN was last rotated.", - "nullable" : true, - "readOnly" : true - }, - "rotationPeriodDays" : { - "type" : "integer", - "format" : "int32", - "description" : "Duration in days that determines when this PIN will be automatically rotated. If an expiration date is specified, that is when the first rotation will occur. Auto-rotation is disabled if this value is null.", - "minimum" : 1, - "nullable" : true - }, - "shared" : { - "type" : "boolean", - "description" : "Determines whether this PIN can be shared.", - "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds when this PIN becomes active.", - "nullable" : true - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in epoch ms when this PIN was last modified.", - "nullable" : true, - "readOnly" : true - }, - "userUuids" : { + "unassignedACDLicensesDoorUuids" : { "type" : "array", - "description" : "Set of user uuids associated with this PIN.", + "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", @@ -44317,237 +44839,151 @@ "nullable" : true, "uniqueItems" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "value" : { - "type" : "string", - "description" : "PIN value.", - "maxLength" : 16, - "minLength" : 4, - "nullable" : true - } - }, - "required" : [ "locationUuids", "value" ] - }, - "AlertMonitoringPinType" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "pin" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "AlertMonitoringRuleTriggerType" : { + "Accesscontrol_badgetemplate_CreateBadgeTemplateWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "alertMonitoringRulesEventType" : { - "$ref" : "#/components/schemas/AlertMonitoringRulesEventTypeEnum" - }, - "locationUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request to create a new badge template.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + "template" : { + "$ref" : "#/components/schemas/BadgeTemplate" } } }, - "AlertMonitoringRulesEventTypeEnum" : { - "type" : "string", - "enum" : [ "ALARM_CREATED", "ALARM_CANCELED", "UNKNOWN" ] - }, - "AlertMonitoringSubmissionDelayIntervalType" : { + "Accesscontrol_badgetemplate_CreateBadgeTemplateWSResponse" : { "type" : "object", + "description" : "Response containing the created badge template.", "properties" : { - "escalationDelayMinutes" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "minuteOfWeekStart" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "minuteOfWeekStop" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "promptTheme" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + "template" : { + "$ref" : "#/components/schemas/BadgeTemplate" } } }, - "AlertMonitoringThreatCaseType" : { + "Accesscontrol_badgetemplate_DeleteBadgeTemplateImageWSRequest" : { "type" : "object", - "description" : "List of threat cases matching the request criteria", + "description" : "Request to delete a specific badge template image by UUID.", "properties" : { - "associatedDeviceUuids" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "deviceUuid" : { + "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "locationName" : { - "type" : "string", - "nullable" : true - }, - "locationUuid" : { + } + } + }, + "Accesscontrol_badgetemplate_DeleteBadgeTemplateImageWSResponse" : { + "type" : "object", + "description" : "Response containing the deleted badge template image metadata.", + "properties" : { + "image" : { + "$ref" : "#/components/schemas/BadgeTemplateImage" + } + } + }, + "Accesscontrol_badgetemplate_DeleteBadgeTemplateWSRequest" : { + "type" : "object", + "description" : "Request to delete a specific badge template by UUID.", + "properties" : { + "templateUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "noonlightAlarmId" : { - "type" : "string", - "nullable" : true - }, - "noonlightVerificationId" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Accesscontrol_badgetemplate_DeleteBadgeTemplateWSResponse" : { + "type" : "object", + "description" : "Response containing the deleted badge template.", + "properties" : { + "template" : { + "$ref" : "#/components/schemas/BadgeTemplate" + } + } + }, + "Accesscontrol_badgetemplate_FindBadgeTemplateImagesWSRequest" : { + "type" : "object", + "description" : "Request to search for badge template images with pagination support.", + "properties" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, - "policyAlertUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true - }, - "policyAlertUuids" : { + } + } + }, + "Accesscontrol_badgetemplate_FindBadgeTemplateImagesWSResponse" : { + "type" : "object", + "description" : "Response containing a list of badge template images with pagination information.", + "properties" : { + "images" : { "type" : "array", + "description" : "List of badge template images found in the search.", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/BadgeTemplateImage" }, - "nullable" : true, - "uniqueItems" : true - }, - "promptTheme" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + "nullable" : true }, - "promptTitle" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true - }, - "sharedClipGroupUuid" : { + } + } + }, + "Accesscontrol_badgetemplate_FindBadgeTemplatesWSRequest" : { + "type" : "object", + "description" : "Request to search for badge templates with pagination support.", + "properties" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, - "sirenSettings" : { - "$ref" : "#/components/schemas/AMSirenSettingsType" - }, - "status" : { - "$ref" : "#/components/schemas/ThreatCaseStatusEnum" - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "submissionTimestampMs" : { + "maxPageSize" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true - }, - "submitDelayExpireTimestampMs" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Accesscontrol_badgetemplate_FindBadgeTemplatesWSResponse" : { + "type" : "object", + "description" : "Response containing a list of badge templates with pagination information.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true }, - "timelineEventList" : { + "templates" : { "type" : "array", + "description" : "List of badge templates found in the search.", "items" : { - "$ref" : "#/components/schemas/ThreatCaseTimelineEventType" + "$ref" : "#/components/schemas/BadgeTemplate" }, "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "verificationHistory" : { - "$ref" : "#/components/schemas/VerificationHistory" } } }, - "Alertmonitoring_AMDeviceHistogramItem" : { + "Accesscontrol_badgetemplate_GetBadgeTemplateImageWSRequest" : { "type" : "object", - "description" : "Histogram item representing alert monitoring data for a specific device.", + "description" : "Request to retrieve metadata for a specific badge template image by UUID.", "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of alerts for this device.", - "nullable" : true - }, - "deviceName" : { - "type" : "string", - "description" : "The name of the device.", - "nullable" : true - }, - "deviceUuid" : { + "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -44556,11 +44992,20 @@ } } }, - "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceForLocationRequest" : { + "Accesscontrol_badgetemplate_GetBadgeTemplateImageWSResponse" : { "type" : "object", - "description" : "Request to accept the terms of service for alert monitoring at a specific location.", + "description" : "Response containing the requested badge template image metadata.", "properties" : { - "locationUuid" : { + "image" : { + "$ref" : "#/components/schemas/BadgeTemplateImage" + } + } + }, + "Accesscontrol_badgetemplate_GetBadgeTemplateWSRequest" : { + "type" : "object", + "description" : "Request to retrieve a specific badge template by UUID.", + "properties" : { + "templateUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -44569,77 +45014,59 @@ } } }, - "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceRequest" : { + "Accesscontrol_badgetemplate_GetBadgeTemplateWSResponse" : { "type" : "object", - "description" : "Request to accept the terms of service for alert monitoring." + "description" : "Response containing the requested badge template.", + "properties" : { + "template" : { + "$ref" : "#/components/schemas/BadgeTemplate" + } + } }, - "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceResponse" : { + "Accesscontrol_badgetemplate_UpdateBadgeTemplateImageWSRequest" : { "type" : "object", - "description" : "Response indicating the result of accepting alert monitoring terms of service.", + "description" : "Request to update metadata for a badge template image with selective field updates.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "selectiveUpdate" : { + "$ref" : "#/components/schemas/BadgeTemplateImageSelectiveUpdate" } } }, - "Alertmonitoring_AddPromptThreatQualificationsWSRequest" : { + "Accesscontrol_badgetemplate_UpdateBadgeTemplateImageWSResponse" : { "type" : "object", - "description" : "Request to add a prompt threat qualification for an org.", + "description" : "Response containing the updated badge template image metadata.", "properties" : { - "threatQualification" : { - "$ref" : "#/components/schemas/NoonlightPromptSelection" + "image" : { + "$ref" : "#/components/schemas/BadgeTemplateImage" } - }, - "required" : [ "threatQualification" ] + } }, - "Alertmonitoring_AddPromptThreatQualificationsWSResponse" : { + "Accesscontrol_badgetemplate_UpdateBadgeTemplateWSRequest" : { "type" : "object", - "description" : "Response for adding a new prompt threat qualification.", + "description" : "Request to update an existing badge template with selective field updates.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "selectiveUpdate" : { + "$ref" : "#/components/schemas/BadgeTemplateSelectiveUpdate" } } }, - "Alertmonitoring_AmModifiedBy" : { + "Accesscontrol_badgetemplate_UpdateBadgeTemplateWSResponse" : { "type" : "object", - "description" : "Information about who modified an alert monitoring configuration and when.", + "description" : "Response containing the updated badge template.", "properties" : { - "armed" : { - "type" : "boolean", - "description" : "Whether the alert monitoring is armed after the modification.", - "nullable" : true - }, - "email" : { + "template" : { + "$ref" : "#/components/schemas/BadgeTemplate" + } + } + }, + "Accesscontrol_credentials_AssignAccessControlCredentialWSRequest" : { + "type" : "object", + "description" : "Request to assign an access control credential to a user.", + "properties" : { + "credentialHexValue" : { "type" : "string", - "description" : "The email address of the user who made the modification.", - "nullable" : true - }, - "event" : { - "$ref" : "#/components/schemas/Alertmonitoring_AmModifiedBy_AmModificationEvent" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the modification occurred in milliseconds since epoch.", + "description" : "Hex value of the credential", + "example" : "1234567890ABCDEF", "nullable" : true }, "userUuid" : { @@ -44651,147 +45078,249 @@ } } }, - "Alertmonitoring_AmModifiedBy_AmModificationEvent" : { - "type" : "string", - "description" : "Enumeration of possible modification events for alert monitoring.", - "enum" : [ "UPDATED", "CREATED", "DELETED", "ARMED", "DISARMED", "NO_CHANGE" ] + "Accesscontrol_credentials_AssignAccessControlCredentialWSResponse" : { + "type" : "object", + "description" : "Response for assigning an access control credential to a user.", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } }, - "Alertmonitoring_CancelThreatCaseWSRequest" : { + "Accesscontrol_credentials_BaseProvisionMobileAccessControlCredentialForCurrentUserWSResponse" : { "type" : "object", - "description" : "Request to cancel a threat case in alert monitoring.", + "discriminator" : { + "mapping" : { + "ERROR" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse", + "SUCCESS" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" + }, { + "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse" + } ], "properties" : { - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } + } + }, + "Accesscontrol_credentials_BaseUnlockAccessControlledDoorForCurrentUserWSResponse" : { + "type" : "object", + "discriminator" : { + "propertyName" : "type" }, - "required" : [ "uuid" ] + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserSuccessWSResponse" + }, { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorForCurrentUserErrorWSResponse" + } ], + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } }, - "Alertmonitoring_CancelThreatCaseWSResponse" : { + "Accesscontrol_credentials_BaseUnlockAccessControlledDoorWSResponse" : { "type" : "object", - "description" : "Response indicating the result of canceling a threat case.", + "discriminator" : { + "propertyName" : "type" + }, + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorSuccessWSResponse" + }, { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledDoorErrorWSResponse" + } ], "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Indicates whether the threat case cancellation was successful", - "example" : true, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" } } }, - "Alertmonitoring_CountType" : { + "Accesscontrol_credentials_BaseUnlockAccessControlledElevatorForCurrentUserWSResponse" : { "type" : "object", - "description" : "Represents count data for a specific day and month with activation/deactivation information.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserSuccessWSResponse" + }, { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorForCurrentUserErrorWSResponse" + } ], "properties" : { - "dayOfMonth" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_credentials_BaseUnlockAccessControlledElevatorWSResponse" : { + "type" : "object", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorSuccessWSResponse" + }, { + "$ref" : "#/components/schemas/Accesscontrol_UnlockAccessControlledElevatorErrorWSResponse" + } ], + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_credentials_BulkProvisionPinCredentialsWSRequest" : { + "type" : "object", + "description" : "Request to bulk provision PIN credentials for multiple users.", + "properties" : { + "endDateEpochSecExclusive" : { "type" : "integer", - "format" : "int32", - "description" : "The day of the month (1-31).", + "format" : "int64", + "description" : "End date in epoch seconds when these credentials expire. Credentials never expire if this value is left null.", + "example" : 1672531200, + "minimum" : 0, "nullable" : true }, - "deactivated" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of deactivated items for this day and month.", + "notifyUsers" : { + "type" : "boolean", + "description" : "Whether to notify users about their new PIN credentials.", + "example" : true, "nullable" : true }, - "month" : { + "pinLength" : { "type" : "integer", "format" : "int32", - "description" : "The month (1-12).", + "default" : 5, + "description" : "Length of PINs to be generated. Accepts length between 4 and 16. Default length is 5.", + "example" : 5, + "maximum" : 16, + "minimum" : 4, "nullable" : true }, - "value" : { + "startDateEpochSecInclusive" : { "type" : "integer", - "format" : "int32", - "description" : "The count value for this day and month.", + "format" : "int64", + "description" : "Start date in epoch seconds when these credentials become active. Credentials activate immediately if this value is left null.", + "example" : 1640995200, + "minimum" : 0, + "nullable" : true + }, + "userUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "example" : "59OcXLkFShWyHK3O2Fh2Ag", + "nullable" : true + }, "nullable" : true } } }, - "Alertmonitoring_CreateCustomPinForNoonlightWSRequest" : { + "Accesscontrol_credentials_BulkProvisionPinCredentialsWSResponse" : { "type" : "object", - "description" : "Request to create a custom PIN for alert monitoring at a specific location.", + "description" : "Response containing the bulk provisioned PIN credentials and any failed users.", "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the PIN", - "example" : "Custom PIN for main entrance access", + "credentials" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", - "description" : "Name for the PIN", - "example" : "Custom Main Entrance PIN", "nullable" : true }, - "pin" : { + "failedUsers" : { + "type" : "array", + "description" : "List of user UUIDs for which PIN credential creation failed", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "description" : "Custom PIN code to be created", - "example" : "5678", "nullable" : true } } }, - "Alertmonitoring_CreateCustomPinForNoonlightWSResponse" : { + "Accesscontrol_credentials_BulkRotatePinCredentialsWSRequest" : { "type" : "object", - "description" : "Response indicating the result of creating a custom PIN for alert monitoring.", + "description" : "Request to bulk rotate PIN credentials for multiple users.", "properties" : { - "alreadyExists" : { - "type" : "boolean", - "description" : "Indicates whether the PIN already exists", - "example" : false, + "credentialUuids" : { + "type" : "array", + "description" : "Set of credential uuids designated for PIN rotation.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds when these credentials expire. Credentials never expire if this value is left null.", + "example" : 1672531200, + "minimum" : 0, "nullable" : true }, - "error" : { + "notifyUsers" : { "type" : "boolean", + "description" : "Whether to notify users about their rotated PIN credentials.", + "example" : true, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "pinLength" : { + "type" : "integer", + "format" : "int32", + "default" : 5, + "description" : "Length of PIN to be generated. Accepts length between 4 and 16. Default is 5.", + "example" : 5, + "maximum" : 16, + "minimum" : 4, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds when these credentials become active. Credentials activate immediately if this value is left null.", + "example" : 1640995200, + "minimum" : 0, "nullable" : true } - } - }, - "Alertmonitoring_CreateNoonlightSettingsForLocationRequest" : { - "type" : "object", - "description" : "Request to create alert monitoring settings for a location.", - "properties" : { - "noonlightSettings" : { - "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" - } - } + }, + "required" : [ "credentialUuids" ] }, - "Alertmonitoring_CreateNoonlightSettingsForLocationResponse" : { + "Accesscontrol_credentials_BulkRotatePinCredentialsWSResponse" : { "type" : "object", - "description" : "Response indicating the result of creating alert monitoring settings for a location.", + "description" : "Response containing the bulk rotated PIN credentials and any failed credentials.", "properties" : { + "credentials" : { + "type" : "array", + "description" : "List of successfully rotated PIN credentials", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -44806,82 +45335,67 @@ } } }, - "Alertmonitoring_CreatePinForNoonlightWSRequest" : { + "Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSRequest" : { "type" : "object", - "description" : "Request to create a PIN for alert monitoring at a specific location.", + "description" : "Request to create an access control credential by hex value and type.", "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the PIN", - "example" : "PIN for main entrance access", - "nullable" : true + "credentialType" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, "nullable" : true }, - "name" : { + "hexValue" : { "type" : "string", - "description" : "Name for the PIN", - "example" : "Main Entrance PIN", + "description" : "Hex value of the credential", + "example" : "1234567890ABCDEF", "nullable" : true - } - } - }, - "Alertmonitoring_CreatePinForNoonlightWSResponse" : { - "type" : "object", - "description" : "Response containing the generated PIN for alert monitoring.", - "properties" : { - "error" : { + }, + "littleEndian" : { "type" : "boolean", + "description" : "Only needed when creating Wiegand credentials", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "numValueBits" : { + "type" : "integer", + "format" : "int32", + "description" : "Only needed when creating Wiegand credentials", "nullable" : true }, - "pin" : { - "type" : "string", - "description" : "The generated PIN code", - "example" : "1234", + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_CumulativeChartData" : { + "Accesscontrol_credentials_CreateAccessControlCredentialByHexValueAndTypeWSResponse" : { "type" : "object", - "description" : "Chart data containing daily and cumulative monthly verification counts.", + "description" : "Response for access control credential creation by hex value and type.", "properties" : { - "cumulativeMonthlyVerifications" : { - "type" : "array", - "description" : "List of cumulative monthly verification counts.", - "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_CountType" - }, - "nullable" : true - }, - "dailyVerifications" : { - "type" : "array", - "description" : "List of daily verification counts.", - "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_CountType" - }, - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, - "Alertmonitoring_DeleteNoonlightSettingsForLocationRequest" : { + "Accesscontrol_credentials_CreateAppleWalletPassWSRequest" : { "type" : "object", - "description" : "Request to delete alert monitoring settings for a location.", + "description" : "Request to create an Apple Wallet pass.", "properties" : { - "locationUuid" : { + "credUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -44890,47 +45404,67 @@ } } }, - "Alertmonitoring_DeleteNoonlightSettingsForLocationResponse" : { + "Accesscontrol_credentials_CreatePinCredentialWSRequest" : { "type" : "object", - "description" : "Response indicating the result of deleting alert monitoring settings for a location.", + "description" : "Request to create a PIN credential for a user.", "properties" : { - "error" : { - "type" : "boolean", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds when this credential expires. Credentials never expire if this value is left null.", + "example" : 1672531200, + "minimum" : 0, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "notifyUser" : { + "type" : "boolean", + "description" : "Whether to notify the user about the new PIN credential.", + "example" : true, "nullable" : true }, - "warningMsg" : { + "pinCode" : { "type" : "string", - "nullable" : true - } - } - }, - "Alertmonitoring_DeletePinForNoonlightWSRequest" : { - "type" : "object", - "description" : "Request to delete a PIN for alert monitoring at a specific location.", - "properties" : { - "locationUuid" : { + "description" : "PIN code (4 to 16 digits), will be generated automatically if one is not provided.", + "example" : "12345", + "maxLength" : 16, + "minLength" : 4, + "nullable" : true + }, + "pinLength" : { + "type" : "integer", + "format" : "int32", + "default" : 5, + "description" : "Length of PIN to be generated if a PIN code is not provided. Accepts length between 4 and 16. Default length is 5.", + "example" : 5, + "maximum" : 16, + "minimum" : 4, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds when this credential becomes active. Credentials activate immediately if this value is left null.", + "example" : 1640995200, + "minimum" : 0, + "nullable" : true + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pin" : { - "type" : "string", - "description" : "PIN code to be deleted", - "example" : "1234", - "nullable" : true } - } + }, + "required" : [ "userUuid" ] }, - "Alertmonitoring_DeletePinForNoonlightWSResponse" : { + "Accesscontrol_credentials_CreatePinCredentialWSResponse" : { "type" : "object", - "description" : "Response indicating the result of deleting a PIN for alert monitoring.", + "description" : "Response containing the created PIN credential details.", "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "error" : { "type" : "boolean", "nullable" : true @@ -44945,152 +45479,420 @@ } } }, - "Alertmonitoring_DeletePromptThreatQualificationByTitleWSRequest" : { + "Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSRequest" : { "type" : "object", - "description" : "Request to delete a prompt threat qualification for an org.", + "description" : "Request to create a Rhombus Secure CSN credential.", "properties" : { - "title" : { + "credentialValue" : { "type" : "string", - "description" : "The title of the prompt threat qualification to delete.", + "description" : "Credential value", + "example" : "123456789", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "title" ] + } }, - "Alertmonitoring_DeletePromptThreatQualificationByTitleWSResponse" : { + "Accesscontrol_credentials_CreateRhombusSecureCsnCredentialWSResponse" : { "type" : "object", - "description" : "Response for deleting a prompt threat qualification.", + "description" : "Response for Rhombus Secure CSN credential creation.", "properties" : { - "error" : { - "type" : "boolean", + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateStandardCsnCredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a standard CSN credential.", + "properties" : { + "credentialValue" : { + "type" : "string", + "description" : "Credential value", + "example" : "123456789", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, "nullable" : true }, - "warningMsg" : { + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_DisableLocationRequest" : { + "Accesscontrol_credentials_CreateStandardCsnCredentialWSResponse" : { "type" : "object", - "description" : "Request to disable alert monitoring for a specific location.", + "description" : "Response for standard CSN credential creation.", "properties" : { - "locationUuid" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a 64-bit raw Wiegand credential.", + "properties" : { + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pin" : { + "value" : { "type" : "string", - "description" : "PIN code required to disable alert monitoring", - "example" : "1234", + "description" : "Credential value", + "example" : "1234567890123456", "nullable" : true } } }, - "Alertmonitoring_DisableLocationResponse" : { + "Accesscontrol_credentials_CreateWiegand64BitRawCredentialWSResponse" : { "type" : "object", - "description" : "Response indicating the result of disabling alert monitoring for a location.", + "description" : "Response for 64-bit raw Wiegand credential creation.", "properties" : { - "error" : { - "type" : "boolean", + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateWiegandCredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a Wiegand credential.", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Card number for the credential", + "example" : 456, "nullable" : true }, - "errorMsg" : { + "companyId" : { + "type" : "integer", + "format" : "int32", + "description" : "Company ID used by HID CORP 1000", + "example" : 1000, + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, + "nullable" : true + }, + "facilityCode" : { + "type" : "integer", + "format" : "int32", + "description" : "Facility code for the credential", + "example" : 123, + "nullable" : true + }, + "siteCode" : { + "type" : "integer", + "format" : "int32", + "description" : "Site code for the credential", + "example" : 789, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "value" : { "type" : "string", + "description" : "Final credential value used in RAW formats", + "example" : "123456789", "nullable" : true + }, + "wiegandFormat" : { + "$ref" : "#/components/schemas/WiegandFormatEnumType" } } }, - "Alertmonitoring_DismissThreatCaseWSRequest" : { + "Accesscontrol_credentials_CreateWiegandCredentialWSResponse" : { "type" : "object", - "description" : "Request to dismiss a threat case in alert monitoring.", + "description" : "Response for Wiegand credential creation.", "properties" : { - "uuid" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateWiegandD10202CredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a D10202 Wiegand credential.", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Card number", + "example" : 456789, + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, + "nullable" : true + }, + "facilityCode" : { + "type" : "integer", + "format" : "int32", + "description" : "Facility code", + "example" : 123, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "uuid" ] + } }, - "Alertmonitoring_DismissThreatCaseWSResponse" : { + "Accesscontrol_credentials_CreateWiegandD10202CredentialWSResponse" : { "type" : "object", - "description" : "Response indicating the result of dismissing a threat case.", + "description" : "Response for D10202 Wiegand credential creation.", "properties" : { - "error" : { - "type" : "boolean", + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateWiegandH10301CredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a H10301 Wiegand credential.", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Card number", + "example" : 456789, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, "nullable" : true }, - "success" : { - "type" : "boolean", - "description" : "Indicates whether the threat case dismissal was successful", - "example" : true, + "facilityCode" : { + "type" : "integer", + "format" : "int32", + "description" : "Facility code", + "example" : 123, "nullable" : true }, - "warningMsg" : { + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_EnableLocationRequest" : { + "Accesscontrol_credentials_CreateWiegandH10301CredentialWSResponse" : { "type" : "object", - "description" : "Request to enable alert monitoring for a specific location.", + "description" : "Response for H10301 Wiegand credential creation.", "properties" : { - "locationUuid" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateWiegandH10302CredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a H10302 Wiegand credential.", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int64", + "description" : "Card number (35-bit, no facility code)", + "example" : 456789, + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pin" : { - "type" : "string", - "description" : "The PIN code required to enable alert monitoring.", - "nullable" : true } } }, - "Alertmonitoring_EnableLocationResponse" : { + "Accesscontrol_credentials_CreateWiegandH10302CredentialWSResponse" : { "type" : "object", - "description" : "Response indicating successful enabling of alert monitoring for a location.", + "description" : "Response for H10302 Wiegand credential creation.", "properties" : { - "error" : { - "type" : "boolean", + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_CreateWiegandH10304CredentialWSRequest" : { + "type" : "object", + "description" : "Request to create a H10304 Wiegand credential.", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Card number", + "example" : 456789, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds (exclusive)", + "example" : 1672531200, "nullable" : true }, - "warningMsg" : { + "facilityCode" : { + "type" : "integer", + "format" : "int32", + "description" : "Facility code", + "example" : 123, + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in epoch seconds (inclusive)", + "example" : 1640995200, + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_EscalateThreatCaseToAlarmWSRequest" : { + "Accesscontrol_credentials_CreateWiegandH10304CredentialWSResponse" : { "type" : "object", - "description" : "Request to escalate a threat case to an alarm for alert monitoring.", + "description" : "Response for H10304 Wiegand credential creation.", "properties" : { - "uuid" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_DeleteAccessControlCredentialWSRequest" : { + "type" : "object", + "description" : "Request to delete an access control credential.", + "properties" : { + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Accesscontrol_credentials_DeleteAccessControlCredentialWSResponse" : { + "type" : "object", + "description" : "Response indicating successful deletion of an access control credential." + }, + "Accesscontrol_credentials_DeletePinCredentialWSRequest" : { + "type" : "object", + "description" : "Request to delete a PIN credential permanently from the system.", + "properties" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -45098,11 +45900,11 @@ "nullable" : true } }, - "required" : [ "uuid" ] + "required" : [ "credentialUuid" ] }, - "Alertmonitoring_EscalateThreatCaseToAlarmWSResponse" : { + "Accesscontrol_credentials_DeletePinCredentialWSResponse" : { "type" : "object", - "description" : "Response indicating the result of escalating a threat case to an alarm.", + "description" : "Response indicating successful deletion of a PIN credential.", "properties" : { "error" : { "type" : "boolean", @@ -45118,121 +45920,115 @@ } } }, - "Alertmonitoring_GenerateMonthlyVerificationsForYearReportForLocationWSRequest" : { + "Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSRequest" : { "type" : "object", - "description" : "Request to generate monthly verifications for year report for alert monitoring at specific locations.", + "description" : "Request to delete an unassigned access control credential.", "properties" : { - "locationUuids" : { - "type" : "array", - "description" : "List of location UUIDs to generate monthly verifications for.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "credentialHexValue" : { + "type" : "string", + "description" : "Hex value of the credential to delete", + "example" : "1234567890ABCDEF", "nullable" : true } - }, - "required" : [ "locationUuids" ] + } }, - "Alertmonitoring_GenerateMonthlyVerificationsForYearReportForLocationWSResponse" : { + "Accesscontrol_credentials_DeleteUnassignedAccessControlCredentialWSResponse" : { "type" : "object", - "description" : "Response containing monthly verifications for year report for alert monitoring at specific locations.", + "description" : "Response indicating successful deletion of an unassigned access control credential." + }, + "Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSRequest" : { + "type" : "object", + "description" : "Request to find access control credentials by guest pass.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" }, - "errorMsg" : { + "guestPassUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "verificationsPerMonthPerLocation" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "description" : "Map of location UUIDs to their monthly verification counts", - "nullable" : true - }, - "description" : "Map of location UUIDs to their monthly verification counts", - "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindAccessControlCredentialByGuestPassWSResponse" : { + "type" : "object", + "description" : "Response containing access control credentials found for a specific guest pass.", + "properties" : { + "credentials" : { + "type" : "array", + "description" : "List of access control credentials", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" }, - "description" : "Map of location UUIDs to their monthly verification counts", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", "nullable" : true } } }, - "Alertmonitoring_GenerateReportDataForLocationWSRequest" : { + "Accesscontrol_credentials_FindAccessControlCredentialByOrgWSRequest" : { "type" : "object", - "description" : "Request to generate report data for alert monitoring at a specific location.", + "description" : "Request to find access control credentials by organization.", "properties" : { - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time for the report period in milliseconds since epoch.", - "example" : 1643673600000, + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" + } + } + }, + "Accesscontrol_credentials_FindAccessControlCredentialByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing access control credentials found for an organization.", + "properties" : { + "credentials" : { + "type" : "array", + "description" : "List of access control credentials", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindAccessControlCredentialByUserWSRequest" : { + "type" : "object", + "description" : "Request to find access control credentials by user.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" }, - "locationUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time for the report period in milliseconds since epoch.", - "example" : 1640995200000, - "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_GenerateReportDataForLocationWSResponse" : { + "Accesscontrol_credentials_FindAccessControlCredentialByUserWSResponse" : { "type" : "object", - "description" : "Response containing generated report data for alert monitoring at a specific location.", + "description" : "Response containing access control credentials found for a specific user.", "properties" : { - "cumulativeChartData" : { - "$ref" : "#/components/schemas/Alertmonitoring_CumulativeChartData" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "modifiedBy" : { - "type" : "array", - "description" : "List of modification records showing who made changes", - "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_AmModifiedBy" - }, - "nullable" : true - }, - "threatCaseReportItems" : { + "credentials" : { "type" : "array", - "description" : "List of threat case report items for the report period", + "description" : "List of access control credentials", "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReportItem" + "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindAccessControlCredentialByUsersWSRequest" : { + "type" : "object", + "description" : "Request to find access control credentials by multiple users.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" }, - "threatCases" : { + "userUuids" : { "type" : "array", - "description" : "Set of uuids corresponding to the threatcases that produced verifications in the report period", + "description" : "Set of user UUIDs to search for", "items" : { "type" : "string", "format" : "RUUID", @@ -45242,101 +46038,160 @@ }, "nullable" : true, "uniqueItems" : true - }, - "verificationsByDevice" : { - "type" : "array", - "description" : "List of device histogram items showing verifications by device", - "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_AMDeviceHistogramItem" + } + } + }, + "Accesscontrol_credentials_FindAccessControlCredentialByUsersWSResponse" : { + "type" : "object", + "description" : "Response containing access control credentials mapped by user UUIDs.", + "properties" : { + "userCredentialsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of user UUIDs to their associated access control credentials", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, + "nullable" : true }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "description" : "Map of user UUIDs to their associated access control credentials", "nullable" : true } } }, - "Alertmonitoring_GenerateReportDataForLocationWSResponseV2" : { + "Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSRequest" : { "type" : "object", - "description" : "Response containing generated report data for alert monitoring at a specific location.", + "description" : "Request to find credential history by credential hex value.", "properties" : { - "cumulativeChartData" : { - "$ref" : "#/components/schemas/Alertmonitoring_CumulativeChartData" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "credentialHexValue" : { "type" : "string", + "description" : "Hex value of the credential to search for", + "example" : "1234567890ABCDEF", "nullable" : true }, - "events" : { + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryByCredentialHexValueWSResponse" : { + "type" : "object", + "description" : "Response containing credential history found by credential hex value.", + "properties" : { + "credentials" : { "type" : "array", - "description" : "List of modification events showing who made changes", + "description" : "List of credential history records", "items" : { - "$ref" : "#/components/schemas/ALMEvent" + "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSRequest" : { + "type" : "object", + "description" : "Request to find credential history by credential value.", + "properties" : { + "credentialType" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" }, - "threatCaseReportItems" : { + "credentialValue" : { + "type" : "string", + "description" : "Credential value to search for", + "example" : "123456789", + "nullable" : true + }, + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryByCredentialValueWSResponse" : { + "type" : "object", + "description" : "Response containing credential history found by credential value.", + "properties" : { + "credentials" : { "type" : "array", - "description" : "List of threat case report items for the report period", + "description" : "List of credential history records", "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReportItem" + "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryByUserWSRequest" : { + "type" : "object", + "description" : "Request to find credential history by user.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" }, - "threatCases" : { + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryByUserWSResponse" : { + "type" : "object", + "description" : "Response containing credential history found for a specific user.", + "properties" : { + "credentials" : { "type" : "array", - "description" : "Set of uuids corresponding to the threat cases that produced verifications in the report period", + "description" : "List of credential history records", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/AccessControlCredentialType" }, - "nullable" : true, - "uniqueItems" : true - }, - "verificationsByDevice" : { + "nullable" : true + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryWSRequest" : { + "type" : "object", + "description" : "Request to find credential history.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" + } + } + }, + "Accesscontrol_credentials_FindCredentialHistoryWSResponse" : { + "type" : "object", + "description" : "Response containing credential history.", + "properties" : { + "credentials" : { "type" : "array", - "description" : "List of device histogram items showing verifications by device", + "description" : "List of credential history records", "items" : { - "$ref" : "#/components/schemas/Alertmonitoring_AMDeviceHistogramItem" + "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Alertmonitoring_GetAlertMonitoringTripwireGroupCountWSRequest" : { + "Accesscontrol_credentials_FindPinCredentialsByOrgWSRequest" : { "type" : "object", - "description" : "Request to get the count of tripwire groups for alert monitoring.", + "description" : "Request to find PIN credentials in the organization with optional filtering.", "properties" : { - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" } } }, - "Alertmonitoring_GetAlertMonitoringTripwireGroupCountWSResponse" : { + "Accesscontrol_credentials_FindPinCredentialsByOrgWSResponse" : { "type" : "object", - "description" : "Response containing the count of tripwire groups for alert monitoring.", + "description" : "Response containing a list of PIN credentials found in the organization.", "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of tripwire groups", - "example" : 5, + "credentials" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "nullable" : true }, "error" : { @@ -45353,29 +46208,23 @@ } } }, - "Alertmonitoring_GetMonitoredDoorSensorsForLocationWSRequest" : { + "Accesscontrol_credentials_FindQrCodeCredentialsByOrgWSRequest" : { "type" : "object", - "description" : "Request to retrieve all monitored door sensors for a location.", + "description" : "Request to find QR code credentials in the organization with optional filtering.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "filter" : { + "$ref" : "#/components/schemas/CredentialQueryFilter" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_GetMonitoredDoorSensorsForLocationWSResponse" : { + "Accesscontrol_credentials_FindQrCodeCredentialsByOrgWSResponse" : { "type" : "object", - "description" : "Response containing all monitored door sensors for a location.", + "description" : "Response containing a list of QR code credentials found in the organization.", "properties" : { - "doorStates" : { + "credentials" : { "type" : "array", - "description" : "List of minimal door state information for all monitored door sensors in a location", "items" : { - "$ref" : "#/components/schemas/Door_MinimalDoorStateType" + "$ref" : "#/components/schemas/AccessControlCredentialType" }, "nullable" : true }, @@ -45393,32 +46242,65 @@ } } }, - "Alertmonitoring_GetNoonlightSettingsForLocationWSRequest" : { + "Accesscontrol_credentials_FindRhombusSecureMobileCredentialsForCurrentUserWSRequest" : { "type" : "object", - "description" : "Request to retrieve alert monitoring settings for a specific location.", + "description" : "Request to find Rhombus Secure mobile credentials for current user." + }, + "Accesscontrol_credentials_FindRhombusSecureMobileCredentialsForCurrentUserWSResponse" : { + "type" : "object", + "description" : "Response for finding Rhombus Secure mobile credentials for current user.", "properties" : { - "includePreviousVersions" : { - "type" : "boolean", - "description" : "If provided and true, response will contain a list of previous versions of the settings. For debugging purposes.", - "example" : false, + "credentials" : { + "type" : "array", + "description" : "List of Rhombus Secure mobile credentials", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "nullable" : true - }, - "locationUuid" : { + } + } + }, + "Accesscontrol_credentials_GetAccessControlCredentialDetailsWSRequest" : { + "type" : "object", + "description" : "Request to get an access control credential's details, including sensitive fields, by UUID.", + "properties" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } + }, + "required" : [ "credentialUuid" ] + }, + "Accesscontrol_credentials_GetAccessControlCredentialDetailsWSResponse" : { + "type" : "object", + "description" : "Response containing an access control credential's details, including sensitive fields.", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } } }, - "Alertmonitoring_GetNoonlightSettingsForLocationWSResponse" : { + "Accesscontrol_credentials_GetAvailablePinCodeWSRequest" : { "type" : "object", - "description" : "Response containing alert monitoring settings for a specific location.", + "description" : "Request to get an available PIN code for creating a PIN credential.", + "properties" : { + "pinLength" : { + "type" : "integer", + "format" : "int32", + "description" : "Length of PIN to be generated.", + "example" : 5, + "nullable" : true + } + }, + "required" : [ "pinLength" ] + }, + "Accesscontrol_credentials_GetAvailablePinCodeWSResponse" : { + "type" : "object", + "description" : "Response containing an available PIN code for credential creation.", "properties" : { - "alertMonitoringSettings" : { - "$ref" : "#/components/schemas/Alertmonitoring_NoonlightWSSettings" - }, "error" : { "type" : "boolean", "nullable" : true @@ -45427,12 +46309,10 @@ "type" : "string", "nullable" : true }, - "previousVersions" : { - "type" : "array", - "description" : "List of previous versions of the alert monitoring settings", - "items" : { - "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" - }, + "pinCode" : { + "type" : "string", + "description" : "The generated PIN code", + "example" : "12345", "nullable" : true }, "warningMsg" : { @@ -45441,21 +46321,26 @@ } } }, - "Alertmonitoring_GetNoonlightSettingsWSRequest" : { + "Accesscontrol_credentials_GetPinCredentialDetailsWSRequest" : { "type" : "object", - "description" : "Request to retrieve alert monitoring settings." + "description" : "Request to get detailed information about a PIN credential including sensitive data.", + "properties" : { + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "credentialUuid" ] }, - "Alertmonitoring_GetNoonlightSettingsWSResponse" : { + "Accesscontrol_credentials_GetPinCredentialDetailsWSResponse" : { "type" : "object", - "description" : "Response containing alert monitoring settings for multiple locations.", + "description" : "Response containing detailed PIN credential information including sensitive data.", "properties" : { - "alertMonitoringSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Alertmonitoring_NoonlightWSSettings" - }, - "description" : "Map of location UUIDs to their alert monitoring settings", - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" }, "error" : { "type" : "boolean", @@ -45471,51 +46356,80 @@ } } }, - "Alertmonitoring_GetPromptThreatQualificationsWSRequest" : { - "type" : "object", - "description" : "Request to retrieve prompt threat qualifications for an org." - }, - "Alertmonitoring_GetPromptThreatQualificationsWSResponse" : { + "Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSRequest" : { "type" : "object", - "description" : "Response containing prompt threat qualifications for an org.", + "description" : "Request to get Rhombus Secure CSN credential details.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "credentialUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "threatQualifications" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoonlightPromptSelection" - }, - "nullable" : true - }, - "warningMsg" : { + } + } + }, + "Accesscontrol_credentials_GetRhombusSecureCsnCredentialDetailsWSResponse" : { + "type" : "object", + "description" : "Response containing Rhombus Secure CSN credential details.", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_GetRhombusSecureMobileAppStateStatsForOrgWSRequest" : { + "type" : "object", + "description" : "Request to get Rhombus Secure mobile app state stats for organization." + }, + "Accesscontrol_credentials_GetRhombusSecureMobileAppStateStatsForOrgWSResponse" : { + "type" : "object", + "description" : "Response for getting Rhombus Secure mobile app state stats for organization.", + "properties" : { + "appStateStats" : { + "$ref" : "#/components/schemas/RhombusSecureMobileAppStateStats" + } + } + }, + "Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSRequest" : { + "type" : "object", + "description" : "Request to get standard CSN credential details.", + "properties" : { + "credentialUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_LocationStatusWSRequest" : { + "Accesscontrol_credentials_GetStandardCsnCredentialDetailsWSResponse" : { "type" : "object", - "description" : "Request to retrieve alarm monitoring status for a specific location.", + "description" : "Response containing standard CSN credential details.", "properties" : { - "locationUuid" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_GetStaticQrCodeCredentialImageWSRequest" : { + "type" : "object", + "description" : "Request to render the scannable QR image for a single static QR code credential.", + "properties" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "credentialUuid" ] }, - "Alertmonitoring_LocationStatusWSResponse" : { + "Accesscontrol_credentials_GetStaticQrCodeCredentialImageWSResponse" : { "type" : "object", - "description" : "Response containing alarm monitoring status for a specific location.", + "description" : "Response containing a ready-to-display QR image for a static QR code credential.", "properties" : { "error" : { "type" : "boolean", @@ -45525,8 +46439,16 @@ "type" : "string", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/MonitoringEnableStatus" + "qrCode" : { + "type" : "array", + "description" : "The scannable QR code rendered as a PNG. Encodes the RHMB-tagged binary payload (header + format version + the token's raw bytes), not the token string.", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "The scannable QR code rendered as a PNG. Encodes the RHMB-tagged binary payload (header + format version + the token's raw bytes), not the token string.", + "nullable" : true + }, + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -45534,218 +46456,136 @@ } } }, - "Alertmonitoring_NoonlightWSSettings" : { + "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialErrorEnumType" : { + "type" : "string", + "description" : "Enumeration of possible errors when provisioning mobile access control credentials.", + "enum" : [ "USER_HAS_MAX_ALLOWED_CREDENTIALS" ] + }, + "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserErrorWSResponse" : { "type" : "object", - "description" : "Web service settings for Noonlight integration with alert monitoring.", + "allOf" : [ { + "type" : "object", + "properties" : { + "errorType" : { + "$ref" : "#/components/schemas/Accesscontrol_credentials_ProvisionMobileAccessControlCredentialErrorEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "acceptedTermsOfService" : { - "type" : "boolean", + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserSuccessWSResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, + "encodedPrivateKey" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BasicResponseEnumType" + } + } + }, + "Accesscontrol_credentials_ProvisionMobileAccessControlCredentialForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request to provision mobile access control credential for current user.", + "properties" : { + "appName" : { + "type" : "string", + "description" : "Name of the mobile app", + "example" : "Rhombus Key", "nullable" : true }, - "badgeAuthDisablesMonitoring" : { - "type" : "boolean", + "appNotifications" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "appOS" : { + "type" : "string", + "description" : "Operating system of the mobile device", + "example" : "iOS 15.0", "nullable" : true }, - "defaultDelay" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "defaultEmergencyContact" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, - "defaultPromptTheme" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" - }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "disabledOnMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when Noonlight integration was disabled in milliseconds since epoch.", - "nullable" : true - }, - "emergencyContacts" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EmergencyResponseContactsScheduleType" - }, - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "enabledOnMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when Noonlight integration was enabled in milliseconds since epoch.", - "nullable" : true - }, - "entryInstructions" : { - "type" : "string", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "manualEscalationSettings" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, - "modifiedByEmail" : { + "appVersion" : { "type" : "string", + "description" : "Version of the mobile app", + "example" : "1.2.3", "nullable" : true }, - "modifiedByIntegration" : { - "type" : "boolean", - "nullable" : true - }, - "modifiedByMetadata" : { - "type" : "string", - "nullable" : true + "clientType" : { + "$ref" : "#/components/schemas/MobileTokenOSEnum" }, - "modifiedByUuid" : { + "deviceModel" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "modifiedTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "monitoringMode" : { - "$ref" : "#/components/schemas/MonitoringModeEnum" - }, - "oneTimePauses" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, - "nullable" : true - }, - "oneTimeSchedules" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, + "description" : "Model of the mobile device", + "example" : "iPhone 13", "nullable" : true }, - "orgUuid" : { + "installationId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "pins" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringPinType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "rules" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "schedules" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, + "description" : "Installation ID of the mobile app", + "example" : "abc123def456", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/MonitoringEnableStatus" - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "tapToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" }, - "talkdownEnabled" : { - "type" : "boolean", - "nullable" : true + "waveToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" } } }, - "Alertmonitoring_OrgStatusWSRequest" : { + "Accesscontrol_credentials_RevokeAccessControlCredentialWSRequest" : { "type" : "object", - "description" : "Request to retrieve alarm monitoring status for all locations in an organization.", + "description" : "Request to revoke an access control credential.", "properties" : { - "includeDeleted" : { - "type" : "boolean", - "description" : "If true, includes alert monitoring settings that were soft deleted in the response.", - "example" : false, + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_OrgStatusWSResponse" : { + "Accesscontrol_credentials_RevokeAccessControlCredentialWSResponse" : { "type" : "object", - "description" : "Response containing alarm monitoring status for all locations in an organization.", + "description" : "Response containing the revoked access control credential details.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "locationStatuses" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MonitoringEnableStatus" - }, - "description" : "Map of location UUIDs to their monitoring enable status", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, - "Alertmonitoring_ResetAlertMonitoringTripwireGroupCountWSRequest" : { + "Accesscontrol_credentials_RevokePinCredentialWSRequest" : { "type" : "object", - "description" : "Request to reset the count of tripwire groups for alert monitoring.", + "description" : "Request to revoke a PIN credential, making it inactive.", "properties" : { - "scheduleUuid" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds since epoch when the reset should occur", - "example" : 1640995200000, - "nullable" : true } - } + }, + "required" : [ "credentialUuid" ] }, - "Alertmonitoring_ResetAlertMonitoringTripwireGroupCountWSResponse" : { + "Accesscontrol_credentials_RevokePinCredentialWSResponse" : { "type" : "object", - "description" : "Response indicating the result of resetting the tripwire group count for alert monitoring.", + "description" : "Response indicating successful revocation of a PIN credential.", "properties" : { "error" : { "type" : "boolean", @@ -45761,181 +46601,83 @@ } } }, - "Alertmonitoring_ThreatCaseReportItem" : { + "Accesscontrol_credentials_RevokeRhombusSecureMobileCredentialForCurrentUserWSRequest" : { "type" : "object", - "description" : "Report item containing threat case information with device and alert details.", + "description" : "Request to revoke Rhombus Secure mobile credential for current user.", "properties" : { - "alertNotFound" : { - "type" : "boolean", - "description" : "Whether the alert was not found for this threat case.", - "nullable" : true - }, - "alertTypes" : { - "type" : "array", - "description" : "List of alert types associated with this threat case.", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true - }, - "associatedDeviceUuids" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "deviceName" : { - "type" : "string", - "description" : "The name of the device involved in this threat case.", - "nullable" : true - }, - "deviceNotFound" : { - "type" : "boolean", - "description" : "Whether the device was not found for this threat case.", - "nullable" : true - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "locationName" : { - "type" : "string", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "noonlightAlarmId" : { - "type" : "string", - "nullable" : true - }, - "noonlightVerificationId" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "policyAlertUuid" : { + } + } + }, + "Accesscontrol_credentials_RevokeRhombusSecureMobileCredentialForCurrentUserWSResponse" : { + "type" : "object", + "description" : "Response for revoking Rhombus Secure mobile credential for current user." + }, + "Accesscontrol_credentials_RotatePinCredentialWSRequest" : { + "type" : "object", + "description" : "Request to rotate a PIN credential with a new value.", + "properties" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyAlertUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "promptTheme" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" - }, - "promptTitle" : { - "type" : "string", - "nullable" : true - }, - "reason" : { - "type" : "string", - "description" : "The reason for the threat case result.", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "End date in epoch seconds when this credential expires. If left null, copies the end date from the previous PIN.", + "example" : 1672531200, + "minimum" : 0, "nullable" : true }, - "result" : { - "type" : "string", - "description" : "The result of the threat case investigation.", + "notifyUser" : { + "type" : "boolean", + "description" : "Whether to notify the user about their rotated PIN credential.", + "example" : true, "nullable" : true }, - "sharedClipGroupUuid" : { + "pinCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "PIN code (4 to 16 digits), will be generated automatically if one is not provided.", + "example" : "12345", + "maxLength" : 16, + "minLength" : 4, "nullable" : true }, - "sirenSettings" : { - "$ref" : "#/components/schemas/AMSirenSettingsType" - }, - "status" : { - "$ref" : "#/components/schemas/ThreatCaseStatusEnum" - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "submissionTimestampMs" : { + "pinLength" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Length of PIN to be generated if a PIN code is not provided. Accepts length between 4 and 16. If left null, the generated PIN will have the same length as the previous PIN.", + "example" : 5, + "maximum" : 16, + "minimum" : 4, "nullable" : true }, - "submitDelayExpireTimestampMs" : { + "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", + "description" : "Start date in epoch seconds when this credential becomes active. If left null, copies the start date from the previous PIN.", + "example" : 1640995200, + "minimum" : 0, "nullable" : true - }, - "timelineEventList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ThreatCaseTimelineEventType" - }, - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "verificationHistory" : { - "$ref" : "#/components/schemas/VerificationHistory" } - } - }, - "Alertmonitoring_UpdateNoonlightSettingsForLocationRequest" : { - "type" : "object", - "description" : "Request to update alert monitoring settings for a location.", - "properties" : { - "noonlightSettings" : { - "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" - } - } + }, + "required" : [ "credentialUuid" ] }, - "Alertmonitoring_UpdateNoonlightSettingsForLocationResponse" : { + "Accesscontrol_credentials_RotatePinCredentialWSResponse" : { "type" : "object", - "description" : "Response indicating the result of updating alert monitoring settings for a location.", + "description" : "Response containing the rotated PIN credential details.", "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "error" : { "type" : "boolean", "nullable" : true @@ -45950,131 +46692,108 @@ } } }, - "Alertmonitoring_UpdatePromptThreatQualificationWSRequest" : { - "type" : "object", - "description" : "Request to update a prompt threat qualification for an org.", - "properties" : { - "promptSelection" : { - "$ref" : "#/components/schemas/NoonlightPromptSelection" - } - }, - "required" : [ "promptSelection" ] - }, - "Alertmonitoring_UpdatePromptThreatQualificationWSResponse" : { + "Accesscontrol_credentials_SuspendAccessControlCredentialWSRequest" : { "type" : "object", - "description" : "Response for updating a prompt threat qualification.", + "description" : "Request to suspend an access control credential.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "credentialUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_config_AcceptALMLocationTermsOfServiceWSRequest" : { + "Accesscontrol_credentials_SuspendAccessControlCredentialWSResponse" : { "type" : "object", - "description" : "Request to accept terms of service for ALM location.", + "description" : "Response containing the suspended access control credential details.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_ArmMonitoringWSRequest" : { + "Accesscontrol_credentials_UnsuspendAccessControlCredentialWSRequest" : { "type" : "object", - "description" : "Request to arm monitoring.", + "description" : "Request to unsuspend an access control credential.", "properties" : { - "armingRule" : { - "$ref" : "#/components/schemas/ArmMonitoringRule" - }, - "locationUuid" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_CancelManualArmWSRequest" : { + "Accesscontrol_credentials_UnsuspendAccessControlCredentialWSResponse" : { "type" : "object", - "description" : "Request to cancel manual arming.", + "description" : "Response containing the unsuspended access control credential details.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_CancelManualDisarmWSRequest" : { + "Accesscontrol_credentials_UpdateAccessControlCredentialNoteWSRequest" : { "type" : "object", - "description" : "Request to cancel manual disarming.", + "description" : "Request to update the note field of an access control credential.", "properties" : { - "locationUuid" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "note" : { + "type" : "string", + "description" : "Note to be associated with the credential. Max length is 250 characters.", + "example" : "Employee badge", + "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_CreateLocationALMConfigWSRequest" : { + "Accesscontrol_credentials_UpdateAccessControlCredentialNoteWSResponse" : { "type" : "object", - "description" : "Request to create a location ALM config.", + "description" : "Response for updating the note field of an access control credential.", "properties" : { - "locationConfig" : { - "$ref" : "#/components/schemas/LocationALMConfig" + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } - }, - "required" : [ "locationConfig" ] + } }, - "Alertmonitoring_config_CreateZoneALMConfigWSRequest" : { + "Accesscontrol_credentials_UpdatePinCredentialWSRequest" : { "type" : "object", - "description" : "Request to create a zone ALM config.", + "description" : "Request to update a PIN credential with new start and end dates.", "properties" : { - "monitoringEnabled" : { - "type" : "boolean", - "description" : "Whether to have monitoring enabled in manual mode.", + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "zoneConfig" : { - "$ref" : "#/components/schemas/ZoneALMConfig" + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } - }, - "required" : [ "zoneConfig" ] + } }, - "Alertmonitoring_config_CreateZoneALMConfigWSResponse" : { + "Accesscontrol_credentials_UpdatePinCredentialWSResponse" : { "type" : "object", - "description" : "Response containing a zone ALM config and monitoring state.", + "description" : "Response containing the updated PIN credential details.", "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "error" : { "type" : "boolean", "nullable" : true @@ -46083,154 +46802,210 @@ "type" : "string", "nullable" : true }, - "monitoringState" : { - "$ref" : "#/components/schemas/ALMMonitoringState" - }, "warningMsg" : { "type" : "string", "nullable" : true - }, - "zoneConfig" : { - "$ref" : "#/components/schemas/ZoneALMConfig" } } }, - "Alertmonitoring_config_DeleteLocationALMConfigWSRequest" : { + "Accesscontrol_credentials_UpdateRhombusKeyMobileAppStateForCurrentUserWSRequest" : { "type" : "object", - "description" : "Request to delete a location ALM config.", + "description" : "Request to update Rhombus Key mobile app state for current user.", "properties" : { - "locationUuid" : { + "appName" : { + "type" : "string", + "description" : "Name of the mobile app", + "example" : "Rhombus Key", + "nullable" : true + }, + "appNotifications" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "appOS" : { + "type" : "string", + "description" : "Operating system of the mobile device", + "example" : "iOS 15.0", + "nullable" : true + }, + "appVersion" : { + "type" : "string", + "description" : "Version of the mobile app", + "example" : "1.2.3", + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/MobileTokenOSEnum" + }, + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "deviceModel" : { + "type" : "string", + "description" : "Model of the mobile device", + "example" : "iPhone 13", + "nullable" : true + }, + "tapToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "waveToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_DeleteZoneALMConfigWSRequest" : { + "Accesscontrol_credentials_UpdateRhombusKeyMobileAppStateForCurrentUserWSResponse" : { "type" : "object", - "description" : "Request to delete a zone ALM config.", + "description" : "Response for updating Rhombus Key mobile app state for current user.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "appState" : { + "$ref" : "#/components/schemas/RhombusSecureMobileAppState" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_DisarmMonitoringWSRequest" : { + "Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSRequest" : { "type" : "object", - "description" : "Request to disarm monitoring.", + "description" : "Request to update a Rhombus Secure CSN credential.", "properties" : { - "disarmingRule" : { - "$ref" : "#/components/schemas/DisarmMonitoringRule" - }, - "locationUuid" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_GetALMZoneContextWSRequest" : { + "Accesscontrol_credentials_UpdateRhombusSecureCsnCredentialWSResponse" : { "type" : "object", - "description" : "Request to retrieve ALM zone context.", + "description" : "Response containing the updated Rhombus Secure CSN credential.", "properties" : { - "locationUuid" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSRequest" : { + "type" : "object", + "description" : "Request to update a Rhombus Secure mobile credential.", + "properties" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_GetALMZoneContextWSResponse" : { + "Accesscontrol_credentials_UpdateRhombusSecureMobileCredentialWSResponse" : { "type" : "object", - "description" : "Response containing an ALM zone's context.", + "description" : "Response containing the updated Rhombus Secure mobile credential.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - }, - "zoneContext" : { - "$ref" : "#/components/schemas/ALMZoneContext" + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" } } }, - "Alertmonitoring_config_GetALMZoneContextsByLocationWSRequest" : { + "Accesscontrol_credentials_UpdateStandardCsnCredentialWSRequest" : { "type" : "object", - "description" : "Request to retrieve ALM zone contexts by location.", + "description" : "Request to update a standard CSN credential.", "properties" : { - "locationUuid" : { + "credentialUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_GetALMZoneContextsByLocationWSResponse" : { + "Accesscontrol_credentials_UpdateStandardCsnCredentialWSResponse" : { "type" : "object", - "description" : "Response containing ALM zone contexts for a location.", + "description" : "Response containing the updated standard CSN credential.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } + }, + "Accesscontrol_credentials_UpdateWiegandCredentialWSRequest" : { + "type" : "object", + "description" : "Request to update a Wiegand credential.", + "properties" : { + "credentialUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "zoneContexts" : { - "type" : "array", - "description" : "List of the latest ALM zone contexts in the location.", - "items" : { - "$ref" : "#/components/schemas/ALMZoneContext" - }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Alertmonitoring_config_GetALMZoneContextsByOrgWSRequest" : { + "Accesscontrol_credentials_UpdateWiegandCredentialWSResponse" : { "type" : "object", - "description" : "Request to retrieve ALM zone contexts by org." + "description" : "Response containing the updated Wiegand credential.", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + } + } }, - "Alertmonitoring_config_GetALMZoneContextsByOrgWSResponse" : { + "Accesscontrol_doorexception_CreateDoorScheduleExceptionWSRequest" : { "type" : "object", - "description" : "Response containing ALM zone contexts for an org.", + "description" : "Request to create a new door schedule exception.", + "properties" : { + "exception" : { + "$ref" : "#/components/schemas/DoorScheduleExceptionType" + } + } + }, + "Accesscontrol_doorexception_CreateDoorScheduleExceptionWSResponse" : { + "type" : "object", + "description" : "Response containing the created door schedule exception.", "properties" : { "error" : { "type" : "boolean", @@ -46240,48 +47015,57 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "exception" : { + "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, - "zoneContexts" : { + "expiredACDLicensesDoorUuids" : { "type" : "array", - "description" : "List of the latest ALM zone contexts in the org.", + "description" : "Set of expired ACD license door UUIDs", "items" : { - "$ref" : "#/components/schemas/ALMZoneContext" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unassignedACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of unassigned ACD license door UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, + "nullable" : true, + "uniqueItems" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Alertmonitoring_config_GetALMZoneMonitoredDevicesWSRequest" : { + "Accesscontrol_doorexception_DeleteDoorScheduleExceptionWSRequest" : { "type" : "object", - "description" : "Request to retrieve monitored devices in an ALM zone.", + "description" : "Request to delete a specific door schedule exception by UUID.", "properties" : { - "locationUuid" : { + "exceptionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "modeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/MonitoringModeEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_GetALMZoneMonitoredDevicesWSResponse" : { + "Accesscontrol_doorexception_DeleteDoorScheduleExceptionWSResponse" : { "type" : "object", - "description" : "Response containing an ALM zone's monitored devices.", + "description" : "Response confirming the deletion of a door schedule exception.", "properties" : { "error" : { "type" : "boolean", @@ -46291,50 +47075,31 @@ "type" : "string", "nullable" : true }, - "monitoredDevices" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Lists of monitored devices by type.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "description" : "Lists of monitored devices by type.", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Alertmonitoring_config_GetLocationALMConfigWSRequest" : { + "Accesscontrol_doorexception_FindDoorScheduleExceptionsForDoorWSRequest" : { "type" : "object", - "description" : "Request to retrieve a location ALM config.", + "description" : "Request to search for door schedule exceptions for a specific door with optional date range filtering.", "properties" : { - "locationUuid" : { + "dateRangeFilter" : { + "$ref" : "#/components/schemas/DateRangeFilter" + }, + "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuid" ] - }, - "Alertmonitoring_config_GetLocationALMConfigsByOrgWSRequest" : { - "type" : "object", - "description" : "Request to retrieve location ALM configs by org." + } }, - "Alertmonitoring_config_GetLocationALMConfigsByOrgWSResponse" : { + "Accesscontrol_doorexception_FindDoorScheduleExceptionsForDoorWSResponse" : { "type" : "object", - "description" : "Response containing location ALM configs for an org.", + "description" : "Response containing a list of door schedule exceptions found for a specific door.", "properties" : { "error" : { "type" : "boolean", @@ -46344,11 +47109,11 @@ "type" : "string", "nullable" : true }, - "locationConfigs" : { + "exceptions" : { "type" : "array", - "description" : "List of the latest location ALM configs in the org.", + "description" : "List of door schedule exceptions found for the specified door.", "items" : { - "$ref" : "#/components/schemas/LocationALMConfig" + "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "nullable" : true }, @@ -46358,27 +47123,13 @@ } } }, - "Alertmonitoring_config_GetMonitoringStateWSRequest" : { + "Accesscontrol_doorexception_FindDoorScheduleExceptionsForLocationWSRequest" : { "type" : "object", - "description" : "Request to retrieve a monitoring state.", + "description" : "Request to search for door schedule exceptions for a specific location with optional date range filtering.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "dateRangeFilter" : { + "$ref" : "#/components/schemas/DateRangeFilter" }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - } - }, - "required" : [ "locationUuid" ] - }, - "Alertmonitoring_config_GetMonitoringStatesByLocationWSRequest" : { - "type" : "object", - "description" : "Request to retrieve monitoring states by location.", - "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -46386,12 +47137,11 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_GetMonitoringStatesByLocationWSResponse" : { + "Accesscontrol_doorexception_FindDoorScheduleExceptionsForLocationWSResponse" : { "type" : "object", - "description" : "Response containing monitoring states for a location.", + "description" : "Response containing a list of door schedule exceptions found for a specific location.", "properties" : { "error" : { "type" : "boolean", @@ -46401,11 +47151,11 @@ "type" : "string", "nullable" : true }, - "monitoringStates" : { + "exceptions" : { "type" : "array", - "description" : "List of the latest monitoring states in the location.", + "description" : "List of door schedule exceptions found for the specified location.", "items" : { - "$ref" : "#/components/schemas/ALMMonitoringState" + "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "nullable" : true }, @@ -46415,13 +47165,18 @@ } } }, - "Alertmonitoring_config_GetMonitoringStatesByOrgWSRequest" : { + "Accesscontrol_doorexception_FindDoorScheduleExceptionsWSRequest" : { "type" : "object", - "description" : "Request to retrieve monitoring states by org." + "description" : "Request to search for door schedule exceptions with optional date range filtering.", + "properties" : { + "dateRangeFilter" : { + "$ref" : "#/components/schemas/DateRangeFilter" + } + } }, - "Alertmonitoring_config_GetMonitoringStatesByOrgWSResponse" : { + "Accesscontrol_doorexception_FindDoorScheduleExceptionsWSResponse" : { "type" : "object", - "description" : "Response containing monitoring states for an org.", + "description" : "Response containing a list of door schedule exceptions found in the search.", "properties" : { "error" : { "type" : "boolean", @@ -46431,11 +47186,11 @@ "type" : "string", "nullable" : true }, - "monitoringStates" : { + "exceptions" : { "type" : "array", - "description" : "List of the latest monitoring states in the org.", + "description" : "List of door schedule exceptions found in the search.", "items" : { - "$ref" : "#/components/schemas/ALMMonitoringState" + "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, "nullable" : true }, @@ -46445,40 +47200,22 @@ } } }, - "Alertmonitoring_config_GetZoneALMConfigWSRequest" : { - "type" : "object", - "description" : "Request to retrieve a zone ALM config.", - "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - } - }, - "required" : [ "locationUuid" ] - }, - "Alertmonitoring_config_GetZoneALMConfigsByLocationWSRequest" : { + "Accesscontrol_doorexception_GetDoorScheduleExceptionWSRequest" : { "type" : "object", - "description" : "Request to retrieve zone ALM configs by location.", + "description" : "Request to retrieve a specific door schedule exception by UUID.", "properties" : { - "locationUuid" : { + "exceptionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_GetZoneALMConfigsByLocationWSResponse" : { + "Accesscontrol_doorexception_GetDoorScheduleExceptionWSResponse" : { "type" : "object", - "description" : "Response containing zone ALM configs for a location.", + "description" : "Response containing the requested door schedule exception.", "properties" : { "error" : { "type" : "boolean", @@ -46488,27 +47225,27 @@ "type" : "string", "nullable" : true }, + "exception" : { + "$ref" : "#/components/schemas/DoorScheduleExceptionType" + }, "warningMsg" : { "type" : "string", "nullable" : true - }, - "zoneConfigs" : { - "type" : "array", - "description" : "List of the latest zone ALM configs in the location.", - "items" : { - "$ref" : "#/components/schemas/ZoneALMConfig" - }, - "nullable" : true } } }, - "Alertmonitoring_config_GetZoneALMConfigsByOrgWSRequest" : { + "Accesscontrol_doorexception_UpdateDoorScheduleExceptionWSRequest" : { "type" : "object", - "description" : "Request to retrieve zone ALM configs by org." + "description" : "Request to update an existing door schedule exception.", + "properties" : { + "exception" : { + "$ref" : "#/components/schemas/DoorScheduleExceptionType" + } + } }, - "Alertmonitoring_config_GetZoneALMConfigsByOrgWSResponse" : { + "Accesscontrol_doorexception_UpdateDoorScheduleExceptionWSResponse" : { "type" : "object", - "description" : "Response containing zone ALM configs for an org.", + "description" : "Response containing the updated door schedule exception and license information.", "properties" : { "error" : { "type" : "boolean", @@ -46518,103 +47255,203 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "exception" : { + "$ref" : "#/components/schemas/DoorScheduleExceptionType" }, - "zoneConfigs" : { + "expiredACDLicensesDoorUuids" : { "type" : "array", - "description" : "List of the latest zone ALM configs in the org.", + "description" : "Set of door UUIDs with expired access control licenses.", "items" : { - "$ref" : "#/components/schemas/ZoneALMConfig" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unassignedACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of door UUIDs with unassigned access control licenses.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, + "nullable" : true, + "uniqueItems" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Alertmonitoring_config_ManageLocationALMConfigWSResponse" : { + "Accesscontrol_firstin_ApplyDoorAuthFirstInGroupStateWSRequest" : { "type" : "object", - "description" : "Response containing a location ALM config.", + "description" : "Request to apply door auth first-in state to all doors in a first-in settings group.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "settingsUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationConfig" : { - "$ref" : "#/components/schemas/LocationALMConfig" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, - "Alertmonitoring_config_ManageMonitoringStateWSResponse" : { + "Accesscontrol_firstin_ApplyDoorAuthFirstInGroupStateWSResponse" : { "type" : "object", - "description" : "Response containing a monitoring state.", + "description" : "Response containing the updated location first-in settings after applying door auth first-in group state.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "monitoringState" : { - "$ref" : "#/components/schemas/ALMMonitoringState" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" } } }, - "Alertmonitoring_config_ManageZoneALMConfigWSResponse" : { + "Accesscontrol_firstin_ApplyDoorAuthFirstInStateWSRequest" : { "type" : "object", - "description" : "Response containing a zone ALM config.", + "description" : "Request to apply door auth first-in state to a specific door.", "properties" : { - "error" : { - "type" : "boolean", + "doorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" + } + } + }, + "Accesscontrol_firstin_ApplyDoorAuthFirstInStateWSResponse" : { + "type" : "object", + "description" : "Response containing the updated door after applying door auth first-in state.", + "properties" : { + "door" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + } + } + }, + "Accesscontrol_firstin_ApplyDoorScheduleFirstInGroupStateWSRequest" : { + "type" : "object", + "description" : "Request to apply door schedule first-in state to all doors in a first-in settings group.", + "properties" : { + "settingsUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" + } + } + }, + "Accesscontrol_firstin_ApplyDoorScheduleFirstInGroupStateWSResponse" : { + "type" : "object", + "description" : "Response containing the updated location first-in settings after applying door schedule first-in group state.", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + } + } + }, + "Accesscontrol_firstin_ApplyDoorScheduleFirstInStateWSRequest" : { + "type" : "object", + "description" : "Request to apply door schedule first-in state to a specific door.", + "properties" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "zoneConfig" : { - "$ref" : "#/components/schemas/ZoneALMConfig" + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, - "Alertmonitoring_config_SummarizeALMZoneStatusWSRequest" : { + "Accesscontrol_firstin_ApplyDoorScheduleFirstInStateWSResponse" : { "type" : "object", - "description" : "Request to summarize an ALM zone's status.", + "description" : "Response containing the updated door after applying door schedule first-in state.", "properties" : { - "locationUuid" : { + "door" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + } + } + }, + "Accesscontrol_firstin_ApplyElevatorLandingAccessScheduleFirstInStateWSRequest" : { + "type" : "object", + "description" : "Request to apply access schedule first-in state to a specific elevator landing.", + "properties" : { + "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_SummarizeALMZoneStatusWSResponse" : { + "Accesscontrol_firstin_ApplyElevatorLandingAccessScheduleFirstInStateWSResponse" : { "type" : "object", - "description" : "Response containing a summary of an ALM zone's status.", + "description" : "Response containing the updated elevator landing after applying access schedule first-in state.", + "properties" : { + "elevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + } + } + }, + "Accesscontrol_firstin_ApplyElevatorLandingAuthFirstInStateWSRequest" : { + "type" : "object", + "description" : "Request to apply auth first-in state to a specific elevator landing.", + "properties" : { + "elevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" + } + } + }, + "Accesscontrol_firstin_ApplyElevatorLandingAuthFirstInStateWSResponse" : { + "type" : "object", + "description" : "Response containing the updated elevator landing after applying auth first-in state.", + "properties" : { + "elevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + } + } + }, + "Accesscontrol_firstin_CreateLocationFirstInSettingsWSRequest" : { + "type" : "object", + "description" : "Request to create new location first-in settings.", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + } + } + }, + "Accesscontrol_firstin_CreateLocationFirstInSettingsWSResponse" : { + "type" : "object", + "description" : "Response containing the created location first-in settings.", "properties" : { "error" : { "type" : "boolean", @@ -46624,141 +47461,252 @@ "type" : "string", "nullable" : true }, + "expiredACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of expired ACD license door UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + }, + "unassignedACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of unassigned ACD license door UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, "warningMsg" : { "type" : "string", "nullable" : true - }, - "zoneSummary" : { - "$ref" : "#/components/schemas/ALMZoneSummary" } } }, - "Alertmonitoring_config_SummarizeALMZoneStatusesForLocationWSRequest" : { + "Accesscontrol_firstin_DeleteLocationFirstInSettingsWSRequest" : { "type" : "object", - "description" : "Request to summarize a location's ALM zone statuses.", + "description" : "Request to delete specific location first-in settings by UUID.", "properties" : { - "locationUuid" : { + "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Alertmonitoring_config_SummarizeALMZoneStatusesForLocationWSResponse" : { + "Accesscontrol_firstin_DeleteLocationFirstInSettingsWSResponse" : { "type" : "object", - "description" : "Response containing summaries of ALM zone statuses for a location.", + "description" : "Response containing the deleted location first-in settings.", "properties" : { - "error" : { - "type" : "boolean", + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + } + } + }, + "Accesscontrol_firstin_FindLocationFirstInSettingsByLocationWSRequest" : { + "type" : "object", + "description" : "Request to search for location first-in settings for a specific location with pagination support.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, - "errorMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "nullable" : true + } + } + }, + "Accesscontrol_firstin_FindLocationFirstInSettingsByLocationWSResponse" : { + "type" : "object", + "description" : "Response containing a list of location first-in settings found for the specified location with pagination information.", + "properties" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true }, - "zoneSummaries" : { + "settingsList" : { "type" : "array", - "description" : "List of summaries of the ALM zone statuses in the location.", + "description" : "List of location first-in settings found for the specified location.", "items" : { - "$ref" : "#/components/schemas/ALMZoneSummary" + "$ref" : "#/components/schemas/LocationFirstInSettings" }, "nullable" : true } } }, - "Alertmonitoring_config_SummarizeALMZoneStatusesForOrgWSRequest" : { - "type" : "object", - "description" : "Request to summarize an org's ALM zone statuses." - }, - "Alertmonitoring_config_SummarizeALMZoneStatusesForOrgWSResponse" : { + "Accesscontrol_firstin_FindLocationFirstInSettingsByOrgWSRequest" : { "type" : "object", - "description" : "Response containing summaries of ALM zone statuses for an org.", + "description" : "Request to search for location first-in settings across the organization with pagination support.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, - "warningMsg" : { + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "nullable" : true + } + } + }, + "Accesscontrol_firstin_FindLocationFirstInSettingsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing a list of location first-in settings found in the organization with pagination information.", + "properties" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true }, - "zoneSummaries" : { + "settingsList" : { "type" : "array", - "description" : "List of summaries of the ALM zone statuses in the org.", + "description" : "List of location first-in settings found in the organization.", "items" : { - "$ref" : "#/components/schemas/ALMZoneSummary" + "$ref" : "#/components/schemas/LocationFirstInSettings" }, "nullable" : true } } }, - "Alertmonitoring_config_UpdateLocationALMConfigWSRequest" : { + "Accesscontrol_firstin_GetLocationFirstInSettingsForDoorWSRequest" : { "type" : "object", - "description" : "Request to update a location ALM config.", + "description" : "Request to retrieve location first-in settings for a specific door.", "properties" : { - "update" : { - "$ref" : "#/components/schemas/LocationALMConfig" + "doorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } - }, - "required" : [ "update" ] + } }, - "Alertmonitoring_config_UpdateZoneALMConfigWSRequest" : { + "Accesscontrol_firstin_GetLocationFirstInSettingsForDoorWSResponse" : { "type" : "object", - "description" : "Request to update a zone ALM config.", + "description" : "Response containing the location first-in settings for the specified door.", "properties" : { - "update" : { - "$ref" : "#/components/schemas/ZoneALMConfig" + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" } - }, - "required" : [ "update" ] + } }, - "Alertmonitoring_pin_BasePinWSResponse" : { + "Accesscontrol_firstin_GetLocationFirstInSettingsWSRequest" : { "type" : "object", - "description" : "Base response containing alert monitoring PIN information.", + "description" : "Request to retrieve specific location first-in settings by UUID.", "properties" : { - "error" : { - "type" : "boolean", + "settingsUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "errorMsg" : { + } + } + }, + "Accesscontrol_firstin_GetLocationFirstInSettingsWSResponse" : { + "type" : "object", + "description" : "Response containing the requested location first-in settings.", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + } + } + }, + "Accesscontrol_firstin_RemoveDoorLocationFirstInSettingsWSRequest" : { + "type" : "object", + "description" : "Request to remove a door from its assigned location first-in settings.", + "properties" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pin" : { - "$ref" : "#/components/schemas/AlertMonitoringPIN" - }, - "warningMsg" : { + } + } + }, + "Accesscontrol_firstin_RemoveDoorLocationFirstInSettingsWSResponse" : { + "type" : "object", + "description" : "Response containing the updated location first-in settings after removing the door.", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + } + } + }, + "Accesscontrol_firstin_RemoveElevatorLandingLocationFirstInSettingsWSRequest" : { + "type" : "object", + "description" : "Request to remove an elevator landing from its assigned location first-in settings.", + "properties" : { + "elevatorLandingUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Alertmonitoring_pin_BulkPinsWSResponse" : { + "Accesscontrol_firstin_RemoveElevatorLandingLocationFirstInSettingsWSResponse" : { "type" : "object", - "description" : "Response containing multiple alert monitoring PINs for bulk operations.", + "description" : "Response containing the updated location first-in settings after removing the elevator landing.", "properties" : { - "error" : { + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + } + } + }, + "Accesscontrol_firstin_UpdateLocationFirstInSettingsWSRequest" : { + "type" : "object", + "description" : "Request to update existing location first-in settings with selective field updates.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Optional description for the first-in settings.", + "nullable" : true + }, + "doorAuthRequirementEnabled" : { "type" : "boolean", + "description" : "Optional flag to enable/disable door auth requirement.", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "doorScheduleRequirementEnabled" : { + "type" : "boolean", + "description" : "Optional flag to enable/disable door schedule requirement.", "nullable" : true }, - "failedUsers" : { + "doorUuids" : { "type" : "array", - "description" : "List of user UUIDs that failed during bulk operations.", + "description" : "Optional sorted set of door UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", @@ -46766,36 +47714,25 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "pins" : { + "elevatorLandingUuids" : { "type" : "array", - "description" : "List of alert monitoring PINs created or updated.", + "description" : "Optional sorted set of elevator landing UUIDs to assign to these settings.", "items" : { - "$ref" : "#/components/schemas/AlertMonitoringPIN" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Alertmonitoring_pin_BulkProvisionPinsWSRequest" : { - "type" : "object", - "description" : "Request to bulk provision alert monitoring PINs for multiple users.", - "properties" : { - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "End date in epoch seconds when these PINs expire. PINs never expire if this value is left null.", - "minimum" : 0, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "locationUuids" : { + "groupUuids" : { "type" : "array", - "description" : "Set of location uuids these PINs are assigned to.", + "description" : "Optional sorted set of group UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", @@ -46806,37 +47743,29 @@ "nullable" : true, "uniqueItems" : true }, - "notifyUsers" : { - "type" : "boolean", - "default" : false, - "description" : "If enabled, sends an email to the assigned users notifying them of their new PIN code.", - "nullable" : true - }, - "pinLength" : { - "type" : "integer", - "format" : "int32", - "description" : "Length of PINs to be generated. Accepts length between 4 and 16.", - "maximum" : 16, - "minimum" : 4, + "name" : { + "type" : "string", + "description" : "Optional name for the first-in settings.", "nullable" : true }, - "rotationPeriodDays" : { - "type" : "integer", - "format" : "int32", - "description" : "Period in days when PINs should be automatically rotated. If left null, PINs will not be auto-rotated.", - "minimum" : 1, + "resets" : { + "type" : "array", + "description" : "Optional list of first-in reset configurations.", + "items" : { + "$ref" : "#/components/schemas/BaseFirstInReset" + }, "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in epoch seconds when these PINs become active. PINs activate immediately if this value is left null.", - "minimum" : 0, + "settingsUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "userUuids" : { "type" : "array", - "description" : "Set of user uuids to provision PINs for.", + "description" : "Optional sorted set of user UUIDs to assign to these settings.", "items" : { "type" : "string", "format" : "RUUID", @@ -46847,30 +47776,39 @@ "nullable" : true, "uniqueItems" : true } - }, - "required" : [ "locationUuids", "pinLength", "userUuids" ] + } }, - "Alertmonitoring_pin_BulkRotatePinsWSRequest" : { + "Accesscontrol_firstin_UpdateLocationFirstInSettingsWSResponse" : { "type" : "object", - "description" : "Request to bulk rotate multiple alert monitoring PINs.", + "description" : "Response containing the updated location first-in settings.", "properties" : { - "notifyUsers" : { + "error" : { "type" : "boolean", - "default" : false, - "description" : "If enabled, sends an email to the assigned users notifying them of their new PIN code.", "nullable" : true }, - "pinLength" : { - "type" : "integer", - "format" : "int32", - "description" : "Length of PINs to be generated. Accepts length between 4 and 16.", - "maximum" : 16, - "minimum" : 4, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "pinUuids" : { + "expiredACDLicensesDoorUuids" : { "type" : "array", - "description" : "Uuids of PINs to rotate in bulk.", + "description" : "Set of expired ACD license door UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "settings" : { + "$ref" : "#/components/schemas/LocationFirstInSettings" + }, + "unassignedACDLicensesDoorUuids" : { + "type" : "array", + "description" : "Set of unassigned ACD license door UUIDs", "items" : { "type" : "string", "format" : "RUUID", @@ -46880,321 +47818,417 @@ }, "nullable" : true, "uniqueItems" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } - }, - "required" : [ "pinLength", "pinUuids" ] + } }, - "Alertmonitoring_pin_CreatePinWSRequest" : { + "Accesscontrol_guestpass_CreateGuestPassWSRequest" : { "type" : "object", - "description" : "Request to create a new alert monitoring PIN.", + "description" : "Request to create a guest pass with N access periods (each its own door/landing set and absolute intervals), plus any credentials to mint or assign in the same operation.", "properties" : { - "notifyUser" : { + "accessPeriods" : { + "type" : "array", + "description" : "Access periods for the pass. The pass window must span at most 7 days and start within 90 days.", + "items" : { + "$ref" : "#/components/schemas/LocationGuestPassAccessPeriod" + }, + "nullable" : true + }, + "createWithExistingCredentials" : { + "type" : "array", + "description" : "Hex values of existing, currently-unassigned credentials to assign to the new guest pass. Each entry is validated up front; missing-credential / already-assigned aborts the create with rollback.", + "items" : { + "$ref" : "#/components/schemas/ExistingGuestPassCredentialAssignment" + }, + "nullable" : true + }, + "createWithNewCredentials" : { + "type" : "array", + "description" : "Polymorphic specs for credentials to be minted and bound to the new guest pass. Each entry is discriminated on the 'type' field (currently only PIN_CODE is supported). All entries are validated up front; any invalid entry aborts the create with rollback.", + "items" : { + "$ref" : "#/components/schemas/NewGuestPassCredentialSpec" + }, + "nullable" : true + }, + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + }, + "sendEmail" : { "type" : "boolean", - "default" : false, - "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their new PIN code. If no user is assigned, notifications will not be sent.", + "description" : "Email the guest their PIN and QR code once the pass is created. Needs a PLAIN pass with a guestEmail; the request is rejected otherwise. If the send fails the pass is still created, and emailSent on the response is false.", + "nullable" : true + } + } + }, + "Accesscontrol_guestpass_CreateGuestPassWSResponse" : { + "type" : "object", + "description" : "Created guest pass plus any credentials minted/assigned to it in the same call. createdNewCredentials and assignedExistingCredentials are in the order of the corresponding request lists.", + "properties" : { + "assignedExistingCredentials" : { + "type" : "array", + "description" : "Existing credentials newly assigned to the pass as part of this create, in the order of CreateGuestPassWSRequest.createWithExistingCredentials.", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "nullable" : true }, - "pin" : { - "$ref" : "#/components/schemas/AlertMonitoringPIN" + "createdNewCredentials" : { + "type" : "array", + "description" : "Credentials minted as part of this create, in the order of CreateGuestPassWSRequest.createWithNewCredentials. For PIN_CODE entries the returned credential carries the (possibly server-generated) PIN value so the caller can surface it to the guest.", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, + "nullable" : true + }, + "emailSent" : { + "type" : "boolean", + "description" : "Whether the guest was emailed their credentials. False when sendEmail wasn't set, when the pass has no PIN or QR code to send, or when the send failed.", + "nullable" : true + }, + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } - }, - "required" : [ "pin" ] + } }, - "Alertmonitoring_pin_DeletePinWSRequest" : { + "Accesscontrol_guestpass_DeleteGuestPassWSRequest" : { "type" : "object", - "description" : "Request to delete an alert monitoring PIN by UUID.", "properties" : { - "pinUuid" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "pinUuid" ] + } }, - "Alertmonitoring_pin_FindPinsByLocationAndUserWSRequest" : { + "Accesscontrol_guestpass_DeleteGuestPassWSResponse" : { "type" : "object", - "description" : "Request to find alert monitoring PINs filtered by location and/or user.", "properties" : { - "locationUuid" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + } + } + }, + "Accesscontrol_guestpass_ExpireGuestPassWSRequest" : { + "type" : "object", + "description" : "Retire a guest pass early, revoking its access. This is the normal operator retirement action.", + "properties" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "userUuid" : { + } + } + }, + "Accesscontrol_guestpass_ExpireGuestPassWSResponse" : { + "type" : "object", + "properties" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + } + } + }, + "Accesscontrol_guestpass_FindGuestPassesByLocationWSRequest" : { + "type" : "object", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "startAfterMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Alertmonitoring_pin_FindPinsByOrgWSRequest" : { + "Accesscontrol_guestpass_FindGuestPassesByOrgWSRequest" : { "type" : "object", - "description" : "Request to find alert monitoring PINs in the organization with optional filtering and pagination.", "properties" : { - "filter" : { - "$ref" : "#/components/schemas/PinQueryFilter" - }, "pageRequest" : { "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "startAfterMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "startBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Alertmonitoring_pin_FindPinsWSResponse" : { + "Accesscontrol_guestpass_FindGuestPassesByPrincipalWSRequest" : { "type" : "object", - "description" : "Response containing a list of alert monitoring PINs with optional pagination information.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "principalId" : { "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Last evaluated key for pagination in subsequent requests.", + "principalType" : { + "$ref" : "#/components/schemas/LocationGuestPassPrincipalTypeEnum" + }, + "startAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "pins" : { + "startBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "Accesscontrol_guestpass_FindGuestPassesWSResponse" : { + "type" : "object", + "properties" : { + "guestPasses" : { "type" : "array", - "description" : "List of alert monitoring PINs found.", "items" : { - "$ref" : "#/components/schemas/AlertMonitoringPIN" + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, "nullable" : true }, - "warningMsg" : { + "lastEvaluatedKey" : { "type" : "string", "nullable" : true } } }, - "Alertmonitoring_pin_GetAvailableALMPinCodeWSRequest" : { + "Accesscontrol_guestpass_GetGuestPassFullWSRequest" : { "type" : "object", - "description" : "Request to get an available PIN code for alert monitoring.", "properties" : { - "pinLength" : { - "type" : "integer", - "format" : "int32", - "description" : "Length of PIN to be generated.", + "guestPassUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "pinLength" ] + } }, - "Alertmonitoring_pin_GetAvailableALMPinCodeWSResponse" : { + "Accesscontrol_guestpass_GetGuestPassFullWSResponse" : { "type" : "object", - "description" : "Response containing an available PIN code for alert monitoring.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "pinCode" : { - "type" : "string", - "description" : "The generated PIN code for alert monitoring.", + "credentials" : { + "type" : "array", + "description" : "Credentials assigned to the pass.", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialType" + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, - "Alertmonitoring_pin_GetPinWSRequest" : { + "Accesscontrol_guestpass_GetGuestPassWSRequest" : { "type" : "object", - "description" : "Request to retrieve an alert monitoring PIN by UUID.", "properties" : { - "pinUuid" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "pinUuid" ] + } }, - "Alertmonitoring_pin_RotatePinWSRequest" : { + "Accesscontrol_guestpass_GetGuestPassWSResponse" : { "type" : "object", - "description" : "Request to rotate an alert monitoring PIN.", + "description" : "The bare guest pass. Use getGuestPassFull for the materialized access periods + credentials.", "properties" : { - "notifyUser" : { - "type" : "boolean", - "default" : false, - "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their new PIN code. If no user is assigned, notifications will not be sent.", - "nullable" : true - }, - "pinUuid" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + } + } + }, + "Accesscontrol_guestpass_ResendGuestPassEmailWSRequest" : { + "type" : "object", + "description" : "Email a guest pass's PIN and QR code to its guest again.", + "properties" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "pinUuid" ] + } }, - "Alertmonitoring_pin_UpdatePinWSRequest" : { + "Accesscontrol_guestpass_ResendGuestPassEmailWSResponse" : { "type" : "object", - "description" : "Request to update an existing alert monitoring PIN.", "properties" : { - "notifyUser" : { - "type" : "boolean", - "default" : false, - "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their current PIN code. If no user is assigned, notifications will not be sent.", - "nullable" : true - }, - "pin" : { - "$ref" : "#/components/schemas/AlertMonitoringPIN" - }, - "selectiveUpdate" : { - "type" : "boolean", - "default" : false, - "description" : "If set to true, only the non-null fields will be considered for this update.", + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + } + } + }, + "Accesscontrol_guestpass_SuspendGuestPassWSRequest" : { + "type" : "object", + "description" : "Pause a guest pass: flips lifecycle to SUSPENDED and suspends its credentials, leaving grants + schedule intact. Reversible via unsuspendGuestPass.", + "properties" : { + "guestPassUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "pin" ] + } }, - "AlteredView" : { + "Accesscontrol_guestpass_SuspendGuestPassWSResponse" : { "type" : "object", - "description" : "Map of device facet UUIDs to altered view configurations", "properties" : { - "crop" : { - "$ref" : "#/components/schemas/CroppedPermyriadRect" - }, - "dewarp" : { - "$ref" : "#/components/schemas/DewarpedView" + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } } }, - "AmtSettings" : { + "Accesscontrol_guestpass_UnsuspendGuestPassWSRequest" : { "type" : "object", + "description" : "Resume a paused guest pass: flips lifecycle back to ACTIVE and unsuspends its credentials. Rejected if the pass is no longer SUSPENDED (e.g. already expired).", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "email" : { - "type" : "string", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "enablingUser" : { - "type" : "string", - "nullable" : true - }, - "enablingUserUuid" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "password" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { + } + } + }, + "Accesscontrol_guestpass_UnsuspendGuestPassWSResponse" : { + "type" : "object", + "properties" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + } + } + }, + "Accesscontrol_guestpass_UpdateGuestPassNoteWSRequest" : { + "type" : "object", + "description" : "Update only the operator note on a guest pass. Lifecycle-independent -- allowed even after the pass is EXPIRED or ARCHIVED. Empty note clears it.", + "properties" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "note" : { + "type" : "string", "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Accesscontrol_guestpass_UpdateGuestPassNoteWSResponse" : { + "type" : "object", + "properties" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + } + } + }, + "Accesscontrol_guestpass_UpdateGuestPassWSRequest" : { + "type" : "object", + "description" : "Update a guest pass's access. accessPeriodUpdates create/update/delete individual access periods. The note is edited via updateGuestPassNote.", + "properties" : { + "accessPeriodUpdates" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LocationGuestPassAccessPeriodUpdate" + }, "nullable" : true }, - "webhookSignatureSecret" : { + "guestPassUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "AperioActivatorStateEvent" : { + "Accesscontrol_guestpass_UpdateGuestPassWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "state" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } + "description" : "Updated guest pass plus its access periods as they stand after the update.", + "properties" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" } - } ], - "nullable" : true, + } + }, + "Accesscontrol_lockdownplan_ActivateLockdownForLocationViaRhombusKeyWSRequest" : { + "type" : "object", + "description" : "Request to activate lockdown for a specific location via Rhombus Key with optional optimistic locking.", "properties" : { - "componentUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", - "nullable" : true + "lockdownPlanUuids" : { + "type" : "array", + "description" : "Set of lockdown plan UUIDs to activate for the location.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "createdAtMs" : { + "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", + "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_ActivateLockdownForLocationViaRhombusKeyWSResponse" : { + "type" : "object", + "description" : "Response containing the result of activating lockdown for a location via Rhombus Key.", + "properties" : { + "result" : { + "$ref" : "#/components/schemas/LockdownActivationResultEnumType" }, + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } + }, + "Accesscontrol_lockdownplan_ActivateLockdownForLocationWSRequest" : { + "type" : "object", + "description" : "Request to activate lockdown for a specific location with optional optimistic locking.", + "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -47202,418 +48236,327 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "lockdownPlanUuids" : { + "type" : "array", + "description" : "Set of lockdown plan UUIDs to activate for the location.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "timestampMs" : { + "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", + "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_ActivateLockdownForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing the result of activating lockdown for a location.", + "properties" : { + "result" : { + "$ref" : "#/components/schemas/LockdownActivationResultEnumType" }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" } } }, - "AperioDoorExtension" : { + "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioDoorDeviceId" : { + "description" : "Request to activate lockdown for multiple locations via Rhombus Key with optional optimistic locking.\n", + "properties" : { + "lockdownPlansByLocation" : { + "type" : "object", + "additionalProperties" : { "type" : "array", + "description" : "Mapping of lockdown plan UUIDs by location UUID. Indicates which lockdown plans to activate for\neach location.\n", "items" : { "type" : "string", - "format" : "byte", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "aperioDoorId" : { - "type" : "string", - "nullable" : true + "description" : "Mapping of lockdown plan UUIDs by location UUID. Indicates which lockdown plans to activate for\neach location.\n", + "nullable" : true + }, + "stateUpdatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Optional timestamp used for optimistic locking. It ensures that a user can update only the most\nrecent record for a given location. The lockdown state is updated only if the provided timestamp\nmatches the timestamp of the most recent update.\n", + "nullable" : true + } + }, + "required" : [ "lockdownPlansByLocation" ] + }, + "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse" : { + "type" : "object", + "description" : "Response containing the results of activating lockdown for multiple locations via Rhombus key.\n", + "properties" : { + "lockdownResults" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownActivationResult" }, - "aperioGatewayId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - } + "description" : "The results of the lockdown activation attempt per location.", + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Accesscontrol_lockdownplan_ActivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownActivationResult" : { + "type" : "object", + "description" : "The results of the lockdown activation attempt per location.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" + "info" : { + "type" : "string", + "description" : "Additional info regarding the outcome of the activation attempt.", + "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "result" : { + "$ref" : "#/components/schemas/LockdownActivationResultEnumType" + }, + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } + }, + "Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSRequest" : { + "type" : "object", + "description" : "Request to create a new location lockdown plan.", + "properties" : { + "lockdownPlan" : { + "$ref" : "#/components/schemas/LocationLockdownPlanType" + } + } + }, + "Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSResponse" : { + "type" : "object", + "description" : "Response containing the created location lockdown plan.", + "properties" : { + "lockdownPlan" : { + "$ref" : "#/components/schemas/LocationLockdownPlanType" + } + } + }, + "Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSRequest" : { + "type" : "object", + "description" : "Request to create a new lockdown rule for a specific location.", + "properties" : { + "rule" : { + "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" + } + }, + "required" : [ "rule" ] + }, + "Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing the UUID of the created lockdown rule.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationViaRhombusKeyWSRequest" : { + "type" : "object", + "description" : "Request to deactivate lockdown for a specific location via Rhombus Key with optional optimistic locking.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "portImmutable" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { + "stateUpdatedAtMillis" : { "type" : "integer", "format" : "int64", + "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", + } + } + }, + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationViaRhombusKeyWSResponse" : { + "type" : "object", + "description" : "Response containing the result of deactivating lockdown for a location via Rhombus Key.", + "properties" : { + "result" : { + "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" + }, + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } + }, + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSRequest" : { + "type" : "object", + "description" : "Request to deactivate lockdown for a specific location with optional optimistic locking.", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "stateUpdatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Optional timestamp for optimistic locking to ensure the user is updating the latest record.", + "nullable" : true } - }, - "required" : [ "aperioDoorDeviceId", "aperioDoorId", "aperioGatewayId" ] + } }, - "AperioDoorExtensionShadow" : { + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "activatorState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "activatorStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "aperioDoorDeviceId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "aperioGatewayId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "aperioId" : { - "type" : "string", - "nullable" : true - }, - "clockRetrievedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "connected" : { - "type" : "boolean", - "nullable" : true - }, - "connectionStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceClockSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceTimezone" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "doorMode" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "doorModeUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "dtcs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DtcInfo" - }, - "nullable" : true - }, - "dtcsUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "gatewayComponentId" : { + "description" : "Response containing the result of deactivating lockdown for a location.", + "properties" : { + "result" : { + "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" + }, + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } + }, + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSRequest" : { + "type" : "object", + "description" : "Request to deactivate lockdown for multiple locations via Rhombus Key with optional optimistic locking.\n", + "properties" : { + "locationUuids" : { + "type" : "array", + "description" : "Set of location UUIDs to deactivate lockdown for.", + "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "handleState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "handleStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "keyCylinderState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "keyCylinderStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "removed" : { - "type" : "boolean", - "nullable" : true - }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "tamperState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "nullable" : true, + "uniqueItems" : true + }, + "stateUpdatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Optional timestamp used for optimistic locking. It ensures that a user can update only the most\nrecent record for a given location. The lockdown state is updated only if the provided timestamp\nmatches the timestamp of the most recent update.\n", + "nullable" : true + } + }, + "required" : [ "locationUuids" ] + }, + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse" : { + "type" : "object", + "description" : "Response containing the results of deactivating lockdown for multiple locations via Rhombus key.\n", + "properties" : { + "lockdownResults" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownDeactivationResult" }, - "tamperStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } + "description" : "The results of the lockdown activation attempt per location.", + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Accesscontrol_lockdownplan_DeactivateLockdownForLocationsViaRhombusKeyWSResponse_LocationLockdownDeactivationResult" : { + "type" : "object", + "description" : "The results of the lockdown activation attempt per location.", "properties" : { - "componentUuid" : { + "info" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Additional info regarding the outcome of the deactivation attempt.", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "result" : { + "$ref" : "#/components/schemas/LockdownDeactivationResultEnumType" }, - "orgUuid" : { + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } + }, + "Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSRequest" : { + "type" : "object", + "description" : "Request to delete the lockdown state tracking for a specific location.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ownerDeviceUuid" : { + } + } + }, + "Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSResponse" : { + "type" : "object", + "description" : "Response indicating successful deletion of location lockdown state." + }, + "Accesscontrol_lockdownplan_DeleteLockdownPlanWSRequest" : { + "type" : "object", + "description" : "Request to delete a specific lockdown plan by UUID.", + "properties" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "AperioDoorExtensionStateEvent" : { + "Accesscontrol_lockdownplan_DeleteLockdownPlanWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "activatorState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "activatorStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "aperioId" : { - "type" : "string", - "nullable" : true - }, - "clockRetrievedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "connected" : { - "type" : "boolean", - "nullable" : true - }, - "connectionStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceClockSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceTimezone" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "doorMode" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "doorModeUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "dtcs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DtcInfo" - }, - "nullable" : true - }, - "handleState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "handleStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "keyCylinderState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "keyCylinderStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "removed" : { - "type" : "boolean", - "nullable" : true - }, - "tamperState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "tamperStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Response confirming the deletion of a lockdown plan.", "properties" : { - "componentUuid" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, + } + } + }, + "Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSRequest" : { + "type" : "object", + "description" : "Request to delete a specific lockdown rule for a location.", + "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -47621,29 +48564,77 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSResponse" : { + "type" : "object", + "description" : "Response indicating successful deletion of a lockdown rule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "ownerDeviceUuid" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_DeleteLockdownRuleForPlanWSRequest" : { + "type" : "object", + "description" : "Request to delete a specific lockdown rule owned by a lockdown plan.", + "properties" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "lockdownPlanUuid", "ruleUuid" ] + }, + "Accesscontrol_lockdownplan_DeleteLockdownRuleForPlanWSResponse" : { + "type" : "object", + "description" : "Response indicating successful deletion of a plan-owned lockdown rule.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "uuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSRequest" : { + "type" : "object", + "description" : "Request to disable test mode for lockdown at a specific location.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -47652,47 +48643,43 @@ } } }, - "AperioDoorHandleStateEvent" : { + "Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "state" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } + "description" : "Response containing the updated lockdown state after disabling test mode.", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" } - } ], - "nullable" : true, + } + }, + "Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSRequest" : { + "type" : "object", + "description" : "Request to enable test mode for lockdown at a specific location.", "properties" : { - "componentUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing the updated lockdown state after enabling test mode.", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" + } + } + }, + "Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" : { + "type" : "object", + "description" : "External representation of a lockdown plan rule configuration.", + "properties" : { + "action" : { + "$ref" : "#/components/schemas/RuleActionType" }, "locationUuid" : { "type" : "string", @@ -47701,109 +48688,259 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "ruleFilters" : { + "$ref" : "#/components/schemas/RuleFilterType" + }, + "ruleName" : { + "type" : "string", + "description" : "The name of the lockdown rule.", + "nullable" : true + }, + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { + "triggerActivity" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + }, + "required" : [ "action", "locationUuid", "ruleName", "triggerActivity" ] + }, + "Accesscontrol_lockdownplan_FindLocationLockdownEventsWSRequest" : { + "type" : "object", + "description" : "Request to find lockdown events for a specific location with optional time filtering.", + "properties" : { + "createdAfterMs" : { "type" : "integer", "format" : "int64", + "description" : "Returns events created after (exclusive) the specified millisecond epoch timestamp", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Returns events created before (exclusive) the specified millisecond epoch timestamp", + "nullable" : true }, - "uuid" : { + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Limits the number of returned events to the latest LIMIT events", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } + }, + "required" : [ "locationUuid" ] + }, + "Accesscontrol_lockdownplan_FindLocationLockdownEventsWSResponse" : { + "type" : "object", + "description" : "Response containing a list of lockdown events for a specific location.", + "properties" : { + "events" : { + "type" : "array", + "description" : "List of lockdown events found for the specified location.", + "items" : { + "$ref" : "#/components/schemas/BaseLockdownStateEventType" + }, + "nullable" : true + } } }, - "AperioDoorModeEvent" : { + "Accesscontrol_lockdownplan_FindLocationLockdownStatesWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "description" : "Request to find location lockdown states with optional filtering.", + "properties" : { + "stateFilter" : { + "type" : "array", + "description" : "Optional filter to limit results to specific lockdown states.", + "items" : { + "$ref" : "#/components/schemas/LocationLockdownStateEnumType" }, - "state" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_FindLocationLockdownStatesWSResponse" : { + "type" : "object", + "description" : "Response containing a list of location lockdown states.", + "properties" : { + "states" : { + "type" : "array", + "description" : "List of location lockdown states found for the organization.", + "items" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSRequest" : { + "type" : "object", + "description" : "Request to search for lockdown plans for a specific location.", "properties" : { - "componentUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "correlationId" : { - "type" : "string", + } + } + }, + "Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSResponse" : { + "type" : "object", + "description" : "Response containing a list of lockdown plans found for the specified location.", + "properties" : { + "lockdownPlans" : { + "type" : "array", + "description" : "List of lockdown plans found for the specified location.", + "items" : { + "$ref" : "#/components/schemas/BaseLockdownPlanType" + }, "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Accesscontrol_lockdownplan_FindLockdownPlansWSRequest" : { + "type" : "object", + "description" : "Request to search for lockdown plans across the organization." + }, + "Accesscontrol_lockdownplan_FindLockdownPlansWSResponse" : { + "type" : "object", + "description" : "Response containing a list of lockdown plans found in the organization.", + "properties" : { + "lockdownPlans" : { + "type" : "array", + "description" : "List of lockdown plans found in the organization.", + "items" : { + "$ref" : "#/components/schemas/BaseLockdownPlanType" + }, "nullable" : true - }, - "locationUuid" : { + } + } + }, + "Accesscontrol_lockdownplan_GetLockdownPlanWSRequest" : { + "type" : "object", + "description" : "Request to retrieve a specific lockdown plan by UUID.", + "properties" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Accesscontrol_lockdownplan_GetLockdownPlanWSResponse" : { + "type" : "object", + "description" : "Response containing the requested lockdown plan.", + "properties" : { + "lockdownPlan" : { + "$ref" : "#/components/schemas/BaseLockdownPlanType" + } + } + }, + "Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSRequest" : { + "type" : "object", + "description" : "Request to retrieve all lockdown rules for a specific location.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing a list of lockdown rules for a specific location.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "ownerDeviceUuid" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "rules" : { + "type" : "array", + "description" : "List of lockdown rules configured for the specified location.", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_GetLockdownRulesForPlanWSRequest" : { + "type" : "object", + "description" : "Request to retrieve all lockdown rules for a specific lockdown plan.", + "properties" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "lockdownPlanUuid" ] + }, + "Accesscontrol_lockdownplan_GetLockdownRulesForPlanWSResponse" : { + "type" : "object", + "description" : "Response containing a list of lockdown rules for a specific lockdown plan.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "rules" : { + "type" : "array", + "description" : "List of lockdown rules configured for the specified lockdown plan.", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType" + }, + "nullable" : true }, - "uuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSRequest" : { + "type" : "object", + "description" : "Request to retrieve an existing lockdown state or create one for a specific location.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -47812,171 +48949,194 @@ } } }, - "AperioDoorPositionIndicator" : { + "Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioDoorId" : { - "type" : "string", - "nullable" : true - }, - "aperioGatewayId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "dpiType" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" - }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" - } + "description" : "Response containing the lockdown state for the specified location.", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateType" } - } ], - "nullable" : true, + } + }, + "Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSRequest" : { + "type" : "object", + "description" : "Request to update an existing location lockdown plan with selective field updates.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" + "activationPlan" : { + "$ref" : "#/components/schemas/LockdownActivationPlanType" }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "deactivationPlan" : { + "$ref" : "#/components/schemas/LockdownDeactivationPlanType" }, - "name" : { - "type" : "string", + "defaultLockdownState" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "doorLockdownStateMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, "nullable" : true }, - "orgUuid" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "physicalAccess" : { + "$ref" : "#/components/schemas/LockdownPhysicalAccessType" + }, + "testPlan" : { + "$ref" : "#/components/schemas/LockdownTestPlanType" + } + } + }, + "Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSResponse" : { + "type" : "object", + "description" : "Response containing the updated location lockdown plan.", + "properties" : { + "lockdownPlan" : { + "$ref" : "#/components/schemas/LocationLockdownPlanType" + } + } + }, + "Accesscontrol_qr_GenerateQRAccessCodeWSRequest" : { + "type" : "object", + "description" : "Request to generate a QR access code.", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "portImmutable" : { - "type" : "boolean", + "auditPrincipal" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { + "validDurationSec" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Valid duration in seconds", + "example" : 300, "nullable" : true - }, - "uuid" : { + } + } + }, + "Accesscontrol_qr_GenerateQRAccessCodeWSResponse" : { + "type" : "object", + "description" : "Response for QR access code generation.", + "properties" : { + "accessTokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "qrCode" : { + "type" : "array", + "description" : "QR code as PNG byte array", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "QR code as PNG byte array", + "nullable" : true + }, + "nullable" : true } } }, - "AperioDoorReader" : { + "Accesscontrol_qr_GetQRAccessCodesWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioDoorId" : { - "type" : "string", - "nullable" : true - }, - "aperioGatewayId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "disableCardReader" : { - "type" : "boolean", - "nullable" : true - }, - "disableKeypad" : { - "type" : "boolean", - "nullable" : true - }, - "disableWaveToUnlock" : { - "type" : "boolean", - "nullable" : true - }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "readerType" : { - "$ref" : "#/components/schemas/DoorReaderEnumType" + "description" : "Request to get QR access codes." + }, + "Accesscontrol_qr_GetQRAccessCodesWSResponse" : { + "type" : "object", + "description" : "Response for getting QR access codes.", + "properties" : { + "qrAccessCodes" : { + "type" : "array", + "description" : "List of QR access codes", + "items" : { + "$ref" : "#/components/schemas/Accesscontrol_qr_QRAccessCodeType" }, - "remoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - } + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Accesscontrol_qr_QRAccessCodeType" : { + "type" : "object", + "description" : "QR code access configuration for a specific door.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "accesTokenUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "auditPrincipal" : { "type" : "string", + "description" : "Information about the user of the QR code so that audit events can be tracked.", "nullable" : true }, - "orgUuid" : { + "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "expirationTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "The expiration time of this QR code in seconds since epoch.", + "nullable" : true + } + } + }, + "ActivateLocationLockdownActionRecordType" : { + "type" : "object", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "lockdownPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "portImmutable" : { + "succeeded" : { "type" : "boolean", "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "ActivateLocationLockdownActionType" : { + "type" : "object", + "properties" : { + "locationLockdownPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -47985,388 +49145,533 @@ } } }, - "AperioDoorRelay" : { + "ActivityEnum" : { + "type" : "string", + "enum" : [ "SOUND_LOUD", "SOUND_GUN_SHOT", "TAMPER", "VISUAL_TAMPER", "MOTION_TAMPER", "MOTION", "MOTION_HUMAN", "MOTION_CAR", "MOTION_ANIMAL", "MOTION_PACKAGE", "PACKAGE_ARRIVED", "PACKAGE_DEPARTED", "FACE", "FACE_IDENTIFIED", "FACE_UNIDENTIFIED", "FACE_BLACKLISTED", "FACE_ALERT", "POSE_ANOMALOUS", "POSE_FALL", "LICENSEPLATE", "LICENSEPLATE_IDENTIFIED", "LICENSEPLATE_UNIDENTIFIED", "LICENSEPLATE_ALERT", "LICENSEPLATE_BLACKLISTED", "LICENSEPLATE_TRUSTED", "PEOPLECOUNT_HIGH", "PEOPLECOUNT_HIGH_RESET", "PEOPLECOUNT_LOW", "PEOPLECOUNT_LOW_RESET", "HUMAN_ENTER", "HUMAN_EXIT", "CAR_ENTER", "CAR_EXIT", "TEMPERATURE_EXCEEDED_HIGH", "TEMPERATURE_EXCEEDED_LOW", "HUMIDITY_EXCEEDED_HIGH", "HUMIDITY_EXCEEDED_LOW", "PM25_EXCEEDED_HIGH", "TVOC_EXCEEDED_HIGH", "ETOH_EXCEEDED_HIGH", "IAQ_EXCEEDED_HIGH", "CO2_EXCEEDED_HIGH", "CO2_EXCEEDED_LOW", "PROBE_TEMPERATURE_EXCEEDED_HIGH", "PROBE_TEMPERATURE_EXCEEDED_LOW", "PROBE_DISCONNECTED", "PROBE_CONNECTED", "HEAT_INDEX_EXCEEDED_HIGH", "PRESSURE_EXCEEDED_HIGH", "PRESSURE_EXCEEDED_LOW", "PM10_EXCEEDED_HIGH", "PM40_EXCEEDED_HIGH", "PM100_EXCEEDED_HIGH", "VOC_IDX_EXCEEDED_HIGH", "NOX_IDX_EXCEEDED_HIGH", "FORMALDEHYDE_EXCEEDED_HIGH", "CARBON_MONOXIDE_EXCEEDED_HIGH", "AQI_EXCEEDED_HIGH", "DOOR_AJAR", "DOOR_OPENED", "DOOR_CLOSED", "BUTTON_SINGLE_PRESSED", "BUTTON_DOUBLE_PRESSED", "BUTTON_LONG_PRESSED", "TAG_ARRIVED", "TAG_DEPARTED", "TAG_MOVED", "TAG_POSITIONING_CHANGED", "TAG_BOUNDARY_INGRESS", "TAG_BOUNDARY_EGRESS", "TAG_PANIC", "BADGE_AUTHORIZED", "BADGE_UNAUTHORIZED", "BADGE_UNAUTHORIZED_V2", "BADGE_AJAR", "BADGE_MANUAL", "BADGE_FORCED_OPEN", "BADGE_LOCKDOWN", "BADGE_REQUEST_TO_EXIT", "BADGE_DURESS", "BADGE_SECURITY_BREACH", "BADGE_TAMPER", "BADGE_FACE_MISMATCH", "POS_ORDER", "GUN_DETECT_EVENT", "IOT_SOUND_AGGRESSION", "IOT_SOUND_HELP", "IOT_AIR_CO", "IOT_AIR_CO2", "IOT_AIR_MASKING", "IOT_AIR_THC", "IOT_AIR_VAPE", "IOT_AIR_VOC", "IOT_AIR_TEMP", "IOT_TAMPER", "IOT_GUNSHOT", "IOT_BUTTON_SINGLE_CLICK", "IOT_BUTTON_DOUBLE_CLICK", "IOT_BUTTON_HOLD", "IOT_PANIC_BUTTON_TRIGGERED", "AUDIO_SOUND_SIGNIFICANT", "AUDIO_SOUND_LOUD", "AUDIO_SOUND_ABUSIVE", "AUDIO_SOUND_GREETING", "AUDIO_SOUND_HELP", "AUDIO_SOUND_GUN", "AUDIO_SOUND_GLASS_BREAK", "AUDIO_SOUND_ALARM_SMOKE_FIRE", "AUDIO_SOUND_ALARM_CARBON_MONOXIDE", "AUDIO_SOUND_SIREN", "CLIMATE_VOC", "CLIMATE_VAPE", "CLIMATE_SMOKE", "CLIMATE_THC", "CLIMATE_CO2", "CLIMATE_ETOH", "CLIMATE_PM25", "CLIMATE_IAQ", "CLIMATE_LEAK", "SOUND_AGGRESSION", "SOUND_HELP", "AIR_CO", "AIR_CO2", "AIR_MASKING", "AIR_THC", "AIR_VAPE", "AIR_VOC", "MASK_MISSING", "HELMET_MISSING", "GLOVES_MISSING", "PIR_OCCUPIED", "PIR_MOVEMENT", "PIR_VACANT", "CUSTOM", "VISITOR_ARRIVED", "VISITOR_DEPARTED", "AC_DR_CONNECTED", "AC_DR_DISCONNECTED", "AC_DPI_DOOR_OPEN", "AC_DPI_DOOR_CLOSED", "AC_DPI_DOOR_AJAR", "AC_DPI_DOOR_FORCED_OPEN", "AC_DSR_UNLOCKED", "AC_DSR_LOCKED", "AC_DB_TRIGGERED", "AC_PANIC_BUTTON_TRIGGERED", "AC_REMOTE_UNLOCK", "AC_BADGE_AUTHORIZED", "AC_BADGE_UNAUTHORIZED", "AC_BADGE_FACE_MISMATCH", "AC_LOCKDOWN_ACTIVATED", "AC_LOCKDOWN_DEACTIVATED", "AC_LOCKDOWN_PLAN_SWITCHED", "AC_TAMPER_PROX", "AC_TAMPER_ACCEL", "AC_TAMPER_SWITCH", "AC_GR_ACTIVE", "AC_GR_INACTIVE", "AC_GI_ACTIVE", "AC_GI_INACTIVE", "AC_REX_ACTIVE", "AC_REX_INACTIVE", "AC_APERIO_DEVICE_DISCONNECTED", "AC_APERIO_DEVICE_CONNECTED", "AC_APERIO_DEVICE_REBOOT", "AC_APERIO_DEVICE_TAMPER", "AC_APERIO_LOW_BATTERY", "AC_APERIO_FLAT_BATTERY", "AC_APERIO_OK_BATTERY", "AC_SCHLAGE_GW_DISCONNECTED", "AC_SCHLAGE_GW_CONNECTED", "AC_SCHLAGE_APM_DISCONNECTED", "AC_SCHLAGE_APM_CONNECTED", "AC_SCHLAGE_LOW_BATTERY", "AC_SCHLAGE_CRITICAL_BATTERY", "AC_SCHLAGE_OK_BATTERY", "POWER_SWITCH_BATTERY", "POWER_SWITCH_PRIMARY", "AI_SEARCH_MATCH", "AI_SEARCH_MATCH_PERSON_SMOKING", "AI_SEARCH_MATCH_PERSON_ON_PHONE", "AI_SEARCH_MATCH_PERSON_FALLING", "CUSTOM_LLM_BOOLEAN_TRUE", "CUSTOM_LLM_BOOLEAN_FALSE", "CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW", "CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH", "ALM_AUTHORITIES_CONTACTED", "ALM_MONITORING_ENABLED", "ALM_MONITORING_DISABLED", "ALM_MONITORING_SETTINGS_CHANGE", "ALM_THREAT_CASE_CLOSED", "ALM_THREAT_DETECTED", "ALM_MONITORING_EVENT_DETECTED", "ROBOT_DOG_DETECTED", "ROBOT_ARRIVED_AT_WAYPOINT", "ROBOT_ARRIVED_AT_POSE", "ROBOT_WAITING_AT_POSE", "ROBOT_MANUAL_CMD_VEL", "ROBOT_MANUAL_ACTION", "ROBOT_MANUAL_POSTURE", "ROBOT_NAVIGATE_TO_POSE_START", "ROBOT_NAVIGATE_TO_POSE_END", "ROBOT_NAVIGATE_TO_HOME_START", "ROBOT_NAVIGATE_TO_HOME_END", "ROBOT_NAVIGATE_TO_WAYPOINT_START", "ROBOT_NAVIGATE_TO_WAYPOINT_END", "ROBOT_ROUTE_RUN_START", "ROBOT_ROUTE_RUN_END", "ROBOT_LOW_BATTERY_DOCKING", "ROBOT_IDLE_DOCKING", "ROBOT_EMERGENCY", "LOITER_HUMAN", "INACTIVITY_HUMAN", "INACTIVITY_CAR", "GROUP_ENTRY", "ONGUARD_BADGE_AUTHORIZED", "ONGUARD_BADGE_ANOMALY", "ONGUARD_NO_ENTRY_MADE", "ELEMENTS_BADGE_AUTHORIZED", "ELEMENTS_BADGE_ANOMALY", "ELEMENTS_NO_ENTRY_MADE", "NETBOX_BADGE_AUTHORIZED", "NETBOX_BADGE_ANOMALY", "NETBOX_NO_ENTRY_MADE", "THERMAL_TEMPERATURE_ALARM", "THERMAL_TEMPERATURE_WARNING", "THERMAL_FIRE_DETECTED", "THERMAL_SMOKING_DETECTED", "THERMAL_FIRE_VERIFIED", "THERMAL_HEAT_NO_THREAT", "THERMAL_VISUAL_HOTSPOT", "THERMAL_VISUAL_HEAT_RISE", "THERMAL_VISUAL_WARM_BODY", "UNKNOWN" ] + }, + "ActivityEventData" : { + "type" : "object", + "properties" : { + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true + }, + "boundingBoxes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipBoundingBoxType" + }, + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "AddNewPassAccessUpdate" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "aperioDoorId" : { - "type" : "string", - "nullable" : true - }, - "aperioGatewayId" : { + "absoluteIntervals" : { "type" : "array", "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true + "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" }, "nullable" : true }, - "deviceId" : { + "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", - "format" : "byte", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "relayType" : { - "$ref" : "#/components/schemas/DoorRelayEnumType" + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "autoDailyInterval" : { + "type" : "boolean", + "nullable" : true + }, + "createWithExistingCredentials" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ExistingGuestPassCredentialAssignment" + }, + "nullable" : true + }, + "createWithNewCredentials" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NewGuestPassCredentialSpec" + }, + "nullable" : true + }, + "dailyIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DailyMinuteIntervalType" + }, + "nullable" : true } } } ], "nullable" : true, "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" + "action" : { + "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" + } + }, + "required" : [ "action" ] + }, + "AddOnLicenseEnum" : { + "type" : "string", + "enum" : [ "CLOUD_ARCHIVING", "PERCEPTION", "POSE", "BEHAVIOR", "VEHICLE", "PEOPLE", "PPE", "PEOPLE_ANALYTICS", "UNKNOWN" ] + }, + "AddOnLicenseInvoiceType" : { + "type" : "object", + "properties" : { + "cloudArchiveDays" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "createdAtMillis" : { + "count" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "name" : { + "description" : { "type" : "string", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "license" : { + "$ref" : "#/components/schemas/AddOnLicenseEnum" + }, + "perceptionTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PerceptionTypeEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "price" : { + "type" : "number", + "format" : "float", "nullable" : true + } + } + }, + "AddOnLicenseStats" : { + "type" : "object", + "properties" : { + "addOnLicenseType" : { + "$ref" : "#/components/schemas/AddOnLicenseEnum" }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "assignedCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "assignedLicenseStateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" }, - "portImmutable" : { - "type" : "boolean", + "deviceLicenseFamilyStats" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyStats" + }, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" + "lastEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest past date on which licenses belonging to the group expired.", + "nullable" : true }, - "updatedAtMillis" : { + "nearExpirationCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, - "uuid" : { + "nextEndDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", + "description" : "The closest future date on which licenses belonging to the group will expire.", + "nullable" : true + }, + "stateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group.", "nullable" : true } } }, - "AperioDoorRequestToExit" : { + "AddReusePassAccessUpdate" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "aperioDoorId" : { - "type" : "string", + "absoluteIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" + }, "nullable" : true }, - "aperioGatewayId" : { + "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", - "format" : "byte", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "intentOnly" : { - "type" : "boolean", - "nullable" : true + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "intentOnlyEvents" : { + "autoDailyInterval" : { "type" : "boolean", "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" + "dailyIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DailyMinuteIntervalType" + }, + "nullable" : true }, - "rexType" : { - "$ref" : "#/components/schemas/RequestToExitEnumType" + "existingGuestPassUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } } ], "nullable" : true, "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "action" : { + "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" + } + }, + "required" : [ "action" ] + }, + "AdvancedRMAType" : { + "type" : "object", + "properties" : { + "falseReport" : { + "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", + "invoiceNeeded" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "knownIssue" : { + "type" : "boolean", "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "managerialApproved" : { + "type" : "boolean", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "portImmutable" : { + "rctpPartnerRequested" : { "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "rctpPartnerUuid" : { + "type" : "string", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rectified" : { + "type" : "boolean", "nullable" : true } } }, - "AperioDtcEvent" : { + "AiProductEnum" : { + "type" : "string", + "description" : "AI product to update.", + "enum" : [ "MIND", "CUSTOM_EVENTS" ] + }, + "AiProductModeEnum" : { + "type" : "string", + "description" : "Tier the org should run this product in.", + "enum" : [ "FREE", "PREMIUM", "COMPED", "SELF", "DISABLED" ] + }, + "Aiconfig_AiProductConfigWSType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioDeviceId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "dtcs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DtcInfo" - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Per-org configuration of a single AI product. Never carries API keys.", "properties" : { - "componentUuid" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch timestamp in milliseconds when this config was created", + "nullable" : true + }, + "executionStrategy" : { + "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" + }, + "mode" : { + "$ref" : "#/components/schemas/AiProductModeEnum" + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", + "product" : { + "$ref" : "#/components/schemas/AiProductEnum" + }, + "tokenValid" : { + "type" : "boolean", + "description" : "Indicator if the org-provided LLM API key is valid (MIND SELF tier only)", "nullable" : true }, - "createdAtMs" : { + "updatedAtMs" : { "type" : "integer", "format" : "int64", + "description" : "Epoch timestamp in milliseconds when this config was last updated", "nullable" : true + } + }, + "required" : [ "mode", "orgUuid", "product" ] + }, + "Aiconfig_BaseAiProductConfigWSResponse" : { + "type" : "object", + "description" : "Response object carrying a single AI product config.", + "properties" : { + "config" : { + "$ref" : "#/components/schemas/Aiconfig_AiProductConfigWSType" }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Aiconfig_GetAiProductConfigsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving the current org's AI product configs." + }, + "Aiconfig_GetAiProductConfigsWSResponse" : { + "type" : "object", + "description" : "Response object carrying the current org's AI product configs. Products without a config have never been provisioned and should be treated as DISABLED.", + "properties" : { + "configs" : { + "type" : "array", + "description" : "The org's AI product configurations, at most one per product.", + "items" : { + "$ref" : "#/components/schemas/Aiconfig_AiProductConfigWSType" + }, "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "AperioGateway" : { + "Aiconfig_UpdateAiProductConfigWSRequest" : { "type" : "object", + "description" : "Request object for updating the tier of one AI product for the current org.", "properties" : { - "aperioGatewayId" : { + "executionStrategy" : { + "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" + }, + "mode" : { + "$ref" : "#/components/schemas/AiProductModeEnum" + }, + "product" : { + "$ref" : "#/components/schemas/AiProductEnum" + } + }, + "required" : [ "mode", "product" ] + }, + "AirQualityIndexPollutantEnum" : { + "type" : "string", + "description" : "Primary pollutant affecting air quality index", + "enum" : [ "OZONE", "PM2P5", "PM10P0", "CO", "NO2", "SO2", "UNKNOWN" ] + }, + "AlarmRule" : { + "type" : "object", + "description" : "The rules governing threat detection and subsequent actions.", + "nullable" : true, + "properties" : { + "monitoredAccessControlledDevices" : { "type" : "array", + "description" : "The UUIDs of access controlled devices (e.g. doors) monitored for the specified activities. If any\nmonitored device reports a matching activity, a threat case will be created.\n", "items" : { "type" : "string", - "format" : "byte", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "hwVersion" : { + "monitoredDevices" : { "type" : "array", + "description" : "The faceted UUIDs of devices monitored for the specified activities. If any monitored device reports\na matching activity, a threat case will be created.\n", "items" : { "type" : "string", - "format" : "byte", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "name" : { - "type" : "string", - "nullable" : true + "siren" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" }, - "oemCode" : { - "type" : "string", - "nullable" : true + "threatQualifier" : { + "$ref" : "#/components/schemas/ThreatQualifier" }, - "oemGeneratedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "triggers" : { + "type" : "array", + "description" : "The activity types that can trigger an alarm when reported by a monitored device.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "tripwire" : { + "$ref" : "#/components/schemas/TripwireSettings" }, - "ownerDeviceUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "portImmutable" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "uuid" : { + } + }, + "required" : [ "threatQualifier", "triggers" ] + }, + "AlertActionRecordType" : { + "type" : "object", + "properties" : { + "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/AlertActionStatusEnum" } } }, - "AperioGatewayConnectionStateChangeEvent" : { + "AlertActionStatusEnum" : { + "type" : "string", + "enum" : [ "SUCCESS", "ERROR", "PAUSED", "IGNORED", "MUTED", "BACKOFF", "UNKNOWN" ] + }, + "AlertGroupingStrategyEnum" : { + "type" : "string", + "enum" : [ "ALARM_RULES", "POLICY", "CUSTOM_EVENTS", "DOORBELL", "MULTIPURPOSE_BUTTON" ] + }, + "AlertMonitoringCatalogItem" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "aperioId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "connected" : { - "type" : "boolean", - "nullable" : true - }, - "ipAddress" : { - "type" : "string", - "nullable" : true - }, - "stateChangedAtMs" : { + "monthlyVerificationLimit" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "durationMonths" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "correlationId" : { + "productCode" : { "type" : "string", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + } + } + }, + "AlertMonitoringEventRecordType" : { + "type" : "object", + "properties" : { + "alertMonitoringEventType" : { + "$ref" : "#/components/schemas/AlertMonitoringRulesEventTypeEnum" }, "locationUuid" : { "type" : "string", @@ -48375,14 +49680,15 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "ownerDeviceUuid" : { + "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -48393,265 +49699,52 @@ "type" : "integer", "format" : "int64", "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true } } }, - "AperioGatewayShadow" : { + "AlertMonitoringLicenseType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "connected" : { - "type" : "boolean", - "nullable" : true - }, - "connectionStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceClockSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceTimezone" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "dtcs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DtcInfo" - }, - "nullable" : true - }, - "firmwareVersion" : { - "type" : "string", - "nullable" : true - }, - "hwVersion" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "ipAddress" : { - "type" : "string", - "nullable" : true - }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "oemCode" : { - "type" : "string", - "nullable" : true - }, - "oemCodeFetchedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "protocolVersionMajor" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "protocolVersionMinor" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "protocolVersionPatch" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "rawTamperState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "List of alert monitoring licenses available for the client organization", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdAtMillis" : { + "allowedDeviceCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "orgUuid" : { + "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "createdOn" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - }, - "AperioGatewayStateEvent" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioId" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "connected" : { - "type" : "boolean", - "nullable" : true - }, - "connectionStateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceClockSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deviceTimezone" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "dtcs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DtcInfo" - }, - "nullable" : true - }, - "firmwareVersion" : { - "type" : "string", - "nullable" : true - }, - "hwVersion" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "ipAddress" : { - "type" : "string", - "nullable" : true - }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "oemCode" : { + "deviceUuids" : { + "type" : "array", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "oemCodeFetchedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "protocolVersionMajor" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "protocolVersionMinor" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "protocolVersionPatch" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "rawTamperState" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "correlationId" : { + "firstAssignedDate" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" }, "locationUuid" : { "type" : "string", @@ -48660,107 +49753,85 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "maxDeleteDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "monthlyFallbackVerificationLimit" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "timestampMs" : { + "monthlyVerificationLimit" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "monthsReset" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "AperioKeyCylinderStateEvent" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "state" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + }, + "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "percentUsage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "locationUuid" : { + "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "productCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "remainingAlarms" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "timestampMs" : { + "remainingFallbackVerifications" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "remainingVerifications" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true }, "uuid" : { "type" : "string", @@ -48768,60 +49839,54 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "warningStage" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "AperioTamperStateEvent" : { + "AlertMonitoringPIN" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "aperioDoorId" : { - "type" : "string", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "state" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "stateUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Alert monitoring PIN to update.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in epoch ms when this PIN was created.", + "nullable" : true, + "readOnly" : true }, - "correlationId" : { + "description" : { "type" : "string", + "description" : "PIN description.", + "maxLength" : 255, "nullable" : true }, - "createdAtMs" : { + "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", + "description" : "End date in epoch seconds when this PIN expires.", "nullable" : true }, - "locationUuid" : { + "locationUuids" : { + "type" : "array", + "description" : "Set of location uuids associated with this PIN.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "PIN name.", + "maxLength" : 64, "nullable" : true }, "orgUuid" : { @@ -48831,20 +49896,64 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rotatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in epoch ms when this PIN was last rotated.", + "nullable" : true, + "readOnly" : true + }, + "rotationPeriodDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days that determines when this PIN will be automatically rotated. If an expiration date is specified, that is when the first rotation will occur. Auto-rotation is disabled if this value is null.", + "minimum" : 1, "nullable" : true }, - "timestampMs" : { + "shared" : { + "type" : "boolean", + "description" : "Determines whether this PIN can be shared.", + "nullable" : true + }, + "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", + "description" : "Start date in epoch seconds when this PIN becomes active.", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "subLocationsHierarchyKeys" : { + "type" : "array", + "description" : "Set of sub-location keys associated with this PIN.", + "items" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "nullable" : true, + "uniqueItems" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in epoch ms when this PIN was last modified.", + "nullable" : true, + "readOnly" : true + }, + "userUuids" : { + "type" : "array", + "description" : "Set of user uuids associated with this PIN.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, "uuid" : { "type" : "string", @@ -48852,60 +49961,94 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "value" : { + "type" : "string", + "description" : "PIN value.", + "maxLength" : 16, + "minLength" : 4, + "nullable" : true } - } + }, + "required" : [ "value" ] }, - "AperioType" : { + "AlertMonitoringPinType" : { "type" : "object", - "allOf" : [ ], - "nullable" : true, "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "description" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "pin" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "ApiClientTypeEnum" : { - "type" : "string", - "description" : "Optional filter for API client types", - "enum" : [ "PARTNER_DEVELOPER", "DEVELOPER", "INTERNAL_SALESFORCE", "TVOS", "KIOSK", "KEYPAD", "SQUARE", "KISI", "OPENPATH", "TOAST", "BOULEVARD", "BRIVO", "EXECUTABLE", "HALO", "SALTO", "BUTTERFLYMX", "GENEA", "PRODATAKEY", "ENVOY", "AMT", "PIMLOC", "PLACEOS", "OMNIALERT", "FLIC", "SHELLY_DEVICE_EVENT", "NINEONEONECELLULAR", "CHATBOT", "UNKNOWN" ] - }, - "ApiTokenApplicationType" : { + "AlertMonitoringRuleTriggerType" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "alertMonitoringRulesEventType" : { + "$ref" : "#/components/schemas/AlertMonitoringRulesEventTypeEnum" + }, + "locationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "authType" : { - "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "AlertMonitoringRulesEventTypeEnum" : { + "type" : "string", + "enum" : [ "ALARM_CREATED", "ALARM_CANCELED", "UNKNOWN" ] + }, + "AlertMonitoringSubmissionDelayIntervalType" : { + "type" : "object", + "properties" : { + "escalationDelayMinutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "authenticationTokenHash" : { - "type" : "string", + "minuteOfWeekStart" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "clientDetails" : { + "minuteOfWeekStop" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "promptTheme" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + } + } + }, + "AlertMonitoringThreatCaseType" : { + "type" : "object", + "description" : "List of threat cases matching the request criteria", + "properties" : { + "alertGroupingKeys" : { "type" : "object", "additionalProperties" : { "type" : "string", @@ -48913,157 +50056,192 @@ }, "nullable" : true }, - "clientType" : { - "$ref" : "#/components/schemas/ApiClientTypeEnum" + "alertGroupingStrategy" : { + "$ref" : "#/components/schemas/AlertGroupingStrategyEnum" }, - "csr" : { - "type" : "string", + "associatedDeviceUuids" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "nullable" : true }, - "displayName" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "orgUuid" : { + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "permissionGroupUuid" : { + "locationName" : { + "type" : "string", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenUuid" : { + "noonlightAlarmId" : { + "type" : "string", + "nullable" : true + }, + "noonlightVerificationId" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ApiTokenAuthTypeEnum" : { - "type" : "string", - "description" : "Authentication type for the API token", - "enum" : [ "API_TOKEN", "CERT" ] - }, - "ApiTokenEventOriginator" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "tokenName" : { + }, + "policyAlertComponentCompositeUuids" : { + "type" : "array", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenUuid" : { + "nullable" : true, + "uniqueItems" : true + }, + "policyAlertDeviceUuids" : { + "type" : "array", + "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" - } - } - }, - "ApiTokenLockdownEventOriginator" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "tokenName" : { - "type" : "string", - "nullable" : true }, - "tokenUuid" : { + "nullable" : true, + "uniqueItems" : true + }, + "policyAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyAlertUuids" : { + "type" : "array", + "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" - } - } - }, - "ApiTokenType" : { - "type" : "object", - "description" : "List of API tokens", - "properties" : { - "allowedRequetsPerSecond" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "authType" : { - "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "authenticationTokenHash" : { - "type" : "string", - "nullable" : true + "promptTheme" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, - "cert" : { + "promptTitle" : { "type" : "string", "nullable" : true }, - "certFingerprint" : { + "sharedClipGroupUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "clientDetails" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true + "sirenSettings" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" }, - "clientType" : { - "$ref" : "#/components/schemas/ApiClientTypeEnum" + "status" : { + "$ref" : "#/components/schemas/ThreatCaseStatusEnum" }, - "csr" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "submissionTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "displayName" : { - "type" : "string", + "submitDelayExpireTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "hashed" : { - "type" : "boolean", + "timelineEventList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ThreatCaseTimelineEventType" + }, "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "permissionGroupUuid" : { + "verificationHistory" : { + "$ref" : "#/components/schemas/VerificationHistory" + }, + "verificationMode" : { + "$ref" : "#/components/schemas/ThreatCaseVerificationModeEnum" + } + } + }, + "Alertmonitoring_AMDeviceHistogramItem" : { + "type" : "object", + "description" : "Histogram item representing alert monitoring data for a specific device.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "The count of alerts for this device.", + "nullable" : true + }, + "deviceName" : { + "type" : "string", + "description" : "The name of the device.", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "tokenUuid" : { + } + } + }, + "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceForLocationRequest" : { + "type" : "object", + "description" : "Request to accept the terms of service for alert monitoring at a specific location.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -49072,336 +50250,385 @@ } } }, - "ArmMonitoringRule" : { + "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceRequest" : { "type" : "object", - "description" : "Rule used to manually arm scheduled alarm policies while the monitoring mode is set to scheduled.\n", + "description" : "Request to accept the terms of service for alert monitoring." + }, + "Alertmonitoring_AcceptAlertMonitoringTermsOfServiceResponse" : { + "type" : "object", + "description" : "Response indicating the result of accepting alert monitoring terms of service.", "properties" : { - "activeSinceMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX timestamp (in milliseconds) when this rule went into effect.", + "error" : { + "type" : "boolean", "nullable" : true }, - "alarmPolicyUuids" : { - "type" : "array", - "description" : "The UUIDs of the scheduled alarm policies to manually arm.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "armedUntilMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX timestamp (in milliseconds) after which this rule is no longer active.", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "AspectRatio" : { + "Alertmonitoring_AddPromptThreatQualificationsWSRequest" : { "type" : "object", + "description" : "Request to add a prompt threat qualification for an org.", "properties" : { - "height" : { - "type" : "integer", - "format" : "int32", + "threatQualification" : { + "$ref" : "#/components/schemas/NoonlightPromptSelection" + } + }, + "required" : [ "threatQualification" ] + }, + "Alertmonitoring_AddPromptThreatQualificationsWSResponse" : { + "type" : "object", + "description" : "Response for adding a new prompt threat qualification.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "width" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "AudioExpressionDetectionConfig" : { + "Alertmonitoring_AmModifiedBy" : { "type" : "object", + "description" : "Information about who modified an alert monitoring configuration and when.", "properties" : { - "category" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "confidence_min" : { - "type" : "number", - "format" : "float", + "armed" : { + "type" : "boolean", + "description" : "Whether the alert monitoring is armed after the modification.", "nullable" : true }, - "expression" : { + "email" : { "type" : "string", + "description" : "The email address of the user who made the modification.", "nullable" : true }, - "loudness_min" : { + "event" : { + "$ref" : "#/components/schemas/Alertmonitoring_AmModifiedBy_AmModificationEvent" + }, + "timestamp" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "The timestamp when the modification occurred in milliseconds since epoch.", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "AudioGatewayStatusEnum" : { + "Alertmonitoring_AmModifiedBy_AmModificationEvent" : { "type" : "string", - "enum" : [ "SUCCESS", "ERROR", "BACKOFF", "IGNORED", "INITIATED", "SUBMITTED", "UNKNOWN" ] + "description" : "Enumeration of possible modification events for alert monitoring.", + "enum" : [ "UPDATED", "CREATED", "DELETED", "ARMED", "DISARMED", "NO_CHANGE" ] }, - "AudioLoudActivityEventType" : { + "Alertmonitoring_BulkDismissThreatCasesWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "audioLufsThreshold" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request to dismiss multiple threat cases in alert monitoring.", "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" + "authenticatePin" : { + "type" : "boolean", + "description" : "When true, the server authenticates the provided PIN against each threat case's zone and\nrecords a per-case error for those that fail authentication. Expected from clients that\ncannot identify their caller such as alarm pads.\n", + "nullable" : true + }, + "pin" : { + "type" : "string", + "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", + "nullable" : true + }, + "threatCaseUuids" : { + "type" : "array", + "description" : "Unique identifiers of the threat cases to dismiss.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true } - } + }, + "required" : [ "threatCaseUuids" ] }, - "AudioParamConfig" : { + "Alertmonitoring_BulkDismissThreatCasesWSResponse" : { "type" : "object", - "description" : "Audio analysis parameters", + "description" : "Response listing the threat cases that could not be dismissed and the reason for each failure. Threat cases not present in the map were dismissed successfully.", "properties" : { - "expressions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AudioExpressionDetectionConfig" + "errors" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of failed threat case UUID to the error message describing why it could not be dismissed. Successfully dismissed threat cases are not included.", + "nullable" : true }, - "nullable" : true - }, - "significant_loudness_min" : { - "type" : "integer", - "format" : "int32", + "description" : "Map of failed threat case UUID to the error message describing why it could not be dismissed. Successfully dismissed threat cases are not included.", "nullable" : true } } }, - "AudioPlaybackActionRecordType" : { + "Alertmonitoring_CancelThreatCaseWSRequest" : { "type" : "object", + "description" : "Request to cancel a threat case in alert monitoring.", "properties" : { - "audioClipUuid" : { + "authenticatePin" : { + "type" : "boolean", + "description" : "When true, the server authenticates the provided PIN against the threat case's zone and rejects\nthe request if authentication fails. Expected from clients that cannot identify their caller\nsuch as alarm pads.\n", + "nullable" : true + }, + "pin" : { + "type" : "string", + "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "uuid" ] + }, + "Alertmonitoring_CancelThreatCaseWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of canceling a threat case.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "audioGatewayStatuses" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/AudioGatewayStatusEnum" - }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "success" : { + "type" : "boolean", + "description" : "Indicates whether the threat case cancellation was successful", + "example" : true, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "AudioPlaybackActionType" : { + "Alertmonitoring_CountType" : { "type" : "object", + "description" : "Represents count data for a specific day and month with activation/deactivation information.", "properties" : { - "audioClipUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "The day of the month (1-31).", "nullable" : true }, - "audioGateways" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "deactivated" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of deactivated items for this day and month.", "nullable" : true }, - "loopDurationSec" : { + "month" : { "type" : "integer", "format" : "int32", + "description" : "The month (1-12).", "nullable" : true }, - "playCount" : { + "value" : { "type" : "integer", "format" : "int32", + "description" : "The count value for this day and month.", "nullable" : true } } }, - "AudioPolicyType" : { + "Alertmonitoring_CreateCustomPinForNoonlightWSRequest" : { "type" : "object", - "description" : "List of audio policies using the schedule", + "description" : "Request to create a custom PIN for alert monitoring at a specific location.", "properties" : { - "defaultTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AudioTriggerType" - }, - "nullable" : true, - "uniqueItems" : true - }, "description" : { "type" : "string", + "description" : "Description of the PIN", + "example" : "Custom PIN for main entrance access", "nullable" : true }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AudioScheduledTriggerType" - }, + "name" : { + "type" : "string", + "description" : "Name for the PIN", + "example" : "Custom Main Entrance PIN", "nullable" : true }, - "uuid" : { + "pin" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Custom PIN code to be created", + "example" : "5678", "nullable" : true } } }, - "AudioScheduledTriggerType" : { + "Alertmonitoring_CreateCustomPinForNoonlightWSResponse" : { "type" : "object", + "description" : "Response indicating the result of creating a custom PIN for alert monitoring.", "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "alreadyExists" : { + "type" : "boolean", + "description" : "Indicates whether the PIN already exists", + "example" : false, + "nullable" : true }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AudioTriggerType" - }, - "nullable" : true, - "uniqueItems" : true + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "AudioTriggerType" : { + "Alertmonitoring_CreateNoonlightSettingsForLocationRequest" : { "type" : "object", + "description" : "Request to create alert monitoring settings for a location.", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "noonlightSettings" : { + "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" } } }, - "AudioUploadMetadataType" : { + "Alertmonitoring_CreateNoonlightSettingsForLocationResponse" : { "type" : "object", - "description" : "List of audio upload metadata for the organization", + "description" : "Response indicating the result of creating alert monitoring settings for a location.", "properties" : { - "audioPlaintext" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "audioSSML" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "description" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "displayName" : { + } + } + }, + "Alertmonitoring_CreatePinForNoonlightWSRequest" : { + "type" : "object", + "description" : "Request to create a PIN for alert monitoring at a specific location.", + "properties" : { + "description" : { "type" : "string", + "description" : "Description of the PIN", + "example" : "PIN for main entrance access", "nullable" : true }, - "durationMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "mutable" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "s3ObjectKey" : { + "name" : { + "type" : "string", + "description" : "Name for the PIN", + "example" : "Main Entrance PIN", + "nullable" : true + } + } + }, + "Alertmonitoring_CreatePinForNoonlightWSResponse" : { + "type" : "object", + "description" : "Response containing the generated PIN for alert monitoring.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "uuid" : { + "pin" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "The generated PIN code", + "example" : "1234", "nullable" : true }, - "voiceId" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Audiogateway_AudioGatewayOfflineLanStreamingInfo" : { + "Alertmonitoring_CumulativeChartData" : { "type" : "object", - "description" : "Information for offline LAN streaming of audio gateway content.", + "description" : "Chart data containing daily and cumulative monthly verification counts.", "properties" : { - "accessToken" : { - "type" : "string", - "description" : "Access token for offline LAN streaming", - "example" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", + "cumulativeMonthlyVerifications" : { + "type" : "array", + "description" : "List of cumulative monthly verification counts.", + "items" : { + "$ref" : "#/components/schemas/Alertmonitoring_CountType" + }, "nullable" : true }, - "lanAddresses" : { + "dailyVerifications" : { "type" : "array", - "description" : "List of LAN addresses for offline streaming", + "description" : "List of daily verification counts.", "items" : { - "type" : "string", - "description" : "List of LAN addresses for offline streaming", - "nullable" : true + "$ref" : "#/components/schemas/Alertmonitoring_CountType" }, "nullable" : true } } }, - "Audiogateway_DeleteAudioGatewayWSRequest" : { + "Alertmonitoring_DeleteNoonlightSettingsForLocationRequest" : { "type" : "object", - "description" : "Request to remove an audio gateway from organization.", + "description" : "Request to delete alert monitoring settings for a location.", "properties" : { - "gatewayUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "mummify" : { - "type" : "boolean", - "description" : "Indicates whether to mummify the audio gateway", - "example" : false, - "nullable" : true } } }, - "Audiogateway_DeleteAudioGatewayWSResponse" : { + "Alertmonitoring_DeleteNoonlightSettingsForLocationResponse" : { "type" : "object", - "description" : "Response indicating the result of deleting an audio gateway.", + "description" : "Response indicating the result of deleting alert monitoring settings for a location.", "properties" : { "error" : { "type" : "boolean", @@ -49411,35 +50638,35 @@ "type" : "string", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Audiogateway_GetAudioGatewayConfigWSRequest" : { + "Alertmonitoring_DeletePinForNoonlightWSRequest" : { "type" : "object", - "description" : "Request to get configuration for an audio gateway.", + "description" : "Request to delete a PIN for alert monitoring at a specific location.", "properties" : { - "audioGatewayUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "pin" : { + "type" : "string", + "description" : "PIN code to be deleted", + "example" : "1234", + "nullable" : true } } }, - "Audiogateway_GetAudioGatewayConfigWSResponse" : { + "Alertmonitoring_DeletePinForNoonlightWSResponse" : { "type" : "object", - "description" : "Response containing configuration for an audio gateway.", + "description" : "Response indicating the result of deleting a PIN for alert monitoring.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/IAudioUserConfig" - }, "error" : { "type" : "boolean", "nullable" : true @@ -49454,13 +50681,21 @@ } } }, - "Audiogateway_GetAudioGatewayOfflineLanStreamingInfoWSRequest" : { + "Alertmonitoring_DeletePromptThreatQualificationByTitleWSRequest" : { "type" : "object", - "description" : "Request to get offline LAN streaming information for all audio gateways." + "description" : "Request to delete a prompt threat qualification for an org.", + "properties" : { + "title" : { + "type" : "string", + "description" : "The title of the prompt threat qualification to delete.", + "nullable" : true + } + }, + "required" : [ "title" ] }, - "Audiogateway_GetAudioGatewayOfflineLanStreamingInfoWSResponse" : { + "Alertmonitoring_DeletePromptThreatQualificationByTitleWSResponse" : { "type" : "object", - "description" : "Response containing offline LAN streaming information for all audio gateways.", + "description" : "Response for deleting a prompt threat qualification.", "properties" : { "error" : { "type" : "boolean", @@ -49470,50 +50705,34 @@ "type" : "string", "nullable" : true }, - "info" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Audiogateway_AudioGatewayOfflineLanStreamingInfo" - }, - "description" : "Map of audio gateway UUIDs to their offline LAN streaming information", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Audiogateway_GetAudioSeekpointsWSRequest" : { + "Alertmonitoring_DisableLocationRequest" : { "type" : "object", - "description" : "Request to get audio seek points for an audio gateway.", + "description" : "Request to disable alert monitoring for a specific location.", "properties" : { - "deviceUuid" : { + "locationUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "duration" : { - "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startTime" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds since epoch", - "example" : 1640995200000, + "pin" : { + "type" : "string", + "description" : "PIN code required to disable alert monitoring", + "example" : "1234", "nullable" : true } } }, - "Audiogateway_GetAudioSeekpointsWSResponse" : { + "Alertmonitoring_DisableLocationResponse" : { "type" : "object", - "description" : "Response containing audio seek points for an audio gateway.", + "description" : "Response indicating the result of disabling alert monitoring for a location.", "properties" : { "error" : { "type" : "boolean", @@ -49523,42 +50742,39 @@ "type" : "string", "nullable" : true }, - "footageSeekPoints" : { - "type" : "array", - "description" : "List of audio seek points for the specified time period", - "items" : { - "$ref" : "#/components/schemas/FootageSeekPointV2Type" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Audiogateway_GetFullAudioGatewayStateWSRequest" : { + "Alertmonitoring_DismissThreatCaseWSRequest" : { "type" : "object", - "description" : "Request to get detailed information about the state of a specified audio gateway.", + "description" : "Request to dismiss a threat case in alert monitoring.", "properties" : { - "deviceUuid" : { + "authenticatePin" : { + "type" : "boolean", + "description" : "When true, the server authenticates the provided PIN against the threat case's zone and rejects\nthe request if authentication fails. Expected from clients that cannot identify their caller\nsuch as alarm pads.\n", + "nullable" : true + }, + "pin" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, - "force" : { - "type" : "boolean", - "description" : "Force refresh of the device state", - "example" : false, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "uuid" ] }, - "Audiogateway_GetFullAudioGatewayStateWSResponse" : { + "Alertmonitoring_DismissThreatCaseWSResponse" : { "type" : "object", - "description" : "Response containing detailed information about the state of a specified audio gateway.", + "description" : "Response indicating the result of dismissing a threat case.", "properties" : { "error" : { "type" : "boolean", @@ -49568,8 +50784,11 @@ "type" : "string", "nullable" : true }, - "fullAudioGatewayState" : { - "$ref" : "#/components/schemas/FullDeviceStateType" + "success" : { + "type" : "boolean", + "description" : "Indicates whether the threat case dismissal was successful", + "example" : true, + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -49577,22 +50796,27 @@ } } }, - "Audiogateway_GetMediaUrisWSRequest" : { + "Alertmonitoring_EnableLocationRequest" : { "type" : "object", - "description" : "Request to get media URIs for an audio gateway to retrieve footage.", + "description" : "Request to enable alert monitoring for a specific location.", "properties" : { - "gatewayUuid" : { + "locationUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pin" : { + "type" : "string", + "description" : "The PIN code required to enable alert monitoring.", "nullable" : true } } }, - "Audiogateway_GetMediaUrisWSResponse" : { + "Alertmonitoring_EnableLocationResponse" : { "type" : "object", - "description" : "Response containing media URIs for audio gateway footage retrieval.", + "description" : "Response indicating successful enabling of alert monitoring for a location.", "properties" : { "error" : { "type" : "boolean", @@ -49602,59 +50826,46 @@ "type" : "string", "nullable" : true }, - "lanCheckUrls" : { - "type" : "array", - "description" : "List of LAN check URLs to verify device availability on local network", - "items" : { - "type" : "string", - "description" : "List of LAN check URLs to verify device availability on local network", - "nullable" : true - }, - "nullable" : true - }, - "lanLiveMpdUris" : { - "type" : "array", - "description" : "List of LAN live MPD URIs for local network media streaming", - "items" : { - "type" : "string", - "description" : "List of LAN live MPD URIs for local network media streaming", - "nullable" : true - }, - "nullable" : true - }, - "lanLiveOpusUris" : { - "type" : "array", - "description" : "List of LAN live Opus URIs for local network audio streaming", - "items" : { - "type" : "string", - "description" : "List of LAN live Opus URIs for local network audio streaming", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "lanVodMpdUrisTemplates" : { - "type" : "array", - "description" : "List of LAN VOD MPD URI templates for local network video on demand", - "items" : { - "type" : "string", - "description" : "List of LAN VOD MPD URI templates for local network video on demand", - "nullable" : true - }, + } + } + }, + "Alertmonitoring_EscalateThreatCaseToAlarmWSRequest" : { + "type" : "object", + "description" : "Request to escalate a threat case to an alarm for alert monitoring.", + "properties" : { + "authenticatePin" : { + "type" : "boolean", + "description" : "When true, the server authenticates the provided PIN against the threat case's zone and rejects\nthe request if authentication fails. Expected from clients that cannot identify their caller\nsuch as alarm pads.\n", "nullable" : true }, - "wanLiveMpdUri" : { + "pin" : { "type" : "string", - "description" : "WAN live MPD URI for real-time media streaming", + "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, - "wanLiveOpusUri" : { + "uuid" : { "type" : "string", - "description" : "WAN live Opus URI for real-time audio streaming", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "uuid" ] + }, + "Alertmonitoring_EscalateThreatCaseToAlarmWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of escalating a threat case to an alarm.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "wanVodMpdUriTemplate" : { + "errorMsg" : { "type" : "string", - "description" : "WAN VOD MPD URI template for video on demand content", "nullable" : true }, "warningMsg" : { @@ -49663,22 +50874,29 @@ } } }, - "Audiogateway_GetMinimalAudioGatewayStatesWSRequest" : { - "type" : "object", - "description" : "Request to get basic state information for all audio gateways." - }, - "Audiogateway_GetMinimalAudioGatewayStatesWSResponse" : { + "Alertmonitoring_GenerateMonthlyVerificationsForYearReportForLocationWSRequest" : { "type" : "object", - "description" : "Response containing basic state information for all audio gateways.", + "description" : "Request to generate monthly verifications for year report for alert monitoring at specific locations.", "properties" : { - "audioGatewayStates" : { + "locationUuids" : { "type" : "array", - "description" : "List of minimal audio gateway state information", + "description" : "List of location UUIDs to generate monthly verifications for.", "items" : { - "$ref" : "#/components/schemas/MinimalAudioGatewayStateType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true - }, + } + }, + "required" : [ "locationUuids" ] + }, + "Alertmonitoring_GenerateMonthlyVerificationsForYearReportForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing monthly verifications for year report for alert monitoring at specific locations.", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -49687,284 +50905,348 @@ "type" : "string", "nullable" : true }, + "verificationsPerMonthPerLocation" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "Map of location UUIDs to their monthly verification counts", + "nullable" : true + }, + "description" : "Map of location UUIDs to their monthly verification counts", + "nullable" : true + }, + "description" : "Map of location UUIDs to their monthly verification counts", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Audiogateway_RebootAudioGatewayWSRequest" : { + "Alertmonitoring_GenerateReportDataForLocationWSRequest" : { "type" : "object", - "description" : "Request to reboot the specified audio gateway.", + "description" : "Request to generate report data for alert monitoring at a specific location.", "properties" : { - "audioGatewayUuid" : { + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time for the report period in milliseconds since epoch.", + "example" : 1643673600000, + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time for the report period in milliseconds since epoch.", + "example" : 1640995200000, + "nullable" : true } }, - "required" : [ "audioGatewayUuid" ] + "required" : [ "locationUuid" ] }, - "Audiogateway_UpdateAudioGatewayConfigWSRequest" : { + "Alertmonitoring_GenerateReportDataForLocationWSResponse" : { "type" : "object", - "description" : "Request to update configuration for an audio gateway.", + "description" : "Response containing generated report data for alert monitoring at a specific location.", "properties" : { - "audioAnalysisParams" : { - "$ref" : "#/components/schemas/AudioParamConfig" + "cumulativeChartData" : { + "$ref" : "#/components/schemas/Alertmonitoring_CumulativeChartData" }, - "audioExternalMicBoost" : { - "type" : "integer", - "format" : "int32", - "description" : "Adjust boost for external mic. Integer between 0 and 3.", - "example" : 1, + "error" : { + "type" : "boolean", "nullable" : true }, - "audioExternalMicVolume" : { - "type" : "integer", - "format" : "int32", - "description" : "Adjust volume for external mic. Integer between 0 and 63.", - "example" : 32, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audioExternalSpeakerVolume" : { - "type" : "integer", - "format" : "int32", - "description" : "Adjust volume for external speaker. Integer between 0 and 127.", - "example" : 64, + "modifiedBy" : { + "type" : "array", + "description" : "List of modification records showing who made changes", + "items" : { + "$ref" : "#/components/schemas/Alertmonitoring_AmModifiedBy" + }, "nullable" : true }, - "audioInternalMicAecEnabled" : { - "type" : "boolean", - "description" : "Enable acoustic echo cancellation for internal microphone", - "example" : true, + "threatCaseReportItems" : { + "type" : "array", + "description" : "List of threat case report items for the report period", + "items" : { + "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReportItem" + }, "nullable" : true }, - "audioInternalMicBoost" : { - "type" : "integer", - "format" : "int32", - "description" : "Adjust boost for internal mic. Integer between 0 and 3.", - "example" : 1, - "nullable" : true + "threatCases" : { + "type" : "array", + "description" : "Set of uuids corresponding to the threatcases that produced verifications in the report period", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "audioInternalMicVolume" : { - "type" : "integer", - "format" : "int32", - "description" : "Adjust volume for internal mic. Integer between 0 and 63.", - "example" : 32, + "verificationsByDevice" : { + "type" : "array", + "description" : "List of device histogram items showing verifications by device", + "items" : { + "$ref" : "#/components/schemas/Alertmonitoring_AMDeviceHistogramItem" + }, "nullable" : true }, - "audioInternalSpeakerVolume" : { - "type" : "integer", - "format" : "int32", - "description" : "Adjust volume for internal speaker. Integer between 0 and 127.", - "example" : 64, + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Alertmonitoring_GenerateReportDataForLocationWSResponseV2" : { + "type" : "object", + "description" : "Response containing generated report data for alert monitoring at a specific location.", + "properties" : { + "cumulativeChartData" : { + "$ref" : "#/components/schemas/Alertmonitoring_CumulativeChartData" }, - "audioRecord" : { + "error" : { "type" : "boolean", - "description" : "Enable/disable audio recording. Cannot set to true unless organization settings allow it", - "example" : true, "nullable" : true }, - "audioUseExternalMic" : { - "type" : "boolean", - "description" : "Use external microphone instead of internal", - "example" : false, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audioUseExternalSpeaker" : { - "type" : "boolean", - "description" : "Use external speaker instead of internal", - "example" : false, - "nullable" : true - }, - "deviceMicEnabled" : { - "type" : "boolean", - "description" : "Enable/disable device mic. Cannot set to true unless organization settings allow it", - "example" : true, + "events" : { + "type" : "array", + "description" : "List of modification events showing who made changes", + "items" : { + "$ref" : "#/components/schemas/ALMEvent" + }, "nullable" : true }, - "deviceSpeakerEnabled" : { - "type" : "boolean", - "description" : "Enable/disable device speaker", - "example" : true, + "threatCaseReportItems" : { + "type" : "array", + "description" : "List of threat case report items for the report period", + "items" : { + "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReportItem" + }, "nullable" : true }, - "frontendEqualizerHighShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerLowShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking1" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking2" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking3" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "threatCases" : { + "type" : "array", + "description" : "Set of uuids corresponding to the threat cases that produced verifications in the report period", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "frontendNoiseSuppression" : { - "type" : "boolean", - "description" : "Enable frontend noise suppression", - "example" : true, + "verificationsByDevice" : { + "type" : "array", + "description" : "List of device histogram items showing verifications by device", + "items" : { + "$ref" : "#/components/schemas/Alertmonitoring_AMDeviceHistogramItem" + }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Audiogateway_UpdateAudioGatewayConfigWSResponse" : { + "Alertmonitoring_GetActiveThreatCaseReviewersWSRequest" : { "type" : "object", - "description" : "Response indicating the result of updating audio gateway configuration.", + "description" : "Request to retrieve active reviewers for one or more threat cases.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "threatCaseUuids" : { + "type" : "array", + "description" : "Unique identifiers of the threat cases for which to retrieve active reviewers.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } - } + }, + "required" : [ "threatCaseUuids" ] }, - "Audiogateway_UpdateAudioGatewayDetailsWSRequest" : { + "Alertmonitoring_GetActiveThreatCaseReviewersWSResponse" : { "type" : "object", - "description" : "Request to update details for an audio gateway. Note: uuid is a required field.", + "description" : "Response containing list of active threat case reviewers.", "properties" : { - "associatedCameras" : { + "reviewers" : { "type" : "array", - "description" : "List of associated camera device UUIDs", + "description" : "List of active threat case reviewers.", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/Alertmonitoring_ThreatCaseReviewer" }, "nullable" : true - }, - "associatedCamerasUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "deleted" : { - "type" : "boolean", - "description" : "Indicates whether the audio gateway is deleted", - "example" : false, - "nullable" : true - }, - "deletedUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "description" : { + } + } + }, + "Alertmonitoring_GetAlertMonitoringTripwireGroupCountWSRequest" : { + "type" : "object", + "description" : "Request to get the count of tripwire groups for alert monitoring.", + "properties" : { + "scheduleUuid" : { "type" : "string", - "description" : "Description of the audio gateway", - "example" : "Audio gateway for main entrance monitoring", - "nullable" : true - }, - "descriptionUpdated" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "floorNumber" : { + } + } + }, + "Alertmonitoring_GetAlertMonitoringTripwireGroupCountWSResponse" : { + "type" : "object", + "description" : "Response containing the count of tripwire groups for alert monitoring.", + "properties" : { + "count" : { "type" : "integer", "format" : "int32", - "description" : "Floor number where the audio gateway is located", - "example" : 1, + "description" : "Number of tripwire groups", + "example" : 5, "nullable" : true }, - "floorNumberUpdated" : { + "error" : { "type" : "boolean", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the audio gateway location", - "example" : 37.7749, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "latitudeUpdated" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, + } + } + }, + "Alertmonitoring_GetMonitoredDoorSensorsForLocationWSRequest" : { + "type" : "object", + "description" : "Request to retrieve all monitored door sensors for a location.", + "properties" : { "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "locationUuidUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the audio gateway location", - "example" : -122.4194, + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_GetMonitoredDoorSensorsForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing all monitored door sensors for a location.", + "properties" : { + "doorStates" : { + "type" : "array", + "description" : "List of minimal door state information for all monitored door sensors in a location", + "items" : { + "$ref" : "#/components/schemas/Door_MinimalDoorStateType" + }, "nullable" : true }, - "longitudeUpdated" : { + "error" : { "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", - "description" : "Name of the audio gateway", - "example" : "Main Entrance Audio Gateway", "nullable" : true }, - "nameUpdated" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Alertmonitoring_GetNoonlightSettingsForLocationWSRequest" : { + "type" : "object", + "description" : "Request to retrieve alert monitoring settings for a specific location.", + "properties" : { + "includePreviousVersions" : { "type" : "boolean", + "description" : "If provided and true, response will contain a list of previous versions of the settings. For debugging purposes.", + "example" : false, "nullable" : true }, - "policyUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Alertmonitoring_GetNoonlightSettingsForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing alert monitoring settings for a specific location.", + "properties" : { + "alertMonitoringSettings" : { + "$ref" : "#/components/schemas/Alertmonitoring_NoonlightWSSettings" }, - "policyUuidUpdated" : { + "error" : { "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", + "previousVersions" : { + "type" : "array", + "description" : "List of previous versions of the alert monitoring settings", + "items" : { + "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" + }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Audiogateway_UpdateAudioGatewayDetailsWSResponse" : { + "Alertmonitoring_GetNoonlightSettingsWSRequest" : { "type" : "object", - "description" : "Response indicating the result of updating audio gateway details.", + "description" : "Request to retrieve alert monitoring settings." + }, + "Alertmonitoring_GetNoonlightSettingsWSResponse" : { + "type" : "object", + "description" : "Response containing alert monitoring settings for multiple locations.", "properties" : { + "alertMonitoringSettings" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Alertmonitoring_NoonlightWSSettings" + }, + "description" : "Map of location UUIDs to their alert monitoring settings", + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -49979,27 +51261,13 @@ } } }, - "Audioplayback_CancelLoopingAudioPlaybackWSRequest" : { + "Alertmonitoring_GetPromptThreatQualificationsWSRequest" : { "type" : "object", - "description" : "Request to cancel looping audio playback on audio devices.", - "properties" : { - "audioDevices" : { - "type" : "array", - "description" : "List of audio device UUIDs to cancel looping playback on", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true - } - } + "description" : "Request to retrieve prompt threat qualifications for an org." }, - "Audioplayback_CancelLoopingAudioPlaybackWSResponse" : { + "Alertmonitoring_GetPromptThreatQualificationsWSResponse" : { "type" : "object", - "description" : "Response from canceling looping audio playback.", + "description" : "Response containing prompt threat qualifications for an org.", "properties" : { "error" : { "type" : "boolean", @@ -50009,14 +51277,11 @@ "type" : "string", "nullable" : true }, - "successMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "description" : "Map of audio device UUIDs to success status for canceling playback", - "nullable" : true + "threatQualifications" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NoonlightPromptSelection" }, - "description" : "Map of audio device UUIDs to success status for canceling playback", "nullable" : true }, "warningMsg" : { @@ -50025,11 +51290,11 @@ } } }, - "Audioplayback_DeleteAudioUploadMetadataWSRequest" : { + "Alertmonitoring_LocationStatusWSRequest" : { "type" : "object", - "description" : "Request to delete audio upload metadata.", + "description" : "Request to retrieve alarm monitoring status for a specific location.", "properties" : { - "audioUploadUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -50038,9 +51303,9 @@ } } }, - "Audioplayback_DeleteAudioUploadMetadataWSResponse" : { + "Alertmonitoring_LocationStatusWSResponse" : { "type" : "object", - "description" : "Response from deleting audio upload metadata.", + "description" : "Response containing alarm monitoring status for a specific location.", "properties" : { "error" : { "type" : "boolean", @@ -50050,158 +51315,187 @@ "type" : "string", "nullable" : true }, + "status" : { + "$ref" : "#/components/schemas/MonitoringEnableStatus" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Audioplayback_GetAudioUploadMetadataForOrgWSRequest" : { - "type" : "object", - "description" : "Request to get audio upload metadata for organization." - }, - "Audioplayback_GetAudioUploadMetadataForOrgWSResponse" : { + "Alertmonitoring_NoonlightWSSettings" : { "type" : "object", - "description" : "Response containing audio upload metadata for organization.", + "description" : "Web service settings for Noonlight integration with alert monitoring.", "properties" : { - "audioUploadMetadata" : { - "type" : "array", - "description" : "List of audio upload metadata for the organization", - "items" : { - "$ref" : "#/components/schemas/AudioUploadMetadataType" - }, + "acceptedTermsOfService" : { + "type" : "boolean", "nullable" : true }, - "error" : { + "badgeAuthDisablesMonitoring" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "defaultDelay" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "defaultEmergencyContact" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, + "defaultPromptTheme" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + }, + "deleted" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Audioplayback_PlayAudioUploadWSRequest" : { - "type" : "object", - "description" : "Request to play an uploaded audio clip through audio devices.", - "properties" : { - "audioGatewayUuids" : { + }, + "disabledOnMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when Noonlight integration was disabled in milliseconds since epoch.", + "nullable" : true + }, + "emergencyContacts" : { "type" : "array", - "description" : "List of audio gateway device UUIDs to play audio through", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/EmergencyResponseContactsScheduleType" }, "nullable" : true }, - "audioUploadUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "loopDurationSec" : { + "enabledOnMs" : { "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds to loop the audio playback", - "example" : 30, + "format" : "int64", + "description" : "The timestamp when Noonlight integration was enabled in milliseconds since epoch.", "nullable" : true }, - "playCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of times to play the audio clip", - "example" : 1, + "entryInstructions" : { + "type" : "string", "nullable" : true - } - } - }, - "Audioplayback_PlayAudioUploadWSResponse" : { - "type" : "object", - "description" : "Response from playing an uploaded audio clip.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "manualEscalationSettings" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, + "modifiedByEmail" : { "type" : "string", "nullable" : true }, - "success" : { + "modifiedByIntegration" : { "type" : "boolean", - "description" : "Indicates if audio playback was successful", - "example" : true, "nullable" : true }, - "warningMsg" : { + "modifiedByMetadata" : { "type" : "string", "nullable" : true - } - } - }, - "Audioplayback_UpdateAudioUploadMetadataWSRequest" : { - "type" : "object", - "description" : "Request to update audio upload metadata.", - "properties" : { - "audioUploadUuid" : { + }, + "modifiedByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "newDescription" : { - "type" : "string", - "description" : "New description for the audio clip", - "example" : "Updated welcome message for visitors", + "modifiedTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "newDisplayName" : { - "type" : "string", - "description" : "New display name for the audio clip", - "example" : "Updated Welcome Message", + "monitoringMode" : { + "$ref" : "#/components/schemas/MonitoringModeEnum" + }, + "oneTimePauses" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, "nullable" : true - } - } - }, - "Audioplayback_UpdateAudioUploadMetadataWSResponse" : { - "type" : "object", - "description" : "Response from updating audio upload metadata.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "oneTimeSchedules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "pins" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringPinType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "rules" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "schedules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/MonitoringEnableStatus" + }, + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "talkdownEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "Audioplayback_UploadAudioPcmWSResponse" : { + "Alertmonitoring_OrgStatusWSRequest" : { "type" : "object", - "description" : "Response from uploading PCM audio clip.", + "description" : "Request to retrieve alarm monitoring status for all locations in an organization.", "properties" : { - "encodingFailure" : { + "includeDeleted" : { "type" : "boolean", - "description" : "Indicates if audio encoding failed", + "description" : "If true, includes alert monitoring settings that were soft deleted in the response.", "example" : false, "nullable" : true - }, + } + } + }, + "Alertmonitoring_OrgStatusWSResponse" : { + "type" : "object", + "description" : "Response containing alarm monitoring status for all locations in an organization.", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -50210,11 +51504,12 @@ "type" : "string", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "locationStatuses" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MonitoringEnableStatus" + }, + "description" : "Map of location UUIDs to their monitoring enable status", "nullable" : true }, "warningMsg" : { @@ -50223,52 +51518,66 @@ } } }, - "Audioplayback_UploadAudioTextWSRequest" : { + "Alertmonitoring_RecordThreatCaseReviewerLeaveWSRequest" : { "type" : "object", - "description" : "Request to upload text for audio synthesis.", + "description" : "Request to record that a reviewer is no longer reviewing the specified threat case.", "properties" : { - "audioPlaintext" : { - "type" : "string", - "description" : "Plain text to synthesize into audio", - "example" : "Welcome to our facility", - "nullable" : true - }, - "audioSSML" : { + "threatCaseUuid" : { "type" : "string", - "description" : "SSML markup for audio synthesis", - "example" : "Welcome to our facility", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "description" : { + } + }, + "required" : [ "threatCaseUuid" ] + }, + "Alertmonitoring_RecordThreatCaseReviewerLeaveWSResponse" : { + "type" : "object", + "description" : "Response indicating that a reviewer is no longer reviewing the specified threat case." + }, + "Alertmonitoring_RecordThreatCaseReviewerPresenceWSRequest" : { + "type" : "object", + "description" : "Request to record that a reviewer is actively viewing or reviewing the specified threat case.", + "properties" : { + "threatCaseUuid" : { "type" : "string", - "description" : "Description of the audio clip", - "example" : "A welcome message for visitors", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "displayName" : { + } + }, + "required" : [ "threatCaseUuid" ] + }, + "Alertmonitoring_RecordThreatCaseReviewerPresenceWSResponse" : { + "type" : "object", + "description" : "Response indicating that a reviewer is actively viewing or reviewing the specified threat case." + }, + "Alertmonitoring_ResetAlertMonitoringTripwireGroupCountWSRequest" : { + "type" : "object", + "description" : "Request to reset the count of tripwire groups for alert monitoring.", + "properties" : { + "scheduleUuid" : { "type" : "string", - "description" : "Display name for the audio clip", - "example" : "Welcome Message", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "voiceId" : { - "type" : "string", - "description" : "Voice ID for text-to-speech synthesis", - "example" : "en-US-Neural2-F", + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds since epoch when the reset should occur", + "example" : 1640995200000, "nullable" : true } } }, - "Audioplayback_UploadAudioTextWSResponse" : { + "Alertmonitoring_ResetAlertMonitoringTripwireGroupCountWSResponse" : { "type" : "object", - "description" : "Response from uploading text for audio synthesis.", + "description" : "Response indicating the result of resetting the tripwire group count for alert monitoring.", "properties" : { - "encodingFailure" : { - "type" : "boolean", - "description" : "Indicates if audio encoding failed", - "example" : false, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -50277,450 +51586,321 @@ "type" : "string", "nullable" : true }, - "invalidSSML" : { - "type" : "boolean", - "description" : "Indicates if SSML markup is invalid", - "example" : false, - "nullable" : true - }, - "synthesisFailure" : { - "type" : "boolean", - "description" : "Indicates if text-to-speech synthesis failed", - "example" : false, - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "AuditActionEnum" : { - "type" : "string", - "enum" : [ "THREAT_CASE_ESCALATED", "THREAT_CASE_CANCELLED", "THREAT_CASE_DISMISSED", "THREAT_CASE_DELETED", "THREAT_CASE_DELETE_BY_STATUS", "PIN_CREATED", "PIN_DELETED", "ALM_PIN_CREATE", "ALM_PIN_BULK_CREATE", "ALM_PIN_UPDATE", "ALM_PIN_ROTATE", "ALM_PIN_BULK_ROTATE", "ALM_PIN_DELETE", "BASIC_AUTH_SUCCESS", "BASIC_AUTH_FAILURE", "SAML_LOGIN_WEB", "LOGIN_WEB", "PASSWORDLESS_LOGIN_WEB", "PARTNER_LOGIN_WEB", "PARTNER_PASSWORDLESS_LOGIN_WEB", "SAML_LOGIN_FAILURE_WEB", "LOGIN_FAILURE_WEB", "RHOMBUS_KEY_LOGIN", "RHOMBUS_KEY_PASSWORDLESS_LOGIN", "RHOMBUS_KEY_SAML_LOGIN", "LOGOUT_WEB", "PARTNER_LOGOUT_WEB", "WEB_CONSOLE_ACCESS", "MOBILE_CONSOLE_ACCESS", "SAML_LOGIN_MOBILE", "PARTNER_LOGIN_MOBILE", "PARTNER_PASSWORDLESS_LOGIN_MOBILE", "LOGIN_MOBILE", "PASSWORDLESS_LOGIN_MOBILE", "SAML_LOGIN_FAILURE_MOBILE", "LOGIN_FAILURE_MOBILE", "LOGOUT_MOBILE", "PARTNER_LOGOUT_MOBILE", "MOBILE_ACCESS", "PARTNER_LOGIN_MOBIlE_REFRESH", "LOGIN_MOBIlE_REFRESH", "RHOMBUS_KEY_LOGIN_REFRESH", "CAMERA_WIFI_NETWORK_CHANGED", "CAMERA_FORCED_REBOOT", "AUDIO_GATEWAY_FORCED_REBOOT", "ENVIRONMENTAL_GATEWAY_FORCED_REBOOT", "DOORBELL_CAMERA_FORCED_REBOOT", "BADGE_READER_FORCED_REBOOT", "NVR_FORCED_REBOOT", "FIRMWARE_UPDATE_CAMERA", "DELETE_CAMERA", "DELETE_USER", "DELETE_LOCATION", "LOCATION_CREATE", "LOCATION_UPDATED", "DELETE_ROLE", "ERASE_CAMERA", "POLICY_UPDATE", "POLICY_DELETE", "POLICY_PAUSED_LOCATION", "POLICY_PAUSED_DEVICE", "POLICY_PAUSED_COMPONENT_COMPOSITE", "CREATE_POLICY_ADDENDUM", "DEVICE_REGISTERED", "PENDING_REGISTRATION_CREATE", "PENDING_REGISTRATION_REMOVED", "PENDING_REGISTRATION_UPDATED", "DEVICE_UPDATE", "DEVICE_SETTINGS_UPDATE", "REVERT_TO_DEFAULTS", "DEVICE_FEATURE_UPDATE", "DEVICE_ORG_REASSIGN", "CLAIMKEY_RENEWAL_CREATED", "LICENSES_CLAIMED", "LICENSES_RETURNED", "LICENSE_ASSIGNED", "LICENSE_CREATED", "LICENSE_UPDATED", "USER_UPDATE", "USER_CREATE", "USER_IMPORT", "BULK_PROVISION_CREDENTIALS", "ROLE_CREATE", "POLICY_CREATE", "PARTNER_CLIENT_CREATE", "PARTNER_CLIENT_DELETE", "PARTNER_CUSTOMIZE_CLIENT", "PARTNER_CUSTOMIZE_CLIENT_DEVICE", "ORG_UPDATE", "DELETE_ORG", "DISABLE_ORG", "CREATE_ORG", "ROLE_UPDATE", "USER_ROLE_UPDATE", "USER_EMAIL_UPDATE", "TIMELAPSE_CREATE", "TIMELAPSE_DELETE", "ALERT_DISMISS", "ALL_ALERT_DISMISS", "SAVED_CLIP_CREATE", "SAVED_CLIP_DELETE", "CLIP_GROUP_CREATED", "CLIP_GROUP_DELETE", "SHARED_CLIP_DELETE", "SHARED_CLIP_CREATE", "SHARED_LINK_SENT", "SHARED_LIVE_VIDEO_STREAM_WITH_PASSWORD_CREATE", "SHARED_LIVE_VIDEO_STREAM_WITHOUT_PASSWORD_CREATE", "SHARED_LIVE_VIDEO_STREAM_DELETE", "SHARED_VIDEOWALL_WITH_PASSWORD_CREATE", "SHARED_VIDEOWALL_WITHOUT_PASSWORD_CREATE", "SHARED_VIDEOWALL_DELETE", "RAW_HTTP_STREAM_CREATED", "RAW_HTTP_STREAM_DELETED", "SETUP_VIRTUAL_MFA_DEVICE", "DELETE_VIRTUAL_MFA_DEVICE", "SETUP_SCIM_API_ACCESS", "REVOKE_SCIM_API_ACCESS", "AUDIT_EXPORT", "COUNT_EXPORT", "DIAGNOSTIC_EXPORT", "INVENTORY_EXPORT", "USERS_EXPORT", "UPTIME_EXPORT", "SUPPORT_TICKET_OPEN", "RMA_OPEN", "FEEDBACK_CREATE", "SUPPORT_ACCESS_GRANT", "SUPPORT_ACCESS_REVOKE", "SUPPORT_PARTNER_ADD", "SUPPORT_PARTNER_REMOVE", "SUPPORT_PARTNER_LOGIN_ACCESS_EXPIRED", "SUPPORT_SEARCH_TICKETS", "ACCEPT_UAP", "ACCEPT_RHOMBUS_UAP", "ACCEPT_ALERTMONITORING_UAP", "CREATE_SEEKPOINT", "DELETE_CUSTOM_SEEKPOINT", "UPDATE_INTEGRATION_SAML", "UPDATE_INTEGRATION_SLACK", "UPDATE_INTEGRATION_SLACK_V2", "DELETE_INTEGRATION_SLACK_V2", "UPDATE_INTEGRATION_BOX", "DELETE_INTEGRATION_BOX", "UPDATE_INTEGRATION_GOOGLE", "DELETE_INTEGRATION_GOOGLE", "UPDATE_INTEGRATION_GOOGLE_V2", "DELETE_INTEGRATION_GOOGLE_V2", "UPDATE_INTEGRATION_PAGERDUTY", "DELETE_INTEGRATION_PAGERDUTY", "UPDATE_INTEGRATION_SERVICENOW", "DELETE_INTEGRATION_SERVICENOW", "UPDATE_INTEGRATION_OFFICE365", "DELETE_INTEGRATION_OFFICE365", "UPDATE_INTEGRATION_DROPBOX", "DELETE_INTEGRATION_DROPBOX", "UPDATE_INTEGRATION_SQUARE", "DELETE_INTEGRATION_SQUARE", "UPDATE_INTEGRATION_AWS", "DELETE_INTEGRATION_AWS", "UPDATE_INTEGRATION_HALO", "DELETE_INTEGRATION_HALO", "UPDATE_INTEGRATION_WEBHOOK", "DELETE_INTEGRATION_WEBHOOK", "UPDATE_INTEGRATION_EMAIL", "DELETE_INTEGRATION_EMAIL", "UPDATE_INTEGRATION_MATTERMOST", "DELETE_INTEGRATION_MATTERMOST", "UPDATE_INTEGRATION_OPENPATH", "DELETE_INTEGRATION_OPENPATH", "UPDATE_INTEGRATION_AVIGILON_ALTA", "DELETE_INTEGRATION_AVIGILON_ALTA", "UPDATE_INTEGRATION_DICE", "DELETE_INTEGRATION_DICE", "UPDATE_INTEGRATION_LUMEO", "DELETE_INTEGRATION_LUMEO", "UPDATE_INTEGRATION_DEVICE", "DELETE_INTEGRATION_DEVICE", "UPDATE_INTEGRATION_GUESTMANAGEMENT", "DELETE_INTEGRATION_GUESTMANAGEMENT", "UPDATE_GUESTMANAGEMENT_SETTINGS", "DELETE_GUESTMANAGEMENT_SETTINGS", "INVITE_GUEST", "CREATE_GUEST", "CHECKIN_GUEST", "CHECKOUT_GUEST", "UPDATE_GUEST", "DELETE_GUEST", "ACTIVATE_KIOSK", "UPDATE_INTEGRATION_OMNIALERT", "DELETE_INTEGRATION_OMNIALERT", "UPDATE_INTEGRATION_OPENTECHALLIANCE", "DELETE_INTEGRATION_OPENTECHALLIANCE", "UPDATE_INTEGRATION_TOAST", "DELETE_INTEGRATION_TOAST", "UPDATE_INTEGRATION_KISI", "DELETE_INTEGRATION_KISI", "UPDATE_INTEGRATION_BRIVO", "DELETE_INTEGRATION_BRIVO", "UPDATE_INTEGRATION_BUTTERFLYMX", "DELETE_INTEGRATION_BUTTERFLYMX", "UPDATE_INTEGRATION_ENVOY", "DELETE_INTEGRATION_ENVOY", "CREATE_ENVOY_INVITE", "UPDATE_INTEGRATION_SALTO", "UPDATE_INTEGRATION_PDK", "DELETE_INTEGRATION_PDK", "UPDATE_INTEGRATION_GENEA", "DELETE_INTEGRATION_GENEA", "UPDATE_INTEGRATION_MICROSOFTTEAMS", "DELETE_INTEGRATION_MICROSOFTTEAMS", "UPDATE_INTEGRATION_AMT", "DELETE_INTEGRATION_AMT", "UPDATE_INTEGRATION_PLACEOS", "DELETE_INTEGRATION_PLACEOS", "UPDATE_INTEGRATION_INTUIFACE", "DELETE_INTEGRATION_INTUIFACE", "UPDATE_INTEGRATION_INFORMACAST", "DELETE_INTEGRATION_INFORMACAST", "UPDATE_INTEGRATION_BOULEVARD", "DELETE_INTEGRATION_BOULEVARD", "UPDATE_INTEGRATION_INNERRANGE", "DELETE_INTEGRATION_INNERRANGE", "UPDATE_INTEGRATION_SHELLY", "DELETE_INTEGRATION_SHELLY", "UPDATE_INTEGRATION_FLIC", "DELETE_INTEGRATION_FLIC", "UPDATE_INTEGRATION_NINEONEONECELLULAR", "DELETE_INTEGRATION_NINEONEONECELLULAR", "UPDATE_INTEGRATION_PIMLOC", "DELETE_INTEGRATION_PIMLOC", "UPDATE_INTEGRATION_RAPTOR", "DELETE_INTEGRATION_RAPTOR", "UPDATE_INTEGRATION_LLM", "DELETE_INTEGRATION_LLM", "UPDATE_INTEGRATION_NOONLIGHT", "UPDATE_INTEGRATION_ALARM_MONITORING", "ENABLE_LIVE_ALARM_MONITORING", "ENABLE_LIVE_ALARM_MONITORING_LOCATION", "CREATE_ALARM_MONITORING_SETTINGS", "UPDATE_ALARM_MONITORING_SETTINGS", "DELETE_ALARM_MONITORING_SETTINGS", "ENABLE_ALARM_MONITORING_SETTINGS", "DISABLE_ALARM_MONITORING_SETTINGS", "ALM_THREAT_QUALIFICATION_CREATE", "ALM_THREAT_QUALIFICATION_UPDATE", "ALM_THREAT_QUALIFICATION_DELETE", "REPORT_VEHICLE_EVENT", "API_TOKEN_REQUEST", "API_TOKEN_REVOKE", "API_INVOCATION", "API_OAUTH_TOKEN_REQUEST", "API_OAUTH_TOKEN_REFRESH", "API_OAUTH_TOKEN_REVOKE", "API_OAUTH_INVOCATION", "API_OAUTH_SUBMIT_APPLICATION", "API_OAUTH_UPDATE_APPLICATION", "API_OAUTH_DELETE_APPLICATION", "API_OAUTH_AUTHORIZE", "VIDEO_WALL_CREATE", "VIDEO_WALL_UPDATE", "VIDEO_WALL_DELETE", "VIEW_SHARE_TIMELAPSE", "VIEW_SHARE_CLIP", "VIEW_SHARE_STREAM", "VIEW_SHARE_VIDEOWALL", "VIEW_CAMERA_VOD", "CAMERA_POLICY_UPDATE", "CAMERA_POLICY_CREATE", "CAMERA_POLICY_DELETE", "TAG_POLICY_UPDATE", "TAG_POLICY_CREATE", "TAG_POLICY_DELETE", "CLIMATE_POLICY_UPDATE", "CLIMATE_POLICY_CREATE", "CLIMATE_POLICY_DELETE", "DOOR_POLICY_UPDATE", "DOOR_POLICY_CREATE", "DOOR_POLICY_DELETE", "DOOR_SCHEDULE_EXCEPTION_UPDATE", "DOOR_SCHEDULE_EXCEPTION_CREATE", "DOOR_SCHEDULE_EXCEPTION_DELETE", "ACCESS_CONTROLLED_DOOR_POLICY_UPDATE", "ACCESS_CONTROLLED_DOOR_POLICY_CREATE", "ACCESS_CONTROLLED_DOOR_POLICY_DELETE", "VIDEO_INTERCOM_POLICY_UPDATE", "VIDEO_INTERCOM_POLICY_CREATE", "VIDEO_INTERCOM_POLICY_DELETE", "OCCUPANCY_POLICY_UPDATE", "OCCUPANCY_POLICY_CREATE", "OCCUPANCY_POLICY_DELETE", "AUDIO_POLICY_UPDATE", "AUDIO_POLICY_CREATE", "AUDIO_POLICY_DELETE", "SCHEDULE_CREATE", "SCHEDULE_DELETE", "SCHEDULE_UPDATE", "CUSTOM_EVENT_CREATE", "CUSTOM_EVENT_DELETE", "CUSTOM_EVENT_UPDATE", "SUBSCRIPTION_SETUP_INTENT_CREATE", "SUBSCRIPTION_CREATE", "SUBSCRIPTION_DELETE", "SUBSCRIPTION_PAYMENT_METHOD_DELETE", "SUBSCRIPTION_PAYMENT_METHOD_UPDATE", "SUBSCRIPTION_MAX_SPEND_UPDATE", "SUBSCRIPTION_CHECKOUT_SESSION_CREATE", "UPLOAD_FLOORPLAN", "ORG_AUDIO_RECORD_UPDATE", "ORG_AUDIO_ANALYSIS_UPDATE", "ORG_LLM_USAGE_UPDATE", "DOOR_ACCESS_UNLOCK", "RHOMBUS_KEY_DOOR_UNLOCK", "ELEVATOR_ACCESS_UNLOCK", "RHOMBUS_KEY_ELEVATOR_UNLOCK", "RHOMBUS_KEY_UPDATE_APP_SETTINGS", "UPLOAD_ACCESS_CONTROLLED_DOOR", "UPLOAD_ACCESS_CONTROLLED_ELEVATOR", "UPLOAD_ACCESS_CONTROLLED_ELEVATOR_LANDING", "UPLOAD_USER_PROFILE_PICTURE", "ACCESS_GRANT_CREATE", "ACCESS_GRANT_UPDATE", "ACCESS_GRANT_DELETE", "ACCESS_REVOCATION_CREATE", "ACCESS_REVOCATION_UPDATE", "ACCESS_REVOCATION_DELETE", "ACCESS_CONTROLLED_DOOR_CREATE", "ACCESS_CONTROLLED_DOOR_UPDATE", "ACCESS_CONTROLLED_DOOR_DELETE", "ACCESS_CONTROLLED_ELEVATOR_CREATE", "ACCESS_CONTROLLED_ELEVATOR_UPDATE", "ACCESS_CONTROLLED_ELEVATOR_DELETE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_CREATE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_UPDATE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_DELETE", "AC_CRED_RHOMBUS_SECURE_CSN_CREATE", "AC_CRED_RHOMBUS_SECURE_CSN_UPDATE", "AC_CRED_RHOMBUS_SECURE_CSN_DELETE", "AC_CRED_RHOMBUS_SECURE_CSN_REVOKED", "AC_CRED_RHOMBUS_SECURE_CSN_ASSIGN", "AC_CRED_RHOMBUS_SECURE_CSN_UNASSIGN", "AC_CRED_RHOMBUS_SECURE_CSN_SUSPEND", "AC_CRED_RHOMBUS_SECURE_CSN_UNSUSPEND", "AC_CRED_STANDARD_CSN_CREATE", "AC_CRED_STANDARD_CSN_UPDATE", "AC_CRED_STANDARD_CSN_DELETE", "AC_CRED_STANDARD_CSN_REVOKED", "AC_CRED_STANDARD_CSN_ASSIGN", "AC_CRED_STANDARD_CSN_UNASSIGN", "AC_CRED_STANDARD_CSN_SUSPEND", "AC_CRED_STANDARD_CSN_UNSUSPEND", "AC_CRED_RHOMBUS_SECURE_MOBILE_CREATE", "AC_CRED_RHOMBUS_SECURE_MOBILE_UPDATE", "AC_CRED_RHOMBUS_SECURE_MOBILE_DELETE", "AC_CRED_RHOMBUS_SECURE_MOBILE_REVOKED", "AC_CRED_RHOMBUS_SECURE_MOBILE_ASSIGN", "AC_CRED_RHOMBUS_SECURE_MOBILE_UNASSIGN", "AC_CRED_RHOMBUS_SECURE_MOBILE_SUSPEND", "AC_CRED_RHOMBUS_SECURE_MOBILE_UNSUSPEND", "AC_CRED_PIN_CREATE", "AC_CRED_PIN_BULK_CREATE", "AC_CRED_PIN_UPDATE", "AC_CRED_PIN_ROTATE", "AC_CRED_PIN_BULK_ROTATE", "AC_CRED_PIN_DELETE", "AC_CRED_PIN_REVOKED", "AC_CRED_PIN_ASSIGN", "AC_CRED_PIN_UNASSIGN", "AC_CRED_PIN_SUSPEND", "AC_CRED_PIN_UNSUSPEND", "AC_CRED_WIEGAND_CREATE", "AC_CRED_WIEGAND_UPDATE", "AC_CRED_WIEGAND_DELETE", "AC_CRED_WIEGAND_REVOKED", "AC_CRED_WIEGAND_ASSIGN", "AC_CRED_WIEGAND_UNASSIGN", "AC_CRED_WIEGAND_SUSPEND", "AC_CRED_WIEGAND_UNSUSPEND", "AC_CRED_NOTE_UPDATE", "AC_LOCKDOWN_PLAN_CREATED", "AC_LOCKDOWN_PLAN_UPDATED", "AC_LOCKDOWN_PLAN_DELETED", "AC_LOCKDOWN_ACTIVATED", "AC_LOCKDOWN_DEACTIVATED", "AC_COMPONENT_POWER_CYCLE", "AC_DOOR_STATE_OVERRIDE_APPLIED", "AC_DOOR_STATE_OVERRIDE_CANCELLED", "AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_APPLIED", "AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_CANCELLED", "SCIM_GET_ALL_USERS", "SCIM_POST_CREATE_USER", "SCIM_PUT_UPDATE_USER", "SCIM_PATCH_UPDATE_USER", "SCIM_GET_USER_BY_ID", "SCIM_DELETE_USER_BY_ID", "SCIM_GET_ALL_GROUPS", "SCIM_POST_CREATE_GROUP", "SCIM_PUT_UPDATE_GROUP", "SCIM_PATCH_UPDATE_GROUP", "SCIM_GET_GROUP_BY_ID", "SCIM_DELETE_GROUP_BY_ID", "CREATE_ACCESS_CONTROL_GROUP", "UPDATE_ACCESS_CONTROL_GROUP", "DELETE_ACCESS_CONTROL_GROUP", "RULE_CREATE", "RULE_DELETE", "RULE_UPDATE", "RULE_PAUSE", "UPLOAD_FACES", "UPDATE_FACE", "REPORT_FACE_EVENT", "FACE_EVENT_UPDATED", "FACE_EVENT_DELETED", "FACE_PERSON_CREATED", "FACE_PERSON_UPDATED", "FACE_PERSON_DELETED", "FACE_MATCHMAKER_CREATED", "FACE_MATCHMAKER_DELETED", "FACE_MATCHMAKER_UPLOADED", "FACE_MATCHING_CONFIG_UPDATED", "EXPUNGE_FACES_ORG", "EXPUNGE_VEHICLES_ORG", "DEVICE_NETWORK_CONFIGURATION_CHANGE", "KIOSK_UPDATED", "KIOSK_DELETED", "KIOSK_CREATED", "UPDATE_APERIO_FIRMWARE", "UPDATE_INTEGRATION_APERIO", "DELETE_INTEGRATION_APERIO", "APERIO_GATEWAY_CREATE", "APERIO_DOORS_CREATE", "APERIO_GATEWAY_REBOOT", "APERIO_DTC_CLEAR", "THIRD_PARTY_CAMERA_CREATE", "THIRD_PARTY_CAMERA_DELETE", "THIRD_PARTY_CAMERA_UPDATED", "THIRD_PARTY_CAMERA_ASSIGNED_TO_CORE", "THIRD_PARTY_CAMERA_ASSIGNED_TO_LITE", "THIRD_PARTY_CAMERA_UNASSIGNED", "THIRD_PARTY_CAMERA_PASSWORD_CREATE", "THIRD_PARTY_CAMERA_PASSWORD_DELTE", "THIRD_PARTY_CAMERA_PASSWORD_DELETE", "CREATE_CHATBOT_CONFIG", "UPDATE_CHATBOT_CONFIG", "DELETE_CHATBOT_CONFIG", "SUPPORT_AUTHORITY_UPDATE", "SUPPORT_AUTHORITY_LOGOUT_ALL", "DELETE_DOOR_CONTROLLER", "DELETE_DOORBELL_CAMERA", "DELETE_BADGE_READER", "DELETE_ENVIRONMENTAL_GATEWAY", "AC_LOCKDOWN_TEST_MODE_ENABLED", "AC_LOCKDOWN_TEST_MODE_DISABLED", "CLOUD_ARCHIVING_CONFIG_UPDATE", "CLOUD_ARCHIVING_CONFIG_DELETE", "SCIM_UPDATE_SETTINGS", "UNKNOWN" ] - }, - "AuditRuleTriggerType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "auditEvent" : { - "$ref" : "#/components/schemas/SimpleAuditEventType" - }, - "userUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" - } - } - }, - "AuthDecisionSourceEnum" : { - "type" : "string", - "enum" : [ "ACCESS_GRANT", "ACCESS_REVOCATION", "LOCKDOWN", "FIRST_IN_SETTINGS", "CONFIG", "ADMIN", "PRIVACY", "ERROR", "UNKNOWN" ] - }, - "AutomatedPrompt" : { + "Alertmonitoring_ThreatCaseReportItem" : { "type" : "object", - "description" : "Selective update applied to the automated job settings.", + "description" : "Report item containing threat case information with device and alert details.", "properties" : { - "apiKey" : { - "type" : "string", + "alertGroupingKeys" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "followUpActions" : { + "alertGroupingStrategy" : { + "$ref" : "#/components/schemas/AlertGroupingStrategyEnum" + }, + "alertNotFound" : { + "type" : "boolean", + "description" : "Whether the alert was not found for this threat case.", + "nullable" : true + }, + "alertTypes" : { "type" : "array", + "description" : "List of alert types associated with this threat case.", "items" : { - "$ref" : "#/components/schemas/FollowUpAction" + "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, - "frequency" : { - "$ref" : "#/components/schemas/PromptFrequency" + "associatedDeviceUuids" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true }, - "invokeAtMs" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "deleted" : { + "type" : "boolean", "nullable" : true }, - "permissionGroupUuid" : { + "deviceName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "The name of the device involved in this threat case.", "nullable" : true }, - "prompt" : { - "type" : "string", + "deviceNotFound" : { + "type" : "boolean", + "description" : "Whether the device was not found for this threat case.", "nullable" : true }, - "responseTemplate" : { - "type" : "string", - "nullable" : true + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "scheduleUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenUuid" : { + "locationName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "AuxiliaryEnumType" : { - "type" : "string", - "enum" : [ "integrated_generic_input", "integrated_generic_relay" ] - }, - "AuxiliaryInputPhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] - }, - "AuxiliaryInputPortType" : { - "type" : "object", - "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "nullable" : true }, - "portNum" : { - "type" : "integer", - "format" : "int32", + "noonlightAlarmId" : { + "type" : "string", "nullable" : true }, - "portType" : { - "$ref" : "#/components/schemas/AuxiliaryInputPhysicalPortEnumType" - }, - "supervisionConfiguration" : { - "$ref" : "#/components/schemas/PortSupervisionConfigurationType" - } - } - }, - "AuxiliaryRelayPhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "GPIO_OUTPUT" ] - }, - "AuxiliaryRelayPortType" : { - "type" : "object", - "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", + "noonlightVerificationId" : { + "type" : "string", "nullable" : true }, - "portNum" : { - "type" : "integer", - "format" : "int32", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "portType" : { - "$ref" : "#/components/schemas/AuxiliaryRelayPhysicalPortEnumType" - } - } - }, - "AvigilonAltaType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorToCameraMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "email" : { - "type" : "string", - "nullable" : true - }, - "eventToWebhookIdMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true - }, - "eventToWebhookMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/WebhookMapEntry" - }, - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "password" : { + "policyAlertComponentCompositeUuids" : { + "type" : "array", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "refreshToken" : { + "nullable" : true, + "uniqueItems" : true + }, + "policyAlertDeviceUuids" : { + "type" : "array", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rhombusToken" : { + "nullable" : true, + "uniqueItems" : true + }, + "policyAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyAlertUuids" : { + "type" : "array", + "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "promptTheme" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "promptTitle" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "reason" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "The reason for the threat case result.", "nullable" : true }, - "userUuid" : { + "result" : { + "type" : "string", + "description" : "The result of the threat case investigation.", + "nullable" : true + }, + "sharedClipGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "AwsSettings" : { - "type" : "object", - "properties" : { - "accessKey" : { - "type" : "string", - "nullable" : true }, - "bucketName" : { + "sirenSettings" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" + }, + "status" : { + "$ref" : "#/components/schemas/ThreatCaseStatusEnum" + }, + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "enabled" : { - "type" : "boolean", + "submissionTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "enabledTimestampMs" : { + "submitDelayExpireTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "timelineEventList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ThreatCaseTimelineEventType" + }, "nullable" : true }, - "enablingUserUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "secretKey" : { - "type" : "string", - "nullable" : true + "verificationHistory" : { + "$ref" : "#/components/schemas/VerificationHistory" + }, + "verificationMode" : { + "$ref" : "#/components/schemas/ThreatCaseVerificationModeEnum" } } }, - "BackblazeSettings" : { + "Alertmonitoring_ThreatCaseReviewer" : { "type" : "object", + "description" : "Information about the user reviewing the threat case.", "properties" : { - "applicationKey" : { + "name" : { "type" : "string", + "description" : "Display name of the reviewer.", "nullable" : true }, - "applicationKeyId" : { + "reviewerUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "bucketName" : { + "threatCaseUuid" : { "type" : "string", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BackgroundCheckEnum" : { - "type" : "string", - "enum" : [ "CLEARED", "NEEDS_ATTENTION" ] + "Alertmonitoring_UpdateNoonlightSettingsForLocationRequest" : { + "type" : "object", + "description" : "Request to update alert monitoring settings for a location.", + "properties" : { + "noonlightSettings" : { + "$ref" : "#/components/schemas/NoonlightVersionedSettingsType" + } + } }, - "BadgeIntegrationDefaultOptions" : { + "Alertmonitoring_UpdateNoonlightSettingsForLocationResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response indicating the result of updating alert monitoring settings for a location.", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "defaultOptionsEnabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "BadgeIntegrationDoorInfoType" : { + "Alertmonitoring_UpdatePromptThreatQualificationWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request to update a prompt threat qualification for an org.", "properties" : { - "assignedCameraList" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "promptSelection" : { + "$ref" : "#/components/schemas/NoonlightPromptSelection" + } + }, + "required" : [ "promptSelection" ] + }, + "Alertmonitoring_UpdatePromptThreatQualificationWSResponse" : { + "type" : "object", + "description" : "Response for updating a prompt threat qualification.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "clipDuration" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "doorName" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Alertmonitoring_config_AcceptALMLocationTermsOfServiceWSRequest" : { + "type" : "object", + "description" : "Request to accept terms of service for ALM location.", + "properties" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_ArmMonitoringWSRequest" : { + "type" : "object", + "description" : "Request to arm monitoring.", + "properties" : { + "armingRule" : { + "$ref" : "#/components/schemas/ArmMonitoringRule" }, - "leadingSeconds" : { - "type" : "integer", - "format" : "int32", + "authenticatePin" : { + "type" : "boolean", + "description" : "When true, the server authenticates the provided PIN against the target zone and rejects the\nrequest if authentication fails. Expected from clients that cannot identify their caller such\nas alarm pads.\n", "nullable" : true }, "locationUuid" : { @@ -50730,321 +51910,460 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "remoteUnlock" : { - "type" : "boolean", + "pin" : { + "type" : "string", + "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } + }, + "required" : [ "locationUuid" ] }, - "BadgeIntegrationRuleTriggerType" : { + "Alertmonitoring_config_CancelManualArmWSRequest" : { "type" : "object", - "allOf" : [ ], - "nullable" : true, + "description" : "Request to cancel manual arming.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } + }, + "required" : [ "locationUuid" ] }, - "BadgeIntegrationSettings" : { + "Alertmonitoring_config_CancelManualDisarmWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request to cancel manual disarming.", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createSeekPoints" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_CreateLocationALMConfigWSRequest" : { + "type" : "object", + "description" : "Request to create a location ALM config.", + "properties" : { + "locationConfig" : { + "$ref" : "#/components/schemas/LocationALMConfig" + } + }, + "required" : [ "locationConfig" ] + }, + "Alertmonitoring_config_CreateZoneALMConfigWSRequest" : { + "type" : "object", + "description" : "Request to create a zone ALM config.", + "properties" : { + "monitoringEnabled" : { "type" : "boolean", + "description" : "Whether to have monitoring enabled in manual mode.", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "identifyFacesFromBadge" : { + "zoneConfig" : { + "$ref" : "#/components/schemas/ZoneALMConfig" + } + }, + "required" : [ "zoneConfig" ] + }, + "Alertmonitoring_config_CreateZoneALMConfigWSResponse" : { + "type" : "object", + "description" : "Response containing a zone ALM config and monitoring state.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "placeId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "monitoringState" : { + "$ref" : "#/components/schemas/ALMMonitoringState" }, - "placeName" : { + "warningMsg" : { "type" : "string", "nullable" : true }, - "rhombusToken" : { + "zoneConfig" : { + "$ref" : "#/components/schemas/ZoneALMConfig" + } + } + }, + "Alertmonitoring_config_DeleteLocationALMConfigWSRequest" : { + "type" : "object", + "description" : "Request to delete a location ALM config.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } - } + }, + "required" : [ "locationUuid" ] }, - "BadgeTemplate" : { + "Alertmonitoring_config_DeleteZoneALMConfigWSRequest" : { "type" : "object", - "description" : "The updated badge template", + "description" : "Request to delete a zone ALM config.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "elements" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BaseBadgeTemplateElement" - }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "front" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_DisarmMonitoringWSRequest" : { + "type" : "object", + "description" : "Request to disarm monitoring.", + "properties" : { + "authenticatePin" : { "type" : "boolean", + "description" : "When true, the server authenticates the provided PIN against the target zone and rejects the\nrequest if authentication fails. Expected from clients that cannot identify their caller such\nas alarm pads.\n", "nullable" : true }, - "name" : { - "type" : "string", - "nullable" : true + "disarmingRule" : { + "$ref" : "#/components/schemas/DisarmMonitoringRule" }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "portrait" : { - "type" : "boolean", - "nullable" : true - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "pin" : { + "type" : "string", + "description" : "Optional PIN used to authenticate this request and identify the initiating user or group.\nOnly honored when authenticatePin is true; otherwise ignored.\n", "nullable" : true }, - "uuid" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_GetALMZoneContextWSRequest" : { + "type" : "object", + "description" : "Request to retrieve ALM zone context.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "version" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } - }, - "BadgeTemplateElementEnum" : { - "type" : "string", - "enum" : [ "CUSTOM_TEXT", "USER_METADATA", "USER_CUSTOM_METADATA", "CUSTOM_IMAGE", "USER_PROFILE_PHOTO" ] + }, + "required" : [ "locationUuid" ] }, - "BadgeTemplateImage" : { + "Alertmonitoring_config_GetALMZoneContextWSResponse" : { "type" : "object", - "description" : "The updated badge template image metadata.", + "description" : "Response containing an ALM zone's context.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "imageS3Key" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "zoneContext" : { + "$ref" : "#/components/schemas/ALMZoneContext" + } + } + }, + "Alertmonitoring_config_GetALMZoneContextsByLocationWSRequest" : { + "type" : "object", + "description" : "Request to retrieve ALM zone contexts by location.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_GetALMZoneContextsByLocationWSResponse" : { + "type" : "object", + "description" : "Response containing ALM zone contexts for a location.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "originalFileName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "zoneContexts" : { + "type" : "array", + "description" : "List of the latest ALM zone contexts in the location.", + "items" : { + "$ref" : "#/components/schemas/ALMZoneContext" + }, "nullable" : true } } }, - "BadgeTemplateImageSelectiveUpdate" : { + "Alertmonitoring_config_GetALMZoneContextsByOrgWSRequest" : { "type" : "object", - "description" : "The selective update containing the fields to update for the badge template image.", + "description" : "Request to retrieve ALM zone contexts by org." + }, + "Alertmonitoring_config_GetALMZoneContextsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing ALM zone contexts for an org.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "imageS3Key" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "zoneContexts" : { + "type" : "array", + "description" : "List of the latest ALM zone contexts in the org.", + "items" : { + "$ref" : "#/components/schemas/ALMZoneContext" + }, + "nullable" : true + } + } + }, + "Alertmonitoring_config_GetALMZoneMonitoredDevicesWSRequest" : { + "type" : "object", + "description" : "Request to retrieve monitored devices in an ALM zone.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "originalFileName" : { + "modeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MonitoringModeEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_GetALMZoneMonitoredDevicesWSResponse" : { + "type" : "object", + "description" : "Response containing an ALM zone's monitored devices.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "updatedSetMethodMap" : { + "monitoredAccessControlledDoors" : { + "type" : "array", + "description" : "List of monitored access controlled doors.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "monitoredDevices" : { "type" : "object", "additionalProperties" : { - "type" : "boolean", + "type" : "array", + "description" : "Lists of monitored devices by type.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, + "description" : "Lists of monitored devices by type.", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BadgeTemplateSelectiveUpdate" : { + "Alertmonitoring_config_GetLocationALMConfigWSRequest" : { "type" : "object", - "description" : "The selective update containing the fields to update.", + "description" : "Request to retrieve a location ALM config.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "elements" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BaseBadgeTemplateElement" - }, - "nullable" : true - }, - "front" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "portrait" : { + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_GetLocationALMConfigsByOrgWSRequest" : { + "type" : "object", + "description" : "Request to retrieve location ALM configs by org." + }, + "Alertmonitoring_config_GetLocationALMConfigsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing location ALM configs for an org.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true + "locationConfigs" : { + "type" : "array", + "description" : "List of the latest location ALM configs in the org.", + "items" : { + "$ref" : "#/components/schemas/LocationALMConfig" }, "nullable" : true }, - "uuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Alertmonitoring_config_GetMonitoringStateWSRequest" : { + "type" : "object", + "description" : "Request to retrieve a monitoring state.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "version" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } + }, + "required" : [ "locationUuid" ] }, - "Badgereader_DeleteBadgeReaderWSRequest" : { + "Alertmonitoring_config_GetMonitoringStatesByLocationWSRequest" : { "type" : "object", - "description" : "Request to delete a badge reader device.", + "description" : "Request to retrieve monitoring states by location.", "properties" : { - "badgeReaderUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "mummify" : { - "type" : "boolean", - "description" : "Whether to mummify the device instead of hard delete", - "example" : false, - "nullable" : true } }, - "required" : [ "badgeReaderUuid", "mummify" ] + "required" : [ "locationUuid" ] }, - "Badgereader_DeleteBadgeReaderWSResponse" : { + "Alertmonitoring_config_GetMonitoringStatesByLocationWSResponse" : { "type" : "object", - "description" : "Response from deleting a badge reader device.", + "description" : "Response containing monitoring states for a location.", "properties" : { "error" : { "type" : "boolean", @@ -51054,8 +52373,13 @@ "type" : "string", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" + "monitoringStates" : { + "type" : "array", + "description" : "List of the latest monitoring states in the location.", + "items" : { + "$ref" : "#/components/schemas/ALMMonitoringState" + }, + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -51063,13 +52387,14 @@ } } }, - "Badgereader_GetBadgeReaderConfigWSResponse" : { + "Alertmonitoring_config_GetMonitoringStatesByOrgWSRequest" : { "type" : "object", - "description" : "Response containing badge reader configuration.", + "description" : "Request to retrieve monitoring states by org." + }, + "Alertmonitoring_config_GetMonitoringStatesByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing monitoring states for an org.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" - }, "error" : { "type" : "boolean", "nullable" : true @@ -51078,168 +52403,157 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Badgereader_GetBadgeReaderFullStateWSResponse" : { - "type" : "object", - "description" : "Response containing full state information for a badge reader.", - "properties" : { - "fullState" : { - "$ref" : "#/components/schemas/FullDeviceStateType" - } - } - }, - "Badgereader_GetBadgeReaderMinimalStateListWSResponse" : { - "type" : "object", - "description" : "Response containing minimal state information for all badge readers in organization.", - "properties" : { - "minimalStates" : { + "monitoringStates" : { "type" : "array", - "description" : "List of minimal device state information for badge readers", + "description" : "List of the latest monitoring states in the org.", "items" : { - "$ref" : "#/components/schemas/MinimalDeviceStateType" + "$ref" : "#/components/schemas/ALMMonitoringState" }, "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Badgereader_RebootBadgeReaderWSRequest" : { + "Alertmonitoring_config_GetZoneALMConfigWSRequest" : { "type" : "object", - "description" : "Request to reboot a badge reader device.", + "description" : "Request to retrieve a zone ALM config.", "properties" : { - "badgeReaderUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } }, - "required" : [ "badgeReaderUuid" ] + "required" : [ "locationUuid" ] }, - "Badgereader_UpdateBadgeReaderConfigWSRequest" : { + "Alertmonitoring_config_GetZoneALMConfigsByLocationWSRequest" : { "type" : "object", - "description" : "Request to update badge reader configuration.", + "description" : "Request to retrieve zone ALM configs by location.", "properties" : { - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } - } + }, + "required" : [ "locationUuid" ] }, - "Badgereader_UpdateBadgeReaderDetailsWSRequest" : { + "Alertmonitoring_config_GetZoneALMConfigsByLocationWSResponse" : { "type" : "object", - "description" : "Request to update badge reader device details.", + "description" : "Response containing zone ALM configs for a location.", "properties" : { - "description" : { - "type" : "string", - "description" : "Optional description for the badge reader", - "example" : "Primary access point for employees", + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "description" : "Optional direction in radians", - "example" : 1.5708, + "warningMsg" : { + "type" : "string", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Optional floor number", - "example" : 1, + "zoneConfigs" : { + "type" : "array", + "description" : "List of the latest zone ALM configs in the location.", + "items" : { + "$ref" : "#/components/schemas/ZoneALMConfig" + }, "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Optional latitude coordinate", - "example" : 37.7749, + } + } + }, + "Alertmonitoring_config_GetZoneALMConfigsByOrgWSRequest" : { + "type" : "object", + "description" : "Request to retrieve zone ALM configs by org." + }, + "Alertmonitoring_config_GetZoneALMConfigsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing zone ALM configs for an org.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Optional longitude coordinate", - "example" : -122.4194, "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", - "description" : "Optional name for the badge reader", - "example" : "Main Entrance Reader", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key has been updated", - "example" : false, + "zoneConfigs" : { + "type" : "array", + "description" : "List of the latest zone ALM configs in the org.", + "items" : { + "$ref" : "#/components/schemas/ZoneALMConfig" + }, "nullable" : true } } }, - "BaseAccessStateOverride" : { + "Alertmonitoring_config_ManageLocationALMConfigWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, + "description" : "Response containing a location ALM config.", "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" + "error" : { + "type" : "boolean", + "nullable" : true }, - "requestedAtMillis" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" + "locationConfig" : { + "$ref" : "#/components/schemas/LocationALMConfig" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "BaseAccessStateOverride_Minimal" : { + "Alertmonitoring_config_ManageMonitoringStateWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, + "description" : "Response containing a monitoring state.", "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator_Minimal" + "error" : { + "type" : "boolean", + "nullable" : true }, - "requestedAtMillis" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ManualAccessStateChangeEnum_Minimal" + "monitoringState" : { + "$ref" : "#/components/schemas/ALMMonitoringState" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "BaseApiResponse" : { + "Alertmonitoring_config_ManageZoneALMConfigWSResponse" : { "type" : "object", - "description" : "Base response object denoting success, or failure with a reason, for an endpoint.", + "description" : "Response containing a zone ALM config.", "properties" : { "error" : { "type" : "boolean", @@ -51252,763 +52566,531 @@ "warningMsg" : { "type" : "string", "nullable" : true + }, + "zoneConfig" : { + "$ref" : "#/components/schemas/ZoneALMConfig" } } }, - "BaseBadgeTemplateElement" : { + "Alertmonitoring_config_SummarizeALMZoneStatusWSRequest" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/CustomTextElement" - }, { - "$ref" : "#/components/schemas/UserMetadataTextElement" - }, { - "$ref" : "#/components/schemas/UserCustomMetadataTextElement" - }, { - "$ref" : "#/components/schemas/CustomImageElement" - }, { - "$ref" : "#/components/schemas/UserProfilePhotoElement" - } ], + "description" : "Request to summarize an ALM zone's status.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/BadgeTemplateElementEnum" - }, - "x" : { - "type" : "integer", - "format" : "int32", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "y" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } + }, + "required" : [ "locationUuid" ] }, - "BaseCatalogItem" : { + "Alertmonitoring_config_SummarizeALMZoneStatusWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "productType" - }, + "description" : "Response containing a summary of an ALM zone's status.", "properties" : { - "durationMonths" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "productCode" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "zoneSummary" : { + "$ref" : "#/components/schemas/ALMZoneSummary" } } }, - "BaseClaimKey" : { + "Alertmonitoring_config_SummarizeALMZoneStatusesForLocationWSRequest" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, + "description" : "Request to summarize a location's ALM zone statuses.", "properties" : { - "claimEndDate" : { + "locationUuid" : { "type" : "string", - "format" : "date-time", - "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "claimStartDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date/time when claiming of licenses represented by this claim key started.", + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_config_SummarizeALMZoneStatusesForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing summaries of ALM zone statuses for a location.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "createdOn" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "endDate" : { + "warningMsg" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "expirationEmailState" : { - "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" + "zoneSummaries" : { + "type" : "array", + "description" : "List of summaries of the ALM zone statuses in the location.", + "items" : { + "$ref" : "#/components/schemas/ALMZoneSummary" + }, + "nullable" : true + } + } + }, + "Alertmonitoring_config_SummarizeALMZoneStatusesForOrgWSRequest" : { + "type" : "object", + "description" : "Request to summarize an org's ALM zone statuses." + }, + "Alertmonitoring_config_SummarizeALMZoneStatusesForOrgWSResponse" : { + "type" : "object", + "description" : "Response containing summaries of ALM zone statuses for an org.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "gracePeriodEndDate" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "maskedClaimCode" : { + "warningMsg" : { "type" : "string", - "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "zoneSummaries" : { + "type" : "array", + "description" : "List of summaries of the ALM zone statuses in the org.", + "items" : { + "$ref" : "#/components/schemas/ALMZoneSummary" + }, "nullable" : true + } + } + }, + "Alertmonitoring_config_UpdateLocationALMConfigWSRequest" : { + "type" : "object", + "description" : "Request to update a location ALM config.", + "properties" : { + "update" : { + "$ref" : "#/components/schemas/LocationALMConfig" + } + }, + "required" : [ "update" ] + }, + "Alertmonitoring_config_UpdateZoneALMConfigWSRequest" : { + "type" : "object", + "description" : "Request to update a zone ALM config.", + "properties" : { + "update" : { + "$ref" : "#/components/schemas/ZoneALMConfig" + } + }, + "required" : [ "update" ] + }, + "Alertmonitoring_event_GetALMEventsByLocationWSRequest" : { + "type" : "object", + "description" : "Request to retrieve ALM events for a specific location.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ALMEventFilter" }, - "renewedByClaimKeyUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "requestId" : { - "type" : "string", - "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", + "minimal" : { + "type" : "boolean", + "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, - "returnHistory" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClaimKeyReturnEvent" - }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "sortAscending" : { + "type" : "boolean", + "description" : "If true, return events in ascending timestamp order. Defaults to false.", + "nullable" : true + } + }, + "required" : [ "locationUuid" ] + }, + "Alertmonitoring_event_GetALMEventsByOrgWSRequest" : { + "type" : "object", + "description" : "Request to retrieve ALM events for the caller's org.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ALMEventFilter" + }, + "minimal" : { + "type" : "boolean", + "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/ClaimKeyStateEnum" + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" }, - "trial" : { + "sortAscending" : { "type" : "boolean", + "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true + } + } + }, + "Alertmonitoring_event_GetALMEventsByPrincipalNameWSRequest" : { + "type" : "object", + "description" : "Request to retrieve ALM events initiated by principals matching a name.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ALMEventFilter" }, - "type" : { - "$ref" : "#/components/schemas/ClaimKeyTypeEnum" + "minimal" : { + "type" : "boolean", + "description" : "If true, events are returned without snapshot config/state data.", + "nullable" : true }, - "updatedOn" : { + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "principalName" : { "type" : "string", - "format" : "date-time", + "description" : "Case-insensitive name of the principal to retrieve ALM events for.", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "sortAscending" : { + "type" : "boolean", + "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true } - } + }, + "required" : [ "principalName" ] }, - "BaseComponentType" : { + "Alertmonitoring_event_GetALMEventsByPrincipalUuidWSRequest" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" - }, { - "$ref" : "#/components/schemas/OsdpDoorReaderType" - }, { - "$ref" : "#/components/schemas/WiegandDoorReaderType" - }, { - "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" - }, { - "$ref" : "#/components/schemas/IntegratedRequestToExitType" - }, { - "$ref" : "#/components/schemas/IntegratedDoorRelayType" - }, { - "$ref" : "#/components/schemas/IntegratedGenericRelayType" - }, { - "$ref" : "#/components/schemas/IntegratedGenericInputType" - }, { - "$ref" : "#/components/schemas/IntegratedGenericButtonType" - }, { - "$ref" : "#/components/schemas/AperioDoorReader" - }, { - "$ref" : "#/components/schemas/AperioGateway" - }, { - "$ref" : "#/components/schemas/AperioDoorExtension" - }, { - "$ref" : "#/components/schemas/AperioDoorRelay" - }, { - "$ref" : "#/components/schemas/AperioDoorPositionIndicator" - } ], + "description" : "Request to retrieve ALM events initiated by a specific principal.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" + "filter" : { + "$ref" : "#/components/schemas/ALMEventFilter" }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "minimal" : { + "type" : "boolean", + "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, - "name" : { - "type" : "string", - "nullable" : true + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" }, - "orgUuid" : { + "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "sortAscending" : { + "type" : "boolean", + "description" : "If true, return events in ascending timestamp order. Defaults to false.", + "nullable" : true + } + }, + "required" : [ "principalUuid" ] + }, + "Alertmonitoring_event_GetALMEventsByZoneWSRequest" : { + "type" : "object", + "description" : "Request to retrieve ALM events for a specific zone.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ALMEventFilter" + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "portImmutable" : { + "minimal" : { "type" : "boolean", + "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "sortAscending" : { + "type" : "boolean", + "description" : "If true, return events in ascending timestamp order. Defaults to false.", "nullable" : true }, - "uuid" : { + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } + }, + "required" : [ "locationUuid" ] }, - "BaseEventOriginator" : { + "Alertmonitoring_event_GetALMEventsWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/SupportAuthorityEventOriginator" - }, { - "$ref" : "#/components/schemas/ApiTokenEventOriginator" - }, { - "$ref" : "#/components/schemas/UserEventOriginator" - }, { - "$ref" : "#/components/schemas/RuleEventOriginator" - }, { - "$ref" : "#/components/schemas/ComponentCompositeEventOriginator" - } ], + "description" : "Response containing a page of ALM events.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "result" : { + "$ref" : "#/components/schemas/DynamoPageResultALMEvent" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "BaseEventOriginator_Minimal" : { + "Alertmonitoring_pin_BasePinWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/SupportAuthorityEventOriginator" - }, { - "$ref" : "#/components/schemas/ApiTokenEventOriginator" - }, { - "$ref" : "#/components/schemas/UserEventOriginator" - }, { - "$ref" : "#/components/schemas/RuleEventOriginator" - }, { - "$ref" : "#/components/schemas/ComponentCompositeEventOriginator" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/EventOriginatorEnum_Minimal" - } - } - }, - "BaseFirstInReset" : { - "type" : "object", - "description" : "Optional list of first-in reset configurations.", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/DailyFirstInReset" - } ], - "properties" : { - "type" : { - "$ref" : "#/components/schemas/FirstInResetEnum" - } - } - }, - "BaseLicenseType" : { - "type" : "object", - "description" : "List of licenses found by claim key", - "discriminator" : { - "propertyName" : "productType" - }, + "description" : "Base response containing alert monitoring PIN information.", "properties" : { - "claimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "firstAssignedDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "licenseToUnassignEmailState" : { - "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" - }, - "maxDeleteDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "priorClaimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "productCode" : { - "type" : "string", - "nullable" : true - }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - }, - "state" : { - "$ref" : "#/components/schemas/LicenseStateEnum" - }, - "trial" : { + "error" : { "type" : "boolean", "nullable" : true }, - "updatedOn" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "uuid" : { + "pin" : { + "$ref" : "#/components/schemas/AlertMonitoringPIN" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BaseLocationLockdownEventOriginator" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" - } - } - }, - "BaseLockdownPlanType" : { + "Alertmonitoring_pin_BulkPinsWSResponse" : { "type" : "object", - "description" : "The requested lockdown plan.", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/LocationLockdownPlanType" - } ], + "description" : "Response containing multiple alert monitoring PINs for bulk operations.", "properties" : { - "activationPlan" : { - "$ref" : "#/components/schemas/LockdownActivationPlanType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "deactivationPlan" : { - "$ref" : "#/components/schemas/LockdownDeactivationPlanType" - }, - "defaultLockdownState" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" - }, - "doorLockdownStateMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" - }, - "nullable" : true - }, - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "physicalAccess" : { - "$ref" : "#/components/schemas/LockdownPhysicalAccessType" - }, - "scopeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "failedUsers" : { + "type" : "array", + "description" : "List of user UUIDs that failed during bulk operations.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "testPlan" : { - "$ref" : "#/components/schemas/LockdownTestPlanType" - }, - "type" : { - "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "pins" : { + "type" : "array", + "description" : "List of alert monitoring PINs created or updated.", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringPIN" + }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BaseLockdownStateEventType" : { + "Alertmonitoring_pin_BulkProvisionPinsWSRequest" : { "type" : "object", - "description" : "List of lockdown events found for the specified location.", - "discriminator" : { - "propertyName" : "type" - }, + "description" : "Request to bulk provision alert monitoring PINs for multiple users.", "properties" : { - "createdAtMillis" : { + "endDateEpochSecExclusive" : { "type" : "integer", "format" : "int64", + "description" : "End date in epoch seconds when these PINs expire. PINs never expire if this value is left null.", + "minimum" : 0, "nullable" : true }, - "followingTestPlan" : { + "locationUuids" : { + "type" : "array", + "description" : "Set of location uuids these PINs are assigned to.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "notifyUsers" : { "type" : "boolean", + "default" : false, + "description" : "If enabled, sends an email to the assigned users notifying them of their new PIN code.", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "pinLength" : { + "type" : "integer", + "format" : "int32", + "description" : "Length of PINs to be generated. Accepts length between 4 and 16.", + "maximum" : 16, + "minimum" : 4, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rotationPeriodDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Period in days when PINs should be automatically rotated. If left null, PINs will not be auto-rotated.", + "minimum" : 1, "nullable" : true }, - "originator" : { - "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" - }, - "stateChangedAtMillis" : { + "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", + "description" : "Start date in epoch seconds when these PINs become active. PINs activate immediately if this value is left null.", + "minimum" : 0, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/LockdownStateEventEnumType" - } - } - }, - "BasePolicyAlertType" : { - "type" : "object", - "description" : "List of policy alerts matching the request criteria", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/PolicyAlertV2Type" - }, { - "$ref" : "#/components/schemas/AccessControlledDoorPolicyAlertType" - } ], - "properties" : { - "alertMonitoringThreatCaseUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "alertMonitoringVerified" : { - "type" : "boolean", - "nullable" : true - }, - "clipLocationMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" + "subLocationsHierarchyKeys" : { + "type" : "array", + "description" : "Set of sub-location keys these PINs are assigned to.", + "items" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "clipLocationMapV2" : { - "type" : "object", - "additionalProperties" : { + "userUuids" : { + "type" : "array", + "description" : "Set of user uuids to provision PINs for.", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "delayedProcessing" : { - "type" : "boolean", - "nullable" : true - }, - "deleted" : { + "nullable" : true, + "uniqueItems" : true + } + }, + "required" : [ "pinLength", "userUuids" ] + }, + "Alertmonitoring_pin_BulkRotatePinsWSRequest" : { + "type" : "object", + "description" : "Request to bulk rotate multiple alert monitoring PINs.", + "properties" : { + "notifyUsers" : { "type" : "boolean", + "default" : false, + "description" : "If enabled, sends an email to the assigned users notifying them of their new PIN code.", "nullable" : true }, - "durationSec" : { + "pinLength" : { "type" : "integer", "format" : "int32", + "description" : "Length of PINs to be generated. Accepts length between 4 and 16.", + "maximum" : 16, + "minimum" : 4, "nullable" : true }, - "finalized" : { - "type" : "boolean", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "notificationSent" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "policyAlertTriggers" : { + "pinUuids" : { "type" : "array", + "description" : "Uuids of PINs to rotate in bulk.", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "saved" : { - "type" : "boolean", - "nullable" : true - }, - "shared" : { - "type" : "boolean", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "textDescription" : { - "type" : "string", - "description" : "Natural language description of the alert", - "nullable" : true - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "thumbnailLocationV2" : { - "type" : "string", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/PolicyAlertEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "nullable" : true, + "uniqueItems" : true } - } + }, + "required" : [ "pinLength", "pinUuids" ] }, - "BaseRuleTriggerType" : { + "Alertmonitoring_pin_CreatePinWSRequest" : { "type" : "object", - "discriminator" : { - "mapping" : { - "ALERT_MONITORING_EVENT" : "#/components/schemas/AlertMonitoringRuleTriggerType", - "AUDIT_EVENT" : "#/components/schemas/AuditRuleTriggerType", - "BADGE_INTEGRATION_EVENT" : "#/components/schemas/BadgeIntegrationRuleTriggerType", - "BUTTON_INTEGRATION_EVENT" : "#/components/schemas/ButtonIntegrationRuleTriggerType", - "CUSTOM_LLM_EVENT" : "#/components/schemas/CustomLLMEventRuleTriggerType", - "DEVICE_ACTIVITY_EVENT" : "#/components/schemas/DeviceActivityRuleTriggerType", - "DIAGNOSTIC_EVENT" : "#/components/schemas/DiagnosticRuleTriggerType", - "LOCATION_LOCKDOWN_ACTIVATED_EVENT" : "#/components/schemas/LocationLockdownActivatedRuleTriggerType", - "LOCATION_LOCKDOWN_DEACTIVATED_EVENT" : "#/components/schemas/LocationLockdownDeactivatedRuleTriggerType", - "RECURRING_EVENT" : "#/components/schemas/RecurringRuleTriggerType", - "SCHEDULED_EVENT" : "#/components/schemas/ScheduledRuleTriggerType", - "SHELLY_INTEGRATION_EVENT" : "#/components/schemas/ShellyIntegrationRuleTriggerType", - "VISION_LLM_EVENT" : "#/components/schemas/VisionLLMRuleTriggerType" - }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/DeviceActivityRuleTriggerType" - }, { - "$ref" : "#/components/schemas/AuditRuleTriggerType" - }, { - "$ref" : "#/components/schemas/AlertMonitoringRuleTriggerType" - }, { - "$ref" : "#/components/schemas/DiagnosticRuleTriggerType" - }, { - "$ref" : "#/components/schemas/BadgeIntegrationRuleTriggerType" - }, { - "$ref" : "#/components/schemas/ScheduledRuleTriggerType" - }, { - "$ref" : "#/components/schemas/VisionLLMRuleTriggerType" - }, { - "$ref" : "#/components/schemas/RecurringRuleTriggerType" - }, { - "$ref" : "#/components/schemas/LocationLockdownActivatedRuleTriggerType" - }, { - "$ref" : "#/components/schemas/LocationLockdownDeactivatedRuleTriggerType" - }, { - "$ref" : "#/components/schemas/CustomLLMEventRuleTriggerType" - }, { - "$ref" : "#/components/schemas/ButtonIntegrationRuleTriggerType" - }, { - "$ref" : "#/components/schemas/ShellyIntegrationRuleTriggerType" - } ], + "description" : "Request to create a new alert monitoring PIN.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + "notifyUser" : { + "type" : "boolean", + "default" : false, + "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their new PIN code. If no user is assigned, notifications will not be sent.", + "nullable" : true + }, + "pin" : { + "$ref" : "#/components/schemas/AlertMonitoringPIN" } }, - "title" : "RuleTriggerType" + "required" : [ "pin" ] }, - "BaseSavedScheduleType" : { + "Alertmonitoring_pin_DeletePinWSRequest" : { "type" : "object", - "description" : "Schedule for the shared live stream", - "discriminator" : { - "propertyName" : "strategy" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - }, { - "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" - }, { - "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" - }, { - "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" - } ], + "description" : "Request to delete an alert monitoring PIN by UUID.", "properties" : { - "mutable" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "oneTimeUse" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "strategy" : { - "$ref" : "#/components/schemas/ScheduleStrategyEnum" - }, - "uuid" : { + "pinUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "pinUuid" ] }, - "BaseSavedScheduleType_Minimal" : { + "Alertmonitoring_pin_FindPinsByLocationAndUserWSRequest" : { "type" : "object", - "description" : "List of schedules", - "discriminator" : { - "propertyName" : "strategy" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - }, { - "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" - }, { - "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" - }, { - "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" - } ], + "description" : "Request to find alert monitoring PINs filtered by location and/or user.", "properties" : { - "mutable" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "oneTimeUse" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "strategy" : { - "$ref" : "#/components/schemas/ScheduleStrategyEnum_Minimal" - }, - "uuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -52017,50 +53099,42 @@ } } }, - "BasicResponseEnumType" : { - "type" : "string", - "enum" : [ "ERROR", "SUCCESS" ] - }, - "BatchRegistrationTokenUsageResult" : { + "Alertmonitoring_pin_FindPinsByOrgWSRequest" : { "type" : "object", - "description" : "List of batch registration token usage results", + "description" : "Request to find alert monitoring PINs in the organization with optional filtering and pagination.", "properties" : { - "di" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "hi" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "rs" : { - "type" : "string", - "nullable" : true + "filter" : { + "$ref" : "#/components/schemas/PinQueryFilter" }, - "ts" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" } } }, - "Billing_CreateCheckoutSessionWSRequest" : { + "Alertmonitoring_pin_FindPinsBySubLocationAndUserWSRequest" : { "type" : "object", + "description" : "Request to find alert monitoring PINs filtered by sub-location and/or user.", "properties" : { - "invoiceId" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_CreateCheckoutSessionWSResponse" : { + "Alertmonitoring_pin_FindPinsWSResponse" : { "type" : "object", + "description" : "Response containing a list of alert monitoring PINs with optional pagination information.", "properties" : { "error" : { "type" : "boolean", @@ -52070,12 +53144,17 @@ "type" : "string", "nullable" : true }, - "sessionId" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Last evaluated key for pagination in subsequent requests.", "nullable" : true }, - "sessionUrl" : { - "type" : "string", + "pins" : { + "type" : "array", + "description" : "List of alert monitoring PINs found.", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringPIN" + }, "nullable" : true }, "warningMsg" : { @@ -52084,35 +53163,23 @@ } } }, - "Billing_CreateSubscriptionWSRequest" : { + "Alertmonitoring_pin_GetAvailableALMPinCodeWSRequest" : { "type" : "object", + "description" : "Request to get an available PIN code for alert monitoring.", "properties" : { - "billingCycleTimezone" : { - "type" : "string", - "nullable" : true - }, - "maxSpendPerMonth" : { + "pinLength" : { "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "paymentMethodId" : { - "type" : "string", - "nullable" : true - }, - "termsOfServiceAccepted" : { - "type" : "boolean", + "format" : "int32", + "description" : "Length of PIN to be generated.", "nullable" : true } - } + }, + "required" : [ "pinLength" ] }, - "Billing_CreateSubscriptionWSResponse" : { + "Alertmonitoring_pin_GetAvailableALMPinCodeWSResponse" : { "type" : "object", + "description" : "Response containing an available PIN code for alert monitoring.", "properties" : { - "customerId" : { - "type" : "string", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -52121,16 +53188,9 @@ "type" : "string", "nullable" : true }, - "paymentMethodId" : { - "type" : "string", - "nullable" : true - }, - "status" : { - "type" : "string", - "nullable" : true - }, - "subscriptionId" : { + "pinCode" : { "type" : "string", + "description" : "The generated PIN code for alert monitoring.", "nullable" : true }, "warningMsg" : { @@ -52139,1387 +53199,2448 @@ } } }, - "Billing_CustomEventsMonthlyBreakdownWSRequest" : { + "Alertmonitoring_pin_GetPinWSRequest" : { "type" : "object", + "description" : "Request to retrieve an alert monitoring PIN by UUID.", "properties" : { - "date" : { + "pinUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "pinUuid" ] }, - "Billing_CustomEventsMonthlyBreakdownWSResponse" : { + "Alertmonitoring_pin_RotatePinWSRequest" : { "type" : "object", + "description" : "Request to rotate an alert monitoring PIN.", "properties" : { - "breakdowns" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_CustomEventsMonthlyBreakdownWSResponse_BreakdownElement" - }, - "nullable" : true - }, - "error" : { + "notifyUser" : { "type" : "boolean", + "default" : false, + "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their new PIN code. If no user is assigned, notifications will not be sent.", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "pinUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "pinUuid" ] }, - "Billing_CustomEventsMonthlyBreakdownWSResponse_BreakdownElement" : { + "Alertmonitoring_pin_UpdatePinWSRequest" : { "type" : "object", + "description" : "Request to update an existing alert monitoring PIN.", "properties" : { - "eventCount" : { - "type" : "integer", - "format" : "int64", + "notifyUser" : { + "type" : "boolean", + "default" : false, + "description" : "If enabled, sends an email to the user assigned this PIN notifying them of their current PIN code. If no user is assigned, notifications will not be sent.", "nullable" : true }, - "promptName" : { - "type" : "string", - "nullable" : true + "pin" : { + "$ref" : "#/components/schemas/AlertMonitoringPIN" }, - "promptUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "selectiveUpdate" : { + "type" : "boolean", + "default" : false, + "description" : "If set to true, only the non-null fields will be considered for this update.", "nullable" : true } - } + }, + "required" : [ "pin" ] }, - "Billing_DeletePaymentMethodWSRequest" : { + "AlteredView" : { "type" : "object", + "description" : "Map of device facet UUIDs to altered view configurations", "properties" : { - "paymentMethodId" : { - "type" : "string", - "nullable" : true + "crop" : { + "$ref" : "#/components/schemas/CroppedPermyriadRect" + }, + "dewarp" : { + "$ref" : "#/components/schemas/DewarpedView" } } }, - "Billing_DeletePaymentMethodWSResponse" : { + "AmtSettings" : { "type" : "object", "properties" : { - "error" : { + "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "removed" : { - "type" : "boolean", + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, "nullable" : true }, - "warningMsg" : { + "email" : { "type" : "string", "nullable" : true - } - } - }, - "Billing_FreeCreditEligibilityWSResponse" : { - "type" : "object", - "properties" : { - "customEvents" : { - "$ref" : "#/components/schemas/Billing_FreeCreditEligibilityWSResponse_FreeCreditInfo" }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "enablingUserUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Billing_FreeCreditEligibilityWSResponse_FreeCreditInfo" : { - "type" : "object", - "properties" : { - "freeCreditAmountCents" : { - "type" : "integer", - "format" : "int32", + }, + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "freeCreditRemainingCents" : { - "type" : "integer", - "format" : "int32", + "password" : { + "type" : "string", "nullable" : true }, - "hasSubscription" : { - "type" : "boolean", + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "isEligibleForVoucher" : { + "saveClips" : { "type" : "boolean", "nullable" : true }, - "isOnVoucher" : { - "type" : "boolean", + "webhookId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "isVoucherExhausted" : { - "type" : "boolean", + "webhookSignatureSecret" : { + "type" : "string", "nullable" : true } } }, - "Billing_FreeTrialEligibilityWSResponse" : { + "AnnotationPosition" : { "type" : "object", + "description" : "Normalized position of an annotation on a timeline entry's image, relative to the top-left corner. The position is independent of the displayed image size.", "properties" : { - "customEvents" : { - "type" : "boolean", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", + "x" : { + "type" : "number", + "format" : "float", + "description" : "Normalized horizontal position, where 0 is the left edge and 1 is the right edge.", + "maximum" : 1, + "minimum" : 0, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "y" : { + "type" : "number", + "format" : "float", + "description" : "Normalized vertical position, where 0 is the top edge and 1 is the bottom edge.", + "maximum" : 1, + "minimum" : 0, "nullable" : true } } }, - "Billing_GetCustomerInformationWSRequest" : { - "type" : "object" + "AntiPassbackModeEnum" : { + "type" : "string", + "enum" : [ "HARD_STRICT", "HARD_PERMISSIVE", "SOFT", "NONE" ] }, - "Billing_GetCustomerInformationWSResponse" : { + "AntiPassbackModeEnum_Minimal" : { + "type" : "string", + "enum" : [ "HARD_STRICT", "HARD_PERMISSIVE", "SOFT", "NONE" ] + }, + "AperioActivatorButton" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "activatorFunction" : { + "$ref" : "#/components/schemas/AperioActivatorFunctionEnum" + }, + "buttonType" : { + "$ref" : "#/components/schemas/ButtonEnumType" + }, + "eacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gatewayEacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "mode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + } + } + } ], + "nullable" : true, "properties" : { - "addressCity" : { - "type" : "string", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "addressCountry" : { + "name" : { "type" : "string", "nullable" : true }, - "addressLine1" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "addressLine2" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "addressPostalCode" : { - "type" : "string", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "addressState" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "businessName" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "eacAddress" ] + }, + "AperioActivatorFunctionEnum" : { + "type" : "string", + "enum" : [ "NONE", "PRIVACY" ] + }, + "AperioActivatorStateEvent" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "state" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "email" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "error" : { - "type" : "boolean", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "individualName" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "phone" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "termsOfServiceAcceptanceTimestamp" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_GetInvoicesWSRequest" : { + "AperioBatteryStateEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "FLAT", "LOW", "OK" ] + }, + "AperioDoorExtension" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioDoorDeviceId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "aperioDoorId" : { + "type" : "string", + "nullable" : true + }, + "aperioGatewayId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "limit" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "startingAfter" : { + "name" : { "type" : "string", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/Billing_InvoiceStatus" - }, - "subscriptionId" : { + "orgUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Billing_GetInvoicesWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "hasMore" : { + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "invoices" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_GetInvoicesWSResponse_Invoice" - }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", - "nullable" : true - } - } + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "aperioDoorDeviceId", "aperioDoorId", "aperioGatewayId" ] }, - "Billing_GetInvoicesWSResponse_Invoice" : { + "AperioDoorExtensionShadow" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "activatorState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "activatorStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "aperioDoorDeviceId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "aperioGatewayId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "aperioId" : { + "type" : "string", + "nullable" : true + }, + "batteryState" : { + "$ref" : "#/components/schemas/AperioBatteryStateEnum" + }, + "clockRetrievedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceClockSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceTimezone" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorMode" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorModeUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "dtcs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DtcInfo" + }, + "nullable" : true + }, + "dtcsUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "gatewayComponentId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "handleState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "handleStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "keyCylinderState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "keyCylinderStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "removed" : { + "type" : "boolean", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "tamperState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "tamperStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "amount" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "amountDue" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "amountPaid" : { - "type" : "integer", - "format" : "int64", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "created" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "currency" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "description" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dueDate" : { + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" + }, + "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true - }, - "hostedInvoiceUrl" : { - "type" : "string", - "nullable" : true - }, - "id" : { - "type" : "string", - "nullable" : true - }, - "invoicePdf" : { + } + } + }, + "AperioDoorExtensionStateEvent" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "activatorState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "activatorStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "aperioId" : { + "type" : "string", + "nullable" : true + }, + "clockRetrievedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceClockSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceTimezone" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorMode" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorModeUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "dtcs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DtcInfo" + }, + "nullable" : true + }, + "handleState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "handleStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "keyCylinderState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "keyCylinderStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "removed" : { + "type" : "boolean", + "nullable" : true + }, + "tamperState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "tamperStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "number" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "periodEnd" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "periodStart" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "productName" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "quantity" : { - "type" : "integer", - "format" : "int64", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "status" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subtotal" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "tax" : { + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "total" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "usageDescriptions" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_GetMetersWSRequest" : { - "type" : "object" - }, - "Billing_GetMetersWSResponse" : { + "AperioDoorHandleStateEvent" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "state" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "meters" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_GetMetersWSResponse_Meter" - }, - "nullable" : true - }, - "warningMsg" : { + "correlationId" : { "type" : "string", "nullable" : true - } - } - }, - "Billing_GetMetersWSResponse_Meter" : { - "type" : "object", - "properties" : { - "archived" : { - "type" : "boolean", - "nullable" : true }, - "created" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "displayName" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "eventName" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "eventTimeWindow" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "id" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true - } - } - }, - "Billing_GetPaymentMethodsWSRequest" : { - "type" : "object" - }, - "Billing_GetPaymentMethodsWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "errorMsg" : { - "type" : "string", + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "paymentMethods" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_GetPaymentMethodsWSResponse_PaymentMethod" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_GetPaymentMethodsWSResponse_PaymentMethod" : { + "AperioDoorModeEvent" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "state" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "brand" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "default" : { - "type" : "boolean", + "correlationId" : { + "type" : "string", "nullable" : true }, - "displayBrand" : { - "type" : "string", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "id" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "last4" : { + "orgUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Billing_GetProductsWSRequest" : { - "type" : "object" - }, - "Billing_GetProductsWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "products" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_GetProductsWSResponse_Product" - }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_GetProductsWSResponse_Price" : { + "AperioDoorPositionIndicator" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioDoorId" : { + "type" : "string", + "nullable" : true + }, + "aperioGatewayId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "dpiType" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "active" : { - "type" : "boolean", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "billingScheme" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "currency" : { + "name" : { "type" : "string", "nullable" : true }, - "id" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lookupKey" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nickname" : { - "type" : "string", - "nullable" : true + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "productId" : { - "type" : "string", + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "productNameId" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "recurringInterval" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "AperioDoorReader" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioDoorId" : { + "type" : "string", + "nullable" : true + }, + "aperioGatewayId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "disableCardReader" : { + "type" : "boolean", + "nullable" : true + }, + "disableKeypad" : { + "type" : "boolean", + "nullable" : true + }, + "disableWaveToUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "disposition" : { + "$ref" : "#/components/schemas/ReaderDispositionEnum" + }, + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "readerType" : { + "$ref" : "#/components/schemas/DoorReaderEnumType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "recurringIntervalCount" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "recurringUsageType" : { + "name" : { "type" : "string", "nullable" : true }, - "taxBehavior" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "transformQuantity" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "type" : "string", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "unitAmount" : { - "type" : "number", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "unitAmountDecimal" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_GetProductsWSResponse_Product" : { + "AperioDoorRelay" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioDoorId" : { + "type" : "string", + "nullable" : true + }, + "aperioGatewayId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "deviceId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "relayType" : { + "$ref" : "#/components/schemas/DoorRelayEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "active" : { - "type" : "boolean", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "created" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "defaultPriceId" : { - "type" : "string", - "nullable" : true - }, - "description" : { - "type" : "string", - "nullable" : true - }, - "id" : { + "name" : { "type" : "string", "nullable" : true }, - "name" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nameId" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "prices" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_GetProductsWSResponse_Price" - }, - "nullable" : true + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "statementDescriptor" : { - "type" : "string", - "nullable" : true - } - } - }, - "Billing_GetSubscriptionWSRequest" : { - "type" : "object" - }, - "Billing_GetSubscriptionWSResponse" : { - "type" : "object", - "properties" : { - "error" : { + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" }, - "subscriptions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_GetSubscriptionWSResponse_Subscription" - }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_GetSubscriptionWSResponse_Subscription" : { + "AperioDoorRequestToExit" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioDoorId" : { + "type" : "string", + "nullable" : true + }, + "aperioGatewayId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "intentOnly" : { + "type" : "boolean", + "nullable" : true + }, + "intentOnlyEvents" : { + "type" : "boolean", + "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "rexType" : { + "$ref" : "#/components/schemas/RequestToExitEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "cancelAtPeriodEnd" : { - "type" : "boolean", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "canceledAt" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "collectionMethod" : { + "name" : { "type" : "string", "nullable" : true }, - "created" : { - "type" : "integer", - "format" : "int64", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "currency" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "currentPeriodEnd" : { - "type" : "integer", - "format" : "int64", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "currentPeriodStart" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "defaultPaymentMethod" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "id" : { + } + } + }, + "AperioDtcEvent" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioDeviceId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "dtcs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DtcInfo" + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "isApproachingLimit" : { - "type" : "boolean", + "correlationId" : { + "type" : "string", "nullable" : true }, - "maxSpendPerMonth" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "pricePerUnit" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "product" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "status" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "trialEnd" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "upcomingInvoiceAmount" : { - "type" : "string", - "nullable" : true - }, - "upcomingInvoiceCurrency" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "usageType" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_HistoricalUsageWSRequest" : { + "AperioGateway" : { "type" : "object", "properties" : { - "products" : { + "aperioGatewayId" : { "type" : "array", "items" : { "type" : "string", + "format" : "byte", "nullable" : true }, "nullable" : true }, - "range" : { - "type" : "object", - "additionalProperties" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "hwVersion" : { + "type" : "array", + "items" : { "type" : "string", + "format" : "byte", "nullable" : true }, "nullable" : true - } - } - }, - "Billing_HistoricalUsageWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "usage" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Billing_HistoricalUsageWSResponse_HistoricalUsageElement" - }, - "nullable" : true - }, - "nullable" : true - }, - "warningMsg" : { + "oemCode" : { "type" : "string", "nullable" : true - } - } - }, - "Billing_HistoricalUsageWSResponse_HistoricalUsageElement" : { - "type" : "object", - "properties" : { - "costInCent" : { + }, + "oemGeneratedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "date" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "eventCount" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - }, - "Billing_InvoiceStatus" : { - "type" : "string", - "enum" : [ "DRAFT", "OPEN", "PAID", "UNCOLLECTIBLE", "VOID", "ALL" ] - }, - "Billing_SetDefaultPaymentMethodForSubscriptionWSRequest" : { - "type" : "object", - "properties" : { - "paymentMethodId" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subscriptionId" : { + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_SetDefaultPaymentMethodForSubscriptionWSResponse" : { + "AperioGatewayConnectionStateChangeEvent" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "nullable" : true + }, + "stateChangedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Billing_SetDefaultPaymentMethodWSRequest" : { - "type" : "object", - "properties" : { - "overrideAllSubscriptionPaymentMethods" : { - "type" : "boolean", + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "paymentMethodId" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Billing_SetDefaultPaymentMethodWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_SetupSubscriptionWSRequest" : { + "AperioGatewayShadow" : { "type" : "object", - "properties" : { - "termsOfServiceAccepted" : { - "type" : "boolean", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceClockSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceTimezone" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "dtcs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DtcInfo" + }, + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "hwVersion" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "nullable" : true + }, + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "oemCode" : { + "type" : "string", + "nullable" : true + }, + "oemCodeFetchedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "protocolVersionMajor" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "protocolVersionMinor" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "protocolVersionPatch" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "rawTamperState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } } - } - }, - "Billing_SetupSubscriptionWSResponse" : { - "type" : "object", + } ], + "nullable" : true, "properties" : { - "clientSecret" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "customerId" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "error" : { - "type" : "boolean", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Billing_UnsubscribeWSRequest" : { + "AperioGatewayStateEvent" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "aperioId" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceClockSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceTimezone" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "dtcs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DtcInfo" + }, + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "hwVersion" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "nullable" : true + }, + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "oemCode" : { + "type" : "string", + "nullable" : true + }, + "oemCodeFetchedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "protocolVersionMajor" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "protocolVersionMinor" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "protocolVersionPatch" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "rawTamperState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "subscriptionId" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Billing_UnsubscribeWSResponse" : { - "type" : "object", - "properties" : { - "cancelAtPeriodEnd" : { - "type" : "boolean", + }, + "correlationId" : { + "type" : "string", "nullable" : true }, - "canceledAt" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "error" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "status" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subscriptionId" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_UpdateCustomerInformationWSRequest" : { + "AperioKeyCylinderStateEvent" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "state" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "addressCity" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "addressCountry" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "addressLine1" : { - "type" : "string", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "addressLine2" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "addressPostalCode" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "addressState" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "businessName" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "email" : { - "type" : "string", + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "individualName" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "phone" : { + "uuid" : { "type" : "string", - "nullable" : true - }, - "termsOfServiceAccepted" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Billing_UpdateCustomerInformationWSResponse" : { + "AperioLockModelEnum" : { + "type" : "string", + "description" : "What kind of lock this is. Stated because the protocol does not report it: Device Info gives a product class, which says what a device does rather than which model it is. A model the controller cannot drive is refused - it has to be V3 hardware, which is the only generation that reports a door mode, and it has to lock something.", + "enum" : [ "C100_V3", "E100_V3", "L100_V3", "H100_V3", "AU100_V3", "IN100_V3_MC", "G100_V3", "KL100_V3", "K100_V3_MC", "KS100_V3_MC", "ES100_V3_MC", "DL100_V3_MC", "DR100_V3_MC", "R100_V3_MC", "C100", "C100_V2SE", "E100", "E100_V2SE", "L100", "PROFILE_N2_MORTISE", "INCEPTA", "A100", "K100", "K100DI", "KS100", "M100", "R100" ], + "example" : "IN100_V3_MC" + }, + "AperioRs485DoorExtension" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "eacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gatewayEacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "model" : { + "$ref" : "#/components/schemas/AperioLockModelEnum" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Billing_UpdateSubscriptionMaxSpendWSRequest" : { - "type" : "object", - "properties" : { - "maxSpendPerMonth" : { - "type" : "integer", - "format" : "int64", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subscriptionId" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Billing_UpdateSubscriptionMaxSpendWSResponse" : { - "type" : "object", - "properties" : { - "error" : { + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" }, - "maxSpendPerMonth" : { + "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "subscriptionId" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BinaryAggregationValue" : { + "AperioRs485DoorPositionIndicator" : { "type" : "object", - "description" : "Map of binary count reports", + "allOf" : [ { + "type" : "object", + "properties" : { + "dpiType" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" + }, + "eacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gatewayEacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + } + } + } ], + "nullable" : true, "properties" : { - "eventCount" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "false" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "localDate" : { + "name" : { "type" : "string", "nullable" : true }, - "maxValueTimestampMs" : { - "type" : "integer", - "format" : "int64", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "minValueTimestampMs" : { - "type" : "integer", - "format" : "int64", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "true" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "utcDate" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Ble_BleDeviceMap" : { + "AperioRs485DoorReader" : { "type" : "object", - "description" : "Map of BLE device keys to their advertisement data.", - "properties" : { - "keyToSecureBeacon" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device keys to secure beacon advertisement data", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Map of device keys to secure beacon advertisement data", - "nullable" : true - }, + "allOf" : [ { + "type" : "object", + "properties" : { + "disableCardReader" : { + "type" : "boolean", "nullable" : true }, - "description" : "Map of device keys to secure beacon advertisement data", - "nullable" : true + "disableKeypad" : { + "type" : "boolean", + "nullable" : true + }, + "disableWaveToUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "disposition" : { + "$ref" : "#/components/schemas/ReaderDispositionEnum" + }, + "eacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gatewayEacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "readerType" : { + "$ref" : "#/components/schemas/DoorReaderEnumType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + } } - } - }, - "Ble_BleRegisteredDeviceWSType" : { - "type" : "object", - "description" : "Information about a registered BLE device.", + } ], + "nullable" : true, "properties" : { - "deleted" : { - "type" : "boolean", - "description" : "Indicates if the device has been deleted", - "example" : false, + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "deviceUuid" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "hwVariation" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerHardwareType" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "name" : { - "type" : "string", - "description" : "Name of the registered BLE device", - "example" : "Temperature Sensor 1", + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "secret" : { - "type" : "array", - "description" : "Secret data for the registered BLE device", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Secret data for the registered BLE device", - "nullable" : true - }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "updateToFirmwareVersion" : { + "uuid" : { "type" : "string", - "description" : "Firmware version to update to", - "example" : "2.1.0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "eacAddress" ] }, - "Ble_BleUnregisteredHardwareWSType" : { + "AperioRs485DoorRelay" : { "type" : "object", - "description" : "Information about an unregistered BLE hardware device.", - "properties" : { - "mac" : { - "type" : "string", - "description" : "MAC address of the unregistered BLE device", - "example" : "AA:BB:CC:DD:EE:FF", - "nullable" : true - }, - "secret" : { - "type" : "array", - "description" : "Secret data for the unregistered BLE device", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Secret data for the unregistered BLE device", + "allOf" : [ { + "type" : "object", + "properties" : { + "eacAddress" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "nullable" : true - } - } - }, - "Ble_GetBaseStationsWSRequest" : { - "type" : "object", - "description" : "Request to get available base stations for BLE sensors." - }, - "Ble_GetBaseStationsWSResponse" : { - "type" : "object", - "description" : "Response containing available base stations for BLE sensors.", - "properties" : { - "baseStations" : { - "type" : "array", - "description" : "List of base station UUIDs available for BLE sensors", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "gatewayEacAddress" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "nullable" : true + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "rateLimitingEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "relayType" : { + "$ref" : "#/components/schemas/DoorRelayEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "error" : { - "type" : "boolean", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Ble_GetSecureSecretForRegisteredWSResponse" : { - "type" : "object", - "description" : "Response containing secure secrets for registered BLE devices.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "hardwareVariationToFirmwareDownloadUrl" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of hardware variations to firmware download URLs", - "nullable" : true - }, - "description" : "Map of hardware variations to firmware download URLs", - "nullable" : true - }, - "description" : "Map of hardware variations to firmware download URLs", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "keyToRegisteredDevice" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Ble_BleRegisteredDeviceWSType" - }, - "description" : "Map of device keys to registered device information", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Ble_GetSecureSecretForUnregisteredWSResponse" : { + "AperioRs485DoorRequestToExit" : { "type" : "object", - "description" : "Response containing secure secrets for unregistered BLE devices.", + "allOf" : [ { + "type" : "object", + "properties" : { + "eacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gatewayEacAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "intentOnly" : { + "type" : "boolean", + "nullable" : true + }, + "intentOnlyEvents" : { + "type" : "boolean", + "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "rexType" : { + "$ref" : "#/components/schemas/RequestToExitEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "keyToUnregisteredDevice" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Ble_BleUnregisteredHardwareWSType" - }, - "description" : "Map of serial numbers to unregistered device information", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Ble_GetSensorHardwareFirmwareUpdateDetailsRequest" : { - "type" : "object", - "description" : "Request to get firmware update details for BLE sensors." - }, - "Ble_GetSensorHardwareFirmwareUpdateDetailsResponse" : { - "type" : "object", - "description" : "Response containing firmware update details for BLE sensors.", - "properties" : { - "hardwareVariationToFirmwareDownloadUrl" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of hardware variations to firmware download URLs", - "nullable" : true - }, - "description" : "Map of hardware variations to firmware download URLs", - "nullable" : true - }, - "description" : "Map of hardware variations to firmware download URLs", + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Ble_RegisterSensorWSRequest" : { + "AperioRs485Gateway" : { "type" : "object", - "description" : "Request to register a BLE sensor device.", "properties" : { - "bleData" : { + "aperioGatewayId" : { "type" : "array", - "description" : "BLE advertisement data from the sensor", "items" : { "type" : "string", "format" : "byte", - "description" : "BLE advertisement data from the sensor", "nullable" : true }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate for sensor placement", - "example" : 37.7749, + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "eacAddress" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate for sensor placement", - "example" : -122.4194, + "hwVersion" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, "nullable" : true }, "name" : { "type" : "string", - "description" : "Name for the sensor device", - "example" : "Temperature Sensor 1", "nullable" : true }, - "serialNum" : { + "orgUuid" : { "type" : "string", - "description" : "Serial number of the BLE sensor", - "example" : "SN123456789", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Ble_RegisterSensorWSResponse" : { - "type" : "object", - "description" : "Response from registering a BLE sensor.", - "properties" : { - "deviceUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" }, - "warningMsg" : { - "type" : "string", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Ble_UnregisterSensorWSRequest" : { - "type" : "object", - "description" : "Request to unregister a BLE sensor.", - "properties" : { - "deviceUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -53528,725 +55649,368 @@ } } }, - "Ble_UnregisterSensorWSResponse" : { - "type" : "object", - "description" : "Response from unregistering a BLE sensor.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "failureReason" : { - "type" : "string", - "description" : "Reason for failure if unregistration was not successful", - "example" : "Device not found", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Indicates if the unregistration was successful", - "example" : true, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "BoardPhysicalPortConfigType" : { - "type" : "object", - "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "portMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PhysicalPortType" - }, - "nullable" : true - } - } - }, - "BodyPart" : { - "type" : "object", - "nullable" : true, - "properties" : { - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" - }, - "entity" : { - "type" : "object", - "nullable" : true - }, - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "messageBodyWorkers" : { - "$ref" : "#/components/schemas/MessageBodyWorkers" - }, - "parameterizedHeaders" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ParameterizedHeader" - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "parent" : { - "$ref" : "#/components/schemas/MultiPart" - }, - "providers" : { - "$ref" : "#/components/schemas/Providers" - } - } - }, - "BoulevardType" : { + "AperioTamperStateEvent" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "accessWindowAfterMinutes" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "accessWindowBeforeMinutes" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "boulevardBusinessId" : { - "type" : "string", - "nullable" : true - }, - "boulevardLocationToRhombusLocationMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "refreshToken" : { + "aperioDoorId" : { "type" : "string", "nullable" : true }, - "rhombusToken" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "state" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } } ], "nullable" : true, "properties" : { - "enabled" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "correlationId" : { + "type" : "string", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Boulevard_BoulevardUnlockRequest" : { - "type" : "object", - "description" : "Request object for unlocking a door via Boulevard.", - "properties" : { - "doorUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sessionToken" : { - "type" : "string", - "description" : "Boulevard session token", - "nullable" : true - } - } - }, - "Boulevard_BoulevardUnlockResponse" : { - "type" : "object", - "description" : "Response object for a Boulevard unlock request.", - "properties" : { - "doorName" : { - "type" : "string", - "description" : "Name of the door that was unlocked", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMessage" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Error message if unlock failed", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "errorMsg" : { - "type" : "string", + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "success" : { - "type" : "boolean", - "description" : "Whether the unlock was successful", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BoundingBoxType" : { - "type" : "object", - "properties" : { - "bottom" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "left" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "right" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "top" : { - "type" : "number", - "format" : "float", - "nullable" : true - } - } - }, - "BoxSettings" : { + "AperioType" : { "type" : "object", - "description" : "Box file storage integration settings to update", + "allOf" : [ ], + "nullable" : true, "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "enablingUser" : { - "type" : "string", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "enablingUserUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "enterpriseId" : { - "type" : "string", - "nullable" : true - }, - "folderId" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BrivoSettings" : { + "ApiClientTypeEnum" : { + "type" : "string", + "enum" : [ "PARTNER_DEVELOPER", "DEVELOPER", "DOOR_STATION", "INTERNAL_SALESFORCE", "TVOS", "WINDOWS", "LINUX", "KIOSK", "KEYPAD", "SQUARE", "KISI", "OPENPATH", "TOAST", "BOULEVARD", "BRIVO", "EXECUTABLE", "HALO", "SALTO", "BUTTERFLYMX", "GENEA", "PRODATAKEY", "ENVOY", "AMT", "PIMLOC", "PLACEOS", "OMNIALERT", "FLIC", "SHELLY_DEVICE_EVENT", "NINEONEONECELLULAR", "HONEYWELL_ELEMENTS", "HONEYWELL_ONGUARD", "HONEYWELL_NETBOX", "TRITON", "CHATBOT", "SIGNATURE_API", "INCOMING_WEBHOOK", "UNKNOWN" ] + }, + "ApiTokenApplicationType" : { "type" : "object", "properties" : { - "accessToken" : { - "type" : "string", - "nullable" : true - }, - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "clientId" : { - "type" : "string", - "nullable" : true + "authType" : { + "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" }, - "clientSecret" : { + "authenticationTokenHash" : { "type" : "string", "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorToCameraMap" : { + "clientDetails" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "type" : "string", "nullable" : true }, - "nullable" : true, - "writeOnly" : true - }, - "enabled" : { - "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "clientType" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" + }, + "csr" : { + "type" : "string", "nullable" : true }, - "enablingUser" : { + "displayName" : { "type" : "string", "nullable" : true }, - "enablingUserUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "migrated" : { - "type" : "boolean", - "nullable" : true - }, - "password" : { - "type" : "string", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "username" : { + "tokenUuid" : { "type" : "string", - "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "BrivoType" : { + "ApiTokenAuthTypeEnum" : { + "type" : "string", + "description" : "Authentication type for the API token", + "enum" : [ "API_TOKEN", "CERT" ] + }, + "ApiTokenEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "accessToken" : { - "type" : "string", - "nullable" : true - }, - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiKey" : { - "type" : "string", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "clientId" : { - "type" : "string", - "nullable" : true - }, - "clientSecret" : { + "tokenName" : { "type" : "string", "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "password" : { + "tokenUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "refreshToken" : { + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" + } + } + }, + "ApiTokenLockdownEventOriginator" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "tokenName" : { "type" : "string", "nullable" : true }, - "rhombusToken" : { + "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "username" : { - "type" : "string", - "nullable" : true - }, - "version" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } } } ], "nullable" : true, "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" } } }, - "BurstyRateLimit" : { + "ApiTokenType" : { "type" : "object", + "description" : "List of API tokens", "properties" : { - "base_interval_ms" : { + "allowedRequetsPerSecond" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "burst_token_generation_ms" : { - "type" : "integer", - "format" : "int32", + "authType" : { + "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" + }, + "authenticationTokenHash" : { + "type" : "string", "nullable" : true }, - "burst_token_initial_count" : { - "type" : "integer", - "format" : "int32", + "cert" : { + "type" : "string", "nullable" : true }, - "burst_token_max_count" : { - "type" : "integer", - "format" : "int32", + "certFingerprint" : { + "type" : "string", "nullable" : true - } - } - }, - "ButterflyMXSettings" : { - "type" : "object", - "properties" : { - "buildingWebhookIdMap" : { + }, + "clientDetails" : { "type" : "object", "additionalProperties" : { "type" : "string", - "description" : "A HashMap of . ", "nullable" : true }, - "description" : "A HashMap of . ", "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true + "clientType" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" }, - "enabled" : { - "type" : "boolean", + "csr" : { + "type" : "string", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "displayName" : { + "type" : "string", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "hashed" : { + "type" : "boolean", "nullable" : true }, - "enablingUserUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "indexFaces" : { - "type" : "boolean", + "permissionGroupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "migrated" : { + "restrictToAllowedIps" : { "type" : "boolean", "nullable" : true }, - "panelInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ButterflymxPanelInfoType" - }, - "description" : "A HashMap of .", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { + "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true } } }, - "ButterflyMXType" : { + "AppleWalletDesfireCredential" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { + "adminKeyDiversificationData" : { "type" : "string", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "buildingWebhookIdMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A HashMap of . ", - "nullable" : true - }, - "description" : "A HashMap of . ", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true + "algorithm" : { + "$ref" : "#/components/schemas/SecureTokenAlgorithmEnum" }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + "appName" : { + "type" : "string", "nullable" : true }, - "doorsValidated" : { - "type" : "boolean", + "appOS" : { + "type" : "string", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "appStatusUpdatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "indexFaces" : { - "type" : "boolean", + "appVersion" : { + "type" : "string", "nullable" : true }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "baseKeyIdentifier" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "panelInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ButterflymxPanelInfoType" - }, - "description" : "A HashMap of .", - "nullable" : true + "clientType" : { + "$ref" : "#/components/schemas/MobileTokenOSEnum" }, - "refreshToken" : { + "deviceModel" : { "type" : "string", "nullable" : true }, - "rhombusToken" : { + "installationId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "userAgent" : { + "type" : "string", "nullable" : true }, - "tokenValid" : { + "userAuthRequired" : { "type" : "boolean", "nullable" : true } @@ -54254,427 +56018,461 @@ } ], "nullable" : true, "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" }, - "orgUuid" : { + "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ButterflymxBuilding" : { - "type" : "object", - "properties" : { - "id" : { + }, + "lastUsedAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "name" : { + "lastUsedLocationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "panels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DoorType" - }, - "nullable" : true - } - } - }, - "ButterflymxPanelInfoType" : { - "type" : "object", - "description" : "A HashMap of .", - "nullable" : true, - "properties" : { - "assignedCameraList" : { - "type" : "array", - "description" : "The list of Rhombus Camera RUUIDs.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "buildingId" : { - "type" : "integer", - "format" : "int32", - "description" : "The ButterflyMx Building Id.", - "nullable" : true + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true }, - "locationUuid" : { + "managedCredUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "panelName" : { + "note" : { "type" : "string", - "description" : "The ButterflyMx Panel Name.", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - } - } - }, - "ButtonEnumType" : { - "type" : "string", - "enum" : [ "integrated_generic_button", "integrated_doorbell_button" ] - }, - "ButtonEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "buttonPress" : { - "$ref" : "#/components/schemas/ButtonPressEnum" - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "newSupervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - }, - "pressDurationMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "createdAtMs" : { + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "locationUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "value" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "Apple_wallet_AppleWalletDeviceRegistrationWSRequest" : { + "type" : "object", + "properties" : { + "pushToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "ButtonIntegrationRuleTriggerType" : { + "Apple_wallet_AppleWalletLogWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "thirdPartyBatteryLevel" : { - "type" : "string", - "nullable" : true - }, - "thirdPartyButtonAction" : { - "type" : "string", - "nullable" : true - }, - "thirdPartyButtonName" : { - "type" : "string", - "nullable" : true - }, - "thirdPartyButtonSerialNumber" : { - "type" : "string", - "nullable" : true - }, - "thirdPartyButtonUuid" : { + "properties" : { + "logs" : { + "type" : "array", + "items" : { "type" : "string", "nullable" : true }, - "timestamp" : { + "nullable" : true + } + } + }, + "ArmMonitoringRule" : { + "type" : "object", + "description" : "Rule used to manually arm scheduled alarm policies while the monitoring mode is set to scheduled.\n", + "properties" : { + "activeSinceMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The UNIX timestamp (in milliseconds) when this rule went into effect.", + "nullable" : true + }, + "armAllUntilMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The UNIX timestamp (in milliseconds) to manually arm all alarm policies until.", + "nullable" : true + }, + "armedAlarmPolicies" : { + "type" : "object", + "additionalProperties" : { "type" : "integer", "format" : "int64", + "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will next resume (i.e., when the manual arm expires).\n", "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + }, + "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will next resume (i.e., when the manual arm expires).\n", + "nullable" : true } } }, - "ButtonModeEnum" : { - "type" : "string", - "description" : "Optional button mode configuration", - "enum" : [ "PANIC", "PROGRAMMABLE", "DOORBELL", "NONE" ] - }, - "ButtonPhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "GPIO_INPUT", "BUTTON_INPUT" ] - }, - "ButtonPortType" : { + "AspectRatio" : { "type" : "object", "properties" : { - "boardNum" : { + "height" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "portNum" : { + "width" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "portType" : { - "$ref" : "#/components/schemas/ButtonPhysicalPortEnumType" } } }, - "ButtonPressEnum" : { - "type" : "string", - "enum" : [ "NONE", "SINGLE", "DOUBLE", "LONG", "INITIAL_PRESS", "LONG_RELEASE" ] - }, - "ButtonSettingsSelectiveUpdate" : { + "AudioExpressionDetectionConfig" : { "type" : "object", - "description" : "Update Button settings", "properties" : { - "button_emergency_onsite_contact" : { - "$ref" : "#/components/schemas/EmergencyContact" + "category" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "button_test_mode_enabled" : { - "type" : "boolean", + "confidence_min" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "expression" : { + "type" : "string", + "nullable" : true + }, + "loudness_min" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Button_ButtonHealthDetailsEnum" : { - "type" : "string", - "description" : "Detailed health status for button sensors.", - "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] - }, - "Button_ButtonHealthEnum" : { + "AudioGatewayStatusEnum" : { "type" : "string", - "description" : "Health status for button sensors.", - "enum" : [ "GREEN", "RED" ] + "enum" : [ "SUCCESS", "ERROR", "BACKOFF", "IGNORED", "INITIATED", "SUBMITTED", "UNKNOWN" ] }, - "Button_CreateRuleForButtonWSRequest" : { + "AudioLoudActivityEventType" : { "type" : "object", - "description" : "Request to create a rule for a button sensor.", + "allOf" : [ { + "type" : "object", + "properties" : { + "audioLufsThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "rule" : { - "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" } } }, - "Button_CreateRuleForButtonWSResponse" : { + "AudioParamConfig" : { "type" : "object", - "description" : "Response from creating a rule for a button sensor.", + "description" : "Audio analysis parameters", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "expressions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AudioExpressionDetectionConfig" + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "significant_loudness_min" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Button_DeleteRuleForButtonWSRequest" : { + "AudioPlaybackActionRecordType" : { "type" : "object", - "description" : "Request to delete a rule for a button sensor.", "properties" : { - "ruleUuid" : { + "audioClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sensorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audioGatewayStatuses" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/AudioGatewayStatusEnum" + }, "nullable" : true } } }, - "Button_DeleteRuleForButtonWSResponse" : { + "AudioPlaybackActionType" : { "type" : "object", - "description" : "Response from deleting a rule for a button sensor.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "audioClipUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "audioGateways" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "loopDurationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "playCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true + }, + "source" : { + "$ref" : "#/components/schemas/AudioPlaybackSourceEnum" } } }, - "Button_ExternalButtonRuleType" : { + "AudioPlaybackSourceEnum" : { + "type" : "string", + "enum" : [ "ON_DEVICE", "STREAM" ] + }, + "AudioPolicyType" : { "type" : "object", - "description" : "External button rule configuration.", + "description" : "List of audio policies using the schedule", "properties" : { - "action" : { - "$ref" : "#/components/schemas/RuleActionType" + "defaultTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AudioTriggerType" + }, + "nullable" : true, + "uniqueItems" : true }, - "ruleFilters" : { - "$ref" : "#/components/schemas/RuleFilterType" + "description" : { + "type" : "string", + "nullable" : true }, - "ruleName" : { + "name" : { "type" : "string", - "description" : "Name of the button rule", - "example" : "Emergency Alert Rule", "nullable" : true }, - "ruleUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sensorUuid" : { + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AudioScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "AudioScheduledTriggerType" : { + "type" : "object", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, - "triggerPress" : { - "$ref" : "#/components/schemas/ButtonPressEnum" + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AudioTriggerType" + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Button_GetButtonPressEventsForSensorWSRequest" : { + "AudioTriggerType" : { "type" : "object", - "description" : "Request to get button press events for a specific sensor.", "properties" : { - "createdAfterMs" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "threshold" : { "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds to get events created after this time", - "example" : 1640995200000, + "format" : "int32", + "nullable" : true + } + } + }, + "AudioUploadMetadataType" : { + "type" : "object", + "description" : "List of audio upload metadata for the organization", + "properties" : { + "audioPlaintext" : { + "type" : "string", "nullable" : true }, - "createdBeforeMs" : { + "audioSSML" : { + "type" : "string", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "durationMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp in milliseconds to get events created before this time", - "example" : 1640995200000, "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of events to return", - "example" : 100, + "mutable" : { + "type" : "boolean", "nullable" : true }, - "sensorUuid" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "s3ObjectKey" : { + "type" : "string", + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "voiceId" : { + "type" : "string", + "nullable" : true } } }, - "Button_GetButtonPressEventsForSensorWSResponse" : { + "Audiogateway_AudioGatewayOfflineLanStreamingInfo" : { "type" : "object", - "description" : "Response containing button press events for a sensor.", + "description" : "Information for offline LAN streaming of audio gateway content.", + "properties" : { + "accessToken" : { + "type" : "string", + "description" : "Access token for offline LAN streaming", + "example" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", + "nullable" : true + }, + "lanAddresses" : { + "type" : "array", + "description" : "List of LAN addresses for offline streaming", + "items" : { + "type" : "string", + "description" : "List of LAN addresses for offline streaming", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Audiogateway_DeleteAudioGatewayWSRequest" : { + "type" : "object", + "description" : "Request to remove an audio gateway from organization.", + "properties" : { + "gatewayUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "mummify" : { + "type" : "boolean", + "description" : "Indicates whether to mummify the audio gateway", + "example" : false, + "nullable" : true + } + } + }, + "Audiogateway_DeleteAudioGatewayWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of deleting an audio gateway.", "properties" : { "error" : { "type" : "boolean", @@ -54684,13 +56482,8 @@ "type" : "string", "nullable" : true }, - "events" : { - "type" : "array", - "description" : "List of button press events for the sensor", - "items" : { - "$ref" : "#/components/schemas/ButtonEventType" - }, - "nullable" : true + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", @@ -54698,26 +56491,25 @@ } } }, - "Button_GetButtonRulesForOrgWSRequest" : { + "Audiogateway_GetAudioGatewayConfigWSRequest" : { "type" : "object", - "description" : "Request to get rules for all buttons in an organization." + "description" : "Request to get configuration for an audio gateway.", + "properties" : { + "audioGatewayUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } }, - "Button_GetButtonRulesForOrgWSResponse" : { + "Audiogateway_GetAudioGatewayConfigWSResponse" : { "type" : "object", - "description" : "Response containing rules for all buttons in an organization.", + "description" : "Response containing configuration for an audio gateway.", "properties" : { - "buttonUuidToRulesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of button UUIDs to their associated rules", - "items" : { - "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" - }, - "nullable" : true - }, - "description" : "Map of button UUIDs to their associated rules", - "nullable" : true + "config" : { + "$ref" : "#/components/schemas/IAudioUserConfig" }, "error" : { "type" : "boolean", @@ -54733,13 +56525,13 @@ } } }, - "Button_GetMinimalButtonStatesWSRequest" : { + "Audiogateway_GetAudioGatewayOfflineLanStreamingInfoWSRequest" : { "type" : "object", - "description" : "Request to get minimal state information for all button sensors." + "description" : "Request to get offline LAN streaming information for all audio gateways." }, - "Button_GetMinimalButtonStatesWSResponse" : { + "Audiogateway_GetAudioGatewayOfflineLanStreamingInfoWSResponse" : { "type" : "object", - "description" : "Response containing minimal state information for all button sensors.", + "description" : "Response containing offline LAN streaming information for all audio gateways.", "properties" : { "error" : { "type" : "boolean", @@ -54749,12 +56541,12 @@ "type" : "string", "nullable" : true }, - "states" : { - "type" : "array", - "description" : "List of minimal button state information", - "items" : { - "$ref" : "#/components/schemas/Button_MinimalButtonStateType" + "info" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Audiogateway_AudioGatewayOfflineLanStreamingInfo" }, + "description" : "Map of audio gateway UUIDs to their offline LAN streaming information", "nullable" : true }, "warningMsg" : { @@ -54763,22 +56555,36 @@ } } }, - "Button_GetRulesForButtonWSRequest" : { + "Audiogateway_GetAudioSeekpointsWSRequest" : { "type" : "object", - "description" : "Request to get rules for a button sensor.", + "description" : "Request to get audio seek points for an audio gateway.", "properties" : { - "sensorUuid" : { + "deviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "duration" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds", + "example" : 3600, + "nullable" : true + }, + "startTime" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds since epoch", + "example" : 1640995200000, "nullable" : true } } }, - "Button_GetRulesForButtonWSResponse" : { + "Audiogateway_GetAudioSeekpointsWSResponse" : { "type" : "object", - "description" : "Response containing rules for a button sensor.", + "description" : "Response containing audio seek points for an audio gateway.", "properties" : { "error" : { "type" : "boolean", @@ -54788,11 +56594,11 @@ "type" : "string", "nullable" : true }, - "rules" : { + "footageSeekPoints" : { "type" : "array", - "description" : "List of rules configured for the button sensor", + "description" : "List of audio seek points for the specified time period", "items" : { - "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" + "$ref" : "#/components/schemas/FootageSeekPointV2Type" }, "nullable" : true }, @@ -54802,148 +56608,312 @@ } } }, - "Button_MinimalButtonStateType" : { + "Audiogateway_GetFullAudioGatewayStateWSRequest" : { "type" : "object", - "description" : "Minimal state information for a button sensor.", + "description" : "Request to get detailed information about the state of a specified audio gateway.", "properties" : { - "associatedCameras" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "force" : { + "type" : "boolean", + "description" : "Force refresh of the device state", + "example" : false, + "nullable" : true + } + } + }, + "Audiogateway_GetFullAudioGatewayStateWSResponse" : { + "type" : "object", + "description" : "Response containing detailed information about the state of a specified audio gateway.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "fullAudioGatewayState" : { + "$ref" : "#/components/schemas/FullDeviceStateType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Audiogateway_GetMediaUrisWSRequest" : { + "type" : "object", + "description" : "Request to get media URIs for an audio gateway to retrieve footage.", + "properties" : { + "gatewayUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + } + } + }, + "Audiogateway_GetMediaUrisWSResponse" : { + "type" : "object", + "description" : "Response containing media URIs for audio gateway footage retrieval.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "lanCheckUrls" : { "type" : "array", - "description" : "List of associated camera device UUIDs", + "description" : "List of LAN check URLs to verify device availability on local network", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "description" : "List of LAN check URLs to verify device availability on local network", "nullable" : true }, "nullable" : true }, - "batteryPercent" : { - "type" : "integer", - "format" : "int32", - "description" : "Battery percentage of the button sensor", - "example" : 85, + "lanLiveMpdUris" : { + "type" : "array", + "description" : "List of LAN live MPD URIs for local network media streaming", + "items" : { + "type" : "string", + "description" : "List of LAN live MPD URIs for local network media streaming", + "nullable" : true + }, "nullable" : true }, - "buttonEmergencyOnsiteContact" : { - "$ref" : "#/components/schemas/EmergencyContact" + "lanLiveOpusUris" : { + "type" : "array", + "description" : "List of LAN live Opus URIs for local network audio streaming", + "items" : { + "type" : "string", + "description" : "List of LAN live Opus URIs for local network audio streaming", + "nullable" : true + }, + "nullable" : true }, - "buttonMode" : { - "$ref" : "#/components/schemas/ButtonModeEnum" + "lanVodMpdUrisTemplates" : { + "type" : "array", + "description" : "List of LAN VOD MPD URI templates for local network video on demand", + "items" : { + "type" : "string", + "description" : "List of LAN VOD MPD URI templates for local network video on demand", + "nullable" : true + }, + "nullable" : true }, - "closestBaseStation" : { + "wanLiveMpdUri" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "WAN live MPD URI for real-time media streaming", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Creation timestamp in milliseconds", - "example" : 1640995200000, + "wanLiveOpusUri" : { + "type" : "string", + "description" : "WAN live Opus URI for real-time audio streaming", "nullable" : true }, - "firmwareVersion" : { + "wanVodMpdUriTemplate" : { "type" : "string", - "description" : "Firmware version of the button sensor", - "example" : "2.1.0", + "description" : "WAN VOD MPD URI template for video on demand content", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the button sensor is located", - "example" : 1, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Audiogateway_GetMinimalAudioGatewayStatesWSRequest" : { + "type" : "object", + "description" : "Request to get basic state information for all audio gateways." + }, + "Audiogateway_GetMinimalAudioGatewayStatesWSResponse" : { + "type" : "object", + "description" : "Response containing basic state information for all audio gateways.", + "properties" : { + "audioGatewayStates" : { + "type" : "array", + "description" : "List of minimal audio gateway state information", + "items" : { + "$ref" : "#/components/schemas/MinimalAudioGatewayStateType" + }, "nullable" : true }, - "health" : { - "$ref" : "#/components/schemas/Button_ButtonHealthEnum" - }, - "healthDetails" : { - "$ref" : "#/components/schemas/Button_ButtonHealthDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lastSeenSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Last time the button sensor was seen in seconds", - "example" : 1640995200, + "error" : { + "type" : "boolean", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the button sensor", - "example" : 37.7749, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Audiogateway_RebootAudioGatewayWSRequest" : { + "type" : "object", + "description" : "Request to reboot the specified audio gateway.", + "properties" : { + "audioGatewayUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "audioGatewayUuid" ] + }, + "Audiogateway_UpdateAudioGatewayConfigWSRequest" : { + "type" : "object", + "description" : "Request to update configuration for an audio gateway.", + "properties" : { + "audioAnalysisParams" : { + "$ref" : "#/components/schemas/AudioParamConfig" }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the button sensor", - "example" : -122.4194, + "audioExternalMicBoost" : { + "type" : "integer", + "format" : "int32", + "description" : "Adjust boost for external mic. Integer between 0 and 3.", + "example" : 1, "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the button sensor", - "example" : "Main Entrance Button", + "audioExternalMicVolume" : { + "type" : "integer", + "format" : "int32", + "description" : "Adjust volume for external mic. Integer between 0 and 63.", + "example" : 32, "nullable" : true }, - "sensorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audioExternalSpeakerVolume" : { + "type" : "integer", + "format" : "int32", + "description" : "Adjust volume for external speaker. Integer between 0 and 127.", + "example" : 64, "nullable" : true }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the button sensor", - "example" : "SN123456789", + "audioInternalMicAecEnabled" : { + "type" : "boolean", + "description" : "Enable acoustic echo cancellation for internal microphone", + "example" : true, "nullable" : true }, - "signalStrength" : { + "audioInternalMicBoost" : { "type" : "integer", "format" : "int32", - "description" : "Signal strength of the button sensor", - "example" : -45, + "description" : "Adjust boost for internal mic. Integer between 0 and 3.", + "example" : 1, "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "audioInternalMicVolume" : { + "type" : "integer", + "format" : "int32", + "description" : "Adjust volume for internal mic. Integer between 0 and 63.", + "example" : 32, + "nullable" : true }, - "testModeEnabled" : { + "audioInternalSpeakerVolume" : { + "type" : "integer", + "format" : "int32", + "description" : "Adjust volume for internal speaker. Integer between 0 and 127.", + "example" : 64, + "nullable" : true + }, + "audioRecord" : { "type" : "boolean", - "description" : "Indicates if test mode is enabled for the button sensor", + "description" : "Enable/disable audio recording. Cannot set to true unless organization settings allow it", + "example" : true, + "nullable" : true + }, + "audioUseExternalMic" : { + "type" : "boolean", + "description" : "Use external microphone instead of internal", + "example" : false, + "nullable" : true + }, + "audioUseExternalSpeaker" : { + "type" : "boolean", + "description" : "Use external speaker instead of internal", "example" : false, "nullable" : true + }, + "deviceMicEnabled" : { + "type" : "boolean", + "description" : "Enable/disable device mic. Cannot set to true unless organization settings allow it", + "example" : true, + "nullable" : true + }, + "deviceSpeakerEnabled" : { + "type" : "boolean", + "description" : "Enable/disable device speaker", + "example" : true, + "nullable" : true + }, + "frontendEqualizerHighShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerLowShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking1" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking2" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking3" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendNoiseSuppression" : { + "type" : "boolean", + "description" : "Enable frontend noise suppression", + "example" : true, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true } } }, - "Button_UpdateButtonConfigWSRequest" : { + "Audiogateway_UpdateAudioGatewayConfigWSResponse" : { "type" : "object", - "description" : "Request to update button sensor configuration.", + "description" : "Response indicating the result of updating audio gateway configuration.", "properties" : { - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableButtonUserConfig" + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Button_UpdateButtonDetailsWSRequest" : { + "Audiogateway_UpdateAudioGatewayDetailsWSRequest" : { "type" : "object", - "description" : "Request to update button sensor details.", + "description" : "Request to update details for an audio gateway. Note: uuid is a required field.", "properties" : { "associatedCameras" : { "type" : "array", @@ -54957,28 +56927,52 @@ }, "nullable" : true }, - "buttonMode" : { - "$ref" : "#/components/schemas/ButtonModeEnum" + "associatedCamerasUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "description" : "Indicates whether the audio gateway is deleted", + "example" : false, + "nullable" : true + }, + "deletedUpdated" : { + "type" : "boolean", + "nullable" : true }, "description" : { "type" : "string", - "description" : "Optional description for the button sensor", + "description" : "Description of the audio gateway", + "example" : "Audio gateway for main entrance monitoring", + "nullable" : true + }, + "descriptionUpdated" : { + "type" : "boolean", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Optional floor number", + "description" : "Floor number where the audio gateway is located", "example" : 1, "nullable" : true }, + "floorNumberUpdated" : { + "type" : "boolean", + "nullable" : true + }, "latitude" : { "type" : "number", "format" : "double", - "description" : "Optional latitude coordinate", + "description" : "Latitude coordinate of the audio gateway location", "example" : 37.7749, "nullable" : true }, + "latitudeUpdated" : { + "type" : "boolean", + "nullable" : true + }, "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -54986,553 +56980,499 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "locationUuidUpdated" : { + "type" : "boolean", + "nullable" : true + }, "longitude" : { "type" : "number", "format" : "double", - "description" : "Optional longitude coordinate", + "description" : "Longitude coordinate of the audio gateway location", "example" : -122.4194, "nullable" : true }, + "longitudeUpdated" : { + "type" : "boolean", + "nullable" : true + }, "name" : { "type" : "string", - "description" : "Optional name for the button sensor", + "description" : "Name of the audio gateway", + "example" : "Main Entrance Audio Gateway", "nullable" : true }, - "sensorUuid" : { + "nameUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "policyUuidUpdated" : { + "type" : "boolean", + "nullable" : true + }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key has been updated", - "example" : false, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Buyer" : { + "Audiogateway_UpdateAudioGatewayDetailsWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating audio gateway details.", "properties" : { - "address1" : { - "type" : "string", - "nullable" : true - }, - "address2" : { - "type" : "string", - "nullable" : true - }, - "address3" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "city" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "companyName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "contactName" : { - "type" : "string", + } + } + }, + "Audioplayback_CancelLoopingAudioPlaybackWSRequest" : { + "type" : "object", + "description" : "Request to cancel looping audio playback on audio devices.", + "properties" : { + "audioDevices" : { + "type" : "array", + "description" : "List of audio device UUIDs to cancel looping playback on", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true - }, - "country" : { - "type" : "string", + } + } + }, + "Audioplayback_CancelLoopingAudioPlaybackWSResponse" : { + "type" : "object", + "description" : "Response from canceling looping audio playback.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "phoneNumber" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "postalCode" : { - "type" : "string", + "successMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "description" : "Map of audio device UUIDs to success status for canceling playback", + "nullable" : true + }, + "description" : "Map of audio device UUIDs to success status for canceling playback", "nullable" : true }, - "state" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "COSensorType" : { + "Audioplayback_DeleteAudioUploadMetadataWSRequest" : { "type" : "object", + "description" : "Request to delete audio upload metadata.", "properties" : { - "adcRaw" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "adcVoltage" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "coConcentration" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + "audioUploadUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "CameraAiDewarpConfigType" : { + "Audioplayback_DeleteAudioUploadMetadataWSResponse" : { "type" : "object", + "description" : "Response from deleting audio upload metadata.", "properties" : { - "dewarp_tile_height" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "dewarp_tile_width" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orientation" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "CameraConfiguration" : { + "Audioplayback_GetAudioUploadMetadataForOrgWSRequest" : { + "type" : "object", + "description" : "Request to get audio upload metadata for organization." + }, + "Audioplayback_GetAudioUploadMetadataForOrgWSResponse" : { "type" : "object", + "description" : "Response containing audio upload metadata for organization.", "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "checkConditionOverride" : { - "$ref" : "#/components/schemas/CheckCondition" - }, - "exampleImages" : { + "audioUploadMetadata" : { "type" : "array", + "description" : "List of audio upload metadata for the organization", "items" : { - "$ref" : "#/components/schemas/ExampleImage" + "$ref" : "#/components/schemas/AudioUploadMetadataType" }, "nullable" : true }, - "promptExtension" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "promptOverride" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "region" : { - "$ref" : "#/components/schemas/RegionPolygonType" - }, - "scheduledActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ScheduledAction" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "CameraCrossCountingSettingsType" : { + "Audioplayback_PlayAudioUploadWSRequest" : { "type" : "object", + "description" : "Request to play an uploaded audio clip through audio devices.", "properties" : { - "directions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CrossingDirectionEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "in_roi" : { + "audioGatewayUuids" : { "type" : "array", + "description" : "List of audio gateway device UUIDs to play audio through", "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "object_type" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" + "audioUploadUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "object_type_id" : { + "loopDurationSec" : { "type" : "integer", "format" : "int32", + "description" : "Duration in seconds to loop the audio playback", + "example" : 30, "nullable" : true }, - "out_roi" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" - }, + "playCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times to play the audio clip", + "example" : 1, "nullable" : true } } }, - "CameraDewarpModeEnum" : { - "type" : "string", - "enum" : [ "NO_TRANSFORM", "NORMAL", "PANORAMA", "SUB_REGION", "VERTICAL_PANORAMA", "TRANSVERSE_MERCATOR", "MERCATOR", "EQUIRECTANGULAR" ] - }, - "CameraHumanLoiteringSettingsType" : { + "Audioplayback_PlayAudioUploadWSResponse" : { "type" : "object", + "description" : "Response from playing an uploaded audio clip.", "properties" : { - "roi" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" - }, + "error" : { + "type" : "boolean", "nullable" : true - } - } - }, - "CameraMeteringConfigType" : { - "type" : "object", - "properties" : { - "rotation" : { - "type" : "integer", - "format" : "int32", + }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "table" : { + "success" : { + "type" : "boolean", + "description" : "Indicates if audio playback was successful", + "example" : true, + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "CameraMotorConfigType" : { + "Audioplayback_UpdateAudioUploadMetadataWSRequest" : { "type" : "object", + "description" : "Request to update audio upload metadata.", "properties" : { - "af_enabled" : { - "type" : "boolean", - "nullable" : true - }, - "af_region" : { - "$ref" : "#/components/schemas/PermyriadRect" - }, - "focus" : { - "type" : "integer", - "format" : "int32", + "audioUploadUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "piris" : { - "type" : "integer", - "format" : "int32", + "newDescription" : { + "type" : "string", + "description" : "New description for the audio clip", + "example" : "Updated welcome message for visitors", "nullable" : true }, - "zoom" : { - "type" : "integer", - "format" : "int32", + "newDisplayName" : { + "type" : "string", + "description" : "New display name for the audio clip", + "example" : "Updated Welcome Message", "nullable" : true } } }, - "CameraMountingDirectionEnum" : { - "type" : "string", - "enum" : [ "DOWN", "UP", "SIDEWAYS", "UNKNOWN" ] - }, - "CameraPTZConfigType" : { + "Audioplayback_UpdateAudioUploadMetadataWSResponse" : { "type" : "object", + "description" : "Response from updating audio upload metadata.", "properties" : { - "offset_x_percent" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "offset_y_percent" : { - "type" : "number", - "format" : "float", + "error" : { + "type" : "boolean", "nullable" : true }, - "rotation" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "size_percent" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "CameraPTZEngineEnum" : { - "type" : "string", - "enum" : [ "DIGITAL", "MECHANICAL", "NONE", "UNKNOWN" ] - }, - "CameraPTZMovementEnum" : { - "type" : "string", - "enum" : [ "RELATIVE", "ABSOLUTE" ] - }, - "CameraPTZTranslationSpaceEnum" : { - "type" : "string", - "enum" : [ "FOV", "DIGITAL", "NONE", "UNKNOWN" ] - }, - "CameraPolicyV2Type" : { + "Audioplayback_UploadAudioPcmWSResponse" : { "type" : "object", - "description" : "List of camera policies using the schedule", + "description" : "Response from uploading PCM audio clip.", "properties" : { - "defaultTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CameraTriggerType" - }, - "nullable" : true, - "uniqueItems" : true + "encodingFailure" : { + "type" : "boolean", + "description" : "Indicates if audio encoding failed", + "example" : false, + "nullable" : true }, - "description" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CameraScheduledTriggerType" - }, - "nullable" : true - }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "CameraScheduledTriggerType" : { + "Audioplayback_UploadAudioTextWSRequest" : { "type" : "object", + "description" : "Request to upload text for audio synthesis.", "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "audioPlaintext" : { + "type" : "string", + "description" : "Plain text to synthesize into audio", + "example" : "Welcome to our facility", + "nullable" : true }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CameraTriggerType" - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "CameraTriggerType" : { - "type" : "object", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "dwellTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "dwellTimeResetMs" : { - "type" : "integer", - "format" : "int64", + "audioSSML" : { + "type" : "string", + "description" : "SSML markup for audio synthesis", + "example" : "Welcome to our facility", "nullable" : true }, - "faceAlertLabelSet" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "faceAlertUnidentified" : { - "type" : "boolean", + "description" : { + "type" : "string", + "description" : "Description of the audio clip", + "example" : "A welcome message for visitors", "nullable" : true }, - "faceAllowedLabelSet" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "threshold" : { - "type" : "integer", - "format" : "int32", + "displayName" : { + "type" : "string", + "description" : "Display name for the audio clip", + "example" : "Welcome Message", "nullable" : true }, - "vehicleAlertLabelSet" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "vehicleAlertUnidentified" : { - "type" : "boolean", + "voiceId" : { + "type" : "string", + "description" : "Voice ID for text-to-speech synthesis", + "example" : "en-US-Neural2-F", "nullable" : true - }, - "vehicleAllowedLabelSet" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true } } }, - "CameraType" : { + "Audioplayback_UploadAudioTextWSResponse" : { "type" : "object", - "description" : "List of third-party cameras assigned to the specified NVR", + "description" : "Response from uploading text for audio synthesis.", "properties" : { - "archiveRegion" : { - "type" : "string", + "encodingFailure" : { + "type" : "boolean", + "description" : "Indicates if audio encoding failed", + "example" : false, "nullable" : true }, - "cameraFramerate" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "customData" : { - "type" : "string", + "invalidSSML" : { + "type" : "boolean", + "description" : "Indicates if SSML markup is invalid", + "example" : false, "nullable" : true }, - "deleted" : { + "synthesisFailure" : { "type" : "boolean", + "description" : "Indicates if text-to-speech synthesis failed", + "example" : false, "nullable" : true }, - "description" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceFacetRadians" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "directionRadians" : { - "type" : "number", - "format" : "float", + } + } + }, + "AuditActionEnum" : { + "type" : "string", + "enum" : [ "THREAT_CASE_ESCALATED", "THREAT_CASE_CANCELLED", "THREAT_CASE_DISMISSED", "THREAT_CASE_DELETED", "THREAT_CASE_DELETE_BY_STATUS", "PIN_CREATED", "PIN_DELETED", "ALM_PIN_CREATE", "ALM_PIN_BULK_CREATE", "ALM_PIN_UPDATE", "ALM_PIN_ROTATE", "ALM_PIN_BULK_ROTATE", "ALM_PIN_DELETE", "ALM_PIN_KEY_IN", "ALM_PIN_KEY_IN_FAILED", "BASIC_AUTH_SUCCESS", "BASIC_AUTH_FAILURE", "SAML_LOGIN_WEB", "LOGIN_WEB", "PASSWORDLESS_LOGIN_WEB", "PARTNER_LOGIN_WEB", "PARTNER_PASSWORDLESS_LOGIN_WEB", "SAML_LOGIN_FAILURE_WEB", "LOGIN_FAILURE_WEB", "RHOMBUS_KEY_LOGIN", "RHOMBUS_KEY_PASSWORDLESS_LOGIN", "RHOMBUS_KEY_SAML_LOGIN", "LOGOUT_WEB", "PARTNER_LOGOUT_WEB", "WEB_CONSOLE_ACCESS", "MOBILE_CONSOLE_ACCESS", "SAML_LOGIN_MOBILE", "PARTNER_LOGIN_MOBILE", "PARTNER_PASSWORDLESS_LOGIN_MOBILE", "LOGIN_MOBILE", "PASSWORDLESS_LOGIN_MOBILE", "SAML_LOGIN_FAILURE_MOBILE", "LOGIN_FAILURE_MOBILE", "LOGOUT_MOBILE", "PARTNER_LOGOUT_MOBILE", "MOBILE_ACCESS", "PARTNER_LOGIN_MOBIlE_REFRESH", "LOGIN_MOBIlE_REFRESH", "RHOMBUS_KEY_LOGIN_REFRESH", "CAMERA_WIFI_NETWORK_CHANGED", "CAMERA_FORCED_REBOOT", "AUDIO_GATEWAY_FORCED_REBOOT", "ENVIRONMENTAL_GATEWAY_FORCED_REBOOT", "DOORBELL_CAMERA_FORCED_REBOOT", "BADGE_READER_FORCED_REBOOT", "NVR_FORCED_REBOOT", "FIRMWARE_UPDATE_CAMERA", "DELETE_CAMERA", "DELETE_USER", "DELETE_LOCATION", "LOCATION_CREATE", "LOCATION_UPDATED", "DELETE_ROLE", "ERASE_CAMERA", "POLICY_UPDATE", "POLICY_DELETE", "POLICY_PAUSED_LOCATION", "POLICY_PAUSED_DEVICE", "POLICY_PAUSED_COMPONENT_COMPOSITE", "CREATE_POLICY_ADDENDUM", "DEVICE_REGISTERED", "PENDING_REGISTRATION_CREATE", "PENDING_REGISTRATION_REMOVED", "PENDING_REGISTRATION_UPDATED", "DEVICE_UPDATE", "DEVICE_SETTINGS_UPDATE", "REVERT_TO_DEFAULTS", "DEVICE_FEATURE_UPDATE", "DEVICE_ORG_REASSIGN", "CLAIMKEY_RENEWAL_CREATED", "LICENSES_CLAIMED", "LICENSES_RETURNED", "LICENSE_ASSIGNED", "LICENSE_CREATED", "LICENSE_UPDATED", "USER_UPDATE", "USER_CREATE", "USER_IMPORT", "BULK_PROVISION_CREDENTIALS", "ROLE_CREATE", "POLICY_CREATE", "PARTNER_CLIENT_CREATE", "PARTNER_CLIENT_DELETE", "PARTNER_CUSTOMIZE_CLIENT", "PARTNER_CUSTOMIZE_CLIENT_DEVICE", "ORG_UPDATE", "DELETE_ORG", "DISABLE_ORG", "CREATE_ORG", "ROLE_UPDATE", "USER_ROLE_UPDATE", "USER_EMAIL_UPDATE", "TIMELAPSE_CREATE", "TIMELAPSE_DELETE", "ALERT_DISMISS", "ALL_ALERT_DISMISS", "SAVED_CLIP_CREATE", "SAVED_CLIP_DELETE", "CLIP_GROUP_CREATED", "CLIP_GROUP_DELETE", "SHARED_CLIP_DELETE", "SHARED_CLIP_CREATE", "SHARED_LINK_SENT", "SHARED_LIVE_VIDEO_STREAM_WITH_PASSWORD_CREATE", "SHARED_LIVE_VIDEO_STREAM_WITHOUT_PASSWORD_CREATE", "SHARED_LIVE_VIDEO_STREAM_DELETE", "SHARED_VIDEOWALL_WITH_PASSWORD_CREATE", "SHARED_VIDEOWALL_WITHOUT_PASSWORD_CREATE", "SHARED_VIDEOWALL_DELETE", "RAW_HTTP_STREAM_CREATED", "RAW_HTTP_STREAM_DELETED", "SETUP_VIRTUAL_MFA_DEVICE", "DELETE_VIRTUAL_MFA_DEVICE", "SETUP_SCIM_API_ACCESS", "REVOKE_SCIM_API_ACCESS", "AUDIT_EXPORT", "COUNT_EXPORT", "DIAGNOSTIC_EXPORT", "INVENTORY_EXPORT", "USERS_EXPORT", "UPTIME_EXPORT", "ALM_EVENT_EXPORT", "SUPPORT_TICKET_OPEN", "RMA_OPEN", "FEEDBACK_CREATE", "SUPPORT_ACCESS_GRANT", "SUPPORT_ACCESS_REVOKE", "SUPPORT_PARTNER_ADD", "SUPPORT_PARTNER_REMOVE", "SUPPORT_PARTNER_LOGIN_ACCESS_EXPIRED", "SUPPORT_SEARCH_TICKETS", "ACCEPT_UAP", "ACCEPT_RHOMBUS_UAP", "ACCEPT_ALERTMONITORING_UAP", "CREATE_SEEKPOINT", "DELETE_CUSTOM_SEEKPOINT", "UPDATE_INTEGRATION_SAML", "UPDATE_INTEGRATION_SLACK", "UPDATE_INTEGRATION_SLACK_V2", "DELETE_INTEGRATION_SLACK_V2", "UPDATE_INTEGRATION_BOX", "DELETE_INTEGRATION_BOX", "UPDATE_INTEGRATION_GOOGLE", "DELETE_INTEGRATION_GOOGLE", "UPDATE_INTEGRATION_GOOGLE_V2", "DELETE_INTEGRATION_GOOGLE_V2", "UPDATE_INTEGRATION_PAGERDUTY", "DELETE_INTEGRATION_PAGERDUTY", "UPDATE_INTEGRATION_SERVICENOW", "DELETE_INTEGRATION_SERVICENOW", "UPDATE_INTEGRATION_OFFICE365", "DELETE_INTEGRATION_OFFICE365", "UPDATE_INTEGRATION_DROPBOX", "DELETE_INTEGRATION_DROPBOX", "UPDATE_INTEGRATION_SQUARE", "DELETE_INTEGRATION_SQUARE", "UPDATE_INTEGRATION_AWS", "DELETE_INTEGRATION_AWS", "UPDATE_INTEGRATION_HALO", "DELETE_INTEGRATION_HALO", "UPDATE_INTEGRATION_TRITON", "DELETE_INTEGRATION_TRITON", "UPDATE_INTEGRATION_WEBHOOK", "DELETE_INTEGRATION_WEBHOOK", "UPDATE_INTEGRATION_EMAIL", "DELETE_INTEGRATION_EMAIL", "UPDATE_INTEGRATION_MATTERMOST", "DELETE_INTEGRATION_MATTERMOST", "UPDATE_INTEGRATION_OPENPATH", "DELETE_INTEGRATION_OPENPATH", "UPDATE_INTEGRATION_AVIGILON_ALTA", "DELETE_INTEGRATION_AVIGILON_ALTA", "UPDATE_INTEGRATION_DICE", "DELETE_INTEGRATION_DICE", "UPDATE_INTEGRATION_LUMEO", "DELETE_INTEGRATION_LUMEO", "UPDATE_INTEGRATION_DEVICE", "DELETE_INTEGRATION_DEVICE", "UPDATE_INTEGRATION_GUESTMANAGEMENT", "DELETE_INTEGRATION_GUESTMANAGEMENT", "UPDATE_GUESTMANAGEMENT_SETTINGS", "DELETE_GUESTMANAGEMENT_SETTINGS", "INVITE_GUEST", "CREATE_GUEST", "CHECKIN_GUEST", "CHECKOUT_GUEST", "UPDATE_GUEST", "DELETE_GUEST", "ACTIVATE_KIOSK", "UPDATE_INTEGRATION_OMNIALERT", "DELETE_INTEGRATION_OMNIALERT", "UPDATE_INTEGRATION_OPENTECHALLIANCE", "DELETE_INTEGRATION_OPENTECHALLIANCE", "UPDATE_INTEGRATION_TOAST", "DELETE_INTEGRATION_TOAST", "UPDATE_INTEGRATION_KISI", "DELETE_INTEGRATION_KISI", "UPDATE_INTEGRATION_BRIVO", "DELETE_INTEGRATION_BRIVO", "UPDATE_INTEGRATION_BUTTERFLYMX", "DELETE_INTEGRATION_BUTTERFLYMX", "UPDATE_INTEGRATION_ENVOY", "DELETE_INTEGRATION_ENVOY", "CREATE_ENVOY_INVITE", "UPDATE_INTEGRATION_SALTO", "UPDATE_INTEGRATION_PDK", "DELETE_INTEGRATION_PDK", "UPDATE_INTEGRATION_GENEA", "DELETE_INTEGRATION_GENEA", "UPDATE_INTEGRATION_MICROSOFTTEAMS", "DELETE_INTEGRATION_MICROSOFTTEAMS", "UPDATE_INTEGRATION_AMT", "DELETE_INTEGRATION_AMT", "UPDATE_INTEGRATION_PLACEOS", "DELETE_INTEGRATION_PLACEOS", "UPDATE_INTEGRATION_INTUIFACE", "DELETE_INTEGRATION_INTUIFACE", "UPDATE_INTEGRATION_INFORMACAST", "DELETE_INTEGRATION_INFORMACAST", "UPDATE_INTEGRATION_BOULEVARD", "DELETE_INTEGRATION_BOULEVARD", "UPDATE_INTEGRATION_INNERRANGE", "DELETE_INTEGRATION_INNERRANGE", "UPDATE_INTEGRATION_HONEYWELL_ELEMENTS", "DELETE_INTEGRATION_HONEYWELL_ELEMENTS", "UPDATE_INTEGRATION_HONEYWELL_ONGUARD", "DELETE_INTEGRATION_HONEYWELL_ONGUARD", "UPDATE_INTEGRATION_SHELLY", "DELETE_INTEGRATION_SHELLY", "SEND_INTEGRATION_COMMAND_SHELLY", "UPDATE_INTEGRATION_FLIC", "DELETE_INTEGRATION_FLIC", "UPDATE_INTEGRATION_NINEONEONECELLULAR", "DELETE_INTEGRATION_NINEONEONECELLULAR", "UPDATE_INTEGRATION_PIMLOC", "DELETE_INTEGRATION_PIMLOC", "UPDATE_INTEGRATION_RAPTOR", "DELETE_INTEGRATION_RAPTOR", "UPDATE_INTEGRATION_LLM", "DELETE_INTEGRATION_LLM", "UPDATE_INTEGRATION_NOONLIGHT", "UPDATE_INTEGRATION_ALARM_MONITORING", "ENABLE_LIVE_ALARM_MONITORING", "ENABLE_LIVE_ALARM_MONITORING_LOCATION", "CREATE_ALARM_MONITORING_SETTINGS", "UPDATE_ALARM_MONITORING_SETTINGS", "DELETE_ALARM_MONITORING_SETTINGS", "ENABLE_ALARM_MONITORING_SETTINGS", "DISABLE_ALARM_MONITORING_SETTINGS", "ALM_CANCEL_MANUAL_ARM", "ALM_CANCEL_MANUAL_DISARM", "ALM_THREAT_QUALIFICATION_CREATE", "ALM_THREAT_QUALIFICATION_UPDATE", "ALM_THREAT_QUALIFICATION_DELETE", "REPORT_VEHICLE_EVENT", "API_TOKEN_REQUEST", "API_TOKEN_REVOKE", "API_INVOCATION", "API_OAUTH_TOKEN_REQUEST", "API_OAUTH_TOKEN_REFRESH", "API_OAUTH_TOKEN_REVOKE", "API_OAUTH_INVOCATION", "API_OAUTH_SUBMIT_APPLICATION", "API_OAUTH_UPDATE_APPLICATION", "API_OAUTH_DELETE_APPLICATION", "API_OAUTH_AUTHORIZE", "VIDEO_WALL_CREATE", "VIDEO_WALL_UPDATE", "VIDEO_WALL_DELETE", "VIEW_SHARE_TIMELAPSE", "VIEW_SHARE_CLIP", "VIEW_SHARE_STREAM", "VIEW_SHARE_VIDEOWALL", "VIEW_CAMERA_VOD", "CAMERA_POLICY_UPDATE", "CAMERA_POLICY_CREATE", "CAMERA_POLICY_DELETE", "TAG_POLICY_UPDATE", "TAG_POLICY_CREATE", "TAG_POLICY_DELETE", "CLIMATE_POLICY_UPDATE", "CLIMATE_POLICY_CREATE", "CLIMATE_POLICY_DELETE", "DOOR_POLICY_UPDATE", "DOOR_POLICY_CREATE", "DOOR_POLICY_DELETE", "DOOR_SCHEDULE_EXCEPTION_UPDATE", "DOOR_SCHEDULE_EXCEPTION_CREATE", "DOOR_SCHEDULE_EXCEPTION_DELETE", "ACCESS_CONTROLLED_DOOR_POLICY_UPDATE", "ACCESS_CONTROLLED_DOOR_POLICY_CREATE", "ACCESS_CONTROLLED_DOOR_POLICY_DELETE", "VIDEO_INTERCOM_POLICY_UPDATE", "VIDEO_INTERCOM_POLICY_CREATE", "VIDEO_INTERCOM_POLICY_DELETE", "OCCUPANCY_POLICY_UPDATE", "OCCUPANCY_POLICY_CREATE", "OCCUPANCY_POLICY_DELETE", "AUDIO_POLICY_UPDATE", "AUDIO_POLICY_CREATE", "AUDIO_POLICY_DELETE", "SCHEDULE_CREATE", "SCHEDULE_DELETE", "SCHEDULE_UPDATE", "CUSTOM_EVENT_CREATE", "CUSTOM_EVENT_DELETE", "CUSTOM_EVENT_UPDATE", "CUSTOM_EVENT_TOS_ACCEPTED", "CUSTOM_EVENT_TOS_REVOKED", "SUBSCRIPTION_SETUP_INTENT_CREATE", "SUBSCRIPTION_CREATE", "SUBSCRIPTION_DELETE", "SUBSCRIPTION_PAYMENT_METHOD_DELETE", "SUBSCRIPTION_PAYMENT_METHOD_UPDATE", "SUBSCRIPTION_MAX_SPEND_UPDATE", "SUBSCRIPTION_CHECKOUT_SESSION_CREATE", "UPLOAD_FLOORPLAN", "ORG_AUDIO_RECORD_UPDATE", "ORG_AUDIO_ANALYSIS_UPDATE", "ORG_LLM_USAGE_UPDATE", "ORG_LLM_USAGE_ENABLED", "ORG_LLM_USAGE_DISABLED", "DOOR_ACCESS_UNLOCK", "RHOMBUS_KEY_DOOR_UNLOCK", "ELEVATOR_ACCESS_UNLOCK", "RHOMBUS_KEY_ELEVATOR_UNLOCK", "VIDEO_INTERCOM_TALK", "RHOMBUS_KEY_UPDATE_APP_SETTINGS", "UPLOAD_ACCESS_CONTROLLED_DOOR", "UPLOAD_ACCESS_CONTROLLED_ELEVATOR", "UPLOAD_ACCESS_CONTROLLED_ELEVATOR_LANDING", "UPLOAD_USER_PROFILE_PICTURE", "ACCESS_GRANT_CREATE", "ACCESS_GRANT_UPDATE", "ACCESS_GRANT_DELETE", "ACCESS_REVOCATION_CREATE", "ACCESS_REVOCATION_UPDATE", "ACCESS_REVOCATION_DELETE", "ACCESS_CONTROLLED_DOOR_CREATE", "ACCESS_CONTROLLED_DOOR_UPDATE", "ACCESS_CONTROLLED_DOOR_DELETE", "ACCESS_CONTROLLED_ELEVATOR_CREATE", "ACCESS_CONTROLLED_ELEVATOR_UPDATE", "ACCESS_CONTROLLED_ELEVATOR_DELETE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_CREATE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_UPDATE", "ACCESS_CONTROLLED_ELEVATOR_LANDING_DELETE", "AC_CRED_RHOMBUS_SECURE_CSN_CREATE", "AC_CRED_RHOMBUS_SECURE_CSN_UPDATE", "AC_CRED_RHOMBUS_SECURE_CSN_DELETE", "AC_CRED_RHOMBUS_SECURE_CSN_REVOKED", "AC_CRED_RHOMBUS_SECURE_CSN_ASSIGN", "AC_CRED_RHOMBUS_SECURE_CSN_UNASSIGN", "AC_CRED_RHOMBUS_SECURE_CSN_SUSPEND", "AC_CRED_RHOMBUS_SECURE_CSN_UNSUSPEND", "AC_CRED_STANDARD_CSN_CREATE", "AC_CRED_STANDARD_CSN_UPDATE", "AC_CRED_STANDARD_CSN_DELETE", "AC_CRED_STANDARD_CSN_REVOKED", "AC_CRED_STANDARD_CSN_ASSIGN", "AC_CRED_STANDARD_CSN_UNASSIGN", "AC_CRED_STANDARD_CSN_SUSPEND", "AC_CRED_STANDARD_CSN_UNSUSPEND", "AC_CRED_RHOMBUS_SECURE_MOBILE_CREATE", "AC_CRED_RHOMBUS_SECURE_MOBILE_UPDATE", "AC_CRED_RHOMBUS_SECURE_MOBILE_DELETE", "AC_CRED_RHOMBUS_SECURE_MOBILE_REVOKED", "AC_CRED_RHOMBUS_SECURE_MOBILE_ASSIGN", "AC_CRED_RHOMBUS_SECURE_MOBILE_UNASSIGN", "AC_CRED_RHOMBUS_SECURE_MOBILE_SUSPEND", "AC_CRED_RHOMBUS_SECURE_MOBILE_UNSUSPEND", "AC_CRED_PIN_CREATE", "AC_CRED_PIN_BULK_CREATE", "AC_CRED_PIN_UPDATE", "AC_CRED_PIN_ROTATE", "AC_CRED_PIN_BULK_ROTATE", "AC_CRED_PIN_DELETE", "AC_CRED_PIN_REVOKED", "AC_CRED_PIN_ASSIGN", "AC_CRED_PIN_UNASSIGN", "AC_CRED_PIN_SUSPEND", "AC_CRED_PIN_UNSUSPEND", "AC_CRED_QR_CREATE", "AC_CRED_QR_REVOKED", "AC_CRED_QR_DELETE", "AC_CRED_QR_SUSPEND", "AC_CRED_QR_UNSUSPEND", "AC_CRED_WIEGAND_CREATE", "AC_CRED_WIEGAND_UPDATE", "AC_CRED_WIEGAND_DELETE", "AC_CRED_WIEGAND_REVOKED", "AC_CRED_WIEGAND_ASSIGN", "AC_CRED_WIEGAND_UNASSIGN", "AC_CRED_WIEGAND_SUSPEND", "AC_CRED_WIEGAND_UNSUSPEND", "AC_CRED_NOTE_UPDATE", "AC_LOCKDOWN_PLAN_CREATED", "AC_LOCKDOWN_PLAN_UPDATED", "AC_LOCKDOWN_PLAN_DELETED", "AC_LOCKDOWN_ACTIVATED", "AC_LOCKDOWN_DEACTIVATED", "AC_LOCKDOWN_PLAN_SWITCHED", "AC_COMPONENT_POWER_CYCLE", "AC_DOOR_STATE_OVERRIDE_APPLIED", "AC_DOOR_STATE_OVERRIDE_CANCELLED", "AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_APPLIED", "AC_ELEVATOR_LANDING_ACCESS_STATE_OVERRIDE_CANCELLED", "AC_GUEST_PASS_CREATE", "AC_GUEST_PASS_UPDATE", "AC_GUEST_PASS_SUSPEND", "AC_GUEST_PASS_UNSUSPEND", "AC_GUEST_PASS_EXPIRE", "AC_GUEST_PASS_DELETE", "SCIM_GET_ALL_USERS", "SCIM_POST_CREATE_USER", "SCIM_PUT_UPDATE_USER", "SCIM_PATCH_UPDATE_USER", "SCIM_GET_USER_BY_ID", "SCIM_DELETE_USER_BY_ID", "SCIM_GET_ALL_GROUPS", "SCIM_POST_CREATE_GROUP", "SCIM_PUT_UPDATE_GROUP", "SCIM_PATCH_UPDATE_GROUP", "SCIM_GET_GROUP_BY_ID", "SCIM_DELETE_GROUP_BY_ID", "CREATE_ACCESS_CONTROL_GROUP", "UPDATE_ACCESS_CONTROL_GROUP", "DELETE_ACCESS_CONTROL_GROUP", "RULE_CREATE", "RULE_DELETE", "RULE_UPDATE", "RULE_PAUSE", "UPLOAD_FACES", "UPDATE_FACE", "REPORT_FACE_EVENT", "FACE_EVENT_UPDATED", "FACE_EVENT_DELETED", "FACE_PERSON_CREATED", "FACE_PERSON_UPDATED", "FACE_PERSON_DELETED", "FACE_MATCHMAKER_CREATED", "FACE_MATCHMAKER_DELETED", "FACE_MATCHMAKER_UPLOADED", "FACE_MATCHING_CONFIG_UPDATED", "EXPUNGE_FACES_ORG", "EXPUNGE_VEHICLES_ORG", "DEVICE_NETWORK_CONFIGURATION_CHANGE", "KIOSK_UPDATED", "KIOSK_DELETED", "KIOSK_CREATED", "GUEST_DELETED", "UPDATE_APERIO_FIRMWARE", "UPDATE_INTEGRATION_APERIO", "DELETE_INTEGRATION_APERIO", "APERIO_GATEWAY_CREATE", "APERIO_DOORS_CREATE", "APERIO_GATEWAY_REBOOT", "APERIO_DTC_CLEAR", "THIRD_PARTY_CAMERA_CREATE", "THIRD_PARTY_CAMERA_DELETE", "THIRD_PARTY_CAMERA_UPDATED", "THIRD_PARTY_CAMERA_ASSIGNED_TO_CORE", "THIRD_PARTY_CAMERA_ASSIGNED_TO_LITE", "THIRD_PARTY_CAMERA_UNASSIGNED", "THIRD_PARTY_CAMERA_PASSWORD_CREATE", "THIRD_PARTY_CAMERA_PASSWORD_DELTE", "THIRD_PARTY_CAMERA_PASSWORD_DELETE", "CREATE_CHATBOT_CONFIG", "UPDATE_CHATBOT_CONFIG", "DELETE_CHATBOT_CONFIG", "SUPPORT_AUTHORITY_UPDATE", "SUPPORT_AUTHORITY_LOGOUT_ALL", "DELETE_DOOR_CONTROLLER", "DELETE_DOORBELL_CAMERA", "DELETE_BADGE_READER", "DELETE_ENVIRONMENTAL_GATEWAY", "AC_LOCKDOWN_TEST_MODE_ENABLED", "AC_LOCKDOWN_TEST_MODE_DISABLED", "CLOUD_ARCHIVING_CONFIG_UPDATE", "CLOUD_ARCHIVING_CONFIG_DELETE", "SCIM_UPDATE_SETTINGS", "INCIDENT_REPORT_CREATE", "INCIDENT_REPORT_DELETE", "INCIDENT_REPORT_UPDATE", "INCIDENT_REPORT_SHARE", "DATA_RETENTION_SETTINGS_UPDATE", "MSP_DESIGNATION_SYNC", "MSP_DESIGNATION_ACTIVATED", "MSP_DESIGNATION_REVOKED", "MSP_CLIENT_ADOPT", "MSP_CLIENT_RELEASE", "MSP_CLIENT_DEACTIVATE", "MSP_CLIENT_POLICY_UPDATE", "MSP_LICENSE_ASSIGN", "MSP_LICENSE_RECLAIM", "MSP_HARDWARE_MOVE", "UNKNOWN" ] + }, + "AuditRuleTriggerType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "auditEvent" : { + "$ref" : "#/components/schemas/SimpleAuditEventType" + }, + "userUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "AuthDecisionSourceEnum" : { + "type" : "string", + "enum" : [ "ACCESS_GRANT", "ACCESS_REVOCATION", "LOCKDOWN", "FIRST_IN_SETTINGS", "CONFIG", "ADMIN", "PRIVACY", "ERROR", "UNKNOWN" ] + }, + "AutomatedPrompt" : { + "type" : "object", + "description" : "Selective update applied to the automated job settings.", + "properties" : { + "apiKey" : { + "type" : "string", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true + "followUpActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FollowUpAction" }, "nullable" : true }, - "floorNumber" : { + "frequency" : { + "$ref" : "#/components/schemas/PromptFrequency" + }, + "invokeAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "hardwareId" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "mediaStorageDeviceUuid" : { + "prompt" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "mummified" : { - "type" : "boolean", "nullable" : true }, - "name" : { + "responseTemplate" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pending" : { - "type" : "boolean", - "nullable" : true - }, - "policyUuid" : { + "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { - "type" : "string", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "unregisteredEmailSent" : { - "type" : "boolean", - "nullable" : true - }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -55542,341 +57482,464 @@ } } }, - "CameraVisualTamperConfigType" : { + "AuxiliaryEnumType" : { + "type" : "string", + "enum" : [ "integrated_generic_input", "integrated_generic_relay" ] + }, + "AuxiliaryInputPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] + }, + "AuxiliaryInputPortType" : { "type" : "object", "properties" : { - "analyze_fps" : { + "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "analyze_res" : { + "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "canny_thresh" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "edge_cov_diff_thresh" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true + "portType" : { + "$ref" : "#/components/schemas/AuxiliaryInputPhysicalPortEnumType" }, - "long_buf_size" : { + "supervisionConfiguration" : { + "$ref" : "#/components/schemas/PortSupervisionConfigurationType" + } + } + }, + "AuxiliaryRelayPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_OUTPUT" ] + }, + "AuxiliaryRelayPortType" : { + "type" : "object", + "properties" : { + "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "short_buf_size" : { + "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true + }, + "portType" : { + "$ref" : "#/components/schemas/AuxiliaryRelayPhysicalPortEnumType" } } }, - "Camera_CameraBackwardsCompatUpdateType" : { + "AvigilonAltaType" : { "type" : "object", - "description" : "Backwards compatible camera update type with optional fields.", + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorToCameraMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "email" : { + "type" : "string", + "nullable" : true + }, + "eventToWebhookIdMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "eventToWebhookMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/WebhookMapEntry" + }, + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "password" : { + "type" : "string", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "webhookId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "archiveRegion" : { - "type" : "string", - "description" : "Archive region for the camera", - "example" : "us-west-1", - "nullable" : true - }, - "deleted" : { + "enabled" : { "type" : "boolean", - "description" : "Whether the camera is deleted", - "example" : false, "nullable" : true }, - "description" : { - "type" : "string", - "description" : "Description of the camera", - "example" : "Camera monitoring the main entrance", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the camera is located", - "example" : 1, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the camera", - "example" : 37.7749, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "AwsSettings" : { + "type" : "object", + "properties" : { + "accessKey" : { + "type" : "string", + "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the camera", - "example" : -122.4194, + "bucketName" : { + "type" : "string", "nullable" : true }, - "mummified" : { + "enabled" : { "type" : "boolean", - "description" : "Whether the camera is mummified", - "example" : false, "nullable" : true }, - "name" : { + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { "type" : "string", - "description" : "Name of the camera", - "example" : "Front Door Camera", "nullable" : true }, - "policyUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "uuid" : { + "secretKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_CameraCurrentStateType" : { + "AxisRange" : { "type" : "object", - "description" : "Current state information for a camera.", "properties" : { - "baseVideoOperationUri" : { - "type" : "string", - "description" : "Base URI for video operations", - "example" : "https://api.example.com/video", + "max" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "connectionStatus" : { - "$ref" : "#/components/schemas/Camera_StatusEnum" - }, - "connectionTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Connection timestamp in milliseconds", - "example" : 1640995200000, + "min" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "defaultInterface" : { + "name" : { "type" : "string", - "description" : "Default network interface", - "example" : "eth0", "nullable" : true - }, - "defaultInterfaceMac" : { + } + } + }, + "BackblazeSettings" : { + "type" : "object", + "properties" : { + "applicationKey" : { "type" : "string", - "description" : "MAC address of default interface", - "example" : "00:11:22:33:44:55", "nullable" : true }, - "firmwareVersion" : { + "applicationKeyId" : { "type" : "string", - "description" : "Current firmware version", - "example" : "1.2.3", "nullable" : true }, - "healthStatus" : { - "$ref" : "#/components/schemas/Camera_StatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/Camera_HealthStatusDetailsEnum" - }, - "latestFirmwareVersion" : { + "bucketName" : { "type" : "string", - "description" : "Latest available firmware version", - "example" : "1.2.4", "nullable" : true }, - "mediaRegion" : { - "type" : "string", - "description" : "Media region", - "example" : "us-west-1", + "enabled" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "BackgroundCheckEnum" : { + "type" : "string", + "enum" : [ "CLEARED", "NEEDS_ATTENTION" ] + }, + "BadgeFaceVerificationModeEnum" : { + "type" : "string", + "enum" : [ "OFF", "SHADOW", "SUPERVISED", "AUTO" ] + }, + "BadgeIntegrationDefaultOptions" : { + "type" : "object", + "nullable" : true, + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "onCameraState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "State information stored on the camera", - "nullable" : true - }, - "description" : "State information stored on the camera", + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", "nullable" : true }, - "onCloudState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "State information stored in the cloud", - "nullable" : true - }, - "description" : "State information stored in the cloud", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "region" : { - "type" : "string", - "description" : "Camera region", - "example" : "us-west-1", + "defaultOptionsEnabled" : { + "type" : "boolean", "nullable" : true }, - "serialNumber" : { - "type" : "string", - "description" : "Camera serial number", - "example" : "CAM123456789", + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "ssid" : { - "type" : "string", - "description" : "WiFi SSID", - "example" : "MyNetwork", + "saveClips" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "BadgeIntegrationDoorInfoType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "assignedCameraList" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "versionsBehind" : { + "clipDuration" : { "type" : "integer", "format" : "int32", - "description" : "Number of firmware versions behind", - "example" : 1, "nullable" : true }, - "wifiApMac" : { + "doorName" : { "type" : "string", - "description" : "MAC address of WiFi access point", - "example" : "AA:BB:CC:DD:EE:FF", "nullable" : true }, - "wifiBars" : { + "leadingSeconds" : { "type" : "integer", "format" : "int32", - "description" : "WiFi signal strength in bars (1-5)", - "example" : 4, "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "WiFi signal strength in dBm", - "example" : -45, - "nullable" : true - } - } - }, - "Camera_CameraExternalFacetedType" : { - "type" : "object", - "description" : "External faceted camera type with device UUID.", - "properties" : { - "archiveRegion" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "cameraFramerate" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "remoteUnlock" : { + "type" : "boolean", "nullable" : true }, - "customData" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + } + }, + "BadgeIntegrationRuleTriggerType" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "BadgeIntegrationSettings" : { + "type" : "object", + "nullable" : true, + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "deleted" : { + "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, - "description" : { - "type" : "string", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "deviceFacetRadians" : { + "doorInfoMap" : { "type" : "object", "additionalProperties" : { - "type" : "number", - "format" : "float", - "nullable" : true + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, "nullable" : true }, - "floorNumber" : { + "placeId" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "latitude" : { - "type" : "number", - "format" : "double", + "placeName" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "mediaStorageDeviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "webhookId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "BadgeTemplate" : { + "type" : "object", + "description" : "The updated badge template", + "properties" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "mummified" : { + "elements" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BaseBadgeTemplateElement" + }, + "nullable" : true + }, + "front" : { "type" : "boolean", "nullable" : true }, @@ -55884,29 +57947,20 @@ "type" : "string", "nullable" : true }, - "pending" : { - "type" : "boolean", - "nullable" : true - }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { - "type" : "string", + "portrait" : { + "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "unregisteredEmailSent" : { - "type" : "boolean", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, "uuid" : { @@ -55915,124 +57969,98 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "version" : { + "type" : "string", + "nullable" : true } } }, - "Camera_CameraExternalType" : { + "BadgeTemplateElementEnum" : { + "type" : "string", + "enum" : [ "CUSTOM_TEXT", "USER_METADATA", "USER_CUSTOM_METADATA", "CUSTOM_IMAGE", "USER_PROFILE_PHOTO" ] + }, + "BadgeTemplateImage" : { "type" : "object", - "description" : "External camera type.", + "description" : "The updated badge template image metadata.", "properties" : { - "archiveRegion" : { - "type" : "string", - "nullable" : true - }, - "cameraFramerate" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "customData" : { + "imageS3Key" : { "type" : "string", "nullable" : true }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "description" : { + "name" : { "type" : "string", "nullable" : true }, - "deviceFacetRadians" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "nullable" : true - }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "originalFileName" : { + "type" : "string", "nullable" : true }, - "floorNumber" : { + "updatedAtMillis" : { "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "latitude" : { - "type" : "number", - "format" : "double", + "format" : "int64", "nullable" : true }, - "locationUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", + } + } + }, + "BadgeTemplateImageSelectiveUpdate" : { + "type" : "object", + "description" : "The selective update containing the fields to update for the badge template image.", + "properties" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "mediaStorageDeviceUuid" : { + "imageS3Key" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "mummified" : { - "type" : "boolean", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, - "pending" : { - "type" : "boolean", - "nullable" : true - }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { + "originalFileName" : { "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "unregisteredEmailSent" : { - "type" : "boolean", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true }, "uuid" : { @@ -56044,73 +58072,90 @@ } } }, - "Camera_CameraOfflineLanStreamingInfo" : { + "BadgeTemplateSelectiveUpdate" : { "type" : "object", - "description" : "Information for offline LAN streaming.", + "description" : "The selective update containing the fields to update.", "properties" : { - "accessToken" : { - "type" : "string", - "description" : "Access token for LAN streaming", - "example" : "abc123def456", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "lanAddresses" : { + "elements" : { "type" : "array", - "description" : "List of LAN addresses for streaming", "items" : { - "type" : "string", - "description" : "List of LAN addresses for streaming", - "nullable" : true + "$ref" : "#/components/schemas/BaseBadgeTemplateElement" }, "nullable" : true - } - } - }, - "Camera_CreateCustomFootageSeekpointsWSRequest" : { - "type" : "object", - "description" : "Request to create custom footage seek points for a camera.", - "properties" : { - "cameraUuid" : { + }, + "front" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "footageSeekPoints" : { - "type" : "array", - "description" : "List of custom footage seek points to create", - "items" : { - "$ref" : "#/components/schemas/CustomFootageSeekPointType" + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "portrait" : { + "type" : "boolean", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true }, "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "version" : { + "type" : "string", + "nullable" : true } } }, - "Camera_CreateFootageBoundingBoxesWSRequest" : { + "Badgereader_DeleteBadgeReaderWSRequest" : { "type" : "object", - "description" : "Request to create footage bounding boxes for a camera.", + "description" : "Request to delete a badge reader device.", "properties" : { - "cameraUuid" : { + "badgeReaderUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "footageBoundingBoxes" : { - "type" : "array", - "description" : "List of footage bounding boxes to create", - "items" : { - "$ref" : "#/components/schemas/FootageBoundingBoxType" - }, + "mummify" : { + "type" : "boolean", + "description" : "Whether to mummify the device instead of hard delete", + "example" : false, "nullable" : true } - } + }, + "required" : [ "badgeReaderUuid", "mummify" ] }, - "Camera_CreateFootageBoundingBoxesWSResponse" : { + "Badgereader_DeleteBadgeReaderWSResponse" : { "type" : "object", - "description" : "Response indicating the result of creating footage bounding boxes.", + "description" : "Response from deleting a badge reader device.", "properties" : { "error" : { "type" : "boolean", @@ -56120,16 +58165,22 @@ "type" : "string", "nullable" : true }, + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_CreateFootageSeekpointsWSResponse" : { + "Badgereader_GetBadgeReaderConfigWSResponse" : { "type" : "object", - "description" : "Response indicating the result of creating footage seek points.", + "description" : "Response containing badge reader configuration.", "properties" : { + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" + }, "error" : { "type" : "boolean", "nullable" : true @@ -56144,204 +58195,167 @@ } } }, - "Camera_CreateSharedLiveVideoStreamWSRequest" : { + "Badgereader_GetBadgeReaderFullStateWSResponse" : { "type" : "object", - "description" : "Request to create a shared live video stream for a camera.", + "description" : "Response containing full state information for a badge reader.", "properties" : { - "audioGatewayUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "fullState" : { + "$ref" : "#/components/schemas/FullDeviceStateType" + } + } + }, + "Badgereader_GetBadgeReaderMinimalStateListWSResponse" : { + "type" : "object", + "description" : "Response containing minimal state information for all badge readers in organization.", + "properties" : { + "minimalStates" : { + "type" : "array", + "description" : "List of minimal device state information for badge readers", + "items" : { + "$ref" : "#/components/schemas/MinimalDeviceStateType" + }, "nullable" : true - }, - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "expirationTimeSecs" : { - "type" : "integer", - "format" : "int32", - "description" : "Add an expiration date for accessing the stream in seconds", - "example" : 86400, - "nullable" : true - }, - "includeAudio" : { - "type" : "boolean", - "description" : "Camera must be associated with an audio gateway to have audio", - "example" : false, - "nullable" : true - }, - "invertSchedule" : { - "type" : "boolean", - "description" : "If given a schedule UUID, will hide the stream during the schedule instead and show it otherwise", - "example" : false, - "nullable" : true - }, - "name" : { - "type" : "string", - "description" : "If not provided, will be named 'Unnamed'", - "example" : "Front Door Live Stream", - "nullable" : true - }, - "password" : { - "type" : "string", - "description" : "Add a password to allow access to your shared stream", - "example" : "mypassword123", - "nullable" : true - }, - "scheduleUuid" : { + } + } + }, + "Badgereader_RebootBadgeReaderWSRequest" : { + "type" : "object", + "description" : "Request to reboot a badge reader device.", + "properties" : { + "badgeReaderUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ssoProtected" : { - "type" : "boolean", - "description" : "Org must have SSO setup to use SSO protected streams", - "example" : false, - "nullable" : true - }, - "streamType" : { - "$ref" : "#/components/schemas/StreamTypeEnum" - }, - "vodEnabled" : { - "type" : "boolean", - "description" : "Enables recording of live footage to a VOD", - "example" : true, - "nullable" : true + } + }, + "required" : [ "badgeReaderUuid" ] + }, + "Badgereader_UpdateBadgeReaderConfigWSRequest" : { + "type" : "object", + "description" : "Request to update badge reader configuration.", + "properties" : { + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" } } }, - "Camera_CreateSharedLiveVideoStreamWSResponse" : { + "Badgereader_UpdateBadgeReaderDetailsWSRequest" : { "type" : "object", - "description" : "Response containing the created shared live video stream information.", + "description" : "Request to update badge reader device details.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "sharedLiveM3U8StreamUrl" : { - "type" : "string", - "description" : "M3U8 URL for the shared live video stream", - "example" : "https://example.com/live/m3u8/stream", - "nullable" : true - }, - "sharedLiveVideoStreamUrl" : { + "description" : { "type" : "string", - "description" : "URL for the shared live video stream", - "example" : "https://example.com/live/video/stream", + "description" : "Optional description for the badge reader", + "example" : "Primary access point for employees", "nullable" : true }, - "sharedLiveVideoStreamUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "directionRadians" : { + "type" : "number", + "format" : "float", + "description" : "Optional direction in radians", + "example" : 1.5708, "nullable" : true - } - } - }, - "Camera_CreateSharedVideoWallWSRequest" : { - "type" : "object", - "description" : "Request to create a shared video wall.", - "properties" : { - "expirationTimeSecs" : { + }, + "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Expiration time in seconds", - "example" : 86400, - "nullable" : true - }, - "invertSchedule" : { - "type" : "boolean", - "description" : "Whether to invert the schedule", - "example" : false, + "description" : "Optional floor number", + "example" : 1, "nullable" : true }, - "password" : { - "type" : "string", - "description" : "Password to protect the shared video wall", - "example" : "mypassword123", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional latitude coordinate", + "example" : 37.7749, "nullable" : true }, - "scheduleUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "videoWallUuid" : { + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional longitude coordinate", + "example" : -122.4194, + "nullable" : true + }, + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Optional name for the badge reader", + "example" : "Main Entrance Reader", "nullable" : true }, - "vodEnabled" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", - "description" : "Whether to enable video on demand", - "example" : true, + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, "nullable" : true } } }, - "Camera_CreateSharedVideoWallWSResponse" : { + "BaseAccessStateOverride" : { "type" : "object", - "description" : "Response containing the created shared video wall information.", + "discriminator" : { + "propertyName" : "type" + }, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "sharedLiveVideoStreamUrl" : { - "type" : "string", - "description" : "URL for accessing the shared video wall", - "example" : "https://share.rhombussystems.com/videowall/abc123", - "nullable" : true + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" }, - "sharedLiveVideoStreamUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "requestedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" } } }, - "Camera_CreateVideoWallWSRequest" : { + "BaseAccessStateOverride_Minimal" : { "type" : "object", - "description" : "Request to create a video wall.", + "discriminator" : { + "propertyName" : "type" + }, "properties" : { - "videoWall" : { - "$ref" : "#/components/schemas/VideoWallType" + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator_Minimal" + }, + "requestedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ManualAccessStateChangeEnum_Minimal" } } }, - "Camera_CreateVideoWallWSResponse" : { + "BaseApiResponse" : { "type" : "object", - "description" : "Response from creating a video wall.", + "description" : "Base response object denoting success, or failure with a reason, for an endpoint.", "properties" : { "error" : { "type" : "boolean", @@ -56351,203 +58365,153 @@ "type" : "string", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_DeleteCameraWSRequest" : { - "type" : "object", - "description" : "Request to delete a camera from the system.", - "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "mummify" : { - "type" : "boolean", - "description" : "Whether to mummify the camera instead of permanent deletion", - "example" : false, - "nullable" : true - } - } - }, - "Camera_DeleteCameraWSResponse" : { + "BaseBadgeTemplateElement" : { "type" : "object", - "description" : "Response indicating the result of deleting a camera.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CustomTextElement" + }, { + "$ref" : "#/components/schemas/UserMetadataTextElement" + }, { + "$ref" : "#/components/schemas/UserCustomMetadataTextElement" + }, { + "$ref" : "#/components/schemas/CustomImageElement" + }, { + "$ref" : "#/components/schemas/UserProfilePhotoElement" + } ], "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, - "errorMsg" : { - "type" : "string", + "x" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" - }, - "warningMsg" : { - "type" : "string", + "y" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Camera_DeleteCustomFootageSeekpointsWSRequest" : { + "BaseCatalogItem" : { "type" : "object", - "description" : "Request to delete custom footage seek points for cameras within a time range.", + "discriminator" : { + "propertyName" : "productType" + }, "properties" : { - "cameraUuids" : { - "type" : "array", - "description" : "List of camera UUIDs to delete custom seek points for", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "durationMonths" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "customName" : { + "productCode" : { "type" : "string", - "description" : "Filter which custom seek points to delete with the custom name provided", - "example" : "motion_event", - "nullable" : true - }, - "endTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX milliseconds timestamp to end custom seek point deletion, up to 24 hours from the start timestamp", - "example" : 1641081600000, "nullable" : true }, - "startTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX milliseconds timestamp to start custom seek point deletion", - "example" : 1640995200000, - "nullable" : true + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" } } }, - "Camera_DeleteCustomFootageSeekpointsWSResponse" : { + "BaseClaimKey" : { "type" : "object", - "description" : "Response containing the results of deleting custom footage seek points.", + "discriminator" : { + "propertyName" : "type" + }, "properties" : { - "deleteSeekpointResponseMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse" - }, - "description" : "Mapping of camera UUIDs to seek point deletion results", + "claimEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", "nullable" : true }, - "error" : { - "type" : "boolean", + "claimStartDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date/time when claiming of licenses represented by this claim key started.", "nullable" : true }, - "errorMsg" : { + "createdOn" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "warningMsg" : { + "endDate" : { "type" : "string", - "nullable" : true - } - } - }, - "Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse" : { - "type" : "object", - "description" : "Response indicating the result of deleting seek points for a camera.", - "properties" : { - "err" : { - "type" : "boolean", - "description" : "Whether an error occurred during deletion", - "example" : false, + "format" : "date-time", "nullable" : true }, - "errMsg" : { + "expirationEmailState" : { + "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" + }, + "gracePeriodEndDate" : { "type" : "string", - "description" : "Error message if deletion failed", - "example" : "Invalid timestamp range", + "format" : "date-time", "nullable" : true - } - } - }, - "Camera_DeleteSharedLiveVideoStreamWSRequest" : { - "type" : "object", - "description" : "Request to delete a shared live video stream.", - "properties" : { - "cameraUuid" : { + }, + "maskedClaimCode" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_DeleteSharedVideoWallWSRequest" : { - "type" : "object", - "description" : "Request to delete a shared video wall.", - "properties" : { - "uuid" : { + }, + "ownerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "videoWallUuid" : { + "renewedByClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_DeleteSharedVideoWallWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of deleting a shared video wall.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "requestId" : { "type" : "string", + "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", "nullable" : true }, - "warningMsg" : { + "returnHistory" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClaimKeyReturnEvent" + }, + "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/ClaimKeyStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ClaimKeyTypeEnum" + }, + "updatedOn" : { "type" : "string", + "format" : "date-time", "nullable" : true - } - } - }, - "Camera_DeleteVideoWallWSRequest" : { - "type" : "object", - "description" : "Request to delete a video wall configuration.", - "properties" : { + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -56557,292 +58521,364 @@ } } }, - "Camera_DeleteVideoWallWSResponse" : { + "BaseComponentType" : { "type" : "object", - "description" : "Response indicating the result of deleting a video wall configuration.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" + }, { + "$ref" : "#/components/schemas/OsdpDoorReaderType" + }, { + "$ref" : "#/components/schemas/WiegandDoorReaderType" + }, { + "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" + }, { + "$ref" : "#/components/schemas/IntegratedRequestToExitType" + }, { + "$ref" : "#/components/schemas/IntegratedDoorRelayType" + }, { + "$ref" : "#/components/schemas/IntegratedGenericRelayType" + }, { + "$ref" : "#/components/schemas/IntegratedGenericInputType" + }, { + "$ref" : "#/components/schemas/IntegratedGenericButtonType" + }, { + "$ref" : "#/components/schemas/SchlageInputButton" + }, { + "$ref" : "#/components/schemas/AperioActivatorButton" + }, { + "$ref" : "#/components/schemas/AperioGateway" + }, { + "$ref" : "#/components/schemas/AperioDoorReader" + }, { + "$ref" : "#/components/schemas/AperioDoorExtension" + }, { + "$ref" : "#/components/schemas/AperioDoorRelay" + }, { + "$ref" : "#/components/schemas/AperioDoorPositionIndicator" + }, { + "$ref" : "#/components/schemas/AperioRs485Gateway" + }, { + "$ref" : "#/components/schemas/AperioRs485DoorReader" + }, { + "$ref" : "#/components/schemas/AperioRs485DoorRelay" + }, { + "$ref" : "#/components/schemas/AperioRs485DoorPositionIndicator" + }, { + "$ref" : "#/components/schemas/AperioRs485DoorRequestToExit" + }, { + "$ref" : "#/components/schemas/AperioRs485DoorExtension" + }, { + "$ref" : "#/components/schemas/SchlageRs485Gateway" + }, { + "$ref" : "#/components/schemas/SchlageRs485DoorReader" + }, { + "$ref" : "#/components/schemas/SchlageRs485DoorExtension" + }, { + "$ref" : "#/components/schemas/SchlageRs485DoorRelay" + }, { + "$ref" : "#/components/schemas/SchlageRs485DoorPositionIndicator" + }, { + "$ref" : "#/components/schemas/SchlageRs485DoorRequestToExit" + } ], "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_EraseCameraWSRequest" : { - "type" : "object", - "description" : "Request to permanently erase a camera from the system.", - "properties" : { - "cameraUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_EraseCameraWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of erasing a camera.", - "properties" : { - "error" : { + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_FindAllSharedLiveVideoStreamsWSRequest" : { + "BaseEventOriginator" : { "type" : "object", - "description" : "Request to find all shared live video streams." + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/SupportAuthorityEventOriginator" + }, { + "$ref" : "#/components/schemas/ApiTokenEventOriginator" + }, { + "$ref" : "#/components/schemas/UserEventOriginator" + }, { + "$ref" : "#/components/schemas/RuleEventOriginator" + }, { + "$ref" : "#/components/schemas/ComponentCompositeEventOriginator" + }, { + "$ref" : "#/components/schemas/GuestPassEventOriginator" + }, { + "$ref" : "#/components/schemas/DeviceServiceEventOriginator" + } ], + "properties" : { + "type" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" + } + } }, - "Camera_FindAllSharedLiveVideoStreamsWSResponse" : { + "BaseEventOriginator_Minimal" : { "type" : "object", - "description" : "Response containing all shared live video streams.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/SupportAuthorityEventOriginator" + }, { + "$ref" : "#/components/schemas/ApiTokenEventOriginator" + }, { + "$ref" : "#/components/schemas/UserEventOriginator" + }, { + "$ref" : "#/components/schemas/RuleEventOriginator" + }, { + "$ref" : "#/components/schemas/ComponentCompositeEventOriginator" + }, { + "$ref" : "#/components/schemas/GuestPassEventOriginator" + }, { + "$ref" : "#/components/schemas/DeviceServiceEventOriginator" + } ], "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "sharedLiveVideoStreams" : { - "type" : "array", - "description" : "List of shared live video streams", - "items" : { - "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/EventOriginatorEnum_Minimal" } } }, - "Camera_FindSharedLiveVideoStreamsForWSRequest" : { + "BaseFirstInReset" : { "type" : "object", - "description" : "Request to find shared live video streams for a camera.", + "description" : "Optional list of first-in reset configurations.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DailyFirstInReset" + } ], "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/FirstInResetEnum" } } }, - "Camera_FindSharedLiveVideoStreamsWSResponse" : { + "BaseLicenseType" : { "type" : "object", - "description" : "Response containing shared live video streams.", + "description" : "List of licenses found by claim key", + "discriminator" : { + "propertyName" : "productType" + }, "properties" : { - "error" : { - "type" : "boolean", + "claimKeyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "createdOn" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "sharedLiveVideoStreams" : { - "type" : "array", - "description" : "List of shared live video streams", - "items" : { - "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" - }, + "firstAssignedDate" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "warningMsg" : { + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "maxDeleteDate" : { "type" : "string", + "format" : "date-time", "nullable" : true - } - } - }, - "Camera_FindSharedVideoWallsWSRequest" : { - "type" : "object", - "description" : "Request to find shared video walls for a video wall.", - "properties" : { - "videoWallUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_FindSharedVideoWallsWSResponse" : { - "type" : "object", - "description" : "Response containing shared video walls for a video wall.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "ownerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "priorClaimKeyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sharedVideoWalls" : { - "type" : "array", - "description" : "List of shared video walls", - "items" : { - "$ref" : "#/components/schemas/Camera_SharedVideoWallWS" - }, + "productCode" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_FootageBoundingBoxSummaryType" : { + "BaseLocationLockdownEventOriginator" : { "type" : "object", - "description" : "Summary of footage bounding boxes by device.", + "discriminator" : { + "propertyName" : "type" + }, "properties" : { - "deviceMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/FootageBoundingBoxType" - }, - "description" : "Map of device UUIDs to their footage bounding box information", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" } } }, - "Camera_FootageSeekPointSummaryType" : { + "BaseLockdownPlanType" : { "type" : "object", - "description" : "Summary of footage seek points with activity counts and metadata.", + "description" : "The requested lockdown plan.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/LocationLockdownPlanType" + } ], "properties" : { - "activityCountMap" : { + "activationPlan" : { + "$ref" : "#/components/schemas/LockdownActivationPlanType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deactivationPlan" : { + "$ref" : "#/components/schemas/LockdownDeactivationPlanType" + }, + "defaultLockdownState" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "doorLockdownStateMap" : { "type" : "object", "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "description" : "Map of activities to device UUIDs and their counts", - "nullable" : true - }, - "description" : "Map of activities to device UUIDs and their counts", - "nullable" : true + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" }, - "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, - "alert" : { - "type" : "boolean", - "description" : "Whether there is an alert", - "example" : false, + "name" : { + "type" : "string", "nullable" : true }, - "faceNames" : { - "type" : "array", - "description" : "Set of recognized face names", - "items" : { - "type" : "string", - "description" : "Set of recognized face names", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "poses" : { - "type" : "array", - "description" : "Set of detected poses", - "items" : { - "type" : "string", - "description" : "Set of detected poses", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "physicalAccess" : { + "$ref" : "#/components/schemas/LockdownPhysicalAccessType" }, - "recognizedObjects" : { - "type" : "array", - "description" : "Set of recognized objects", - "items" : { - "type" : "string", - "description" : "Set of recognized objects", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "scopeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "unidentifiedFaceIds" : { - "type" : "array", - "description" : "Set of unidentified face IDs", - "items" : { - "type" : "string", - "description" : "Set of unidentified face IDs", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "testPlan" : { + "$ref" : "#/components/schemas/LockdownTestPlanType" }, - "vehicleLicensePlates" : { - "type" : "array", - "description" : "Set of vehicle license plates", - "items" : { - "type" : "string", - "description" : "Set of vehicle license plates", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "type" : { + "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" }, - "vehicleNames" : { - "type" : "array", - "description" : "Set of recognized vehicle names", - "items" : { - "type" : "string", - "description" : "Set of recognized vehicle names", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Camera_GenerateBatchRegistrationInfoRequest" : { + "BaseLockdownStateEventType" : { "type" : "object", - "description" : "Request to generate batch registration information for cameras.", + "description" : "List of lockdown events found for the specified location.", + "discriminator" : { + "propertyName" : "type" + }, "properties" : { - "adminUserPermissionGroups" : { - "type" : "array", - "description" : "List of admin user permission group UUIDs", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate", - "example" : 37.7749, + "followingTestPlan" : { + "type" : "boolean", "nullable" : true }, "locationUuid" : { @@ -56852,366 +58888,461 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate", - "example" : -122.4194, - "nullable" : true - }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "readOnlyUserPermissionGroups" : { - "type" : "array", - "description" : "List of read-only user permission group UUIDs", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "originator" : { + "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" + }, + "stateChangedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, - "Camera_GenerateBatchRegistrationInfoResponse" : { + "BasePolicyAlertType" : { "type" : "object", - "description" : "Response containing batch registration information for cameras.", + "description" : "The requested policy alert", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/PolicyAlertV2Type" + }, { + "$ref" : "#/components/schemas/AccessControlledDoorPolicyAlertType" + } ], "properties" : { - "env" : { - "type" : "string", - "description" : "Environment identifier", - "example" : "production", - "nullable" : true - }, - "token" : { + "alertMonitoringThreatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_GenerateWifiChangeAuthorizationTokenWSRequest" : { - "type" : "object", - "description" : "Request to generate a WiFi change authorization token.", - "properties" : { - "perceivedIp" : { - "type" : "string", - "description" : "Perceived IP address", - "example" : "192.168.1.100", + }, + "alertMonitoringVerified" : { + "type" : "boolean", "nullable" : true }, - "ssid" : { - "type" : "string", - "description" : "WiFi network SSID", - "example" : "MyWiFiNetwork", + "archived" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Camera_GenerateWifiChangeAuthorizationTokenWSResponse" : { - "type" : "object", - "description" : "Response containing a WiFi change authorization token.", - "properties" : { - "authorizationToken" : { - "type" : "array", - "description" : "Authorization token for WiFi change", - "items" : { + }, + "clientType" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" + }, + "clipLocationMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "nullable" : true + }, + "clipLocationMapV2" : { + "type" : "object", + "additionalProperties" : { "type" : "string", - "format" : "byte", - "description" : "Authorization token for WiFi change", "nullable" : true }, "nullable" : true }, - "error" : { + "delayedProcessing" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "deleted" : { + "type" : "boolean", "nullable" : true }, - "userUuid" : { + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "finalized" : { + "type" : "boolean", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Camera_GetBatchRegistrationTokenUsageRequest" : { - "type" : "object", - "description" : "Request to retrieve batch registration token usage information.", - "properties" : { - "sinceMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds since epoch to check usage from", - "example" : 1640995200000, + "notificationSent" : { + "type" : "boolean", "nullable" : true }, - "token" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_GetBatchRegistrationTokenUsageResponse" : { - "type" : "object", - "description" : "Response containing batch registration token usage information.", - "properties" : { - "usageList" : { + }, + "policyAlertTriggers" : { "type" : "array", - "description" : "List of batch registration token usage results", "items" : { - "$ref" : "#/components/schemas/BatchRegistrationTokenUsageResult" + "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true - } - } - }, - "Camera_GetCameraAIThresholdsWSRequest" : { - "type" : "object", - "description" : "Request to retrieve AI thresholds for a camera.", - "properties" : { - "cameraUuid" : { + }, + "policyUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - } - } - }, - "Camera_GetCameraAIThresholdsWSResponse" : { - "type" : "object", - "description" : "Response containing AI thresholds for a camera.", - "properties" : { - "consecutiveHumanFilter" : { - "type" : "integer", - "format" : "int32", - "description" : "Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", - "example" : 3, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "consecutiveVehicleFilter" : { - "type" : "integer", - "format" : "int32", - "description" : "Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", - "example" : 3, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { + "saved" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "serverReceivedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "faceConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for face detection. 0 or null means the built-in default.", - "example" : 0.8, + "shared" : { + "type" : "boolean", "nullable" : true }, - "faceMatchConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "deprecated" : true, - "description" : "Confidence threshold for face matching (determining if two faces are the same person). 0 or null means the built-in default. We no longer support device specific face matching threshold. This property is deprecated and will be removed.", - "maximum" : 1.0, - "minimum" : 0.0, - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "humanConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for human detection. 0 or null means the built-in default.", - "example" : 0.7, + "textDescription" : { + "type" : "string", + "description" : "Natural language description of the alert", "nullable" : true }, - "lprConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for license plate detection and character recognition. 0 or null means the built-in default.", - "example" : 0.9, + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "thumbnailLocationV2" : { + "type" : "string", "nullable" : true }, - "maxEventDurationMs" : { + "timestampMs" : { "type" : "integer", - "format" : "int32", - "description" : "The max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.", - "example" : 15000, + "format" : "int64", "nullable" : true }, - "vehicleConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for vehicle detection. 0 or null means the built-in default.", - "example" : 0.7, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/PolicyAlertEnumType" }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_GetCameraDetailsWSRequest" : { + "BaseRuleTriggerType" : { "type" : "object", - "description" : "Request to retrieve detailed information for multiple cameras.", + "discriminator" : { + "mapping" : { + "ALERT_MONITORING_EVENT" : "#/components/schemas/AlertMonitoringRuleTriggerType", + "AUDIT_EVENT" : "#/components/schemas/AuditRuleTriggerType", + "BADGE_INTEGRATION_EVENT" : "#/components/schemas/BadgeIntegrationRuleTriggerType", + "BUTTON_INTEGRATION_EVENT" : "#/components/schemas/ButtonIntegrationRuleTriggerType", + "CUSTOM_LLM_EVENT" : "#/components/schemas/CustomLLMEventRuleTriggerType", + "DEVICE_ACTIVITY_EVENT" : "#/components/schemas/DeviceActivityRuleTriggerType", + "DIAGNOSTIC_EVENT" : "#/components/schemas/DiagnosticRuleTriggerType", + "INCOMING_WEBHOOK_EVENT" : "#/components/schemas/IncomingWebhookRuleTriggerType", + "LOCATION_LOCKDOWN_ACTIVATED_EVENT" : "#/components/schemas/LocationLockdownActivatedRuleTriggerType", + "LOCATION_LOCKDOWN_DEACTIVATED_EVENT" : "#/components/schemas/LocationLockdownDeactivatedRuleTriggerType", + "RECURRING_EVENT" : "#/components/schemas/RecurringRuleTriggerType", + "SCHEDULED_EVENT" : "#/components/schemas/ScheduledRuleTriggerType", + "SHELLY_INTEGRATION_EVENT" : "#/components/schemas/ShellyIntegrationRuleTriggerType", + "VISION_LLM_EVENT" : "#/components/schemas/VisionLLMRuleTriggerType" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DeviceActivityRuleTriggerType" + }, { + "$ref" : "#/components/schemas/AuditRuleTriggerType" + }, { + "$ref" : "#/components/schemas/AlertMonitoringRuleTriggerType" + }, { + "$ref" : "#/components/schemas/DiagnosticRuleTriggerType" + }, { + "$ref" : "#/components/schemas/BadgeIntegrationRuleTriggerType" + }, { + "$ref" : "#/components/schemas/ScheduledRuleTriggerType" + }, { + "$ref" : "#/components/schemas/VisionLLMRuleTriggerType" + }, { + "$ref" : "#/components/schemas/RecurringRuleTriggerType" + }, { + "$ref" : "#/components/schemas/LocationLockdownActivatedRuleTriggerType" + }, { + "$ref" : "#/components/schemas/LocationLockdownDeactivatedRuleTriggerType" + }, { + "$ref" : "#/components/schemas/CustomLLMEventRuleTriggerType" + }, { + "$ref" : "#/components/schemas/ButtonIntegrationRuleTriggerType" + }, { + "$ref" : "#/components/schemas/ShellyIntegrationRuleTriggerType" + }, { + "$ref" : "#/components/schemas/IncomingWebhookRuleTriggerType" + } ], "properties" : { - "cameraUuids" : { - "type" : "array", - "description" : "List of camera UUIDs to retrieve details for", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } - } + }, + "title" : "RuleTriggerType" }, - "Camera_GetCameraDetailsWSResponse" : { + "BaseSavedScheduleType" : { "type" : "object", - "description" : "Response containing detailed information for multiple cameras.", + "description" : "Schedule for the shared live stream", + "discriminator" : { + "propertyName" : "strategy" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, { + "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" + }, { + "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" + }, { + "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" + } ], "properties" : { - "cameras" : { - "type" : "array", - "description" : "List of camera details", - "items" : { - "$ref" : "#/components/schemas/Camera_CameraExternalType" - }, + "internalWriteOnly" : { + "type" : "boolean", "nullable" : true }, - "error" : { + "mutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "oneTimeUse" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "strategy" : { + "$ref" : "#/components/schemas/ScheduleStrategyEnum" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_GetCloudArchivedMediaInfoWSRequest" : { + "BaseSavedScheduleType_Minimal" : { "type" : "object", - "description" : "Request to retrieve cloud archived media information for a camera.", + "description" : "List of schedules", + "discriminator" : { + "propertyName" : "strategy" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, { + "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" + }, { + "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" + }, { + "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" + } ], "properties" : { - "cameraUuid" : { + "internalWriteOnly" : { + "type" : "boolean", + "nullable" : true + }, + "mutable" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "oneTimeUse" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "strategy" : { + "$ref" : "#/components/schemas/ScheduleStrategyEnum_Minimal" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_GetCloudArchivedMediaInfoWSResponse" : { + "BaseTimelineEntry" : { "type" : "object", - "description" : "Response containing cloud archived media information for a camera.", + "description" : "An entry on an incident report timeline.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/SnapshotTimelineEntry" + }, { + "$ref" : "#/components/schemas/EventTimelineEntry" + }, { + "$ref" : "#/components/schemas/ClipTimelineEntry" + }, { + "$ref" : "#/components/schemas/PolicyAlertTimelineEntry" + }, { + "$ref" : "#/components/schemas/ThreatCaseEventTimelineEntry" + } ], "properties" : { - "error" : { - "type" : "boolean", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, - "errorMsg" : { + "createdBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "imageKey" : { "type" : "string", + "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", "nullable" : true }, - "oldestArchivedVideoSegmentSecs" : { + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "systemGenerated" : { + "type" : "boolean", + "description" : "Whether the entry was generated by the system rather than created by a user.", + "nullable" : true + }, + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp of the oldest archived video segment in seconds since epoch", - "example" : 1640995200, + "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", "nullable" : true }, - "warningMsg" : { + "type" : { + "$ref" : "#/components/schemas/TimelineEntryTypeEnum" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_GetCloudArchivingConfigWSRequest" : { + "BasicResponseEnumType" : { + "type" : "string", + "enum" : [ "ERROR", "SUCCESS" ] + }, + "BatchRegistrationTokenUsageResult" : { "type" : "object", - "description" : "Request to get cloud archiving configuration.", + "description" : "List of batch registration token usage results", "properties" : { - "deviceUuid" : { + "di" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_GetCloudArchivingConfigWSResponse" : { - "type" : "object", - "description" : "Response containing cloud archiving configuration.", - "properties" : { - "archivingConfig" : { - "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" }, - "error" : { - "type" : "boolean", + "hi" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "rs" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "ts" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Camera_GetConfigWSRequest" : { + "BehaviorEventTypeEnum" : { + "type" : "string", + "enum" : [ "STARTED", "PROGRESS", "SUSPENDED", "RESUMED", "COMPLETED", "FAILED", "CANCELED", "UNKNOWN" ] + }, + "Billing_CreateCheckoutSessionWSRequest" : { "type" : "object", - "description" : "Request to retrieve camera configuration settings.", "properties" : { - "cameraUuid" : { + "invoiceId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_GetConfigWSResponse" : { + "Billing_CreateCheckoutSessionWSResponse" : { "type" : "object", - "description" : "Response containing camera configuration settings.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableAudioVideoUserConfig" - }, "error" : { "type" : "boolean", "nullable" : true @@ -57220,37 +59351,48 @@ "type" : "string", "nullable" : true }, + "sessionId" : { + "type" : "string", + "nullable" : true + }, + "sessionUrl" : { + "type" : "string", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_GetCurrentStateWSRequest" : { + "Billing_CreateSubscriptionWSRequest" : { "type" : "object", - "description" : "Request to retrieve the current state of a camera (deprecated).", "properties" : { - "cameraUuid" : { + "billingCycleTimezone" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "force" : { + "maxSpendPerMonth" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "paymentMethodId" : { + "type" : "string", + "nullable" : true + }, + "termsOfServiceAccepted" : { "type" : "boolean", - "description" : "Whether to force a refresh of the camera state", - "example" : false, "nullable" : true } } }, - "Camera_GetCurrentStateWSResponse" : { + "Billing_CreateSubscriptionWSResponse" : { "type" : "object", - "description" : "Response containing the current state of a camera (deprecated).", "properties" : { - "cameraState" : { - "$ref" : "#/components/schemas/Camera_CameraCurrentStateType" + "customerId" : { + "type" : "string", + "nullable" : true }, "error" : { "type" : "boolean", @@ -57260,80 +59402,90 @@ "type" : "string", "nullable" : true }, + "paymentMethodId" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "type" : "string", + "nullable" : true + }, + "subscriptionId" : { + "type" : "string", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_GetCustomFootageSeekpointsV2WSRequest" : { + "Billing_CustomEventsMonthlyBreakdownWSRequest" : { "type" : "object", - "description" : "Request to retrieve custom footage seek points V2 for cameras within a time range.", "properties" : { - "customDescription" : { - "type" : "string", - "description" : "Filters which custom footage seek point to search for by description", - "example" : "Motion detected in camera view", - "nullable" : true - }, - "customDisplayName" : { + "date" : { "type" : "string", - "description" : "Filters which custom footage seek point to search for by name", - "example" : "motion_event", "nullable" : true - }, - "deviceUuids" : { + } + } + }, + "Billing_CustomEventsMonthlyBreakdownWSResponse" : { + "type" : "object", + "properties" : { + "breakdowns" : { "type" : "array", - "description" : "List of device UUIDs to filter the search", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/Billing_CustomEventsMonthlyBreakdownWSResponse_BreakdownElement" }, "nullable" : true }, - "duration" : { - "type" : "integer", - "format" : "int64", - "description" : "How far from the start timestamp to search in seconds", - "example" : 3600, + "error" : { + "type" : "boolean", "nullable" : true }, - "locationUuids" : { - "type" : "array", - "description" : "List of location UUIDs to filter the search", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "startTime" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Billing_CustomEventsMonthlyBreakdownWSResponse_BreakdownElement" : { + "type" : "object", + "properties" : { + "eventCount" : { "type" : "integer", "format" : "int64", - "description" : "Starting timestamp of the search in UNIX seconds", - "example" : 1640995200, + "nullable" : true + }, + "promptName" : { + "type" : "string", + "nullable" : true + }, + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_GetCustomFootageSeekpointsV2WSResponse" : { + "Billing_DeletePaymentMethodWSRequest" : { "type" : "object", - "description" : "Response containing custom footage seek points V2 for cameras.", "properties" : { - "customFootageSeekPoints" : { - "type" : "array", - "description" : "List of custom footage seek points V2", - "items" : { - "$ref" : "#/components/schemas/SeekpointIndexType" - }, + "paymentMethodId" : { + "type" : "string", "nullable" : true - }, + } + } + }, + "Billing_DeletePaymentMethodWSResponse" : { + "type" : "object", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -57342,21 +59494,21 @@ "type" : "string", "nullable" : true }, + "removed" : { + "type" : "boolean", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_GetFacetedCameraDetailsWSResponse" : { + "Billing_FreeCreditEligibilityWSResponse" : { "type" : "object", "properties" : { - "cameras" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Camera_CameraExternalFacetedType" - }, - "nullable" : true + "customEvents" : { + "$ref" : "#/components/schemas/Billing_FreeCreditEligibilityWSResponse_FreeCreditInfo" }, "error" : { "type" : "boolean", @@ -57372,42 +59524,75 @@ } } }, - "Camera_GetFootageBoundingBoxesForMultipleWSRequest" : { + "Billing_FreeCreditEligibilityWSResponse_FreeCreditInfo" : { "type" : "object", - "description" : "Request to retrieve footage bounding boxes for multiple cameras within a time range.", "properties" : { - "cameraUuids" : { - "type" : "array", - "description" : "List of camera UUIDs to retrieve bounding boxes for", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "freeCreditAmountCents" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "durationSec" : { + "freeCreditRemainingCents" : { "type" : "integer", "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, + "hasSubscription" : { + "type" : "boolean", + "nullable" : true + }, + "isEligibleForVoucher" : { + "type" : "boolean", + "nullable" : true + }, + "isOnVoucher" : { + "type" : "boolean", + "nullable" : true + }, + "isVoucherExhausted" : { + "type" : "boolean", "nullable" : true } } }, - "Camera_GetFootageBoundingBoxesForMultipleWSResponse" : { + "Billing_GetCustomerInformationWSRequest" : { + "type" : "object" + }, + "Billing_GetCustomerInformationWSResponse" : { "type" : "object", - "description" : "Response containing footage bounding boxes for multiple cameras.", "properties" : { + "addressCity" : { + "type" : "string", + "nullable" : true + }, + "addressCountry" : { + "type" : "string", + "nullable" : true + }, + "addressLine1" : { + "type" : "string", + "nullable" : true + }, + "addressLine2" : { + "type" : "string", + "nullable" : true + }, + "addressPostalCode" : { + "type" : "string", + "nullable" : true + }, + "addressState" : { + "type" : "string", + "nullable" : true + }, + "businessName" : { + "type" : "string", + "nullable" : true + }, + "email" : { + "type" : "string", + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -57416,12 +59601,16 @@ "type" : "string", "nullable" : true }, - "footageBoundingBoxMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Camera_FootageBoundingBoxSummaryType" - }, - "description" : "Mapping of timestamps to footage bounding box summaries", + "individualName" : { + "type" : "string", + "nullable" : true + }, + "phone" : { + "type" : "string", + "nullable" : true + }, + "termsOfServiceAcceptanceTimestamp" : { + "type" : "string", "nullable" : true }, "warningMsg" : { @@ -57430,36 +59619,29 @@ } } }, - "Camera_GetFootageBoundingBoxesWSRequest" : { + "Billing_GetInvoicesWSRequest" : { "type" : "object", - "description" : "Request to retrieve footage bounding boxes for a camera within a time range.", "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "duration" : { + "limit" : { "type" : "integer", "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, "nullable" : true }, - "startTime" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, + "startingAfter" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/Billing_InvoiceStatus" + }, + "subscriptionId" : { + "type" : "string", "nullable" : true } } }, - "Camera_GetFootageBoundingBoxesWSResponse" : { + "Billing_GetInvoicesWSResponse" : { "type" : "object", - "description" : "Response containing footage bounding boxes for a camera.", "properties" : { "error" : { "type" : "boolean", @@ -57469,11 +59651,14 @@ "type" : "string", "nullable" : true }, - "footageBoundingBoxes" : { + "hasMore" : { + "type" : "boolean", + "nullable" : true + }, + "invoices" : { "type" : "array", - "description" : "List of footage bounding boxes", "items" : { - "$ref" : "#/components/schemas/FootageBoundingBoxType" + "$ref" : "#/components/schemas/Billing_GetInvoicesWSResponse_Invoice" }, "nullable" : true }, @@ -57483,159 +59668,107 @@ } } }, - "Camera_GetFootageSeekpointsForMultipleWSRequest" : { + "Billing_GetInvoicesWSResponse_Invoice" : { "type" : "object", - "description" : "Request to retrieve footage seek points for multiple cameras within a time range.", "properties" : { - "cameraUuids" : { - "type" : "array", - "description" : "List of camera UUIDs to retrieve seek points for", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "amount" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "durationSec" : { + "amountDue" : { "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, + "format" : "int64", "nullable" : true }, - "includeAnyMotion" : { - "type" : "boolean", - "description" : "Whether to include any motion events", - "example" : true, + "amountPaid" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "startTimeSec" : { + "created" : { "type" : "integer", "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, "nullable" : true - } - } - }, - "Camera_GetFootageSeekpointsForMultipleWSResponse" : { - "type" : "object", - "description" : "Response containing footage seek points for multiple cameras.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "currency" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "description" : { "type" : "string", "nullable" : true }, - "footageSeekPointMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Camera_FootageSeekPointSummaryType" - }, - "description" : "Mapping of timestamps to footage seek point summaries", + "dueDate" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "hostedInvoiceUrl" : { "type" : "string", "nullable" : true - } - } - }, - "Camera_GetFootageSeekpointsV2WSRequest" : { - "type" : "object", - "description" : "Request to retrieve footage seek points V2 for a camera within a time range.", - "properties" : { - "cameraUuid" : { + }, + "id" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "duration" : { - "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, + "invoicePdf" : { + "type" : "string", "nullable" : true }, - "includeAnyMotion" : { - "type" : "boolean", - "description" : "Whether to include any motion events", - "example" : true, + "number" : { + "type" : "string", "nullable" : true }, - "startTime" : { + "periodEnd" : { "type" : "integer", "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, "nullable" : true - } - } - }, - "Camera_GetFootageSeekpointsV2WSResponse" : { - "type" : "object", - "description" : "Response containing footage seek points V2 for a camera.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "periodStart" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "productName" : { "type" : "string", "nullable" : true }, - "footageSeekPoints" : { - "type" : "array", - "description" : "List of footage seek points V2", - "items" : { - "$ref" : "#/components/schemas/FootageSeekPointV2Type" - }, + "quantity" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "status" : { "type" : "string", "nullable" : true - } - } - }, - "Camera_GetFootageSeekpointsWSRequest" : { - "type" : "object", - "description" : "Request to retrieve footage seek points for a camera within a time range (deprecated).", - "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "subtotal" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "duration" : { + "tax" : { "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, + "format" : "int64", "nullable" : true }, - "startTime" : { + "total" : { "type" : "integer", "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, + "nullable" : true + }, + "usageDescriptions" : { + "type" : "string", "nullable" : true } } }, - "Camera_GetFootageSeekpointsWSResponse" : { + "Billing_GetMetersWSRequest" : { + "type" : "object" + }, + "Billing_GetMetersWSResponse" : { "type" : "object", - "description" : "Response containing footage seek points for a camera (deprecated).", "properties" : { "error" : { "type" : "boolean", @@ -57645,11 +59778,10 @@ "type" : "string", "nullable" : true }, - "footageSeekPoints" : { + "meters" : { "type" : "array", - "description" : "List of footage seek points", "items" : { - "$ref" : "#/components/schemas/FootageSeekPointType" + "$ref" : "#/components/schemas/Billing_GetMetersWSResponse_Meter" }, "nullable" : true }, @@ -57659,28 +59791,41 @@ } } }, - "Camera_GetFullCameraStateWSRequest" : { + "Billing_GetMetersWSResponse_Meter" : { "type" : "object", - "description" : "Request to retrieve the full state information of a camera.", "properties" : { - "cameraUuid" : { + "archived" : { + "type" : "boolean", + "nullable" : true + }, + "created" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "displayName" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "force" : { - "type" : "boolean", - "description" : "Whether to force a refresh of the camera state", - "example" : false, + "eventName" : { + "type" : "string", + "nullable" : true + }, + "eventTimeWindow" : { + "type" : "string", + "nullable" : true + }, + "id" : { + "type" : "string", "nullable" : true } } }, - "Camera_GetFullCameraStateWSResponse" : { + "Billing_GetPaymentMethodsWSRequest" : { + "type" : "object" + }, + "Billing_GetPaymentMethodsWSResponse" : { "type" : "object", - "description" : "Response containing the full state information of a camera.", "properties" : { "error" : { "type" : "boolean", @@ -57690,8 +59835,12 @@ "type" : "string", "nullable" : true }, - "fullCameraState" : { - "$ref" : "#/components/schemas/FullDeviceStateType" + "paymentMethods" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Billing_GetPaymentMethodsWSResponse_PaymentMethod" + }, + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -57699,61 +59848,36 @@ } } }, - "Camera_GetLineCrossingEnabledCamerasForLocationWSRequest" : { + "Billing_GetPaymentMethodsWSResponse_PaymentMethod" : { "type" : "object", - "description" : "Request to get line crossing enabled cameras for a location.", "properties" : { - "locationUuid" : { + "brand" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Camera_GetLineCrossingEnabledCamerasForLocationWSResponse" : { - "type" : "object", - "description" : "Response containing line crossing enabled cameras for a location.", - "properties" : { - "camerasToConfigs" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" - }, - "description" : "Map of camera UUIDs to their line crossing configurations", "nullable" : true }, - "error" : { + "default" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "displayBrand" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "id" : { "type" : "string", "nullable" : true - } - } - }, - "Camera_GetMediaUrisWSRequest" : { - "type" : "object", - "description" : "Request to get media URIs for a camera device.", - "properties" : { - "cameraUuid" : { + }, + "last4" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Camera_GetMediaUrisWSResponse" : { + "Billing_GetProductsWSRequest" : { + "type" : "object" + }, + "Billing_GetProductsWSResponse" : { "type" : "object", - "description" : "Response containing media URIs for camera streaming and playback.", "properties" : { "error" : { "type" : "boolean", @@ -57763,202 +59887,140 @@ "type" : "string", "nullable" : true }, - "lanCheckUrls" : { + "products" : { "type" : "array", - "description" : "List of LAN check URLs to verify device availability", "items" : { - "type" : "string", - "description" : "List of LAN check URLs to verify device availability", - "nullable" : true + "$ref" : "#/components/schemas/Billing_GetProductsWSResponse_Product" }, "nullable" : true }, - "lanLiveH264Uris" : { - "type" : "array", - "description" : "List of LAN H.264 live streaming URIs", - "items" : { - "type" : "string", - "description" : "List of LAN H.264 live streaming URIs", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Billing_GetProductsWSResponse_Price" : { + "type" : "object", + "properties" : { + "active" : { + "type" : "boolean", "nullable" : true }, - "lanLiveM3u8Uris" : { - "type" : "array", - "description" : "List of LAN M3U8 live streaming URIs", - "items" : { - "type" : "string", - "description" : "List of LAN M3U8 live streaming URIs", - "nullable" : true - }, + "billingScheme" : { + "type" : "string", "nullable" : true }, - "lanLiveMpdUris" : { - "type" : "array", - "description" : "List of LAN MPD live streaming URIs", - "items" : { - "type" : "string", - "description" : "List of LAN MPD live streaming URIs", - "nullable" : true - }, + "currency" : { + "type" : "string", "nullable" : true }, - "lanLiveOpusUris" : { - "type" : "array", - "description" : "List of LAN URIs for live Opus audio streams", - "items" : { - "type" : "string", - "description" : "List of LAN URIs for live Opus audio streams", - "nullable" : true - }, + "id" : { + "type" : "string", "nullable" : true }, - "lanVodM3u8UrisTemplates" : { - "type" : "array", - "description" : "List of LAN M3U8 VOD URI templates", - "items" : { - "type" : "string", - "description" : "List of LAN M3U8 VOD URI templates", - "nullable" : true - }, + "lookupKey" : { + "type" : "string", "nullable" : true }, - "lanVodMpdUrisTemplates" : { - "type" : "array", - "description" : "List of LAN MPD VOD URI templates", - "items" : { - "type" : "string", - "description" : "List of LAN MPD VOD URI templates", - "nullable" : true - }, + "nickname" : { + "type" : "string", "nullable" : true }, - "wanLiveH264Uri" : { + "productId" : { "type" : "string", - "description" : "WAN H.264 live streaming URI", - "example" : "rtsp://camera.example.com/live", "nullable" : true }, - "wanLiveM3u8Uri" : { + "productNameId" : { "type" : "string", - "description" : "WAN M3U8 live streaming URI", - "example" : "https://camera.example.com/live.m3u8", "nullable" : true }, - "wanLiveMpdUri" : { + "recurringInterval" : { "type" : "string", - "description" : "WAN MPD live streaming URI", - "example" : "https://camera.example.com/live.mpd", "nullable" : true }, - "wanLiveOpusUri" : { + "recurringIntervalCount" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "recurringUsageType" : { "type" : "string", - "description" : "WAN URI for live Opus audio stream", "nullable" : true }, - "wanVodH264UriTemplate" : { + "taxBehavior" : { "type" : "string", - "description" : "WAN H.264 VOD URI template", - "example" : "https://camera.example.com/vod/{timestamp}.h264", "nullable" : true }, - "wanVodM3u8UriTemplate" : { + "transformQuantity" : { "type" : "string", - "description" : "WAN M3U8 VOD URI template", - "example" : "https://camera.example.com/vod/{timestamp}.m3u8", "nullable" : true }, - "wanVodMpdUriTemplate" : { + "type" : { "type" : "string", - "description" : "WAN MPD VOD URI template", - "example" : "https://camera.example.com/vod/{timestamp}.mpd", "nullable" : true }, - "warningMsg" : { + "unitAmount" : { + "type" : "number", + "nullable" : true + }, + "unitAmountDecimal" : { "type" : "string", "nullable" : true } } }, - "Camera_GetMinimalCameraLocationMapWSRequest" : { - "type" : "object", - "description" : "Request to retrieve a mapping of cameras to their location information." - }, - "Camera_GetMinimalCameraLocationMapWSResponse" : { + "Billing_GetProductsWSResponse_Product" : { "type" : "object", - "description" : "Response containing a mapping of cameras to their location information.", "properties" : { - "cameraLocationMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo" - }, - "description" : "Mapping of camera UUIDs to location information", + "active" : { + "type" : "boolean", "nullable" : true }, - "error" : { - "type" : "boolean", + "created" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "defaultPriceId" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "description" : { "type" : "string", "nullable" : true - } - } - }, - "Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo" : { - "type" : "object", - "description" : "Information about a camera's location.", - "properties" : { - "cameraName" : { + }, + "id" : { "type" : "string", - "description" : "Name of the camera", - "example" : "Front Door Camera", "nullable" : true }, - "locationName" : { + "name" : { "type" : "string", - "description" : "Name of the location", - "example" : "Main Building", "nullable" : true }, - "locationUuid" : { + "nameId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_GetMinimalCameraStateListWSRequest" : { - "type" : "object", - "description" : "Request to retrieve a minimal list of camera states.", - "properties" : { - "includeMummified" : { - "type" : "boolean", - "description" : "Whether to include mummified cameras in the response", - "example" : false, + }, + "prices" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Billing_GetProductsWSResponse_Price" + }, + "nullable" : true + }, + "statementDescriptor" : { + "type" : "string", "nullable" : true } } }, - "Camera_GetMinimalCameraStateListWSResponse" : { + "Billing_GetSubscriptionWSRequest" : { + "type" : "object" + }, + "Billing_GetSubscriptionWSResponse" : { "type" : "object", - "description" : "Response containing a minimal list of camera states.", "properties" : { - "cameraStates" : { - "type" : "array", - "description" : "List of minimal camera state information", - "items" : { - "$ref" : "#/components/schemas/MinimalDeviceStateType" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -57967,114 +60029,125 @@ "type" : "string", "nullable" : true }, + "subscriptions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Billing_GetSubscriptionWSResponse_Subscription" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_GetMinimalListWSRequest" : { + "Billing_GetSubscriptionWSResponse_Subscription" : { "type" : "object", - "description" : "Request to retrieve a minimal list of cameras (deprecated).", "properties" : { - "includeMummified" : { + "cancelAtPeriodEnd" : { "type" : "boolean", - "description" : "Whether to include mummified cameras in the response", - "example" : false, "nullable" : true - } - } - }, - "Camera_GetMinimalListWSResponse" : { - "type" : "object", - "description" : "Response containing a minimal list of cameras (deprecated).", - "properties" : { - "cameras" : { - "type" : "array", - "description" : "List of minimal camera information", - "items" : { - "$ref" : "#/components/schemas/Camera_MinimalCameraType" - }, + }, + "canceledAt" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "error" : { - "type" : "boolean", + "collectionMethod" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "created" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "currency" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "currentPeriodEnd" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "currentPeriodStart" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "defaultPaymentMethod" : { "type" : "string", "nullable" : true - } - } - }, - "Camera_GetOccupancyEnabledCamerasWSRequest" : { - "type" : "object", - "description" : "Request to get occupancy enabled cameras." - }, - "Camera_GetOfflineLanStreamingInfoWSRequest" : { - "type" : "object", - "description" : "Request to retrieve offline LAN streaming information for cameras." - }, - "Camera_GetOfflineLanStreamingInfoWSResponse" : { - "type" : "object", - "description" : "Response containing offline LAN streaming information for cameras.", - "properties" : { - "error" : { + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "isApproachingLimit" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "maxSpendPerMonth" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "pricePerUnit" : { "type" : "string", "nullable" : true }, - "info" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Camera_CameraOfflineLanStreamingInfo" - }, - "description" : "Mapping of camera UUIDs to offline LAN streaming information", + "product" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "status" : { + "type" : "string", + "nullable" : true + }, + "trialEnd" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "upcomingInvoiceAmount" : { + "type" : "string", + "nullable" : true + }, + "upcomingInvoiceCurrency" : { + "type" : "string", + "nullable" : true + }, + "usageType" : { "type" : "string", "nullable" : true } } }, - "Camera_GetPresenceWindowsWSRequest" : { + "Billing_HistoricalUsageWSRequest" : { "type" : "object", - "description" : "Request to retrieve presence windows for a camera within a time range.", "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration in seconds", - "example" : 3600, + "products" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, + "range" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true } } }, - "Camera_GetPresenceWindowsWSResponse" : { + "Billing_HistoricalUsageWSResponse" : { "type" : "object", - "description" : "Response containing presence windows for a camera.", "properties" : { "error" : { "type" : "boolean", @@ -58084,17 +60157,15 @@ "type" : "string", "nullable" : true }, - "presenceWindows" : { + "usage" : { "type" : "object", "additionalProperties" : { "type" : "array", - "description" : "Mapping of presence types to time windows", "items" : { - "$ref" : "#/components/schemas/TimeWindowSeconds" + "$ref" : "#/components/schemas/Billing_HistoricalUsageWSResponse_HistoricalUsageElement" }, "nullable" : true }, - "description" : "Mapping of presence types to time windows", "nullable" : true }, "warningMsg" : { @@ -58103,88 +60174,74 @@ } } }, - "Camera_GetSharedCameraCurrentStateWSResponse" : { + "Billing_HistoricalUsageWSResponse_HistoricalUsageElement" : { "type" : "object", "properties" : { - "cameraState" : { - "$ref" : "#/components/schemas/Camera_SharedCameraCurrentStateType" - }, - "error" : { - "type" : "boolean", + "costInCent" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "date" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "eventCount" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Camera_GetStorageRecoveryFileWSRequest" : { + "Billing_InvoiceStatus" : { + "type" : "string", + "enum" : [ "DRAFT", "OPEN", "PAID", "UNCOLLECTIBLE", "VOID", "ALL" ] + }, + "Billing_SetDefaultPaymentMethodForSubscriptionWSRequest" : { "type" : "object", - "description" : "Request to get storage recovery file for a device.", "properties" : { - "deviceUuid" : { + "paymentMethodId" : { + "type" : "string", + "nullable" : true + }, + "subscriptionId" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Camera_GetStorageRecoveryFileWSResponse" : { + "Billing_SetDefaultPaymentMethodForSubscriptionWSResponse" : { "type" : "object", - "description" : "Response containing storage recovery file contents.", "properties" : { - "fileContents" : { - "type" : "array", - "description" : "Binary contents of the storage recovery file", - "example" : "[binary data]", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Binary contents of the storage recovery file", - "example" : "W2JpbmFyeSBkYXRhXQ==", - "nullable" : true - }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Camera_GetUptimeWindowsWSRequest" : { + "Billing_SetDefaultPaymentMethodWSRequest" : { "type" : "object", - "description" : "Request to retrieve uptime windows for a camera within a time range.", "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "endTime" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in seconds since epoch", - "example" : 1641081600, + "overrideAllSubscriptionPaymentMethods" : { + "type" : "boolean", "nullable" : true }, - "startTime" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, + "paymentMethodId" : { + "type" : "string", "nullable" : true } } }, - "Camera_GetUptimeWindowsWSResponse" : { + "Billing_SetDefaultPaymentMethodWSResponse" : { "type" : "object", - "description" : "Response containing uptime windows for a camera.", "properties" : { "error" : { "type" : "boolean", @@ -58194,52 +60251,38 @@ "type" : "string", "nullable" : true }, - "uptimeWindows" : { - "type" : "array", - "description" : "List of uptime windows", - "items" : { - "$ref" : "#/components/schemas/TimeWindowSeconds" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_GetVideoWallsWSRequest" : { + "Billing_SetupSubscriptionWSRequest" : { "type" : "object", - "description" : "Request to retrieve all video wall configurations." + "properties" : { + "termsOfServiceAccepted" : { + "type" : "boolean", + "nullable" : true + } + } }, - "Camera_GetVideoWallsWSResponse" : { + "Billing_SetupSubscriptionWSResponse" : { "type" : "object", - "description" : "Response containing video wall configurations and associated user name mappings.", "properties" : { - "error" : { - "type" : "boolean", + "clientSecret" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "customerId" : { "type" : "string", "nullable" : true }, - "userNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Mapping of user UUIDs to user names", - "nullable" : true - }, - "description" : "Mapping of user UUIDs to user names", + "error" : { + "type" : "boolean", "nullable" : true }, - "videoWalls" : { - "type" : "array", - "description" : "List of video wall summary information", - "items" : { - "$ref" : "#/components/schemas/Camera_VideoWallSummaryType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, "warningMsg" : { @@ -58248,168 +60291,100 @@ } } }, - "Camera_HealthStatusDetailsEnum" : { - "type" : "string", - "description" : "Detailed health status enumeration for cameras.", - "enum" : [ "DISCONNECTED", "FIRMWARE_BEHIND", "NONE" ] - }, - "Camera_MinimalCameraType" : { + "Billing_UnsubscribeWSRequest" : { "type" : "object", - "description" : "Minimal camera information type.", "properties" : { - "connectionStatus" : { - "$ref" : "#/components/schemas/Camera_StatusEnum" - }, - "defaultInterface" : { + "subscriptionId" : { "type" : "string", - "description" : "Default network interface", - "example" : "eth0", "nullable" : true - }, - "defaultInterfaceMac" : { - "type" : "string", - "description" : "MAC address of default interface", - "example" : "00:11:22:33:44:55", + } + } + }, + "Billing_UnsubscribeWSResponse" : { + "type" : "object", + "properties" : { + "cancelAtPeriodEnd" : { + "type" : "boolean", "nullable" : true }, - "floorNumber" : { + "canceledAt" : { "type" : "integer", - "format" : "int32", - "description" : "Floor number where the camera is located", - "example" : 1, + "format" : "int64", "nullable" : true }, - "healthStatus" : { - "$ref" : "#/components/schemas/Camera_StatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/Camera_HealthStatusDetailsEnum" - }, - "lanAddresses" : { - "type" : "array", - "description" : "List of LAN addresses", - "items" : { - "type" : "string", - "description" : "List of LAN addresses", - "nullable" : true - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the camera", - "example" : 37.7749, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "liveStreamShared" : { - "type" : "boolean", - "description" : "Whether live stream is shared", - "example" : false, + "status" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "subscriptionId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the camera", - "example" : -122.4194, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "mediaRegion" : { + } + } + }, + "Billing_UpdateCustomerInformationWSRequest" : { + "type" : "object", + "properties" : { + "addressCity" : { "type" : "string", - "description" : "Media region", - "example" : "us-west-1", "nullable" : true }, - "mummified" : { - "type" : "boolean", - "description" : "Whether the camera is mummified", - "example" : false, + "addressCountry" : { + "type" : "string", "nullable" : true }, - "name" : { + "addressLine1" : { "type" : "string", - "description" : "Name of the camera", - "example" : "Front Door Camera", "nullable" : true }, - "policyUuid" : { + "addressLine2" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { + "addressPostalCode" : { "type" : "string", - "description" : "Camera region", - "example" : "us-west-1", "nullable" : true }, - "serialNumber" : { + "addressState" : { "type" : "string", - "description" : "Camera serial number", - "example" : "CAM123456789", "nullable" : true }, - "ssid" : { + "businessName" : { "type" : "string", - "description" : "WiFi SSID", - "example" : "MyNetwork", "nullable" : true }, - "uuid" : { + "email" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiApMac" : { + "individualName" : { "type" : "string", - "description" : "MAC address of WiFi access point", - "example" : "AA:BB:CC:DD:EE:FF", "nullable" : true }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", - "description" : "WiFi signal strength in bars (1-5)", - "example" : 4, + "phone" : { + "type" : "string", "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "WiFi signal strength in dBm", - "example" : -45, - "nullable" : true - } - } - }, - "Camera_RebootCameraWSRequest" : { - "type" : "object", - "description" : "Request to reboot a camera device.", - "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "termsOfServiceAccepted" : { + "type" : "boolean", "nullable" : true } } }, - "Camera_RebootCameraWSResponse" : { + "Billing_UpdateCustomerInformationWSResponse" : { "type" : "object", - "description" : "Response from rebooting a camera device.", "properties" : { "error" : { "type" : "boolean", @@ -58419,33 +60394,27 @@ "type" : "string", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/Camera_RebootWSResponseStatus" - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Camera_RebootWSResponseStatus" : { - "type" : "string", - "description" : "Status enumeration for reboot web service responses.", - "enum" : [ "SUCCESS_REBOOT_SENT", "FAILED_CAMERA_OFFLINE", "FAILED_CAMERA_NOT_AUTHORIZED" ] - }, - "Camera_RevertCameraToDefaultsWSRequest" : { + "Billing_UpdateSubscriptionMaxSpendWSRequest" : { "type" : "object", "properties" : { - "cameraUuid" : { + "maxSpendPerMonth" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "subscriptionId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_RevertCameraToDefaultsWSResponse" : { + "Billing_UpdateSubscriptionMaxSpendWSResponse" : { "type" : "object", "properties" : { "error" : { @@ -58456,331 +60425,342 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Camera_SharedCameraCurrentStateType" : { - "type" : "object", - "description" : "Current state information for a shared camera.", - "properties" : { - "baseVideoOperationUrl" : { - "type" : "string", - "description" : "Base URL for video operations", - "example" : "https://api.example.com/video", - "nullable" : true - }, - "connectionStatus" : { - "$ref" : "#/components/schemas/ConnectivityStatus" - }, - "oldestArchivedMediaSeconds" : { + "maxSpendPerMonth" : { "type" : "integer", "format" : "int64", - "description" : "Oldest archived media timestamp in seconds", - "example" : 1640995200, - "nullable" : true - }, - "onCameraState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "State information stored on the camera", - "nullable" : true - }, - "description" : "State information stored on the camera", "nullable" : true }, - "onCloudState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "State information stored in the cloud", - "nullable" : true - }, - "description" : "State information stored in the cloud", + "subscriptionId" : { + "type" : "string", "nullable" : true }, - "region" : { + "warningMsg" : { "type" : "string", - "description" : "Camera region", - "example" : "us-west-1", "nullable" : true } } }, - "Camera_SharedLiveVideoStreamWS" : { + "BinaryAggregationValue" : { "type" : "object", - "description" : "List of shared live video streams for the doorbell camera", + "description" : "Map of binary count reports", "properties" : { - "audioDeviceHwVar" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "audioGatewayUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "eventCount" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "audioPushToTalkEnabled" : { - "type" : "boolean", + "false" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "cameraUuid" : { + "localDate" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "deviceHwVar" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "maxValueTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "expirationTime" : { + "minValueTimestampMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "hideOverlay" : { - "type" : "boolean", + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "invertSchedule" : { - "type" : "boolean", + "true" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "name" : { + "utcDate" : { "type" : "string", "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + } + } + }, + "Ble_BleDeviceMap" : { + "type" : "object", + "description" : "Map of BLE device keys to their advertisement data.", + "properties" : { + "keyToSecureBeacon" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device keys to secure beacon advertisement data", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Map of device keys to secure beacon advertisement data", + "nullable" : true + }, + "nullable" : true + }, + "description" : "Map of device keys to secure beacon advertisement data", "nullable" : true - }, - "passwordProtected" : { + } + } + }, + "Ble_BleRegisteredDeviceWSType" : { + "type" : "object", + "description" : "Information about a registered BLE device.", + "properties" : { + "deleted" : { "type" : "boolean", + "description" : "Indicates if the device has been deleted", + "example" : false, "nullable" : true }, - "scheduleUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sharedLiveM3U8StreamUrl" : { - "type" : "string", - "nullable" : true + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "sharedLiveVideoStreamUrl" : { + "name" : { "type" : "string", + "description" : "Name of the registered BLE device", + "example" : "Temperature Sensor 1", "nullable" : true }, - "sharedWithMonitoringService" : { - "type" : "boolean", - "nullable" : true - }, - "ssoProtected" : { - "type" : "boolean", - "nullable" : true - }, - "streamType" : { - "$ref" : "#/components/schemas/StreamTypeEnum" - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "secret" : { + "type" : "array", + "description" : "Secret data for the registered BLE device", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Secret data for the registered BLE device", + "nullable" : true + }, "nullable" : true }, - "unscheduledMessage" : { + "updateToFirmwareVersion" : { "type" : "string", + "description" : "Firmware version to update to", + "example" : "2.1.0", "nullable" : true - }, - "uuid" : { + } + } + }, + "Ble_BleUnregisteredHardwareWSType" : { + "type" : "object", + "description" : "Information about an unregistered BLE hardware device.", + "properties" : { + "mac" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "MAC address of the unregistered BLE device", + "example" : "AA:BB:CC:DD:EE:FF", "nullable" : true }, - "vodEnabled" : { - "type" : "boolean", + "secret" : { + "type" : "array", + "description" : "Secret data for the unregistered BLE device", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Secret data for the unregistered BLE device", + "nullable" : true + }, "nullable" : true } } }, - "Camera_SharedVideoWallWS" : { + "Ble_GetBaseStationsWSRequest" : { "type" : "object", - "description" : "List of shared video walls", + "description" : "Request to get available base stations for BLE sensors." + }, + "Ble_GetBaseStationsWSResponse" : { + "type" : "object", + "description" : "Response containing available base stations for BLE sensors.", "properties" : { - "deviceScheduleMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DeviceSchedule" + "baseStations" : { + "type" : "array", + "description" : "List of base station UUIDs available for BLE sensors", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true }, - "expirationTime" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "hideOverlay" : { + "error" : { "type" : "boolean", "nullable" : true }, - "invertSchedule" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "passwordProtected" : { + } + } + }, + "Ble_GetSecureSecretForRegisteredWSResponse" : { + "type" : "object", + "description" : "Response containing secure secrets for registered BLE devices.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "permissionGroupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "scheduleUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sharedVideoWallUrl" : { - "type" : "string", + "hardwareVariationToFirmwareDownloadUrl" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of hardware variations to firmware download URLs", + "nullable" : true + }, + "description" : "Map of hardware variations to firmware download URLs", + "nullable" : true + }, + "description" : "Map of hardware variations to firmware download URLs", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "keyToRegisteredDevice" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Ble_BleRegisteredDeviceWSType" + }, + "description" : "Map of device keys to registered device information", "nullable" : true }, - "unscheduledMessage" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Ble_GetSecureSecretForUnregisteredWSResponse" : { + "type" : "object", + "description" : "Response containing secure secrets for unregistered BLE devices.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "uuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "videoWallUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "keyToUnregisteredDevice" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Ble_BleUnregisteredHardwareWSType" + }, + "description" : "Map of serial numbers to unregistered device information", "nullable" : true }, - "vodEnabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Camera_StatusEnum" : { - "type" : "string", - "description" : "Status enumeration for camera states.", - "enum" : [ "RED", "ORANGE", "GREEN" ] + "Ble_GetSensorHardwareFirmwareUpdateDetailsRequest" : { + "type" : "object", + "description" : "Request to get firmware update details for BLE sensors." }, - "Camera_UpdateCameraAIThresholdsWSRequest" : { + "Ble_GetSensorHardwareFirmwareUpdateDetailsResponse" : { "type" : "object", - "description" : "Request to update AI thresholds for a camera.", + "description" : "Response containing firmware update details for BLE sensors.", "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "consecutiveHumanFilter" : { - "type" : "integer", - "format" : "int32", - "description" : "Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", - "example" : 3, - "nullable" : true - }, - "consecutiveVehicleFilter" : { - "type" : "integer", - "format" : "int32", - "description" : "Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", - "example" : 3, + "hardwareVariationToFirmwareDownloadUrl" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of hardware variations to firmware download URLs", + "nullable" : true + }, + "description" : "Map of hardware variations to firmware download URLs", + "nullable" : true + }, + "description" : "Map of hardware variations to firmware download URLs", "nullable" : true - }, - "faceConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for face detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.7", - "example" : 0.8, + } + } + }, + "Ble_RegisterSensorWSRequest" : { + "type" : "object", + "description" : "Request to register a BLE sensor device.", + "properties" : { + "bleData" : { + "type" : "array", + "description" : "BLE advertisement data from the sensor", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "BLE advertisement data from the sensor", + "nullable" : true + }, "nullable" : true }, - "faceMatchConfidenceThreshold" : { + "latitude" : { "type" : "number", - "format" : "float", - "description" : "Confidence threshold for face matching (determining if two faces are the same person). Set to 0 or null to use the default. Maximum range of 1. Default = 0.7. We no longer support device specific face matching threshold. This property is deprecated and will be removed.", - "example" : 0.8, + "format" : "double", + "description" : "Latitude coordinate for sensor placement", + "example" : 37.7749, "nullable" : true }, - "humanConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for human detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.6", - "example" : 0.7, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lprConfidenceThreshold" : { + "longitude" : { "type" : "number", - "format" : "float", - "description" : "Confidence threshold for license plate detection and character recognition. Set to 0 or null to use the default. Maximum range of 1. Default = 0.8", - "example" : 0.9, + "format" : "double", + "description" : "Longitude coordinate for sensor placement", + "example" : -122.4194, "nullable" : true }, - "maxEventDurationMs" : { - "type" : "integer", - "format" : "int32", - "description" : "Set the max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.", - "example" : 15000, + "name" : { + "type" : "string", + "description" : "Name for the sensor device", + "example" : "Temperature Sensor 1", "nullable" : true }, - "vehicleConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Confidence threshold for vehicle detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.6", - "example" : 0.7, + "serialNum" : { + "type" : "string", + "description" : "Serial number of the BLE sensor", + "example" : "SN123456789", "nullable" : true } } }, - "Camera_UpdateCameraAIThresholdsWSResponse" : { + "Ble_RegisterSensorWSResponse" : { "type" : "object", - "description" : "Response indicating the result of updating camera AI thresholds.", + "description" : "Response from registering a BLE sensor.", "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -58795,11 +60775,11 @@ } } }, - "Camera_UpdateCameraFirmwareWSRequest" : { + "Ble_UnregisterSensorWSRequest" : { "type" : "object", - "description" : "Request to update camera firmware.", + "description" : "Request to unregister a BLE sensor.", "properties" : { - "cameraUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -58808,9 +60788,9 @@ } } }, - "Camera_UpdateCameraFirmwareWSResponse" : { + "Ble_UnregisterSensorWSResponse" : { "type" : "object", - "description" : "Response containing the status of camera firmware update.", + "description" : "Response from unregistering a BLE sensor.", "properties" : { "error" : { "type" : "boolean", @@ -58820,693 +60800,768 @@ "type" : "string", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/Camera_UpdateFirmwareWSStatus" - }, - "warningMsg" : { + "failureReason" : { "type" : "string", + "description" : "Reason for failure if unregistration was not successful", + "example" : "Device not found", "nullable" : true - } - } - }, - "Camera_UpdateCameraHumanLoiteringConfigWSRequest" : { - "type" : "object", - "description" : "Request to update human loitering configuration for a camera.", - "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + }, + "success" : { + "type" : "boolean", + "description" : "Indicates if the unregistration was successful", + "example" : true, "nullable" : true }, - "rois" : { - "type" : "array", - "description" : "Region of interests of the human loitering feature. NULL or empty list will disable the feature", - "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Camera_UpdateCameraHumanLoiteringWSResponse" : { + "BoardPhysicalPortConfigType" : { "type" : "object", - "description" : "Response indicating the result of updating camera human loitering configuration.", "properties" : { - "error" : { - "type" : "boolean", + "boardNum" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "warningMsg" : { - "type" : "string", + "portMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PhysicalPortType" + }, "nullable" : true } } }, - "Camera_UpdateCameraLineCrossingThresholdsWSRequest" : { + "BodyPart" : { "type" : "object", - "description" : "Request to update line crossing thresholds for a camera.", + "nullable" : true, "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" + }, + "entity" : { + "type" : "object", "nullable" : true }, - "directions" : { - "type" : "array", - "description" : "Set of crossing directions to monitor.", - "items" : { - "$ref" : "#/components/schemas/CrossingDirectionEnum" - }, - "nullable" : true, - "uniqueItems" : true + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } }, - "inverted" : { - "type" : "boolean", - "description" : "By default, INGRESS events occur when the following condition is met for the following line types: an entity moves from top -> bottom when a horizontal line is defined, an entity moves from left -> right when a vertical line is defined, an entity moves from top-left -> bottom-right when an upwards sloping line is defined, and an entity moves from top-right to bottom-left when a downwards sloping line is defined. Setting this value to true will switch INGRESS to EGRESS events and vice-versa.", - "example" : false, - "nullable" : true + "mediaType" : { + "$ref" : "#/components/schemas/MediaType" }, - "objectType" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" + "messageBodyWorkers" : { + "$ref" : "#/components/schemas/MessageBodyWorkers" }, - "pointA" : { - "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" + "parameterizedHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterizedHeader" + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } }, - "pointB" : { - "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" + "parent" : { + "$ref" : "#/components/schemas/MultiPart" + }, + "providers" : { + "$ref" : "#/components/schemas/Providers" } } }, - "Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" : { + "BoulevardType" : { "type" : "object", - "description" : "(X,Y) coordinate expressed as a percentage of the camera's resolution.Minimum range is 0.1 and maximum range is 0.9. Leaving this value as null will disable line-crossing.", + "allOf" : [ { + "type" : "object", + "properties" : { + "accessWindowAfterMinutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "accessWindowBeforeMinutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "boulevardBusinessId" : { + "type" : "string", + "nullable" : true + }, + "boulevardLocationToRhombusLocationMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "x" : { - "type" : "number", - "format" : "float", - "description" : "Value ranges from 0.1 to 0.9", - "example" : 0.5, + "enabled" : { + "type" : "boolean", "nullable" : true }, - "y" : { - "type" : "number", - "format" : "float", - "description" : "Value ranges from 0.1 to 0.9", - "example" : 0.5, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_UpdateCameraLineCrossingThresholdsWSResponse" : { + "Boulevard_BoulevardUnlockRequest" : { "type" : "object", - "description" : "Response indicating the result of updating camera line crossing thresholds.", + "description" : "Request object for unlocking a door via Boulevard.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "sessionToken" : { "type" : "string", + "description" : "Boulevard session token", "nullable" : true } } }, - "Camera_UpdateCameraV2WSRequest" : { + "Boulevard_BoulevardUnlockResponse" : { "type" : "object", - "description" : "Request to update camera information V2 with partial update support.", + "description" : "Response object for a Boulevard unlock request.", "properties" : { - "customData" : { + "doorName" : { "type" : "string", - "description" : "Custom data for the camera", - "nullable" : true - }, - "customDataUpdated" : { - "type" : "boolean", - "description" : "Whether custom data was updated", - "example" : false, + "description" : "Name of the door that was unlocked", "nullable" : true }, - "deleted" : { + "error" : { "type" : "boolean", - "description" : "Whether the camera is deleted", - "example" : false, "nullable" : true }, - "deletedUpdated" : { - "type" : "boolean", - "description" : "Whether deleted status was updated", - "example" : false, + "errorMessage" : { + "type" : "string", + "description" : "Error message if unlock failed", "nullable" : true }, - "description" : { + "errorMsg" : { "type" : "string", - "description" : "Description of the camera", - "example" : "Camera monitoring the front entrance", "nullable" : true }, - "descriptionUpdated" : { + "success" : { "type" : "boolean", - "description" : "Whether description was updated", - "example" : false, + "description" : "Whether the unlock was successful", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "description" : "Direction in radians", - "example" : 1.5708, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "directionRadiansUpdated" : { + } + } + }, + "BoxSettings" : { + "type" : "object", + "description" : "Box file storage integration settings to update", + "properties" : { + "enabled" : { "type" : "boolean", - "description" : "Whether direction radians was updated", - "example" : false, "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Mapping of device facets to names", - "nullable" : true - }, - "description" : "Mapping of device facets to names", + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "facetNameMapUpdated" : { - "type" : "boolean", - "description" : "Whether facet name map was updated", - "example" : false, + "enablingUser" : { + "type" : "string", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number", - "example" : 1, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "floorNumberUpdated" : { - "type" : "boolean", - "description" : "Whether floor number was updated", - "example" : false, + "enterpriseId" : { + "type" : "string", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate", - "example" : 37.7749, + "folderId" : { + "type" : "string", + "nullable" : true + } + } + }, + "BrivoSettings" : { + "type" : "object", + "properties" : { + "accessToken" : { + "type" : "string", "nullable" : true }, - "latitudeUpdated" : { + "alertUnauthorizedFaces" : { "type" : "boolean", - "description" : "Whether latitude was updated", - "example" : false, "nullable" : true }, - "locationUuid" : { + "clientId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "locationUuidUpdated" : { - "type" : "boolean", - "description" : "Whether location UUID was updated", - "example" : false, "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate", - "example" : -122.4194, + "clientSecret" : { + "type" : "string", "nullable" : true }, - "longitudeUpdated" : { + "createSeekPoints" : { "type" : "boolean", - "description" : "Whether longitude was updated", - "example" : false, "nullable" : true }, - "mummified" : { - "type" : "boolean", - "description" : "Whether the camera is mummified", - "example" : false, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, "nullable" : true }, - "mummifiedUpdated" : { + "doorToCameraMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "writeOnly" : true + }, + "enabled" : { "type" : "boolean", - "description" : "Whether mummified status was updated", - "example" : false, "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the camera", - "example" : "Front Door Camera", + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "nameUpdated" : { - "type" : "boolean", - "description" : "Whether name was updated", - "example" : false, + "enablingUser" : { + "type" : "string", "nullable" : true }, - "policyUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuidUpdated" : { + "identifyFacesFromBadge" : { "type" : "boolean", - "description" : "Whether policy UUID was updated", - "example" : false, "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "subLocationsHierarchyKeyUpdated" : { + "migrated" : { "type" : "boolean", - "description" : "Whether sub-locations hierarchy key was updated", - "example" : false, "nullable" : true }, - "uuid" : { + "password" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Camera_UpdateCameraV2WSResponse" : { - "type" : "object", - "description" : "Response indicating the result of updating camera information V2.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "refreshToken" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "rhombusToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Camera_UpdateCameraWSRequest" : { - "type" : "object", - "description" : "Request to update camera information (deprecated).", - "properties" : { - "camera" : { - "$ref" : "#/components/schemas/Camera_CameraBackwardsCompatUpdateType" - } - } - }, - "Camera_UpdateCameraWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of updating camera information (deprecated).", - "properties" : { - "error" : { + }, + "saveClips" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "username" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "webhookId" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Camera_UpdateCamerasBulkV2WSRequest" : { + "BrivoType" : { "type" : "object", - "description" : "Request to update multiple cameras in bulk V2.", - "properties" : { - "cameraBulkDetails" : { - "type" : "array", - "description" : "List of camera bulk update details", - "items" : { - "$ref" : "#/components/schemas/Camera_UpdateCameraV2WSRequest" + "allOf" : [ { + "type" : "object", + "properties" : { + "accessToken" : { + "type" : "string", + "nullable" : true }, - "nullable" : true - } - } - }, - "Camera_UpdateConfigWSRequest" : { - "type" : "object", - "description" : "Request to update camera configuration settings.", - "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" - } - } - }, - "Camera_UpdateFirmwareWSStatus" : { - "type" : "string", - "description" : "Status of the firmware update operation", - "enum" : [ "ALREADY_ON_THE_LATEST_FIRMWARE", "DEVICE_ON_A_SPECIAL_FIRMWARE_AND_CANNOT_BE_UPDATED", "UPDATE_STARTED", "UNABLE_TO_REACH_DEVICE", "FIRMWARE_UPDATE_ALREADY_IN_PROGESS", "DEVICE_NOT_AUTHROIZED" ] - }, - "Camera_UpdateVideoWallWSRequest" : { - "type" : "object", - "description" : "Request to update a video wall configuration.", - "properties" : { - "videoWall" : { - "$ref" : "#/components/schemas/VideoWallType" + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiKey" : { + "type" : "string", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "clientId" : { + "type" : "string", + "nullable" : true + }, + "clientSecret" : { + "type" : "string", + "nullable" : true + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "password" : { + "type" : "string", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "username" : { + "type" : "string", + "nullable" : true + }, + "version" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "webhookId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } } - } - }, - "Camera_UpdateVideoWallWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of updating a video wall configuration.", + } ], + "nullable" : true, "properties" : { - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Camera_UpdateWifiWSRequest" : { - "type" : "object", - "description" : "Request to update WiFi settings for one or more cameras.", - "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "cameraUuids" : { - "type" : "array", - "description" : "List of camera UUIDs to update WiFi settings for", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, - "password" : { + "orgUuid" : { "type" : "string", - "description" : "WiFi network password", - "example" : "password123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ssid" : { + "userUuid" : { "type" : "string", - "description" : "WiFi network SSID", - "example" : "MyWiFiNetwork", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Camera_UpdateWifiWSResponse" : { + "BurstyRateLimit" : { "type" : "object", - "description" : "Response containing the status of WiFi update operations for each camera.", "properties" : { - "error" : { - "type" : "boolean", + "base_interval_ms" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "burst_token_generation_ms" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "status" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "description" : "Mapping of camera UUIDs to WiFi update success status", - "nullable" : true - }, - "description" : "Mapping of camera UUIDs to WiFi update success status", + "burst_token_initial_count" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "burst_token_max_count" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Camera_VideoWallSummaryType" : { + "ButterflyMXSettings" : { "type" : "object", - "description" : "Summary information for a video wall.", "properties" : { - "deviceList" : { - "type" : "array", - "items" : { + "buildingWebhookIdMap" : { + "type" : "object", + "additionalProperties" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "description" : "A HashMap of . ", "nullable" : true }, + "description" : "A HashMap of . ", "nullable" : true }, - "displayName" : { - "type" : "string", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "numShares" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { "type" : "integer", - "format" : "int32", - "description" : "Number of shares for the video wall", - "example" : 5, + "format" : "int64", "nullable" : true }, - "orgUuid" : { + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "othersCanEdit" : { + "indexFaces" : { "type" : "boolean", "nullable" : true }, - "ownerUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "migrated" : { + "type" : "boolean", "nullable" : true }, - "settings" : { + "panelInfoMap" : { "type" : "object", "additionalProperties" : { - "type" : "object", - "nullable" : true + "$ref" : "#/components/schemas/ButterflymxPanelInfoType" }, + "description" : "A HashMap of .", "nullable" : true }, - "shared" : { - "type" : "boolean", + "refreshToken" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "CancelLoopingAudioPlaybackActionRecordType" : { - "type" : "object", - "properties" : { - "statusMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/AudioGatewayStatusEnum" - }, + }, + "saveClips" : { + "type" : "boolean", "nullable" : true } } }, - "CancelLoopingAudioPlaybackActionType" : { + "ButterflyMXType" : { "type" : "object", - "properties" : { - "_audioDevices" : { - "type" : "array", - "items" : { + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "nullable" : true - }, - "audioDevices" : { - "type" : "array", - "items" : { + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "buildingWebhookIdMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A HashMap of . ", + "nullable" : true + }, + "description" : "A HashMap of . ", + "nullable" : true + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "panelInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ButterflymxPanelInfoType" + }, + "description" : "A HashMap of .", + "nullable" : true + }, + "refreshToken" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "nullable" : true - } - } - }, - "CancelledAccessStateOverride" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "cancelledDoorStateOverride" : { - "$ref" : "#/components/schemas/AccessStateOverride" + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true } } } ], "nullable" : true, "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "requestedAtMillis" : { - "type" : "integer", - "format" : "int64", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" - } - } - }, - "ChangeComponentCompositeAccessStateActionType" : { - "type" : "object", - "properties" : { - "accessState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "alwaysCreateOverrideIfNoFirstIn" : { - "type" : "boolean", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "componentCompositeUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "expirationStrategy" : { - "$ref" : "#/components/schemas/AccessStateOverrideExpirationStrategyEnum" - }, - "expireTimeDelaySeconds" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "expireTimeOfDayLocalSeconds" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "useFirstInRulesIfPossible" : { - "type" : "boolean", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "version" : { - "type" : "integer", - "format" : "int32", - "nullable" : true, - "readOnly" : true } } }, - "ChangeComponentCompositeAccessStateRecordType" : { + "ButterflymxBuilding" : { "type" : "object", "properties" : { - "accessState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "madeChange" : { - "type" : "boolean", - "nullable" : true - }, - "succeeded" : { - "type" : "boolean", + "id" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "usedFirstIn" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "willExpireAtMs" : { - "type" : "integer", - "format" : "int64", + "panels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DoorType" + }, "nullable" : true } } }, - "ChangeTypeEnum" : { - "type" : "string", - "description" : "Change type enum for exposing to OpenAPI component schemas", - "enum" : [ "REFRESH", "DELETE", "CREATE", "UPDATE" ] - }, - "ChatFollowUpActionEnum" : { - "type" : "string", - "enum" : [ "NOTIFY_USERS", "UNKNOWN" ] - }, - "ChatPrivacy" : { + "ButterflymxPanelInfoType" : { "type" : "object", + "description" : "A HashMap of .", + "nullable" : true, "properties" : { - "permissionGroupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "permittedPrincipalUuids" : { + "assignedCameraList" : { "type" : "array", + "description" : "The list of Rhombus Camera RUUIDs.", "items" : { "type" : "string", "format" : "RUUID", @@ -59514,75 +61569,88 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "visibility" : { - "$ref" : "#/components/schemas/ChatVisibilityEnum" - } - } - }, - "ChatQueryFilter" : { - "type" : "object", - "description" : "Optional field for filtering chat records.", - "properties" : { - "afterMs" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "beforeMs" : { + "buildingId" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "The ButterflyMx Building Id.", "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "responseTypes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ResponseTypeEnum" - }, - "nullable" : true, - "uniqueItems" : true + "panelName" : { + "type" : "string", + "description" : "The ButterflyMx Panel Name.", + "nullable" : true }, - "responseTypesStr" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "uniqueItems" : true + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, - "ChatRecord" : { + "ButtonEnumType" : { + "type" : "string", + "enum" : [ "integrated_generic_button", "integrated_doorbell_button", "schlage_rs485_input_button", "aperio_rs485_activator_button" ] + }, + "ButtonEventType" : { "type" : "object", - "description" : "Chat record used for a selective update.", + "allOf" : [ { + "type" : "object", + "properties" : { + "buttonPress" : { + "$ref" : "#/components/schemas/ButtonPressEnum" + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "newSupervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + }, + "pressDurationMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "automatedPromptUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "contextId" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "extra" : { - "type" : "string", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "llmInfo" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { @@ -59592,50 +61660,28 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "principalUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "privacy" : { - "$ref" : "#/components/schemas/ChatPrivacy" - }, - "queriedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "query" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "respondedAtMs" : { + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "response" : { - "type" : "string", - "nullable" : true - }, - "responseType" : { - "$ref" : "#/components/schemas/ResponseTypeEnum" - }, - "timeline" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/QueryTimelineEvent" - }, - "nullable" : true - }, - "toolingTimeline" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/QueryTool" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", @@ -59646,72 +61692,119 @@ } } }, - "ChatVisibilityEnum" : { - "type" : "string", - "enum" : [ "PUBLIC", "ORG_WIDE", "SELECT_USERS", "PRIVATE" ] - }, - "ChatbotConfig" : { + "ButtonIntegrationRuleTriggerType" : { "type" : "object", - "description" : "Rhombus MIND configuration to update.", + "allOf" : [ { + "type" : "object", + "properties" : { + "thirdPartyBatteryLevel" : { + "type" : "string", + "nullable" : true + }, + "thirdPartyButtonAction" : { + "type" : "string", + "nullable" : true + }, + "thirdPartyButtonName" : { + "type" : "string", + "nullable" : true + }, + "thirdPartyButtonSerialNumber" : { + "type" : "string", + "nullable" : true + }, + "thirdPartyButtonUuid" : { + "type" : "string", + "nullable" : true + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "apiKey" : { - "type" : "string", - "description" : "LLM API key used by the chatbot service", - "nullable" : true - }, - "billingType" : { - "$ref" : "#/components/schemas/ChatbotConfigBillingTypeEnum" - }, - "createdAtMs" : { + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "ButtonModeEnum" : { + "type" : "string", + "description" : "Optional button mode configuration", + "enum" : [ "PANIC", "PROGRAMMABLE", "DOORBELL", "NONE" ] + }, + "ButtonPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_INPUT", "BUTTON_INPUT" ] + }, + "ButtonPortType" : { + "type" : "object", + "properties" : { + "boardNum" : { "type" : "integer", - "format" : "int64", - "description" : "Epoch timestamp in milliseconds when this config was created", + "format" : "int32", "nullable" : true }, - "executionStrategy" : { - "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" - }, - "lastUpdatedByPrincipal" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "portNum" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "portType" : { + "$ref" : "#/components/schemas/ButtonPhysicalPortEnumType" + } + } + }, + "ButtonPressEnum" : { + "type" : "string", + "enum" : [ "NONE", "SINGLE", "DOUBLE", "LONG", "INITIAL_PRESS", "LONG_RELEASE" ] + }, + "ButtonSettingsSelectiveUpdate" : { + "type" : "object", + "description" : "Update Button settings", + "properties" : { + "button_emergency_onsite_contact" : { + "$ref" : "#/components/schemas/EmergencyContact" }, - "tokenValid" : { + "button_test_mode_enabled" : { "type" : "boolean", - "description" : "Indicator if the provided LLM API key is valid", "nullable" : true }, - "updatedAtMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Epoch timestamp in milliseconds when this config was last updated", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true } - }, - "required" : [ "billingType" ] + } }, - "ChatbotConfigBillingTypeEnum" : { + "Button_ButtonHealthDetailsEnum" : { "type" : "string", - "description" : "Billing type", - "enum" : [ "SELF_MANAGED", "MANAGED", "TRIAL" ] + "description" : "Detailed health status for button sensors.", + "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] }, - "ChatbotExecutionStrategyEnum" : { + "Button_ButtonHealthEnum" : { "type" : "string", - "description" : "Execution strategy for chat queries. Defaults to MIND_CHATGPT if not specified.", - "enum" : [ "MIND_CHATGPT", "DIRECT_CHATGPT", "DIRECT_CLAUDE" ] + "description" : "Health status for button sensors.", + "enum" : [ "GREEN", "RED" ] }, - "Chatbot_BaseAutomatedPromptWSResponse" : { + "Button_CreateRuleForButtonWSRequest" : { "type" : "object", - "description" : "Response object for creating, updating or retrieving chatbot automation settings.", + "description" : "Request to create a rule for a button sensor.", + "properties" : { + "rule" : { + "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" + } + } + }, + "Button_CreateRuleForButtonWSResponse" : { + "type" : "object", + "description" : "Response from creating a rule for a button sensor.", "properties" : { "error" : { "type" : "boolean", @@ -59721,8 +61814,12 @@ "type" : "string", "nullable" : true }, - "settings" : { - "$ref" : "#/components/schemas/AutomatedPrompt" + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -59730,34 +61827,30 @@ } } }, - "Chatbot_BaseChatWSResponse" : { + "Button_DeleteRuleForButtonWSRequest" : { "type" : "object", - "description" : "Response object for retrieving or updating a chat record.", + "description" : "Request to delete a rule for a button sensor.", "properties" : { - "chat" : { - "$ref" : "#/components/schemas/ChatRecord" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "ruleUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "sensorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Chatbot_BaseChatbotConfigWSResponse" : { + "Button_DeleteRuleForButtonWSResponse" : { "type" : "object", - "description" : "Response object for creating, updating or retrieving Rhombus MIND config.", + "description" : "Response from deleting a rule for a button sensor.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/ChatbotConfig" - }, "error" : { "type" : "boolean", "nullable" : true @@ -59772,110 +61865,78 @@ } } }, - "Chatbot_CreateAutomatedPromptWSRequest" : { - "type" : "object", - "description" : "Request object for creating chatbot automation settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/AutomatedPrompt" - } - }, - "required" : [ "settings" ] - }, - "Chatbot_CreateChatbotConfigWSRequest" : { - "type" : "object", - "description" : "Request object for creating Rhombus MIND config.", - "properties" : { - "config" : { - "$ref" : "#/components/schemas/ChatbotConfig" - } - }, - "required" : [ "config" ] - }, - "Chatbot_DeleteAutomatedPromptWSRequest" : { + "Button_ExternalButtonRuleType" : { "type" : "object", - "description" : "Request object for deleting chatbot automation settings.", + "description" : "External button rule configuration.", "properties" : { - "promptUuid" : { + "action" : { + "$ref" : "#/components/schemas/RuleActionType" + }, + "ruleFilters" : { + "$ref" : "#/components/schemas/RuleFilterType" + }, + "ruleName" : { + "type" : "string", + "description" : "Name of the button rule", + "example" : "Emergency Alert Rule", + "nullable" : true + }, + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "promptUuid" ] - }, - "Chatbot_DeleteChatRecordWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a chat record.", - "properties" : { - "recordUuid" : { + }, + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "triggerPress" : { + "$ref" : "#/components/schemas/ButtonPressEnum" } - }, - "required" : [ "recordUuid" ] - }, - "Chatbot_DeleteChatbotConfigWSRequest" : { - "type" : "object", - "description" : "Request object for deleting Rhombus MIND config." + } }, - "Chatbot_DeleteChatbotConversationWSRequest" : { + "Button_GetButtonPressEventsForSensorWSRequest" : { "type" : "object", - "description" : "Request object for deleting a user's conversation with Rhombus MIND.", + "description" : "Request to get button press events for a specific sensor.", "properties" : { - "contextId" : { - "type" : "string", - "description" : "Context identifier of the conversation to delete.", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds to get events created after this time", + "example" : 1640995200000, "nullable" : true - } - }, - "required" : [ "contextId" ] - }, - "Chatbot_GetAutomatedPromptChatHistoryWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving chat history for a given automated prompt.", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds to get events created before this time", + "example" : 1640995200000, "nullable" : true }, - "maxPageSize" : { + "limit" : { "type" : "integer", "format" : "int32", + "description" : "Maximum number of events to return", + "example" : 100, "nullable" : true }, - "promptUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "promptUuid" ] - }, - "Chatbot_GetAutomatedPromptWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving chatbot automation settings.", - "properties" : { - "promptUuid" : { + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "promptUuid" ] + } }, - "Chatbot_GetAutomatedPromptsForOrgWSResponse" : { + "Button_GetButtonPressEventsForSensorWSResponse" : { "type" : "object", - "description" : "Response object for retrieving chatbot automation settings for an org.", + "description" : "Response containing button press events for a sensor.", "properties" : { "error" : { "type" : "boolean", @@ -59885,16 +61946,11 @@ "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Pagination key to resume a paginated query.", - "nullable" : true - }, - "settingsList" : { + "events" : { "type" : "array", - "description" : "List of chatbot automation settings for this org.", + "description" : "List of button press events for the sensor", "items" : { - "$ref" : "#/components/schemas/AutomatedPrompt" + "$ref" : "#/components/schemas/ButtonEventType" }, "nullable" : true }, @@ -59904,43 +61960,25 @@ } } }, - "Chatbot_GetChatHistoryByContextIdWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a user's chat history for a given conversation with Rhombus MIND.", - "properties" : { - "contextId" : { - "type" : "string", - "description" : "Context ID to get chat history for.", - "nullable" : true - }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - } - }, - "required" : [ "contextId" ] - }, - "Chatbot_GetChatHistoryWSRequest" : { + "Button_GetButtonRulesForOrgWSRequest" : { "type" : "object", - "description" : "Request object for retrieving a user's entire chat history with Rhombus MIND.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/ChatQueryFilter" - }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - } - } + "description" : "Request to get rules for all buttons in an organization." }, - "Chatbot_GetChatHistoryWSResponse" : { + "Button_GetButtonRulesForOrgWSResponse" : { "type" : "object", - "description" : "Response object for retrieving an entity's chat history with Rhombus MIND.", + "description" : "Response containing rules for all buttons in an organization.", "properties" : { - "chatHistory" : { - "type" : "array", - "description" : "An entity's chat history with Rhombus MIND.", - "items" : { - "$ref" : "#/components/schemas/ChatRecord" + "buttonUuidToRulesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of button UUIDs to their associated rules", + "items" : { + "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" + }, + "nullable" : true }, + "description" : "Map of button UUIDs to their associated rules", "nullable" : true }, "error" : { @@ -59951,56 +61989,20 @@ "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Pagination key to resume a paginated query.", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Chatbot_GetChatRecordWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a chat record.", - "properties" : { - "recordUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "recordUuid" ] - }, - "Chatbot_GetChatbotConfigWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving Rhombus MIND config." - }, - "Chatbot_GetChatbotConversationsWSRequest" : { + "Button_GetMinimalButtonStatesWSRequest" : { "type" : "object", - "description" : "Request object for retrieving a user's conversations with Rhombus MIND.", - "properties" : { - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - } - } + "description" : "Request to get minimal state information for all button sensors." }, - "Chatbot_GetChatbotConversationsWSResponse" : { + "Button_GetMinimalButtonStatesWSResponse" : { "type" : "object", - "description" : "Response object for retrieving a user's conversations with Rhombus MIND.", + "description" : "Response containing minimal state information for all button sensors.", "properties" : { - "conversations" : { - "type" : "array", - "description" : "List of a user's conversations.", - "items" : { - "$ref" : "#/components/schemas/ContextRecord" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -60009,9 +62011,12 @@ "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Pagination key to resume a paginated query.", + "states" : { + "type" : "array", + "description" : "List of minimal button state information", + "items" : { + "$ref" : "#/components/schemas/Button_MinimalButtonStateType" + }, "nullable" : true }, "warningMsg" : { @@ -60020,60 +62025,23 @@ } } }, - "Chatbot_GetPublicChatRecordWSRequest" : { + "Button_GetRulesForButtonWSRequest" : { "type" : "object", - "description" : "Request object for retrieving a publicly viewable chat record.", + "description" : "Request to get rules for a button sensor.", "properties" : { - "chatId" : { - "type" : "string", - "description" : "Base64-encoded chat record UUID.", - "nullable" : true - }, - "orgId" : { + "sensorUuid" : { "type" : "string", - "description" : "Base64-encoded org UUID.", - "nullable" : true - } - }, - "required" : [ "chatId", "orgId" ] - }, - "Chatbot_GetRemainingTrialCreditsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving the current org's remaining trial credits for MIND." - }, - "Chatbot_GetRemainingTrialCreditsWSResponse" : { - "type" : "object", - "description" : "Response object for retrieving the current org's remaining trial credits for MIND.", - "properties" : { - "remainingTrialCredits" : { - "type" : "integer", - "format" : "int64", - "description" : "The current org's remaining trial credits for MIND.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Chatbot_GetSharedChatRecordsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving chat records shared with the current user.", - "properties" : { - "filter" : { - "$ref" : "#/components/schemas/ChatQueryFilter" - } - } - }, - "Chatbot_GetSharedChatRecordsWSResponse" : { + "Button_GetRulesForButtonWSResponse" : { "type" : "object", - "description" : "Response object for retrieving chat records shared with the current user.", + "description" : "Response containing rules for a button sensor.", "properties" : { - "chatRecords" : { - "type" : "array", - "description" : "List of chat records shared with the current user.", - "items" : { - "$ref" : "#/components/schemas/ChatRecord" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -60082,642 +62050,556 @@ "type" : "string", "nullable" : true }, + "rules" : { + "type" : "array", + "description" : "List of rules configured for the button sensor", + "items" : { + "$ref" : "#/components/schemas/Button_ExternalButtonRuleType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Chatbot_GetTokenUsageHistoryWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving the current org's LLM token usage history." - }, - "Chatbot_GetTokenUsageHistoryWSResponse" : { + "Button_MinimalButtonStateType" : { "type" : "object", - "description" : "Response object for retrieving the current org's LLM token usage history.", + "description" : "Minimal state information for a button sensor.", "properties" : { - "usageHistory" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/TokenUsageStats" - }, - "description" : "The current org's LLM token usage history.", + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "description" : "The current org's LLM token usage history.", "nullable" : true - } - } - }, - "Chatbot_InterruptChatWSRequest" : { - "type" : "object", - "description" : "Request object for interrupting a chat record.", - "properties" : { - "recordUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "batteryPercent" : { + "type" : "integer", + "format" : "int32", + "description" : "Battery percentage of the button sensor", + "example" : 85, "nullable" : true - } - }, - "required" : [ "recordUuid" ] - }, - "Chatbot_ShareAutomatedPromptResponseWSRequest" : { - "type" : "object", - "description" : "Request object for updating the visibility of an automated prompt response.", - "properties" : { - "chatUuid" : { + }, + "buttonEmergencyOnsiteContact" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, + "buttonMode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" + }, + "closestBaseStation" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "privacy" : { - "$ref" : "#/components/schemas/ChatPrivacy" - } - }, - "required" : [ "chatUuid", "privacy" ] - }, - "Chatbot_SubmitChatWSRequest" : { - "type" : "object", - "description" : "Request object for submitting a query to Rhombus MIND.", - "properties" : { - "contextId" : { - "type" : "string", - "description" : "Uuid used to track the current conversation with Rhombus MIND.", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Creation timestamp in milliseconds", + "example" : 1640995200000, "nullable" : true }, - "conversationName" : { + "firmwareVersion" : { "type" : "string", - "description" : "The name of the conversation if this query is the start of a new conversation. If not specified, the conversation will be named after the first query.", + "description" : "Firmware version of the button sensor", + "example" : "2.1.0", "nullable" : true }, - "query" : { - "type" : "string", - "description" : "The query to submit to Rhombus MIND.", - "nullable" : true - } - }, - "required" : [ "contextId", "query" ] - }, - "Chatbot_SubmitChatWSResponse" : { - "type" : "object", - "description" : "Response object for submitting a query to Rhombus MIND.", - "nullable" : true, - "properties" : { - "chatRecordUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the button sensor is located", + "example" : 1, "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true + "health" : { + "$ref" : "#/components/schemas/Button_ButtonHealthEnum" }, - "errorMsg" : { - "type" : "string", + "healthDetails" : { + "$ref" : "#/components/schemas/Button_ButtonHealthDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lastSeenSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Last time the button sensor was seen in seconds", + "example" : 1640995200, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the button sensor", + "example" : 37.7749, "nullable" : true - } - } - }, - "Chatbot_SubmitCreateReportWSRequest" : { - "type" : "object", - "description" : "Request object for submitting a report query to Rhombus MIND.", - "properties" : { - "contextId" : { + }, + "locationUuid" : { "type" : "string", - "description" : "Uuid used to track the current conversation with Rhombus MIND.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "conversationName" : { - "type" : "string", - "description" : "The name of the conversation if this query is the start of a new conversation. If not specified, the conversation will be named after the first query.", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the button sensor", + "example" : -122.4194, "nullable" : true }, - "query" : { + "name" : { "type" : "string", - "description" : "The query to submit to Rhombus MIND.", + "description" : "Name of the button sensor", + "example" : "Main Entrance Button", "nullable" : true - } - }, - "required" : [ "contextId", "query" ] - }, - "Chatbot_SubmitCreateReportWSResponse" : { - "type" : "object", - "description" : "Response object for submitting a report query to Rhombus MIND.", - "properties" : { - "chatRecordUuid" : { + }, + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { - "type" : "boolean", + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the button sensor", + "example" : "SN123456789", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "Signal strength of the button sensor", + "example" : -45, "nullable" : true }, - "warningMsg" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "testModeEnabled" : { + "type" : "boolean", + "description" : "Indicates if test mode is enabled for the button sensor", + "example" : false, "nullable" : true } } }, - "Chatbot_SubmitTestPromptWSRequest" : { + "Button_UpdateButtonConfigWSRequest" : { "type" : "object", - "description" : "Request object for submitting a test prompt with Rhombus MIND.", + "description" : "Request to update button sensor configuration.", "properties" : { - "responseTemplate" : { - "type" : "string", - "description" : "Template for Rhombus MIND to follow when generating a response.", - "nullable" : true - }, - "testPrompt" : { - "type" : "string", - "description" : "Prompt to test with Rhombus MIND.", - "nullable" : true + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableButtonUserConfig" } - }, - "required" : [ "testPrompt" ] + } }, - "Chatbot_SubmitTestPromptWSResponse" : { + "Button_UpdateButtonDetailsWSRequest" : { "type" : "object", - "description" : "Response object for submitting a test prompt with Rhombus MIND.", + "description" : "Request to update button sensor details.", "properties" : { - "chatUuid" : { + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "buttonMode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" + }, + "description" : { + "type" : "string", + "description" : "Optional description for the button sensor", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Optional floor number", + "example" : 1, + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional latitude coordinate", + "example" : 37.7749, + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { - "type" : "boolean", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional longitude coordinate", + "example" : -122.4194, "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Optional name for the button sensor", "nullable" : true }, - "warningMsg" : { + "sensorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, "nullable" : true } } }, - "Chatbot_UpdateAutomatedPromptWSRequest" : { - "type" : "object", - "description" : "Request object for updating chatbot automation settings.", - "properties" : { - "selectiveUpdate" : { - "$ref" : "#/components/schemas/AutomatedPrompt" - } - }, - "required" : [ "selectiveUpdate" ] - }, - "Chatbot_UpdateChatRecordWSRequest" : { - "type" : "object", - "description" : "Request object for selectively updating a chat record.", - "properties" : { - "chat" : { - "$ref" : "#/components/schemas/ChatRecord" - } - }, - "required" : [ "chat" ] - }, - "Chatbot_UpdateChatbotConfigWSRequest" : { - "type" : "object", - "description" : "Request object for updating Rhombus MIND config.", - "properties" : { - "config" : { - "$ref" : "#/components/schemas/ChatbotConfig" - } - }, - "required" : [ "config" ] - }, - "Chatbot_UpdateChatbotConversationWSRequest" : { - "type" : "object", - "description" : "Request object for selectively updating a user's conversation with Rhombus MIND.", - "properties" : { - "selectiveUpdate" : { - "$ref" : "#/components/schemas/ContextRecordSelectiveUpdate" - } - } - }, - "Chatbot_UpdateChatbotConversationsWSResponse" : { + "Buyer" : { "type" : "object", - "description" : "Response object for updating a user's conversation with Rhombus MIND.", "properties" : { - "conversation" : { - "$ref" : "#/components/schemas/ContextRecord" + "address1" : { + "type" : "string", + "nullable" : true }, - "error" : { - "type" : "boolean", + "address2" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "address3" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "city" : { "type" : "string", "nullable" : true - } - } - }, - "Chatbot_VerifyJobScheduledWSRequest" : { - "type" : "object", - "description" : "Request object for rescheduling an automated prompt that became inactive.", - "properties" : { - "promptUuid" : { + }, + "companyName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "promptUuid" ] - }, - "Chatbot_VerifyJobScheduledWSResponse" : { - "type" : "object", - "description" : "Response object for rescheduling an automated prompt that became inactive.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "contactName" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "country" : { "type" : "string", "nullable" : true }, - "scheduleExpression" : { + "phoneNumber" : { "type" : "string", - "description" : "Schedule expression when this automated prompt will trigger.", "nullable" : true }, - "scheduleTimezone" : { + "postalCode" : { "type" : "string", - "description" : "Timezone the schedule expression is in.", "nullable" : true }, - "warningMsg" : { + "state" : { "type" : "string", "nullable" : true } } }, - "Chatbot_report_AddAIReportTimelineEventWSRequest" : { + "COSensorType" : { "type" : "object", - "description" : "Request object for adding a timeline event to an AI report", "properties" : { - "reportUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "adcRaw" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/QueryStatusEnum" + "adcVoltage" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "timestampMs" : { + "coConcentration" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "timestampSec" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp in milliseconds for the timeline event", "nullable" : true } } }, - "Chatbot_report_BaseAIReportGroupWSResponse" : { + "CameraAiDewarpConfigType" : { "type" : "object", - "description" : "Response object for retrieving or updating an AI report group", "properties" : { - "error" : { - "type" : "boolean", + "dewarp_tile_height" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "dewarp_tile_width" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "group" : { - "$ref" : "#/components/schemas/AIReportGroup" - }, - "warningMsg" : { - "type" : "string", + "orientation" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Chatbot_report_BaseAIReportWSResponse" : { + "CameraConfiguration" : { "type" : "object", - "description" : "Response object for retrieving or updating an AI report", "properties" : { - "error" : { - "type" : "boolean", + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "checkConditionOverride" : { + "$ref" : "#/components/schemas/CheckCondition" + }, + "exampleImages" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ExampleImage" + }, "nullable" : true }, - "report" : { - "$ref" : "#/components/schemas/AIReport" + "promptExtension" : { + "type" : "string", + "nullable" : true }, - "warningMsg" : { + "promptOverride" : { "type" : "string", "nullable" : true + }, + "region" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, + "scheduledActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ScheduledAction" + }, + "nullable" : true } } }, - "Chatbot_report_CreateReportWSRequest" : { + "CameraCrossCountingSettingsType" : { "type" : "object", - "description" : "Request object for generating an AI report.", "properties" : { - "params" : { - "$ref" : "#/components/schemas/AIReportGenerateParams" + "directions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CrossingDirectionEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "privacy" : { - "$ref" : "#/components/schemas/ChatPrivacy" - } - }, - "required" : [ "params", "privacy" ] - }, - "Chatbot_report_CreateReportWSResponse" : { - "type" : "object", - "description" : "Response object for generating an AI report.", - "properties" : { - "error" : { - "type" : "boolean", + "in_roi" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "object_type" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" }, - "reportUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "object_type_id" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "out_roi" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, "nullable" : true } } }, - "Chatbot_report_DeleteAIReportGroupWSRequest" : { + "CameraDewarpModeEnum" : { + "type" : "string", + "enum" : [ "NO_TRANSFORM", "NORMAL", "PANORAMA", "SUB_REGION", "VERTICAL_PANORAMA", "TRANSVERSE_MERCATOR", "MERCATOR", "EQUIRECTANGULAR" ] + }, + "CameraHumanLoiteringSettingsType" : { "type" : "object", - "description" : "Request object for deleting an AI report group", "properties" : { - "groupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "roi" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, "nullable" : true } } }, - "Chatbot_report_DeleteAIReportWSRequest" : { + "CameraInactivitySettingsType" : { "type" : "object", - "description" : "Request object for deleting an AI report", "properties" : { - "reportUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "object_type" : { + "$ref" : "#/components/schemas/InactivityObjectTypeEnum" + }, + "roi" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, + "threshold_ms" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Chatbot_report_GetAIReportGroupsByOrgWSRequest" : { + "CameraMeteringConfigType" : { "type" : "object", - "description" : "Request object for retrieving AI report groups by organization", "properties" : { - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" + "rotation" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "table" : { + "type" : "string", + "nullable" : true } } }, - "Chatbot_report_GetAIReportGroupsByOrgWSResponse" : { + "CameraMotorConfigType" : { "type" : "object", - "description" : "Response object for retrieving AI report groups by organization UUID", "properties" : { - "error" : { + "af_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "af_region" : { + "$ref" : "#/components/schemas/PermyriadRect" }, - "groups" : { - "type" : "array", - "description" : "List of AI reports", - "items" : { - "$ref" : "#/components/schemas/AIReportGroup" - }, + "focus" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "lastEvaluatedKey" : { - "$ref" : "#/components/schemas/DynamoPageRequest" + "pan_degrees" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Chatbot_report_GetAIReportWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving an AI report", - "properties" : { - "reportUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Chatbot_report_GetAIReportsByGroupWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving AI reports by group", - "properties" : { - "groupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - } - } - }, - "Chatbot_report_GetAIReportsByGroupWSResponse" : { - "type" : "object", - "description" : "Response object for retrieving AI reports by group", - "properties" : { - "error" : { - "type" : "boolean", + "piris" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "pt_speed" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "lastEvaluatedKey" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - }, - "reports" : { - "type" : "array", - "description" : "List of AI reports", - "items" : { - "$ref" : "#/components/schemas/AIReport" - }, + "tilt_degrees" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "zoom" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Chatbot_report_GetAIReportsByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving AI reports by organization", - "properties" : { - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - } - } + "CameraMountingDirectionEnum" : { + "type" : "string", + "enum" : [ "DOWN", "UP", "SIDEWAYS", "UNKNOWN" ] }, - "Chatbot_report_GetAIReportsByOrgWSResponse" : { + "CameraPTZConfigType" : { "type" : "object", - "description" : "Response object for retrieving AI reports by organization", "properties" : { - "error" : { - "type" : "boolean", + "offset_x_percent" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "offset_y_percent" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "lastEvaluatedKey" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - }, - "reports" : { - "type" : "array", - "description" : "List of AI reports", - "items" : { - "$ref" : "#/components/schemas/AIReport" - }, + "rotation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "size_percent" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "Chatbot_report_UpdateAIReportWSRequest" : { - "type" : "object", - "description" : "Request object for updating an AI report", - "properties" : { - "report" : { - "$ref" : "#/components/schemas/AIReport" - } - } + "CameraPTZEngineEnum" : { + "type" : "string", + "enum" : [ "DIGITAL", "MECHANICAL", "NONE", "UNKNOWN" ] }, - "CheckCondition" : { - "type" : "object", - "properties" : { - "operator" : { - "$ref" : "#/components/schemas/OPERATOREnum" - }, - "value" : { - "type" : "string", - "nullable" : true - } - } + "CameraPTZMovementEnum" : { + "type" : "string", + "enum" : [ "RELATIVE", "ABSOLUTE" ] }, - "ClaimKey" : { + "CameraPTZTranslationSpaceEnum" : { + "type" : "string", + "enum" : [ "FOV", "DIGITAL", "NONE", "UNKNOWN" ] + }, + "CameraPolicyV2Type" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "entry" : { - "$ref" : "#/components/schemas/ClaimKeyEntry" - }, - "migratedRenewal" : { - "type" : "boolean", - "nullable" : true - }, - "startDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "List of camera policies using the schedule", "properties" : { - "claimEndDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", - "nullable" : true - }, - "claimStartDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date/time when claiming of licenses represented by this claim key started.", - "nullable" : true - }, - "createdOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "endDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "expirationEmailState" : { - "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" + "defaultTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CameraTriggerType" + }, + "nullable" : true, + "uniqueItems" : true }, - "gracePeriodEndDate" : { + "description" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "maskedClaimCode" : { + "name" : { "type" : "string", - "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, "orgUuid" : { @@ -60727,40 +62609,13 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "renewedByClaimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "requestId" : { - "type" : "string", - "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", - "nullable" : true - }, - "returnHistory" : { + "scheduledTriggers" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ClaimKeyReturnEvent" + "$ref" : "#/components/schemas/CameraScheduledTriggerType" }, "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/ClaimKeyStateEnum" - }, - "trial" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ClaimKeyTypeEnum" - }, - "updatedOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -60770,263 +62625,253 @@ } } }, - "ClaimKeyEntry" : { + "CameraPosition" : { "type" : "object", - "nullable" : true, "properties" : { - "productQuantities" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true } } }, - "ClaimKeyExpirationEmailStateEnum" : { - "type" : "string", - "enum" : [ "NINETY_DAY_EMAIL_SUCCEEDED", "NINETY_DAY_EMAIL_FAILED", "SIXTY_DAY_EMAIL_SUCCEEDED", "SIXTY_DAY_EMAIL_FAILED", "FOURTY_FIVE_DAY_EMAIL_SUCCEEDED", "FOURTY_FIVE_DAY_EMAIL_FAILED", "THIRTY_DAY_EMAIL_SUCCEEDED", "THIRTY_DAY_EMAIL_FAILED", "TWENTY_ONE_DAY_EMAIL_SUCCEEDED", "TWENTY_ONE_DAY_EMAIL_FAILED", "FOURTEEN_DAY_EMAIL_SUCCEEDED", "FOURTEEN_DAY_EMAIL_FAILED", "TEN_DAY_EMAIL_SUCCEEDED", "TEN_DAY_EMAIL_FAILED", "FIVE_DAY_EMAIL_SUCCEEDED", "FIVE_DAY_EMAIL_FAILED", "FOUR_DAY_EMAIL_SUCCEEDED", "FOUR_DAY_EMAIL_FAILED", "THREE_DAY_EMAIL_SUCCEEDED", "THREE_DAY_EMAIL_FAILED", "TWO_DAY_EMAIL_SUCCEEDED", "TWO_DAY_EMAIL_FAILED", "ONE_DAY_EMAIL_SUCCEEDED", "ONE_DAY_EMAIL_FAILED", "ZERO_DAY_EMAIL_SUCCEEDED", "ZERO_DAY_EMAIL_FAILED", "GRACE_PERIOD_EMAILS_IN_PROGRESS", "GRACE_PERIOD_EMAILS_COMPLETED", "UNKNOWN" ] - }, - "ClaimKeyReturnEvent" : { + "CameraPtzHome" : { "type" : "object", "properties" : { - "returnedProductQuantities" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "go_home_seq" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "timestamp" : { - "type" : "string", - "format" : "date-time", + "pan_degrees" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tilt_degrees" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "zoom" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "ClaimKeySearchFilter" : { + "CameraScheduledTriggerType" : { "type" : "object", "properties" : { - "excludeUnclaimed" : { - "type" : "boolean", - "nullable" : true - }, - "excludedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClaimKeyStateEnum" - }, - "nullable" : true, - "uniqueItems" : true + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, - "includedStates" : { + "triggerSet" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ClaimKeyStateEnum" + "$ref" : "#/components/schemas/CameraTriggerType" }, "nullable" : true, "uniqueItems" : true } } }, - "ClaimKeyStateEnum" : { - "type" : "string", - "enum" : [ "CREATED", "CLAIMING_PENDING", "CLAIMING_IN_PROGRESS", "CLAIMING_FAILED", "CLAIMED", "EXPIRED_UNCLAIMED", "EXPIRED", "RETURNED", "RENEWED" ] - }, - "ClaimKeyTypeEnum" : { - "type" : "string", - "enum" : [ "NEW", "RENEWAL" ] - }, - "ClientEnum" : { - "type" : "string", - "enum" : [ "DEVICE", "MOBILE", "BROWSER", "BROWSER_V2", "BROWSER_PARTNER", "MOBILE_PARTNER", "ANONYMOUS", "SHARE_ANONYMOUS", "SHARE_ANONYMOUS_V2", "SHARE_RAW", "SHARE_SSO", "TV_API", "API", "API_TOKEN", "API_OAUTH_TOKEN", "FEDERATED_TOKEN", "PARTNER_API", "PARTNER_API_TOKEN", "PARTNER_API_OAUTH_TOKEN", "KEYPAD_API", "INTERNAL_SALESFORCE", "RHOMBUS_KEY_MOBILE", "KIOSK_CONSOLE", "KIOSK_IOS_API", "CHATBOT" ] - }, - "ClimateActivityEventType" : { + "CameraTriggerType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "climateThreshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - } - } - } ], - "nullable" : true, "properties" : { - "activityEvent" : { + "activity" : { "$ref" : "#/components/schemas/ActivityEnum" - } - } - }, - "ClimateEventType" : { - "type" : "object", - "description" : "List of climate events for the sensor", - "properties" : { - "alertActivities" : { + }, + "customDetectionUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "baseStationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "dwellTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "batteryPercentage" : { + "dwellTimeResetMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "bleDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "faceAlertLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "faceAlertUnidentified" : { + "type" : "boolean", "nullable" : true }, - "bleRssi" : { + "faceAllowedLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "threshold" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "closeBaseStations" : { + "vehicleAlertLabelSet" : { "type" : "array", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "co2" : { - "type" : "number", - "format" : "float", + "vehicleAlertUnidentified" : { + "type" : "boolean", "nullable" : true }, - "ethanol" : { - "type" : "number", - "format" : "float", + "vehicleAllowedLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "CameraType" : { + "type" : "object", + "description" : "List of third-party cameras assigned to the specified NVR", + "properties" : { + "archiveRegion" : { + "type" : "string", "nullable" : true }, - "heatIndexDegF" : { - "type" : "number", - "format" : "double", + "cameraFramerate" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "heatIndexRangeWarning" : { - "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "humidity" : { - "type" : "number", - "format" : "float", + "customData" : { + "type" : "string", "nullable" : true }, - "iaq" : { - "type" : "number", - "format" : "float", + "deleted" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "description" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "deviceFacetRadians" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, "nullable" : true }, - "pm25" : { + "directionRadians" : { "type" : "number", "format" : "float", "nullable" : true }, - "probeTempC" : { - "type" : "number", - "format" : "float", + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "tampered" : { - "type" : "boolean", + "hardwareId" : { + "type" : "string", "nullable" : true }, - "temp" : { + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "latitude" : { "type" : "number", - "format" : "float", + "format" : "double", "nullable" : true }, - "thcDetected" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "thcPercent" : { + "longitude" : { "type" : "number", - "format" : "float", + "format" : "double", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "mediaRegion" : { + "type" : "string", "nullable" : true }, - "tvoc" : { - "type" : "number", - "format" : "float", + "mediaRegionHistory" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" + }, "nullable" : true }, - "vapeSmokeDetected" : { - "type" : "boolean", + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "vapeSmokePercent" : { - "type" : "number", - "format" : "float", - "nullable" : true - } - } - }, - "ClimatePolicyType" : { - "type" : "object", - "description" : "List of climate policies using the schedule", - "properties" : { - "backoffAlertSecs" : { + "mediaStorageDeviceUuidByFacet" : { "type" : "object", "additionalProperties" : { - "type" : "integer", - "format" : "int64", + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "defaultTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClimateTriggerType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "description" : { - "type" : "string", + "mummified" : { + "type" : "boolean", "nullable" : true }, "name" : { @@ -61040,224 +62885,161 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClimateScheduledTriggerType" - }, + "pending" : { + "type" : "boolean", "nullable" : true }, - "uuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ClimateScheduledTriggerType" : { - "type" : "object", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClimateTriggerType" - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "ClimateSettings" : { - "type" : "object", - "properties" : { - "alert_window_minutes" : { - "type" : "integer", - "format" : "int32", + "serialNumber" : { + "type" : "string", "nullable" : true }, - "smoke_ai_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "thc_ai_threshold" : { - "type" : "number", - "format" : "float", + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "unregisteredEmailSent" : { + "type" : "boolean", "nullable" : true }, - "vape_ai_threshold" : { - "type" : "number", - "format" : "float", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "ClimateSettingsSelectiveUpdate" : { + "CameraVisualTamperConfigType" : { "type" : "object", - "description" : "Update Sensor Climate settings", "properties" : { - "alert_window_minutes" : { + "analyze_fps" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "smoke_ai_threshold" : { + "analyze_res" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "canny_thresh" : { "type" : "number", "format" : "float", "nullable" : true }, - "thc_ai_threshold" : { + "edge_cov_diff_thresh" : { "type" : "number", "format" : "float", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "enabled" : { + "type" : "boolean", "nullable" : true }, - "vape_ai_threshold" : { - "type" : "number", - "format" : "float", + "long_buf_size" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "ClimateTriggerType" : { - "type" : "object", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" }, - "threshold" : { - "type" : "number", - "format" : "float", + "short_buf_size" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Climate_ClimateHealthDetailsEnum" : { - "type" : "string", - "description" : "Detailed health status enumeration for climate sensors.", - "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] - }, - "Climate_ClimateHealthEnum" : { - "type" : "string", - "description" : "Health status enumeration for climate sensors.", - "enum" : [ "GREEN", "RED" ] - }, - "Climate_DeleteEnvironmentalGatewayWSRequest" : { + "Camera_CameraBackwardsCompatUpdateType" : { "type" : "object", - "description" : "Request to delete an environmental gateway.", + "description" : "Backwards compatible camera update type with optional fields.", "properties" : { - "deviceUuid" : { + "archiveRegion" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Archive region for the camera", + "example" : "us-west-1", "nullable" : true }, - "mummify" : { + "deleted" : { "type" : "boolean", - "description" : "Whether to mummify the gateway instead of deleting it", + "description" : "Whether the camera is deleted", "example" : false, "nullable" : true - } - } - }, - "Climate_DeleteEnvironmentalGatewayWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of deleting an environmental gateway.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" }, - "warningMsg" : { + "description" : { "type" : "string", - "nullable" : true - } - } - }, - "Climate_GetClimateEventsForSensorWSRequest" : { - "type" : "object", - "description" : "Request to retrieve climate events for an environmental sensor.", - "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds after which events should be retrieved", - "example" : 1640991600000, + "description" : "Description of the camera", + "example" : "Camera monitoring the main entrance", "nullable" : true }, - "createdBeforeMs" : { + "floorNumber" : { "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds before which events should be retrieved", - "example" : 1640995200000, + "format" : "int32", + "description" : "Floor number where the camera is located", + "example" : 1, "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of events to return", - "example" : 100, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the camera", + "example" : 37.7749, "nullable" : true }, - "sensorUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Climate_GetClimateEventsForSensorWSResponse" : { - "type" : "object", - "description" : "Response containing climate events for an environmental sensor.", - "properties" : { - "climateEvents" : { - "type" : "array", - "description" : "List of climate events for the sensor", - "items" : { - "$ref" : "#/components/schemas/ClimateEventType" - }, + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the camera", + "example" : -122.4194, "nullable" : true }, - "error" : { + "mummified" : { "type" : "boolean", + "description" : "Whether the camera is mummified", + "example" : false, "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Name of the camera", + "example" : "Front Door Camera", "nullable" : true }, - "warningMsg" : { + "policyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Climate_GetClimateSensorConfigWSRequest" : { - "type" : "object", - "description" : "Request to retrieve configuration for an environmental sensor.", - "properties" : { + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -61267,428 +63049,387 @@ } } }, - "Climate_GetClimateSensorConfigWSResponse" : { + "Camera_CameraCurrentStateType" : { "type" : "object", - "description" : "Response containing configuration for an environmental sensor.", + "description" : "Current state information for a camera.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/IClimateUserConfig" + "baseVideoOperationUri" : { + "type" : "string", + "description" : "Base URI for video operations", + "example" : "https://api.example.com/video", + "nullable" : true }, - "error" : { - "type" : "boolean", + "connectionStatus" : { + "$ref" : "#/components/schemas/Camera_StatusEnum" + }, + "connectionTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Connection timestamp in milliseconds", + "example" : 1640995200000, "nullable" : true }, - "errorMsg" : { + "defaultInterface" : { "type" : "string", + "description" : "Default network interface", + "example" : "eth0", "nullable" : true }, - "warningMsg" : { + "defaultInterfaceMac" : { "type" : "string", - "nullable" : true - } - } - }, - "Climate_GetEnvironmentalGatewayShadowsWSRequest" : { - "type" : "object", - "description" : "Request to retrieve environmental gateway shadows." - }, - "Climate_GetEnvironmentalGatewayShadowsWSResponse" : { - "type" : "object", - "description" : "Response containing environmental gateway shadows.", - "properties" : { - "environmentalGatewayShadows" : { - "type" : "array", - "description" : "List of environmental gateway shadows", - "items" : { - "$ref" : "#/components/schemas/EnvironmentalGatewayShadowType" - }, + "description" : "MAC address of default interface", + "example" : "00:11:22:33:44:55", "nullable" : true }, - "error" : { - "type" : "boolean", + "firmwareVersion" : { + "type" : "string", + "description" : "Current firmware version", + "example" : "1.2.3", "nullable" : true }, - "errorMsg" : { + "healthStatus" : { + "$ref" : "#/components/schemas/Camera_StatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/Camera_HealthStatusDetailsEnum" + }, + "latestFirmwareVersion" : { "type" : "string", + "description" : "Latest available firmware version", + "example" : "1.2.4", "nullable" : true }, - "warningMsg" : { + "mediaRegion" : { "type" : "string", + "description" : "Media region", + "example" : "us-west-1", "nullable" : true - } - } - }, - "Climate_GetEventsForEnvironmentalGatewayWSRequest" : { - "type" : "object", - "description" : "Request to retrieve events for an environmental gateway.", - "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds after which events should be retrieved", - "example" : 1640991600000, + }, + "onCameraState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "State information stored on the camera", + "nullable" : true + }, + "description" : "State information stored on the camera", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds before which events should be retrieved", - "example" : 1640995200000, + "onCloudState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "State information stored in the cloud", + "nullable" : true + }, + "description" : "State information stored in the cloud", "nullable" : true }, - "deviceUuid" : { + "region" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Camera region", + "example" : "us-west-1", "nullable" : true }, - "lastEvaluatedKey" : { + "serialNumber" : { "type" : "string", + "description" : "Camera serial number", + "example" : "CAM123456789", "nullable" : true }, - "maxPageSize" : { + "ssid" : { + "type" : "string", + "description" : "WiFi SSID", + "example" : "MyNetwork", + "nullable" : true + }, + "versionsBehind" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of results to return per page", - "example" : 50, - "nullable" : true - } - } - }, - "Climate_GetEventsForEnvironmentalGatewayWSResponse" : { - "type" : "object", - "description" : "Response containing events for an environmental gateway.", - "properties" : { - "events" : { - "type" : "array", - "description" : "List of climate events for the environmental gateway", - "items" : { - "$ref" : "#/components/schemas/E50ClimateEventType" - }, + "description" : "Number of firmware versions behind", + "example" : 1, "nullable" : true }, - "lastEvaluatedKey" : { + "wifiApMac" : { "type" : "string", + "description" : "MAC address of WiFi access point", + "example" : "AA:BB:CC:DD:EE:FF", + "nullable" : true + }, + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "description" : "WiFi signal strength in bars (1-5)", + "example" : 4, + "nullable" : true + }, + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "WiFi signal strength in dBm", + "example" : -45, "nullable" : true } } }, - "Climate_GetMinimalClimateStatesWSRequest" : { - "type" : "object", - "description" : "Request to retrieve minimal climate state information for all environmental sensors." - }, - "Climate_GetMinimalClimateStatesWSResponse" : { + "Camera_CameraExternalFacetedType" : { "type" : "object", - "description" : "Response containing minimal climate state information for environmental sensors.", + "description" : "External faceted camera type with device UUID.", "properties" : { - "climateStates" : { - "type" : "array", - "description" : "List of minimal climate state information", - "items" : { - "$ref" : "#/components/schemas/Climate_MinimalClimateStateType" - }, + "archiveRegion" : { + "type" : "string", "nullable" : true }, - "error" : { - "type" : "boolean", + "cameraFramerate" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "customData" : { "type" : "string", "nullable" : true - } - } - }, - "Climate_GetMinimalEnvironmentalGatewayStatesWSRequest" : { - "type" : "object", - "description" : "Request to retrieve minimal environmental gateway states." - }, - "Climate_GetMinimalEnvironmentalGatewayStatesWSResponse" : { - "type" : "object", - "description" : "Response containing minimal environmental gateway states.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { - "type" : "string", + "deleted" : { + "type" : "boolean", "nullable" : true }, - "lastEvaluatedKey" : { + "description" : { "type" : "string", "nullable" : true }, - "minimalEnvironmentalGatewayStates" : { - "type" : "array", - "description" : "List of minimal environmental gateway states", - "items" : { - "$ref" : "#/components/schemas/Climate_MinimalEnvironmentalGatewayStateType" + "deviceFacetRadians" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "float", + "nullable" : true }, "nullable" : true }, - "warningMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - } - } - }, - "Climate_MinimalClimateStateType" : { - "type" : "object", - "description" : "Minimal climate state information for environmental sensors.", - "properties" : { - "associatedCameras" : { - "type" : "array", - "description" : "List of associated camera device facet UUIDs", - "items" : { + }, + "directionRadians" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "batteryPercent" : { + "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Battery percentage of the environmental sensor", - "example" : 85, "nullable" : true }, - "calibrating" : { - "type" : "boolean", - "description" : "Whether the sensor is currently calibrating", - "example" : false, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "closestBaseStation" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "co2" : { + "longitude" : { "type" : "number", - "format" : "float", - "description" : "CO2 measurement", - "example" : 450.0, + "format" : "double", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Creation timestamp in milliseconds", - "example" : 1640995200000, + "mediaRegion" : { + "type" : "string", "nullable" : true }, - "ethanol" : { - "type" : "number", - "format" : "float", - "description" : "Ethanol measurement", - "example" : 5.2, - "nullable" : true - }, - "firmwareVersion" : { - "type" : "string", - "description" : "Firmware version", - "example" : "1.2.3", - "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number", - "example" : 2, + "mediaRegionHistory" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" + }, "nullable" : true }, - "health" : { - "$ref" : "#/components/schemas/Climate_ClimateHealthEnum" - }, - "healthDetails" : { - "$ref" : "#/components/schemas/Climate_ClimateHealthDetailsEnum" - }, - "heatIndexDegF" : { - "type" : "number", - "format" : "double", - "description" : "Heat index in degrees Fahrenheit", - "example" : 85.2, + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "heatIndexRangeWarning" : { - "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" - }, - "humidity" : { - "type" : "number", - "format" : "float", - "description" : "Relative humidity percentage", - "example" : 45.2, + "mediaStorageDeviceUuidByFacet" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "iaq" : { - "type" : "number", - "format" : "float", - "description" : "Indoor Air Quality index", - "example" : 85.5, + "mummified" : { + "type" : "boolean", "nullable" : true }, - "lastSeenSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Last seen timestamp in seconds", - "example" : 1640995200, + "name" : { + "type" : "string", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate", - "example" : 37.7749, + "pending" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate", - "example" : -122.4194, + "serialNumber" : { + "type" : "string", "nullable" : true }, - "name" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Name of the environmental sensor", - "example" : "Office Climate Sensor", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "pm25" : { - "type" : "number", - "format" : "float", - "description" : "PM2.5 particulate matter measurement", - "example" : 12.3, + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "unregisteredEmailSent" : { + "type" : "boolean", "nullable" : true }, - "policyUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Camera_CameraExternalType" : { + "type" : "object", + "description" : "External camera type.", + "properties" : { + "archiveRegion" : { + "type" : "string", + "nullable" : true }, - "probeConnected" : { - "type" : "boolean", - "description" : "Whether the probe is connected", - "example" : true, + "cameraFramerate" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "probeTempC" : { - "type" : "number", - "format" : "float", - "description" : "Temperature probe measurement in Celsius", - "example" : 24.1, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "sensorUuid" : { + "customData" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the environmental sensor", - "example" : "ES-123456789", + "deleted" : { + "type" : "boolean", "nullable" : true }, - "signalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "Signal strength of the environmental sensor", - "example" : 85, + "description" : { + "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "deviceFacetRadians" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nullable" : true }, - "temperatureCelcius" : { + "directionRadians" : { "type" : "number", "format" : "float", - "description" : "Temperature in Celsius", - "example" : 23.5, "nullable" : true }, - "thcPercent" : { - "type" : "number", - "format" : "float", - "description" : "THC percentage measurement", - "example" : 0.8, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "tvoc" : { - "type" : "number", - "format" : "float", - "description" : "Total Volatile Organic Compounds (TVOC) measurement", - "example" : 125.5, + "floorNumber" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "vapePercent" : { + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "latitude" : { "type" : "number", - "format" : "float", - "description" : "Vape percentage measurement", - "example" : 2.1, + "format" : "double", "nullable" : true - } - } - }, - "Climate_MinimalEnvironmentalGatewayStateType" : { - "type" : "object", - "description" : "Minimal environmental gateway state information.", - "properties" : { - "activities" : { - "type" : "array", - "description" : "List of detected activities", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "airQualityIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "Air quality index value", - "example" : 45, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "airQualityIndexPollutant" : { - "$ref" : "#/components/schemas/AirQualityIndexPollutantEnum" + "mediaRegion" : { + "type" : "string", + "nullable" : true }, - "alertTriggers" : { + "mediaRegionHistory" : { "type" : "array", - "description" : "List of alert triggers", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" }, "nullable" : true }, - "associatedCameras" : { - "type" : "array", - "description" : "List of associated camera device facet UUIDs", - "items" : { + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "mediaStorageDeviceUuidByFacet" : { + "type" : "object", + "additionalProperties" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", @@ -61697,481 +63438,447 @@ }, "nullable" : true }, - "calibrating" : { + "mummified" : { "type" : "boolean", - "description" : "Whether the gateway is currently calibrating", - "example" : false, - "nullable" : true - }, - "ch2oPpb" : { - "type" : "number", - "format" : "float", - "description" : "Formaldehyde measurement in parts per billion", - "example" : 15.7, - "nullable" : true - }, - "co2Ppm" : { - "type" : "integer", - "format" : "int32", - "description" : "CO2 measurement in parts per million", - "example" : 450, "nullable" : true }, - "coConcentration" : { - "type" : "number", - "format" : "double", - "description" : "Carbon monoxide concentration", - "example" : 2.1, + "name" : { + "type" : "string", "nullable" : true }, - "connected" : { + "pending" : { "type" : "boolean", - "description" : "Whether the gateway is connected", - "example" : true, - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Creation timestamp in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "defaultInterfaceMac" : { - "type" : "string", - "description" : "Default interface MAC address", - "example" : "00:1A:2B:3C:4D:5E", "nullable" : true }, - "deviceUuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "externalIPAddress" : { + "serialNumber" : { "type" : "string", - "description" : "External IP address", - "example" : "203.0.113.1", - "nullable" : true - }, - "falsePositiveConfidencePercent" : { - "type" : "number", - "format" : "float", - "description" : "False positive confidence percentage", - "example" : 5.2, "nullable" : true }, - "firmwareVersion" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Firmware version", - "example" : "2.1.5", - "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number", - "example" : 2, - "nullable" : true - }, - "healthDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "heatIndexDegF" : { - "type" : "number", - "format" : "double", - "description" : "Heat index in degrees Fahrenheit", - "example" : 85.2, + "unregisteredEmailSent" : { + "type" : "boolean", "nullable" : true }, - "heatIndexRangeWarning" : { - "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "iaq" : { - "type" : "number", - "format" : "float", - "description" : "Indoor Air Quality index", - "example" : 85.5, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Camera_CameraOfflineLanStreamingInfo" : { + "type" : "object", + "description" : "Information for offline LAN streaming.", + "properties" : { + "accessToken" : { + "type" : "string", + "description" : "Access token for LAN streaming", + "example" : "abc123def456", "nullable" : true }, "lanAddresses" : { "type" : "array", - "description" : "List of LAN IP addresses", + "description" : "List of LAN addresses for streaming", "items" : { "type" : "string", - "description" : "List of LAN IP addresses", + "description" : "List of LAN addresses for streaming", "nullable" : true }, "nullable" : true + } + } + }, + "Camera_CameraPTZMoveWSRequest" : { + "type" : "object", + "description" : "Request object for moving a Rhombus first-party mechanical PTZ camera.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate", - "example" : 37.7749, + "xmovementPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "X-axis movement in permyriad units", + "example" : 1000, "nullable" : true }, - "leakDetected" : { - "type" : "boolean", - "description" : "Whether a leak is detected", - "example" : false, + "ymovementPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Y-axis movement in permyriad units", + "example" : 1000, "nullable" : true }, - "leakProbePresent" : { + "zmovementPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Z-axis movement in permyriad units", + "example" : 1000, + "nullable" : true + } + } + }, + "Camera_CameraPTZMoveWSResponse" : { + "type" : "object", + "description" : "Response object for moving a Rhombus first-party mechanical PTZ camera.", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether leak probe is present", - "example" : true, "nullable" : true }, - "locationUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate", - "example" : -122.4194, "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", - "description" : "Name of the environmental gateway", - "example" : "Main Office Gateway", "nullable" : true - }, - "nc0p5" : { - "type" : "number", - "format" : "float", - "description" : "Number concentration 0.5 measurement", - "example" : 120.5, + } + } + }, + "Camera_CreateCustomFootageSeekpointsWSRequest" : { + "type" : "object", + "description" : "Request to create custom footage seek points for a camera.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "nc10p0" : { - "type" : "number", - "format" : "float", - "description" : "Number concentration 10.0 measurement", - "example" : 15.3, + "footageSeekPoints" : { + "type" : "array", + "description" : "List of custom footage seek points to create", + "items" : { + "$ref" : "#/components/schemas/CustomFootageSeekPointType" + }, "nullable" : true - }, - "nc1p0" : { - "type" : "number", - "format" : "float", - "description" : "Number concentration 1.0 measurement", - "example" : 85.2, + } + } + }, + "Camera_CreateFootageBoundingBoxesWSRequest" : { + "type" : "object", + "description" : "Request to create footage bounding boxes for a camera.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "nc2p5" : { - "type" : "number", - "format" : "float", - "description" : "Number concentration 2.5 measurement", - "example" : 45.8, + "footageBoundingBoxes" : { + "type" : "array", + "description" : "List of footage bounding boxes to create", + "items" : { + "$ref" : "#/components/schemas/FootageBoundingBoxType" + }, "nullable" : true - }, - "nc4p0" : { - "type" : "number", - "format" : "float", - "description" : "Number concentration 4.0 measurement", - "example" : 32.1, + } + } + }, + "Camera_CreateFootageBoundingBoxesWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of creating footage bounding boxes.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "noxIdx" : { - "type" : "number", - "format" : "float", - "description" : "Nitrogen Oxides index", - "example" : 88.2, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pm10p0" : { - "type" : "number", - "format" : "float", - "description" : "PM10.0 particulate matter measurement", - "example" : 18.9, + } + } + }, + "Camera_CreateFootageSeekpointsWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of creating footage seek points.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "pm1p0" : { - "type" : "number", - "format" : "float", - "description" : "PM1.0 particulate matter measurement", - "example" : 8.5, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "pm2p5" : { - "type" : "number", - "format" : "float", - "description" : "PM2.5 particulate matter measurement", - "example" : 12.3, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "pm4p0" : { - "type" : "number", - "format" : "float", - "description" : "PM4.0 particulate matter measurement", - "example" : 15.7, + } + } + }, + "Camera_CreateSharedLiveVideoStreamWSRequest" : { + "type" : "object", + "description" : "Request to create a shared live video stream for a camera.", + "properties" : { + "audioGatewayUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "policyUuid" : { + "cameraUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "pressure" : { - "type" : "number", - "format" : "float", - "description" : "Pressure measurement", - "example" : 1013.25, + "expirationTimeSecs" : { + "type" : "integer", + "format" : "int32", + "description" : "Add an expiration date for accessing the stream in seconds", + "example" : 86400, "nullable" : true }, - "probeTempC" : { - "type" : "number", - "format" : "float", - "description" : "Temperature probe measurement in Celsius", - "example" : 24.5, + "includeAudio" : { + "type" : "boolean", + "description" : "Camera must be associated with an audio gateway to have audio", + "example" : false, "nullable" : true }, - "relHumid" : { - "type" : "number", - "format" : "float", - "description" : "Relative humidity percentage", - "example" : 45.2, + "invertSchedule" : { + "type" : "boolean", + "description" : "If given a schedule UUID, will hide the stream during the schedule instead and show it otherwise", + "example" : false, "nullable" : true }, - "serialNumber" : { + "name" : { "type" : "string", - "description" : "Serial number of the environmental gateway", - "example" : "EG-123456789", + "description" : "If not provided, will be named 'Unnamed'", + "example" : "Front Door Live Stream", "nullable" : true }, - "smokeConfidencePercent" : { - "type" : "number", - "format" : "float", - "description" : "Smoke detection confidence percentage", - "example" : 92.8, + "password" : { + "type" : "string", + "description" : "Add a password to allow access to your shared stream", + "example" : "mypassword123", "nullable" : true }, - "smokeTobaccoConfidencePercent" : { - "type" : "number", - "format" : "float", - "description" : "Smoke tobacco detection confidence percentage", - "example" : 88.1, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "tempC" : { - "type" : "number", - "format" : "float", - "description" : "Temperature in Celsius", - "example" : 23.5, + "ssoProtected" : { + "type" : "boolean", + "description" : "Org must have SSO setup to use SSO protected streams", + "example" : false, "nullable" : true }, - "tempProbePresent" : { + "streamType" : { + "$ref" : "#/components/schemas/StreamTypeEnum" + }, + "vodEnabled" : { "type" : "boolean", - "description" : "Whether temperature probe is present", + "description" : "Enables recording of live footage to a VOD", "example" : true, "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "typPartSize" : { - "type" : "number", - "format" : "float", - "description" : "Typical particle size measurement", - "example" : 2.8, + } + } + }, + "Camera_CreateSharedLiveVideoStreamWSResponse" : { + "type" : "object", + "description" : "Response containing the created shared live video stream information.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "vapeConfidencePercent" : { - "type" : "number", - "format" : "float", - "description" : "Vape detection confidence percentage", - "example" : 85.5, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "vapeDetected" : { - "type" : "boolean", - "description" : "Whether vape is detected", - "example" : false, + "sharedLiveM3U8StreamUrl" : { + "type" : "string", + "description" : "M3U8 URL for the shared live video stream", + "example" : "https://example.com/live/m3u8/stream", "nullable" : true }, - "vapeThcConfidencePercent" : { - "type" : "number", - "format" : "float", - "description" : "Vape THC detection confidence percentage", - "example" : 72.3, + "sharedLiveVideoStreamUrl" : { + "type" : "string", + "description" : "URL for the shared live video stream", + "example" : "https://example.com/live/video/stream", "nullable" : true }, - "vocIdx" : { - "type" : "number", - "format" : "float", - "description" : "Volatile Organic Compounds index", - "example" : 125.5, - "nullable" : true - } - } - }, - "Climate_RebootEnvironmentalGatewayWSRequest" : { - "type" : "object", - "description" : "Request to reboot an environmental gateway.", - "properties" : { - "environmentalGatewayUuid" : { + "sharedLiveVideoStreamUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Climate_UpdateClimateSensorDetailsWSRequest" : { + "Camera_CreateSharedVideoWallWSRequest" : { "type" : "object", - "description" : "Request to update details for an environmental sensor.", + "description" : "Request to create a shared video wall.", "properties" : { - "associatedCameras" : { - "type" : "array", - "description" : "List of associated camera device facet UUIDs", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true - }, - "associatedCamerasUpdated" : { - "type" : "boolean", + "expirationTimeSecs" : { + "type" : "integer", + "format" : "int32", + "description" : "Expiration time in seconds", + "example" : 86400, "nullable" : true }, - "deleted" : { + "invertSchedule" : { "type" : "boolean", - "description" : "Whether the environmental sensor is deleted", + "description" : "Whether to invert the schedule", "example" : false, "nullable" : true }, - "deletedUpdated" : { - "type" : "boolean", + "password" : { + "type" : "string", + "description" : "Password to protect the shared video wall", + "example" : "mypassword123", "nullable" : true }, - "description" : { + "scheduleUuid" : { "type" : "string", - "description" : "Description of the environmental sensor", - "example" : "Temperature and humidity sensor in main office", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "descriptionUpdated" : { - "type" : "boolean", + "videoWallUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the environmental sensor is located", - "example" : 1, + "vodEnabled" : { + "type" : "boolean", + "description" : "Whether to enable video on demand", + "example" : true, "nullable" : true - }, - "floorNumberUpdated" : { + } + } + }, + "Camera_CreateSharedVideoWallWSResponse" : { + "type" : "object", + "description" : "Response containing the created shared video wall information.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the environmental sensor", - "example" : 37.7749, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "latitudeUpdated" : { - "type" : "boolean", + "sharedLiveVideoStreamUrl" : { + "type" : "string", + "description" : "URL for accessing the shared video wall", + "example" : "https://share.rhombussystems.com/videowall/abc123", "nullable" : true }, - "locationUuid" : { + "sharedLiveVideoStreamUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationUuidUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the environmental sensor", - "example" : -122.4194, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "longitudeUpdated" : { + } + } + }, + "Camera_CreateVideoWallWSRequest" : { + "type" : "object", + "description" : "Request to create a video wall.", + "properties" : { + "videoWall" : { + "$ref" : "#/components/schemas/VideoWallType" + } + } + }, + "Camera_CreateVideoWallWSResponse" : { + "type" : "object", + "description" : "Response from creating a video wall.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", - "description" : "Name of the environmental sensor", - "example" : "Main Office Sensor", - "nullable" : true - }, - "nameUpdated" : { - "type" : "boolean", "nullable" : true }, - "policyUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuidUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "uuid" : { + } + } + }, + "Camera_DeleteCameraWSRequest" : { + "type" : "object", + "description" : "Request to delete a camera from the system.", + "properties" : { + "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "mummify" : { + "type" : "boolean", + "description" : "Whether to mummify the camera instead of permanent deletion", + "example" : false, + "nullable" : true } } }, - "Climate_UpdateClimateSensorDetailsWSResponse" : { + "Camera_DeleteCameraWSResponse" : { "type" : "object", - "description" : "Response indicating the result of updating environmental sensor details.", + "description" : "Response indicating the result of deleting a camera.", "properties" : { "error" : { "type" : "boolean", @@ -62181,19 +63888,22 @@ "type" : "string", "nullable" : true }, + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Climate_UpdateEnvironmentalGatewayDetailsWSRequest" : { + "Camera_DeleteCustomFootageSeekpointsWSRequest" : { "type" : "object", - "description" : "Request to update details for an environmental gateway.", + "description" : "Request to delete custom footage seek points for cameras within a time range.", "properties" : { - "associatedCameras" : { + "cameraUuids" : { "type" : "array", - "description" : "List of associated camera device facet UUIDs", + "description" : "List of camera UUIDs to delete custom seek points for", "items" : { "type" : "string", "format" : "DeviceFacetUuid", @@ -62203,122 +63913,134 @@ }, "nullable" : true }, - "associatedCamerasUpdated" : { - "type" : "boolean", - "description" : "Whether the associated cameras have been updated", - "example" : false, + "customName" : { + "type" : "string", + "description" : "Filter which custom seek points to delete with the custom name provided", + "example" : "motion_event", "nullable" : true }, - "deleted" : { - "type" : "boolean", - "description" : "Whether the environmental gateway is deleted", - "example" : false, + "endTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX milliseconds timestamp to end custom seek point deletion, up to 24 hours from the start timestamp", + "example" : 1641081600000, "nullable" : true }, - "deletedUpdated" : { - "type" : "boolean", - "description" : "Whether the deleted status has been updated", - "example" : false, + "startTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX milliseconds timestamp to start custom seek point deletion", + "example" : 1640995200000, "nullable" : true - }, - "description" : { - "type" : "string", - "description" : "Description of the environmental gateway", - "example" : "Environmental monitoring gateway in main office", + } + } + }, + "Camera_DeleteCustomFootageSeekpointsWSResponse" : { + "type" : "object", + "description" : "Response containing the results of deleting custom footage seek points.", + "properties" : { + "deleteSeekpointResponseMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse" + }, + "description" : "Mapping of camera UUIDs to seek point deletion results", "nullable" : true }, - "descriptionUpdated" : { + "error" : { "type" : "boolean", - "description" : "Whether the description has been updated", - "example" : false, "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the environmental gateway is located", - "example" : 1, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "floorNumberUpdated" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Camera_DeleteCustomFootageSeekpointsWSResponse_SeekPointDeleteResponse" : { + "type" : "object", + "description" : "Response indicating the result of deleting seek points for a camera.", + "properties" : { + "err" : { "type" : "boolean", - "description" : "Whether the floor number has been updated", + "description" : "Whether an error occurred during deletion", "example" : false, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the environmental gateway", - "example" : 37.7749, + "errMsg" : { + "type" : "string", + "description" : "Error message if deletion failed", + "example" : "Invalid timestamp range", "nullable" : true - }, - "latitudeUpdated" : { - "type" : "boolean", - "description" : "Whether the latitude has been updated", - "example" : false, + } + } + }, + "Camera_DeleteSharedLiveVideoStreamWSRequest" : { + "type" : "object", + "description" : "Request to delete a shared live video stream.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "locationUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "locationUuidUpdated" : { - "type" : "boolean", - "description" : "Whether the location UUID has been updated", - "example" : false, - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the environmental gateway", - "example" : -122.4194, - "nullable" : true - }, - "longitudeUpdated" : { - "type" : "boolean", - "description" : "Whether the longitude has been updated", - "example" : false, - "nullable" : true - }, - "name" : { + } + } + }, + "Camera_DeleteSharedVideoWallWSRequest" : { + "type" : "object", + "description" : "Request to delete a shared video wall.", + "properties" : { + "uuid" : { "type" : "string", - "description" : "Name of the environmental gateway", - "example" : "Main Office Gateway", - "nullable" : true - }, - "nameUpdated" : { - "type" : "boolean", - "description" : "Whether the name has been updated", - "example" : false, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuid" : { + "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "policyUuidUpdated" : { + } + } + }, + "Camera_DeleteSharedVideoWallWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of deleting a shared video wall.", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether the policy UUID has been updated", - "example" : false, "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key has been updated", - "example" : false, + "errorMsg" : { + "type" : "string", "nullable" : true }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Camera_DeleteVideoWallWSRequest" : { + "type" : "object", + "description" : "Request to delete a video wall configuration.", + "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", @@ -62328,9 +64050,9 @@ } } }, - "Climate_UpdateEnvironmentalGatewayDetailsWSResponse" : { + "Camera_DeleteVideoWallWSResponse" : { "type" : "object", - "description" : "Response indicating the result of updating environmental gateway details.", + "description" : "Response indicating the result of deleting a video wall configuration.", "properties" : { "error" : { "type" : "boolean", @@ -62346,199 +64068,111 @@ } } }, - "ClipAccessSettings" : { + "Camera_EraseCameraWSRequest" : { "type" : "object", - "description" : "Visibility setting for the clip", + "description" : "Request to permanently erase a camera from the system.", "properties" : { - "allowedRoles" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "allowedUsers" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "visibility" : { - "$ref" : "#/components/schemas/ClipVisibilityEnum" + "cameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "ClipBoundingBoxType" : { + "Camera_EraseCameraWSResponse" : { "type" : "object", + "description" : "Response indicating the result of erasing a camera.", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "alert" : { + "error" : { "type" : "boolean", "nullable" : true }, - "bottom" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "confidence" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "croppedImageLocator" : { - "type" : "string", - "nullable" : true - }, - "customActivityColor" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" - }, - "customActivityDescription" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "customActivityDisplayName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "dwelling" : { + } + } + }, + "Camera_FindAllSharedLiveVideoStreamsWSRequest" : { + "type" : "object", + "description" : "Request to find all shared live video streams." + }, + "Camera_FindAllSharedLiveVideoStreamsWSResponse" : { + "type" : "object", + "description" : "Response containing all shared live video streams.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "faceName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "inMotion" : { - "type" : "boolean", - "nullable" : true - }, - "keypointsV2" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PointType" + "sharedLiveVideoStreams" : { + "type" : "array", + "description" : "List of shared live video streams", + "items" : { + "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" }, "nullable" : true }, - "left" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "licensePlate" : { - "type" : "string", - "nullable" : true - }, - "loudness" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "objectId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "pose" : { - "type" : "string", - "nullable" : true - }, - "relativeSecond" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "right" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sensorValType" : { - "$ref" : "#/components/schemas/SensorValType" - }, - "stableTrackId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "toastOrderIdInfo" : { - "$ref" : "#/components/schemas/ToastOrderIdType" - }, - "top" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "unidentifiedFaceId" : { - "type" : "string", - "nullable" : true - }, - "vehicleName" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "ClipGroupType" : { + "Camera_FindSharedLiveVideoStreamsForWSRequest" : { "type" : "object", - "description" : "List of clip groups for the organization", + "description" : "Request to find shared live video streams for a camera.", "properties" : { - "clips" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/SharedClipV2Type" - }, - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "description" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - }, - "isShared" : { + } + } + }, + "Camera_FindSharedLiveVideoStreamsWSResponse" : { + "type" : "object", + "description" : "Response containing shared live video streams.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sharedGroups" : { + "sharedLiveVideoStreams" : { "type" : "array", + "description" : "List of shared live video streams", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" }, "nullable" : true }, - "title" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "uuid" : { + } + } + }, + "Camera_FindSharedVideoWallsWSRequest" : { + "type" : "object", + "description" : "Request to find shared video walls for a video wall.", + "properties" : { + "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -62547,421 +64181,454 @@ } } }, - "ClipGroupWithDetailsType" : { + "Camera_FindSharedVideoWallsWSResponse" : { "type" : "object", - "description" : "Detailed information about the clip group", + "description" : "Response containing shared video walls for a video wall.", "properties" : { - "clips" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/SharedClipWithDetailsType" - }, - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "description" : { - "type" : "string", - "nullable" : true - }, - "isShared" : { + "error" : { "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sharedGroups" : { + "sharedVideoWalls" : { "type" : "array", + "description" : "List of shared video walls", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/Camera_SharedVideoWallWS" }, "nullable" : true }, - "title" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + } + } + }, + "Camera_FootageBoundingBoxSummaryType" : { + "type" : "object", + "description" : "Summary of footage bounding boxes by device.", + "properties" : { + "deviceMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/FootageBoundingBoxType" + }, + "description" : "Map of device UUIDs to their footage bounding box information", "nullable" : true } } }, - "ClipMetaDataType" : { + "Camera_FootageSeekPointSummaryType" : { "type" : "object", + "description" : "Summary of footage seek points with activity counts and metadata.", "properties" : { - "activitySeekPoints" : { + "activityCountMap" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "float", + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, + "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, + "description" : "Map of activities to device UUIDs and their counts", "nullable" : true }, - "activitySeekPointsV2" : { + "alert" : { + "type" : "boolean", + "description" : "Whether there is an alert", + "example" : false, + "nullable" : true + }, + "faceNames" : { "type" : "array", + "description" : "Set of recognized face names", "items" : { - "$ref" : "#/components/schemas/ClipSeekPointType" + "type" : "string", + "description" : "Set of recognized face names", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "activitySeekPointsV3" : { + "poses" : { "type" : "array", + "description" : "Set of detected poses", "items" : { - "$ref" : "#/components/schemas/ClipSeekPointV2Type" + "type" : "string", + "description" : "Set of detected poses", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "boundingBoxes" : { + "recognizedObjects" : { "type" : "array", + "description" : "Set of recognized objects", "items" : { - "$ref" : "#/components/schemas/ClipBoundingBoxType" + "type" : "string", + "description" : "Set of recognized objects", + "nullable" : true }, - "nullable" : true - }, - "clipLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "mGrids" : { + "unidentifiedFaceIds" : { "type" : "array", + "description" : "Set of unidentified face IDs", "items" : { "type" : "string", + "description" : "Set of unidentified face IDs", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "soundSignificantLufs" : { + "vehicleLicensePlates" : { "type" : "array", + "description" : "Set of vehicle license plates", "items" : { - "type" : "integer", - "format" : "int32", + "type" : "string", + "description" : "Set of vehicle license plates", "nullable" : true }, - "nullable" : true - }, - "startTime" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" + "nullable" : true, + "uniqueItems" : true }, - "thumbnailLocationV2" : { - "type" : "string", - "nullable" : true + "vehicleNames" : { + "type" : "array", + "description" : "Set of recognized vehicle names", + "items" : { + "type" : "string", + "description" : "Set of recognized vehicle names", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "ClipSeekPointType" : { + "Camera_GenerateBatchRegistrationInfoRequest" : { "type" : "object", + "description" : "Request to generate batch registration information for cameras.", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "alert" : { - "type" : "boolean", + "adminUserPermissionGroups" : { + "type" : "array", + "description" : "List of admin user permission group UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "bottom" : { + "latitude" : { "type" : "number", - "format" : "float", + "format" : "double", + "description" : "Latitude coordinate", + "example" : 37.7749, "nullable" : true }, - "faceName" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "keypointsV2" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PointType" - }, - "nullable" : true - }, - "left" : { + "longitude" : { "type" : "number", - "format" : "float", - "nullable" : true - }, - "licensePlate" : { - "type" : "string", + "format" : "double", + "description" : "Longitude coordinate", + "example" : -122.4194, "nullable" : true }, - "pose" : { + "policyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "relativeSecond" : { - "type" : "number", - "format" : "float", + "readOnlyUserPermissionGroups" : { + "type" : "array", + "description" : "List of read-only user permission group UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true - }, - "right" : { - "type" : "number", - "format" : "float", + } + } + }, + "Camera_GenerateBatchRegistrationInfoResponse" : { + "type" : "object", + "description" : "Response containing batch registration information for cameras.", + "properties" : { + "env" : { + "type" : "string", + "description" : "Environment identifier", + "example" : "production", "nullable" : true }, - "top" : { - "type" : "number", - "format" : "float", + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "unidentifiedFaceId" : { + } + } + }, + "Camera_GenerateWifiChangeAuthorizationTokenWSRequest" : { + "type" : "object", + "description" : "Request to generate a WiFi change authorization token.", + "properties" : { + "perceivedIp" : { "type" : "string", + "description" : "Perceived IP address", + "example" : "192.168.1.100", "nullable" : true }, - "vehicleName" : { + "ssid" : { "type" : "string", + "description" : "WiFi network SSID", + "example" : "MyWiFiNetwork", "nullable" : true } } }, - "ClipSeekPointV2Type" : { + "Camera_GenerateWifiChangeAuthorizationTokenWSResponse" : { "type" : "object", - "description" : "List of seek points for the clip", + "description" : "Response containing a WiFi change authorization token.", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" + "authorizationToken" : { + "type" : "array", + "description" : "Authorization token for WiFi change", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Authorization token for WiFi change", + "nullable" : true + }, + "nullable" : true }, - "alert" : { + "error" : { "type" : "boolean", "nullable" : true }, - "customActivityColor" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" - }, - "customActivityDescription" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "customActivityDisplayName" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dcao" : { - "type" : "boolean", - "nullable" : true - }, - "dwelling" : { - "type" : "boolean", - "nullable" : true - }, - "faceName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "id" : { + } + } + }, + "Camera_GetBatchRegistrationTokenUsageRequest" : { + "type" : "object", + "description" : "Request to retrieve batch registration token usage information.", + "properties" : { + "sinceMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "Timestamp in milliseconds since epoch to check usage from", + "example" : 1640995200000, "nullable" : true }, - "inMotion" : { - "type" : "boolean", + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "licensePlate" : { + } + } + }, + "Camera_GetBatchRegistrationTokenUsageResponse" : { + "type" : "object", + "description" : "Response containing batch registration token usage information.", + "properties" : { + "usageList" : { + "type" : "array", + "description" : "List of batch registration token usage results", + "items" : { + "$ref" : "#/components/schemas/BatchRegistrationTokenUsageResult" + }, + "nullable" : true + } + } + }, + "Camera_GetCameraAIThresholdsWSRequest" : { + "type" : "object", + "description" : "Request to retrieve AI thresholds for a camera.", + "properties" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + } + } + }, + "Camera_GetCameraAIThresholdsWSResponse" : { + "type" : "object", + "description" : "Response containing AI thresholds for a camera.", + "properties" : { + "consecutiveHumanFilter" : { + "type" : "integer", + "format" : "int32", + "description" : "Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", + "example" : 3, "nullable" : true }, - "loudness" : { + "consecutiveVehicleFilter" : { "type" : "integer", "format" : "int32", + "description" : "Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", + "example" : 3, "nullable" : true }, - "pose" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "relativeSecond" : { + "faceConfidenceThreshold" : { "type" : "number", "format" : "float", + "description" : "Confidence threshold for face detection. 0 or null means the built-in default.", + "example" : 0.8, "nullable" : true }, - "sensorValType" : { - "$ref" : "#/components/schemas/SensorValType" - }, - "stableTrackId" : { - "type" : "integer", - "format" : "int32", + "faceMatchConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "deprecated" : true, + "description" : "Confidence threshold for face matching (determining if two faces are the same person). 0 or null means the built-in default. We no longer support device specific face matching threshold. This property is deprecated and will be removed.", + "maximum" : 1.0, + "minimum" : 0.0, "nullable" : true }, - "toastOrderIdInfo" : { - "$ref" : "#/components/schemas/ToastOrderIdType" - }, - "tu" : { - "type" : "string", + "humanConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for human detection. 0 or null means the built-in default.", + "example" : 0.7, "nullable" : true }, - "unidentifiedFaceId" : { - "type" : "string", + "lprConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for license plate detection and character recognition. 0 or null means the built-in default.", + "example" : 0.9, "nullable" : true }, - "vehicleName" : { - "type" : "string", - "nullable" : true - } - } - }, - "ClipStatusEnum" : { - "type" : "string", - "enum" : [ "INITIATING", "UPLOADING", "RENDERING", "FAILED", "COMPLETE", "OFFLINE", "DELETED", "UNKNOWN" ] - }, - "ClipVisibilityEnum" : { - "type" : "string", - "description" : "Use accessSettings instead", - "enum" : [ "PRIVATE", "ROLE_RESTRICTED", "ORG_WIDE" ] - }, - "CloudArchivingStrategyEnum" : { - "type" : "string", - "enum" : [ "WEEKLY_SCHEDULED", "CONTINUOUS" ] - }, - "Co2SensorType" : { - "type" : "object", - "properties" : { - "co2Ppm" : { + "maxEventDurationMs" : { "type" : "integer", "format" : "int32", + "description" : "The max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.", + "example" : 15000, "nullable" : true }, - "relHumid" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "tempC" : { + "vehicleConfidenceThreshold" : { "type" : "number", "format" : "float", + "description" : "Confidence threshold for vehicle detection. 0 or null means the built-in default.", + "example" : 0.7, "nullable" : true }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "ColorEnum" : { - "type" : "string", - "description" : "Set of colors to filter by", - "enum" : [ "BLACK", "BLUE", "BROWN", "GRAYWHITE", "GREEN", "ORANGE", "PINK", "PURPLE", "RED", "YELLOW", "UNKNOWN" ] - }, - "Common_devices_CalibrateFloorplanProjectionWSRequest" : { + "Camera_GetCameraDetailsWSRequest" : { "type" : "object", - "description" : "Request to calibrate floorplan projection for a device.", + "description" : "Request to retrieve detailed information for multiple cameras.", "properties" : { - "cameraImagePointsPermyriad" : { - "type" : "array", - "description" : "List of camera image points in permyriad coordinates", - "items" : { - "type" : "array", - "description" : "List of camera image points in permyriad coordinates", - "items" : { - "type" : "integer", - "format" : "int32", - "description" : "List of camera image points in permyriad coordinates", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true - }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "floorplanImagePointsPermyriad" : { + "cameraUuids" : { "type" : "array", - "description" : "List of floorplan image points in permyriad coordinates", + "description" : "List of camera UUIDs to retrieve details for", "items" : { - "type" : "array", - "description" : "List of floorplan image points in permyriad coordinates", - "items" : { - "type" : "integer", - "format" : "int32", - "description" : "List of floorplan image points in permyriad coordinates", - "nullable" : true - }, + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true } } }, - "Common_devices_CalibrateFloorplanProjectionWSResponse" : { + "Camera_GetCameraDetailsWSResponse" : { "type" : "object", - "description" : "Response containing the calibrated floorplan projection homography.", + "description" : "Response containing detailed information for multiple cameras.", "properties" : { - "homography" : { + "cameras" : { "type" : "array", - "description" : "3x3 homography matrix for floorplan projection", + "description" : "List of camera details", "items" : { - "type" : "array", - "description" : "3x3 homography matrix for floorplan projection", - "items" : { - "type" : "number", - "format" : "double", - "description" : "3x3 homography matrix for floorplan projection", - "nullable" : true - }, - "nullable" : true + "$ref" : "#/components/schemas/Camera_CameraExternalType" }, "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Common_devices_GetBoundingBoxesWSRequest" : { + "Camera_GetCloudArchivedMediaInfoWSRequest" : { "type" : "object", + "description" : "Request to retrieve cloud archived media information for a camera.", "properties" : { - "deviceUuid" : { + "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - }, - "durationSecs" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "Common_devices_GetBoundingBoxesWSResponse" : { + "Camera_GetCloudArchivedMediaInfoWSResponse" : { "type" : "object", + "description" : "Response containing cloud archived media information for a camera.", "properties" : { "error" : { "type" : "boolean", @@ -62971,11 +64638,11 @@ "type" : "string", "nullable" : true }, - "footageBoundingBoxes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/FootageBoundingBoxType" - }, + "oldestArchivedVideoSegmentSecs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the oldest archived video segment in seconds since epoch", + "example" : 1640995200, "nullable" : true }, "warningMsg" : { @@ -62984,113 +64651,182 @@ } } }, - "Common_devices_GetCameraOrDoorbellCameraSeekpointsWSRequest" : { + "Camera_GetCloudArchivingConfigWSRequest" : { "type" : "object", + "description" : "Request to get cloud archiving configuration.", "properties" : { - "activitySet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, "deviceUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "durationSecs" : { - "type" : "integer", - "format" : "int32", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Camera_GetCloudArchivingConfigWSResponse" : { + "type" : "object", + "description" : "Response containing cloud archiving configuration.", + "properties" : { + "archivingConfig" : { + "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" }, - "includeAnyMotion" : { + "error" : { "type" : "boolean", "nullable" : true }, - "seekpointDurationIntervalSecs" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Common_devices_GetFullDeviceStateWSRequest" : { + "Camera_GetConfigWSRequest" : { "type" : "object", + "description" : "Request to retrieve camera configuration settings.", "properties" : { - "deviceUuid" : { + "cameraUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Camera_GetConfigWSResponse" : { + "type" : "object", + "description" : "Response containing camera configuration settings.", + "properties" : { + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableAudioVideoUserConfig" }, - "force" : { + "error" : { "type" : "boolean", "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Common_devices_GetMediaUrisWSRequest" : { + "Camera_GetCurrentStateWSRequest" : { "type" : "object", + "description" : "Request to retrieve the current state of a camera (deprecated).", "properties" : { - "deviceUuid" : { + "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true + }, + "force" : { + "type" : "boolean", + "description" : "Whether to force a refresh of the camera state", + "example" : false, + "nullable" : true } } }, - "Common_devices_GetMinimalDeviceStateListWSRequest" : { + "Camera_GetCurrentStateWSResponse" : { "type" : "object", + "description" : "Response containing the current state of a camera (deprecated).", "properties" : { - "includeMummified" : { + "cameraState" : { + "$ref" : "#/components/schemas/Camera_CameraCurrentStateType" + }, + "error" : { "type" : "boolean", "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Common_devices_GetPresenceWindowsWSRequest" : { + "Camera_GetCustomFootageSeekpointsV2WSRequest" : { "type" : "object", - "description" : "Request to get stored video information for a device.", + "description" : "Request to retrieve custom footage seek points V2 for cameras within a time range.", "properties" : { - "deviceUuid" : { + "customDescription" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Filters which custom footage seek point to search for by description", + "example" : "Motion detected in camera view", "nullable" : true }, - "durationSec" : { + "customDisplayName" : { + "type" : "string", + "description" : "Filters which custom footage seek point to search for by name", + "example" : "motion_event", + "nullable" : true + }, + "deviceUuids" : { + "type" : "array", + "description" : "List of device UUIDs to filter the search", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "duration" : { "type" : "integer", "format" : "int64", - "description" : "Duration in seconds", + "description" : "How far from the start timestamp to search in seconds", "example" : 3600, "nullable" : true }, - "startTimeSec" : { + "locationUuids" : { + "type" : "array", + "description" : "List of location UUIDs to filter the search", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "startTime" : { "type" : "integer", "format" : "int64", - "description" : "Start time in seconds since epoch", + "description" : "Starting timestamp of the search in UNIX seconds", "example" : 1640995200, "nullable" : true } } }, - "Common_devices_GetPresenceWindowsWSResponse" : { + "Camera_GetCustomFootageSeekpointsV2WSResponse" : { "type" : "object", - "description" : "Response containing stored video information for a device.", + "description" : "Response containing custom footage seek points V2 for cameras.", "properties" : { + "customFootageSeekPoints" : { + "type" : "array", + "description" : "List of custom footage seek points V2", + "items" : { + "$ref" : "#/components/schemas/SeekpointIndexType" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -63099,17 +64835,28 @@ "type" : "string", "nullable" : true }, - "presenceWindows" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of presence types to their time windows", - "items" : { - "$ref" : "#/components/schemas/TimeWindowSeconds" - }, - "nullable" : true + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Camera_GetFacetedCameraDetailsWSResponse" : { + "type" : "object", + "properties" : { + "cameras" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Camera_CameraExternalFacetedType" }, - "description" : "Map of presence types to their time windows", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", "nullable" : true }, "warningMsg" : { @@ -63118,35 +64865,41 @@ } } }, - "Common_devices_GetSeekpointsWSRequest" : { + "Camera_GetFootageBoundingBoxesForMultipleWSRequest" : { "type" : "object", - "description" : "General seekpoints search request parameters", + "description" : "Request to retrieve footage bounding boxes for multiple cameras within a time range.", "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "cameraUuids" : { + "type" : "array", + "description" : "List of camera UUIDs to retrieve bounding boxes for", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "durationSecs" : { + "durationSec" : { "type" : "integer", "format" : "int32", - "nullable" : true - }, - "includeAnyMotion" : { - "type" : "boolean", + "description" : "Duration in seconds", + "example" : 3600, "nullable" : true }, "startTimeSec" : { "type" : "integer", "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, "nullable" : true } } }, - "Common_devices_GetSeekpointsWSResponse" : { + "Camera_GetFootageBoundingBoxesForMultipleWSResponse" : { "type" : "object", + "description" : "Response containing footage bounding boxes for multiple cameras.", "properties" : { "error" : { "type" : "boolean", @@ -63156,11 +64909,12 @@ "type" : "string", "nullable" : true }, - "footageSeekPoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/FootageSeekPointV2Type" + "footageBoundingBoxMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Camera_FootageBoundingBoxSummaryType" }, + "description" : "Mapping of timestamps to footage bounding box summaries", "nullable" : true }, "warningMsg" : { @@ -63169,36 +64923,36 @@ } } }, - "Common_devices_GetUptimeWindowsWSRequest" : { + "Camera_GetFootageBoundingBoxesWSRequest" : { "type" : "object", - "description" : "Request to get uptime information for a device.", + "description" : "Request to retrieve footage bounding boxes for a camera within a time range.", "properties" : { - "deviceUuid" : { + "cameraUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "endTimeMs" : { + "duration" : { "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds since epoch", - "example" : 1643673600000, + "format" : "int32", + "description" : "Duration in seconds", + "example" : 3600, "nullable" : true }, - "startTimeMs" : { + "startTime" : { "type" : "integer", "format" : "int64", - "description" : "Start time in milliseconds since epoch", - "example" : 1640995200000, + "description" : "Start time in seconds since epoch", + "example" : 1640995200, "nullable" : true } } }, - "Common_devices_GetUptimeWindowsWSResponse" : { + "Camera_GetFootageBoundingBoxesWSResponse" : { "type" : "object", - "description" : "Response containing uptime information for a device.", + "description" : "Response containing footage bounding boxes for a camera.", "properties" : { "error" : { "type" : "boolean", @@ -63208,11 +64962,11 @@ "type" : "string", "nullable" : true }, - "uptimeWindows" : { + "footageBoundingBoxes" : { "type" : "array", - "description" : "List of uptime windows for the device", + "description" : "List of footage bounding boxes", "items" : { - "$ref" : "#/components/schemas/TimeWindowSeconds" + "$ref" : "#/components/schemas/FootageBoundingBoxType" }, "nullable" : true }, @@ -63222,40 +64976,47 @@ } } }, - "Common_devices_RebootDeviceWSResponse" : { + "Camera_GetFootageSeekpointsForMultipleWSRequest" : { "type" : "object", - "description" : "Response indicating the result of rebooting a device.", + "description" : "Request to retrieve footage seek points for multiple cameras within a time range.", "properties" : { - "result" : { - "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse_RebootResult" - } - } - }, - "Common_devices_RebootDeviceWSResponse_RebootResult" : { - "type" : "string", - "description" : "Result of the reboot operation", - "enum" : [ "REBOOT_SENT", "DEVICE_OFFLINE" ] - }, - "Common_devices_UpdateConfigWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of updating device configuration.", - "properties" : { - "error" : { - "type" : "boolean", + "cameraUuids" : { + "type" : "array", + "description" : "List of camera UUIDs to retrieve seek points for", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds", + "example" : 3600, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "includeAnyMotion" : { + "type" : "boolean", + "description" : "Whether to include any motion events", + "example" : true, + "nullable" : true + }, + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, "nullable" : true } } }, - "Common_devices_UpdateDeviceDetailsWSResponse" : { + "Camera_GetFootageSeekpointsForMultipleWSResponse" : { "type" : "object", + "description" : "Response containing footage seek points for multiple cameras.", "properties" : { "error" : { "type" : "boolean", @@ -63265,37 +65026,56 @@ "type" : "string", "nullable" : true }, + "footageSeekPointMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Camera_FootageSeekPointSummaryType" + }, + "description" : "Mapping of timestamps to footage seek point summaries", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Common_devices_rawstream_CreateRawHttpStreamWSRequest" : { + "Camera_GetFootageSeekpointsV2WSRequest" : { "type" : "object", - "description" : "Request to create a raw HTTP stream for a device.", + "description" : "Request to retrieve footage seek points V2 for a camera within a time range.", "properties" : { - "deviceUuid" : { + "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "rawStreamName" : { - "type" : "string", - "description" : "Name for the raw stream", - "example" : "my_raw_stream", + "duration" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds", + "example" : 3600, "nullable" : true }, - "streamType" : { - "$ref" : "#/components/schemas/StreamTypeEnum" + "includeAnyMotion" : { + "type" : "boolean", + "description" : "Whether to include any motion events", + "example" : true, + "nullable" : true + }, + "startTime" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, + "nullable" : true } } }, - "Common_devices_rawstream_CreateRawHttpStreamWSResponse" : { + "Camera_GetFootageSeekpointsV2WSResponse" : { "type" : "object", - "description" : "Response containing raw HTTP stream URLs for a device.", + "description" : "Response containing footage seek points V2 for a camera.", "properties" : { "error" : { "type" : "boolean", @@ -63305,22 +65085,12 @@ "type" : "string", "nullable" : true }, - "lanAudioUrl" : { - "type" : "string", - "description" : "LAN audio URL for the raw stream", - "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/audio", - "nullable" : true - }, - "lanVideoLowResUrl" : { - "type" : "string", - "description" : "LAN low resolution video URL for the raw stream", - "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/video_low", - "nullable" : true - }, - "lanVideoUrl" : { - "type" : "string", - "description" : "LAN video URL for the raw stream", - "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/video", + "footageSeekPoints" : { + "type" : "array", + "description" : "List of footage seek points V2", + "items" : { + "$ref" : "#/components/schemas/FootageSeekPointV2Type" + }, "nullable" : true }, "warningMsg" : { @@ -63329,50 +65099,36 @@ } } }, - "Common_devices_rawstream_DeleteRawHttpStreamWSRequest" : { + "Camera_GetFootageSeekpointsWSRequest" : { "type" : "object", - "description" : "Request to delete raw HTTP streams for a device.", + "description" : "Request to retrieve footage seek points for a camera within a time range (deprecated).", "properties" : { - "customPathPart" : { - "type" : "string", - "description" : "Custom path part to identify specific stream", - "example" : "my_stream", - "nullable" : true - }, - "deviceUuid" : { + "cameraUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - } - } - }, - "Common_devices_rawstream_DeleteRawHttpStreamWSResponse" : { - "type" : "object", - "description" : "Response indicating the result of deleting raw HTTP streams.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "duration" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds", + "example" : 3600, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "startTime" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, "nullable" : true } } }, - "Common_devices_rawstream_FindAllRawHttpStreamsWSRequest" : { - "type" : "object", - "description" : "Request to retrieve all raw HTTP streams." - }, - "Common_devices_rawstream_FindAllRawHttpStreamsWSResponse" : { + "Camera_GetFootageSeekpointsWSResponse" : { "type" : "object", - "description" : "Response containing all raw HTTP streams.", + "description" : "Response containing footage seek points for a camera (deprecated).", "properties" : { "error" : { "type" : "boolean", @@ -63382,11 +65138,11 @@ "type" : "string", "nullable" : true }, - "rawHttpStreams" : { + "footageSeekPoints" : { "type" : "array", - "description" : "List of all raw HTTP streams", + "description" : "List of footage seek points", "items" : { - "$ref" : "#/components/schemas/Common_devices_rawstream_LanSpecificRawStreamType" + "$ref" : "#/components/schemas/FootageSeekPointType" }, "nullable" : true }, @@ -63396,22 +65152,28 @@ } } }, - "Common_devices_rawstream_GetRawHttpStreamsWSRequest" : { + "Camera_GetFullCameraStateWSRequest" : { "type" : "object", - "description" : "Request to retrieve raw HTTP streams for a device.", + "description" : "Request to retrieve the full state information of a camera.", "properties" : { - "deviceUuid" : { + "cameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true + }, + "force" : { + "type" : "boolean", + "description" : "Whether to force a refresh of the camera state", + "example" : false, + "nullable" : true } } }, - "Common_devices_rawstream_GetRawHttpStreamsWSResponse" : { + "Camera_GetFullCameraStateWSResponse" : { "type" : "object", - "description" : "Response containing raw HTTP streams for a device.", + "description" : "Response containing the full state information of a camera.", "properties" : { "error" : { "type" : "boolean", @@ -63421,13 +65183,8 @@ "type" : "string", "nullable" : true }, - "rawHttpStreams" : { - "type" : "array", - "description" : "List of raw HTTP streams", - "items" : { - "$ref" : "#/components/schemas/Common_devices_rawstream_LanSpecificRawStreamType" - }, - "nullable" : true + "fullCameraState" : { + "$ref" : "#/components/schemas/FullDeviceStateType" }, "warningMsg" : { "type" : "string", @@ -63435,658 +65192,363 @@ } } }, - "Common_devices_rawstream_LanSpecificRawStreamType" : { + "Camera_GetLineCrossingEnabledCamerasForLocationWSRequest" : { "type" : "object", - "description" : "List of raw HTTP streams", + "description" : "Request to get line crossing enabled cameras for a location.", "properties" : { - "audioPath" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBy" : { - "type" : "string", - "nullable" : true - }, - "customPathPart" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + } + } + }, + "Camera_GetLineCrossingEnabledCamerasForLocationWSResponse" : { + "type" : "object", + "description" : "Response containing line crossing enabled cameras for a location.", + "properties" : { + "camerasToConfigs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" + }, + "description" : "Map of camera UUIDs to their line crossing configurations", "nullable" : true }, - "lanAudioUrl" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "lanVideoLowResUrl" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "lanVideoUrl" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "name" : { - "type" : "string", + } + } + }, + "Camera_GetLineCrossingEnabledCamerasWSRequest" : { + "type" : "object", + "description" : "Request to get all line crossing enabled cameras in the org." + }, + "Camera_GetLineCrossingEnabledCamerasWSResponse" : { + "type" : "object", + "description" : "Response containing all line crossing enabled cameras in the org.", + "properties" : { + "camerasToConfigs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" + }, + "description" : "Map of camera UUIDs to their line crossing configurations", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "streamType" : { - "$ref" : "#/components/schemas/StreamTypeEnum" - }, - "videoLowResPath" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "videoPath" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "ComponentBaseEnumType" : { - "type" : "string", - "enum" : [ "reader", "dpi", "relay", "rex", "aux", "aperio", "button" ] - }, - "ComponentCompositeEnumType" : { - "type" : "string", - "enum" : [ "AccessControlledDoor", "AccessControlledElevator", "AccessControlledElevatorLanding" ] - }, - "ComponentCompositeEnumType_Minimal" : { - "type" : "string", - "enum" : [ "AccessControlledDoor", "AccessControlledElevator", "AccessControlledElevatorLanding" ] - }, - "ComponentCompositeEventOriginator" : { + "Camera_GetMediaUrisWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeName" : { - "type" : "string", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "eventUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - } - } - } ], - "nullable" : true, + "description" : "Request to get media URIs for a camera device.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true } } }, - "ComponentCompositeShadowEnum" : { - "type" : "string", - "enum" : [ "AccessControlledDoorShadow", "AccessControlledElevatorLandingShadow" ] - }, - "ComponentEnumType" : { - "type" : "string", - "enum" : [ "RhombusOsdpDoorReader", "OsdpDoorReader", "WiegandDoorReader", "IntegratedDoorPositionIndicator", "IntegratedRequestToExit", "IntegratedDoorRelay", "IntegratedGenericRelay", "IntegratedGenericInput", "IntegratedGenericButton", "AperioGateway", "AperioDoorExtension", "AperioDoorRelay", "AperioDoorPositionIndicator", "AperioDoorReader", "AperioDoorRequestToExit" ] - }, - "ComponentEventEnumType" : { - "type" : "string", - "description" : "Limits results to only contain the specified type of events, if applicable", - "enum" : [ "DoorbellEvent", "DoorReaderStateChangeEvent", "DoorRelayStateChangeEvent", "DoorPositionIndicatorStateChangeEvent", "RequestToExitStateChangeEvent", "CredentialReceivedEvent", "ButtonEvent", "GenericInputStateChangeEvent", "GenericRelayStateChangeEvent", "AccessControlUnitTamperEvent", "AccessControlUnitLocationLockdownStateEvent", "DoorLocationLockdownStateEvent", "PanicButtonEvent", "AccessControlUnitBatteryStateChangeEvent", "WaveToUnlockIntentExpiredEvent", "DoorStateChangeEvent", "DoorAuthFirstInStateEvent", "DoorScheduleFirstInStateEvent", "AccessControlUnitDoorFirstInStateEvent", "AperioDoorExtensionStateEvent", "AperioActivatorStateEvent", "AperioKeyCylinderStateEvent", "AperioDoorModeEvent", "AperioDoorHandleStateEvent", "AperioGatewayStateEvent", "AperioGatewayConnectionStateChangeEvent", "AperioDtcEvent", "AperioTamperStateEvent" ] - }, - "ComponentEventType" : { + "Camera_GetMediaUrisWSResponse" : { "type" : "object", - "description" : "List of component events for the doorbell camera", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/DoorbellEventType" - }, { - "$ref" : "#/components/schemas/DoorReaderStateChangeEventType" - }, { - "$ref" : "#/components/schemas/DoorRelayStateChangeEventType" - }, { - "$ref" : "#/components/schemas/DoorPositionIndicatorStateChangeEventType" - }, { - "$ref" : "#/components/schemas/RequestToExitStateChangeEventType" - }, { - "$ref" : "#/components/schemas/CredentialReceivedEventType" - }, { - "$ref" : "#/components/schemas/ButtonEventType" - }, { - "$ref" : "#/components/schemas/GenericInputStateChangeEventType" - }, { - "$ref" : "#/components/schemas/GenericRelayStateChangeEventType" - }, { - "$ref" : "#/components/schemas/AccessControlUnitTamperEventType" - }, { - "$ref" : "#/components/schemas/AccessControlUnitLocationLockdownStateEventType" - }, { - "$ref" : "#/components/schemas/DoorLocationLockdownStateEventType" - }, { - "$ref" : "#/components/schemas/PanicButtonEventType" - }, { - "$ref" : "#/components/schemas/AccessControlUnitBatteryStateChangeEventType" - }, { - "$ref" : "#/components/schemas/WaveToUnlockIntentExpiredEvent" - }, { - "$ref" : "#/components/schemas/DoorStateChangeEvent" - }, { - "$ref" : "#/components/schemas/DoorAuthFirstInStateEvent" - }, { - "$ref" : "#/components/schemas/DoorScheduleFirstInStateEvent" - }, { - "$ref" : "#/components/schemas/AccessControlUnitDoorFirstInStateEvent" - }, { - "$ref" : "#/components/schemas/AperioDtcEvent" - }, { - "$ref" : "#/components/schemas/AperioDoorExtensionStateEvent" - }, { - "$ref" : "#/components/schemas/AperioActivatorStateEvent" - }, { - "$ref" : "#/components/schemas/AperioDoorModeEvent" - }, { - "$ref" : "#/components/schemas/AperioDoorHandleStateEvent" - }, { - "$ref" : "#/components/schemas/AperioKeyCylinderStateEvent" - } ], + "description" : "Response containing media URIs for camera streaming and playback.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "correlationId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanCheckUrls" : { + "type" : "array", + "description" : "List of LAN check URLs to verify device availability", + "items" : { + "type" : "string", + "description" : "List of LAN check URLs to verify device availability", + "nullable" : true + }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanLiveH264Uris" : { + "type" : "array", + "description" : "List of LAN H.264 live streaming URIs", + "items" : { + "type" : "string", + "description" : "List of LAN H.264 live streaming URIs", + "nullable" : true + }, "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanLiveM3u8Uris" : { + "type" : "array", + "description" : "List of LAN M3U8 live streaming URIs", + "items" : { + "type" : "string", + "description" : "List of LAN M3U8 live streaming URIs", + "nullable" : true + }, "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "lanLiveMpdUris" : { + "type" : "array", + "description" : "List of LAN MPD live streaming URIs", + "items" : { + "type" : "string", + "description" : "List of LAN MPD live streaming URIs", + "nullable" : true + }, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "ComponentReferenceType" : { - "type" : "object", - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanLiveOpusUris" : { + "type" : "array", + "description" : "List of LAN URIs for live Opus audio streams", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for live Opus audio streams", + "nullable" : true + }, "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "ComponentReferenceType_Minimal" : { - "type" : "object", - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanVodM3u8UrisTemplates" : { + "type" : "array", + "description" : "List of LAN M3U8 VOD URI templates", + "items" : { + "type" : "string", + "description" : "List of LAN M3U8 VOD URI templates", + "nullable" : true + }, "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanVodMpdUrisTemplates" : { + "type" : "array", + "description" : "List of LAN MPD VOD URI templates", + "items" : { + "type" : "string", + "description" : "List of LAN MPD VOD URI templates", + "nullable" : true + }, "nullable" : true - } - } - }, - "ComponentRelayOutputTypeEnum" : { - "type" : "string", - "enum" : [ "TRANSIENT", "STEADY" ] - }, - "ComponentSeekPointType" : { - "type" : "object", - "description" : "List of component seekpoints for the doorbell camera", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" }, - "componentCompositeUuid" : { + "wanLiveH264Uri" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "WAN H.264 live streaming URI", + "example" : "rtsp://camera.example.com/live", "nullable" : true }, - "componentUuid" : { + "wanLiveM3u8Uri" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "WAN M3U8 live streaming URI", + "example" : "https://camera.example.com/live.m3u8", "nullable" : true }, - "customActivityColor" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" - }, - "customActivityDescription" : { + "wanLiveMpdUri" : { "type" : "string", + "description" : "WAN MPD live streaming URI", + "example" : "https://camera.example.com/live.mpd", "nullable" : true }, - "customActivityDisplayName" : { + "wanLiveOpusUri" : { "type" : "string", + "description" : "WAN URI for live Opus audio stream", "nullable" : true }, - "locationUuid" : { + "wanPtzControlUri" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "wanVodH264UriTemplate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "originalEvent" : { - "type" : "object", + "description" : "WAN H.264 VOD URI template", + "example" : "https://camera.example.com/vod/{timestamp}.h264", "nullable" : true }, - "ownerDeviceUuid" : { + "wanVodM3u8UriTemplate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "description" : "WAN M3U8 VOD URI template", + "example" : "https://camera.example.com/vod/{timestamp}.m3u8", "nullable" : true }, - "userUuid" : { + "wanVodMpdUriTemplate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "WAN MPD VOD URI template", + "example" : "https://camera.example.com/vod/{timestamp}.mpd", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "ComponentShadowEnumType" : { - "type" : "string", - "enum" : [ "DoorReaderShadow", "DoorRelayShadow", "DoorPositionIndicatorShadow", "RequestToExitShadow", "GenericRelayShadow", "GenericInputShadow", "GenericButtonShadow", "AperioGatewayShadow", "AperioDoorExtensionShadow" ] + "Camera_GetMinimalCameraLocationMapWSRequest" : { + "type" : "object", + "description" : "Request to retrieve a mapping of cameras to their location information." }, - "ComponentShadowType" : { + "Camera_GetMinimalCameraLocationMapWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/DoorReaderShadowType" - }, { - "$ref" : "#/components/schemas/DoorRelayShadowType" - }, { - "$ref" : "#/components/schemas/DoorPositionIndicatorShadowType" - }, { - "$ref" : "#/components/schemas/RequestToExitShadowType" - }, { - "$ref" : "#/components/schemas/GenericInputShadowType" - }, { - "$ref" : "#/components/schemas/IntegratedDoorRelayType" - }, { - "$ref" : "#/components/schemas/GenericRelayShadowType" - }, { - "$ref" : "#/components/schemas/GenericButtonShadowType" - }, { - "$ref" : "#/components/schemas/AperioGatewayShadow" - }, { - "$ref" : "#/components/schemas/AperioDoorExtensionShadow" - } ], + "description" : "Response containing a mapping of cameras to their location information.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "cameraLocationMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo" + }, + "description" : "Mapping of camera UUIDs to location information", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", "nullable" : true } } }, - "Component_AddAccessControlledDoorLabelWSRequest" : { + "Camera_GetMinimalCameraLocationMapWSResponse_CameraLocationInfo" : { "type" : "object", + "description" : "Information about a camera's location.", "properties" : { - "accessControlledDoorUuid" : { + "cameraName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Name of the camera", + "example" : "Front Door Camera", "nullable" : true }, - "label" : { + "locationName" : { "type" : "string", + "description" : "Name of the location", + "example" : "Main Building", "nullable" : true - } - } - }, - "Component_AddAccessControlledDoorLabelWSResponse" : { - "type" : "object" - }, - "Component_AddAccessControlledElevatorLandingLabelWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevatorLandingUuid" : { + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "label" : { - "type" : "string", - "nullable" : true } } }, - "Component_AddAccessControlledElevatorLandingLabelWSResponse" : { - "type" : "object" - }, - "Component_AggregatedCredentialReceivedEventInfo" : { + "Camera_GetMinimalCameraStateListWSRequest" : { "type" : "object", + "description" : "Request to retrieve a minimal list of camera states.", "properties" : { - "firstEvent" : { - "$ref" : "#/components/schemas/CredentialReceivedEventType" - }, - "lastEvent" : { - "$ref" : "#/components/schemas/CredentialReceivedEventType" - }, - "totalCount" : { - "type" : "integer", - "format" : "int32", + "includeMummified" : { + "type" : "boolean", + "description" : "Whether to include mummified cameras in the response", + "example" : false, "nullable" : true } } }, - "Component_ApplyAccessControlledDoorStateOverrideWSRequest" : { + "Camera_GetMinimalCameraStateListWSResponse" : { "type" : "object", - "description" : "Door state overrides are temporary changes to door's lock/unlock state even if otherwise scheduled. They can be superseded or cancelled at anytime.", + "description" : "Response containing a minimal list of camera states.", "properties" : { - "accessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "doorAuthFirstInState" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - }, - "doorScheduleFirstInState" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - }, - "expireEarlyMode" : { - "$ref" : "#/components/schemas/EarlyExpireModeEnum" - }, - "expiresAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "A millisecond epoch time that represents when the override will end if not ended earlier by a regular schedule interval. Cannot be longer than 24 hours and default is 24hours long", + "cameraStates" : { + "type" : "array", + "description" : "List of minimal camera state information", + "items" : { + "$ref" : "#/components/schemas/MinimalDeviceStateType" + }, "nullable" : true }, - "followFirstInRules" : { + "error" : { "type" : "boolean", - "description" : "Default is false if not specified, the door state override will ignore schedule first-in requirements (if applicable) if false", "nullable" : true }, - "startDelaySeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "Default is 0 if not specified, determines how long to wait before applying the override", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + "warningMsg" : { + "type" : "string", + "nullable" : true } - }, - "required" : [ "accessControlledDoorUuid", "state" ] + } }, - "Component_ApplyAccessControlledDoorStateOverrideWSResponse" : { + "Camera_GetMinimalListWSRequest" : { "type" : "object", + "description" : "Request to retrieve a minimal list of cameras (deprecated).", "properties" : { - "accessControlledDoor" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" + "includeMummified" : { + "type" : "boolean", + "description" : "Whether to include mummified cameras in the response", + "example" : false, + "nullable" : true } } }, - "Component_ApplyAccessControlledElevatorLandingAccessStateOverrideWSRequest" : { + "Camera_GetMinimalListWSResponse" : { "type" : "object", - "description" : "Elevator landing state overrides are temporary changes to landings's lock/unlock state even if otherwise scheduled. They can be superseded or cancelled at anytime.", + "description" : "Response containing a minimal list of cameras (deprecated).", "properties" : { - "accessControlledElevatorLandingUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "accessScheduleFirstInState" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - }, - "authFirstInState" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" - }, - "expireEarlyMode" : { - "$ref" : "#/components/schemas/EarlyExpireModeEnum" - }, - "expiresAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "A millisecond epoch time that represents when the override will end if not ended earlier by a regular schedule interval. Cannot be longer than 24 hours and default is 24hours long", + "cameras" : { + "type" : "array", + "description" : "List of minimal camera information", + "items" : { + "$ref" : "#/components/schemas/Camera_MinimalCameraType" + }, "nullable" : true }, - "followFirstInRules" : { + "error" : { "type" : "boolean", - "description" : "Default is false if not specified, the elevator landing state override will ignore schedule first-in requirements (if applicable) if false", "nullable" : true }, - "startDelaySeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "Default is 0 if not specified, determines how long to wait before applying the override", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - } - }, - "required" : [ "accessControlledElevatorLandingUuid", "state" ] - }, - "Component_ApplyAccessControlledElevatorLandingAccessStateOverrideWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledElevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - } - } - }, - "Component_CancelAccessControlledDoorStateOverrideWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledDoorUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "accessControlledDoorUuid" ] - }, - "Component_CancelAccessControlledDoorStateOverrideWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledDoor" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - } } }, - "Component_CancelAccessControlledElevatorLandingAccessStateOverrideWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevatorLandingUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "accessControlledElevatorLandingUuid" ] - }, - "Component_CancelAccessControlledElevatorLandingAccessStateOverrideWSResponse" : { + "Camera_GetOccupancyEnabledCamerasWSRequest" : { "type" : "object", - "properties" : { - "accessControlledElevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - } - } + "description" : "Request to get occupancy enabled cameras." }, - "Component_CreateAccessControlledDoorSeekpointsWSRequest" : { + "Camera_GetOfflineLanStreamingInfoWSRequest" : { "type" : "object", - "properties" : { - "doorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "seekPoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CustomFootageSeekPointType" - }, - "nullable" : true - } - } + "description" : "Request to retrieve offline LAN streaming information for cameras." }, - "Component_CreateAccessControlledDoorSeekpointsWSResponse" : { + "Camera_GetOfflineLanStreamingInfoWSResponse" : { "type" : "object", + "description" : "Response containing offline LAN streaming information for cameras.", "properties" : { "error" : { "type" : "boolean", @@ -64096,8 +65558,12 @@ "type" : "string", "nullable" : true }, - "successMsg" : { - "type" : "string", + "info" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Camera_CameraOfflineLanStreamingInfo" + }, + "description" : "Mapping of camera UUIDs to offline LAN streaming information", "nullable" : true }, "warningMsg" : { @@ -64106,29 +65572,28 @@ } } }, - "Component_CreateAccessControlledDoorWSRequest" : { + "Camera_GetOngoingInactivityWindowsWSRequest" : { "type" : "object", + "description" : "Request to retrieve currently ongoing inactivity windows for cameras.", "properties" : { - "accessControlledDoor" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, - "accessControlledDoorLabels" : { + "deviceUuids" : { "type" : "array", + "description" : "List of device UUIDs to look up ongoing inactivity windows for", "items" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true } } }, - "Component_CreateAccessControlledDoorWSResponse" : { + "Camera_GetOngoingInactivityWindowsWSResponse" : { "type" : "object", + "description" : "Response containing the currently ongoing inactivity windows for the requested cameras.", "properties" : { - "accessControlledDoor" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, "error" : { "type" : "boolean", "nullable" : true @@ -64137,35 +65602,51 @@ "type" : "string", "nullable" : true }, + "ongoingWindows" : { + "type" : "array", + "description" : "Currently ongoing inactivity windows for the requested cameras.", + "items" : { + "$ref" : "#/components/schemas/Camera_OngoingInactivityWindowType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_CreateAccessControlledElevatorLandingWSRequest" : { + "Camera_GetPresenceWindowsWSRequest" : { "type" : "object", + "description" : "Request to retrieve presence windows for a camera within a time range.", "properties" : { - "accessControlledElevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + "cameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "accessControlledElevatorLandingLabels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds", + "example" : 3600, + "nullable" : true + }, + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, + "nullable" : true } } }, - "Component_CreateAccessControlledElevatorLandingWSResponse" : { + "Camera_GetPresenceWindowsWSResponse" : { "type" : "object", + "description" : "Response containing presence windows for a camera.", "properties" : { - "accessControlledElevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - }, "error" : { "type" : "boolean", "nullable" : true @@ -64174,26 +65655,30 @@ "type" : "string", "nullable" : true }, + "presenceWindows" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Mapping of presence types to time windows", + "items" : { + "$ref" : "#/components/schemas/TimeWindowSeconds" + }, + "nullable" : true + }, + "description" : "Mapping of presence types to time windows", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_CreateAccessControlledElevatorWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevator" : { - "$ref" : "#/components/schemas/AccessControlledElevator" - } - } - }, - "Component_CreateAccessControlledElevatorWSResponse" : { + "Camera_GetSharedCameraCurrentStateWSResponse" : { "type" : "object", - "nullable" : true, "properties" : { - "accessControlledElevator" : { - "$ref" : "#/components/schemas/AccessControlledElevator" + "cameraState" : { + "$ref" : "#/components/schemas/Camera_SharedCameraCurrentStateType" }, "error" : { "type" : "boolean", @@ -64209,58 +65694,99 @@ } } }, - "Component_CreateAperioDoorInfo" : { + "Camera_GetStorageRecoveryFileWSRequest" : { "type" : "object", - "description" : "The Aperio-assigned ID of the door(s) and the Aperio-assigned ID of their lock device.", + "description" : "Request to get storage recovery file for a device.", "properties" : { - "aperioDoorDeviceId" : { - "type" : "string", - "nullable" : true - }, - "aperioDoorId" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Component_CreateAperioDoorsWSRequest" : { + "Camera_GetStorageRecoveryFileWSResponse" : { "type" : "object", + "description" : "Response containing storage recovery file contents.", "properties" : { - "aperioGatewayComponentId" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "doors" : { + "fileContents" : { "type" : "array", - "description" : "The Aperio-assigned ID of the door(s) and the Aperio-assigned ID of their lock device.", + "description" : "Binary contents of the storage recovery file", + "example" : "[binary data]", "items" : { - "$ref" : "#/components/schemas/Component_CreateAperioDoorInfo" + "type" : "string", + "format" : "byte", + "description" : "Binary contents of the storage recovery file", + "example" : "W2JpbmFyeSBkYXRhXQ==", + "nullable" : true }, "nullable" : true - }, - "ownerDeviceUuid" : { + } + } + }, + "Camera_GetUptimeWindowsWSRequest" : { + "type" : "object", + "description" : "Request to retrieve uptime windows for a camera within a time range.", + "properties" : { + "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "aperioGatewayComponentId", "doors", "ownerDeviceUuid" ] + }, + "endTime" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds since epoch", + "example" : 1641081600000, + "nullable" : true + }, + "startTime" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds since epoch", + "example" : 1640995200000, + "nullable" : true + } + } }, - "Component_CreateAperioDoorsWSResponse" : { + "Camera_GetUptimeWindowsWSResponse" : { "type" : "object", + "description" : "Response containing uptime windows for a camera.", "properties" : { - "doors" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "uptimeWindows" : { "type" : "array", + "description" : "List of uptime windows", "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" + "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Camera_GetVideoWallsWSRequest" : { + "type" : "object", + "description" : "Request to retrieve all video wall configurations." + }, + "Camera_GetVideoWallsWSResponse" : { + "type" : "object", + "description" : "Response containing video wall configurations and associated user name mappings.", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -64269,10 +65795,21 @@ "type" : "string", "nullable" : true }, - "failedDoors" : { + "userNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Mapping of user UUIDs to user names", + "nullable" : true + }, + "description" : "Mapping of user UUIDs to user names", + "nullable" : true + }, + "videoWalls" : { "type" : "array", + "description" : "List of video wall summary information", "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" + "$ref" : "#/components/schemas/Camera_VideoWallSummaryType" }, "nullable" : true }, @@ -64282,261 +65819,398 @@ } } }, - "Component_CreateAperioGatewayWSRequest" : { + "Camera_HealthStatusDetailsEnum" : { + "type" : "string", + "description" : "Detailed health status enumeration for cameras.", + "enum" : [ "DISCONNECTED", "FIRMWARE_BEHIND", "NONE" ] + }, + "Camera_MinimalCameraType" : { "type" : "object", + "description" : "Minimal camera information type.", "properties" : { - "aperioGatewayId" : { + "connectionStatus" : { + "$ref" : "#/components/schemas/Camera_StatusEnum" + }, + "defaultInterface" : { "type" : "string", - "description" : "The Aperio-assigned ID of the gateway, given as a hex string, e.g. \"034AB5\".", + "description" : "Default network interface", + "example" : "eth0", "nullable" : true }, - "includeAperioDoors" : { + "defaultInterfaceMac" : { + "type" : "string", + "description" : "MAC address of default interface", + "example" : "00:11:22:33:44:55", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the camera is located", + "example" : 1, + "nullable" : true + }, + "healthStatus" : { + "$ref" : "#/components/schemas/Camera_StatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/Camera_HealthStatusDetailsEnum" + }, + "lanAddresses" : { + "type" : "array", + "description" : "List of LAN addresses", + "items" : { + "type" : "string", + "description" : "List of LAN addresses", + "nullable" : true + }, + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the camera", + "example" : 37.7749, + "nullable" : true + }, + "liveStreamShared" : { "type" : "boolean", - "default" : false, - "description" : "If enabled, also creates Aperio doors with this request.", + "description" : "Whether live stream is shared", + "example" : false, "nullable" : true }, - "ownerDeviceUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "aperioGatewayId", "ownerDeviceUuid" ] - }, - "Component_CreateAperioGatewayWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/AperioGateway" }, - "doors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the camera", + "example" : -122.4194, "nullable" : true }, - "error" : { + "mediaRegion" : { + "type" : "string", + "description" : "Media region", + "example" : "us-west-1", + "nullable" : true + }, + "mummified" : { "type" : "boolean", + "description" : "Whether the camera is mummified", + "example" : false, "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Name of the camera", + "example" : "Front Door Camera", "nullable" : true }, - "failedDoors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "region" : { "type" : "string", + "description" : "Camera region", + "example" : "us-west-1", "nullable" : true - } - } - }, - "Component_CreateIntegratedDoorPositionIndicatorWSRequest" : { - "type" : "object", - "properties" : { - "name" : { + }, + "serialNumber" : { "type" : "string", + "description" : "Camera serial number", + "example" : "CAM123456789", "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" + "ssid" : { + "type" : "string", + "description" : "WiFi SSID", + "example" : "MyNetwork", + "nullable" : true }, - "ownerDeviceUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" - } - } - }, - "Component_CreateIntegratedDoorPositionIndicatorWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" + "wifiApMac" : { + "type" : "string", + "description" : "MAC address of WiFi access point", + "example" : "AA:BB:CC:DD:EE:FF", + "nullable" : true + }, + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "description" : "WiFi signal strength in bars (1-5)", + "example" : 4, + "nullable" : true + }, + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "WiFi signal strength in dBm", + "example" : -45, + "nullable" : true } } }, - "Component_CreateIntegratedDoorRelayWSRequest" : { + "Camera_OngoingInactivityWindowType" : { "type" : "object", + "description" : "A single currently ongoing inactivity window for a camera region.", "properties" : { - "name" : { - "type" : "string", - "nullable" : true - }, - "ownerDeviceUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/DoorRelayPortType" + "facetUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "objectType" : { + "$ref" : "#/components/schemas/InactivityObjectTypeEnum" + }, + "windowStartMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds at which the ongoing inactivity window started.", + "nullable" : true } } }, - "Component_CreateIntegratedDoorRelayWSResponse" : { + "Camera_RebootCameraWSRequest" : { "type" : "object", + "description" : "Request to reboot a camera device.", "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedDoorRelayType" + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true } } }, - "Component_CreateIntegratedGenericButtonWSRequest" : { + "Camera_RebootCameraWSResponse" : { "type" : "object", + "description" : "Response from rebooting a camera device.", "properties" : { - "mode" : { - "$ref" : "#/components/schemas/ButtonModeEnum" + "error" : { + "type" : "boolean", + "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "ownerDeviceUuid" : { + "status" : { + "$ref" : "#/components/schemas/Camera_RebootWSResponseStatus" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "port" : { - "$ref" : "#/components/schemas/ButtonPortType" } } }, - "Component_CreateIntegratedGenericButtonWSResponse" : { + "Camera_RebootWSResponseStatus" : { + "type" : "string", + "description" : "Status enumeration for reboot web service responses.", + "enum" : [ "SUCCESS_REBOOT_SENT", "FAILED_CAMERA_OFFLINE", "FAILED_CAMERA_NOT_AUTHORIZED" ] + }, + "Camera_ReportBadDetectionWSRequest" : { "type" : "object", + "description" : "Request object for reporting a bad AI detection.", "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericButtonType" + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "reason" : { + "$ref" : "#/components/schemas/DetectionFeedbackReasonEnum" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Time of the detection (or missed activity) in milliseconds since epoch", + "nullable" : true + }, + "userDescription" : { + "type" : "string", + "description" : "Optional freeform note from the reporter", + "nullable" : true } - } + }, + "required" : [ "activity", "cameraUuid", "reason", "timestampMs" ] }, - "Component_CreateIntegratedGenericInputWSRequest" : { + "Camera_ReportBadDetectionWSResponse" : { "type" : "object", + "description" : "Response object for reporting a bad AI detection.", "properties" : { - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "ownerDeviceUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/AuxiliaryInputPortType" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_CreateIntegratedGenericInputWSResponse" : { + "Camera_RevertCameraToDefaultsWSRequest" : { "type" : "object", "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericInputType" + "cameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Component_CreateIntegratedGenericRelayWSRequest" : { + "Camera_RevertCameraToDefaultsWSResponse" : { "type" : "object", "properties" : { - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "ownerDeviceUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/AuxiliaryRelayPortType" - }, - "steadyState" : { - "$ref" : "#/components/schemas/GenericRelayStateEnumType" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_CreateIntegratedGenericRelayWSResponse" : { + "Camera_SharedCameraCurrentStateType" : { "type" : "object", + "description" : "Current state information for a shared camera.", "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericRelayType" + "baseVideoOperationUrl" : { + "type" : "string", + "description" : "Base URL for video operations", + "example" : "https://api.example.com/video", + "nullable" : true + }, + "connectionStatus" : { + "$ref" : "#/components/schemas/ConnectivityStatus" + }, + "oldestArchivedMediaSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Oldest archived media timestamp in seconds", + "example" : 1640995200, + "nullable" : true + }, + "onCameraState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "State information stored on the camera", + "nullable" : true + }, + "description" : "State information stored on the camera", + "nullable" : true + }, + "onCloudState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "State information stored in the cloud", + "nullable" : true + }, + "description" : "State information stored in the cloud", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Camera region", + "example" : "us-west-1", + "nullable" : true } } }, - "Component_CreateIntegratedRequestToExitWSRequest" : { + "Camera_SharedLiveVideoStreamWS" : { "type" : "object", + "description" : "List of shared live video streams for the doorbell camera", "properties" : { - "intentOnly" : { - "type" : "boolean", + "audioDeviceHwVar" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "audioGatewayUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "intentOnlyEvents" : { + "audioPushToTalkEnabled" : { "type" : "boolean", "nullable" : true }, - "name" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" + "deviceHwVar" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "ownerDeviceUuid" : { + "deviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/RequestToExitPortType" - } - } - }, - "Component_CreateIntegratedRequestToExitWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedRequestToExitType" - } - } - }, - "Component_CreateOsdpReaderWSRequest" : { - "type" : "object", - "properties" : { - "allowUnencrypted" : { - "type" : "boolean", + "expirationTime" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "disableCardReader" : { + "hideOverlay" : { "type" : "boolean", "nullable" : true }, - "disableKeypad" : { + "invertSchedule" : { "type" : "boolean", "nullable" : true }, @@ -64544,344 +66218,244 @@ "type" : "string", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "ownerDeviceUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/OsdpReaderPortType" - }, - "remoteUnlockAudioFeedbackEnabled" : { + "passwordProtected" : { "type" : "boolean", "nullable" : true - } - } - }, - "Component_CreateOsdpReaderWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/OsdpDoorReaderType" - } - } - }, - "Component_CreateRhombusOsdpReaderWSRequest" : { - "type" : "object", - "properties" : { - "deviceUuid" : { + }, + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "disableCardReader" : { + "sharedLiveM3U8StreamUrl" : { + "type" : "string", + "nullable" : true + }, + "sharedLiveVideoStreamUrl" : { + "type" : "string", + "nullable" : true + }, + "sharedWithMonitoringService" : { "type" : "boolean", "nullable" : true }, - "disableWaveToUnlock" : { + "ssoProtected" : { "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", + "streamType" : { + "$ref" : "#/components/schemas/StreamTypeEnum" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "unscheduledMessage" : { + "type" : "string", "nullable" : true }, - "ownerDeviceUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/OsdpReaderPortType" - }, - "remoteUnlockAudioFeedbackEnabled" : { + "vodEnabled" : { "type" : "boolean", "nullable" : true } } }, - "Component_CreateRhombusOsdpReaderWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" - } - } - }, - "Component_CreateWiegandReaderWSRequest" : { + "Camera_SharedVideoWallWS" : { "type" : "object", + "description" : "List of shared video walls", "properties" : { - "buzzerPort" : { - "$ref" : "#/components/schemas/WiegandOutputPortType" - }, - "csnEndian" : { - "$ref" : "#/components/schemas/WiegandCredentialEndianEnumType" - }, - "d0Port" : { - "$ref" : "#/components/schemas/WiegandDataPortType" - }, - "d1Port" : { - "$ref" : "#/components/schemas/WiegandDataPortType" - }, - "disableCardReader" : { - "type" : "boolean", + "deviceScheduleMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DeviceSchedule" + }, "nullable" : true }, - "disableKeypad" : { - "type" : "boolean", + "expirationTime" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "gledPort" : { - "$ref" : "#/components/schemas/WiegandOutputPortType" - }, - "name" : { - "type" : "string", + "hideOverlay" : { + "type" : "boolean", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { + "invertSchedule" : { "type" : "boolean", "nullable" : true }, - "ownerDeviceUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "remoteUnlockAudioFeedbackEnabled" : { + "passwordProtected" : { "type" : "boolean", "nullable" : true }, - "rledPort" : { - "$ref" : "#/components/schemas/WiegandOutputPortType" - }, - "tamperPort" : { - "$ref" : "#/components/schemas/WiegandInputPortType" - } - } - }, - "Component_CreateWiegandReaderWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/WiegandDoorReaderType" - } - } - }, - "Component_DeleteAccessControlledDoorWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledDoorUuid" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Component_DeleteAccessControlledDoorWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledDoor" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - } - } - }, - "Component_DeleteAccessControlledElevatorLandingWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevatorLandingUuid" : { + }, + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Component_DeleteAccessControlledElevatorLandingWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledElevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - } - } - }, - "Component_DeleteAccessControlledElevatorWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevatorUuid" : { + }, + "sharedVideoWallUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Component_DeleteAccessControlledElevatorWSResponse" : { - "type" : "object", - "nullable" : true, - "properties" : { - "accessControlledElevator" : { - "$ref" : "#/components/schemas/AccessControlledElevator" - } - } - }, - "Component_DeleteComponentWSRequest" : { - "type" : "object", - "properties" : { - "componentUuid" : { + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "unscheduledMessage" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Component_DeleteComponentWSResponse" : { - "type" : "object" - }, - "Component_DeleteComponentsByOwnerDeviceWSRequest" : { - "type" : "object", - "properties" : { - "ownerDeviceUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Component_DeleteComponentsByOwnerDeviceWSResponse" : { - "type" : "object" - }, - "Component_FindAccessControlledDoorShadowsByLocationWSRequest" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "nullable" : true }, - "locationUuid" : { + "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "vodEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "Component_FindAccessControlledDoorShadowsByLocationWSResponse" : { + "Camera_StatusEnum" : { + "type" : "string", + "description" : "Status enumeration for camera states.", + "enum" : [ "RED", "ORANGE", "GREEN" ] + }, + "Camera_UpdateCameraAIThresholdsWSRequest" : { "type" : "object", + "description" : "Request to update AI thresholds for a camera.", "properties" : { - "lastEvaluatedKey" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "shadows" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorShadow" - }, - "nullable" : true - } - } - }, - "Component_FindAccessControlledDoorShadowsWSRequest" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + "consecutiveHumanFilter" : { + "type" : "integer", + "format" : "int32", + "description" : "Require this many consecutive frames of seeing a human to include that human detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", + "example" : 3, "nullable" : true }, - "maxPageSize" : { + "consecutiveVehicleFilter" : { "type" : "integer", "format" : "int32", + "description" : "Require this many consecutive frames of seeing a vehicle to include that vehicle detection in results. Set to 1 to always include detections, or higher to avoid false positives due to transient motion like bugs/spiders/rain. Default is 2 consecutive frames.", + "example" : 3, "nullable" : true - } - } - }, - "Component_FindAccessControlledDoorShadowsWSResponse" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + }, + "faceConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for face detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.7", + "example" : 0.8, "nullable" : true }, - "shadows" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorShadow" - }, + "faceMatchConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for face matching (determining if two faces are the same person). Set to 0 or null to use the default. Maximum range of 1. Default = 0.7. We no longer support device specific face matching threshold. This property is deprecated and will be removed.", + "example" : 0.8, "nullable" : true - } - } - }, - "Component_FindAccessControlledDoorsByLocationWSRequest" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + }, + "humanConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for human detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.6", + "example" : 0.7, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lprConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for license plate detection and character recognition. Set to 0 or null to use the default. Maximum range of 1. Default = 0.8", + "example" : 0.9, "nullable" : true }, - "maxPageSize" : { + "maxEventDurationMs" : { "type" : "integer", "format" : "int32", + "description" : "Set the max event duration for an alert in milliseconds. Default is 30000, lowering down to 4000 will result in faster alert delivery but shorter alert clips.", + "example" : 15000, + "nullable" : true + }, + "vehicleConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Confidence threshold for vehicle detection. Set to 0 or null to use the default. Maximum range of 1. Default = 0.6", + "example" : 0.7, "nullable" : true } } }, - "Component_FindAccessControlledDoorsByLocationWSResponse" : { + "Camera_UpdateCameraAIThresholdsWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating camera AI thresholds.", "properties" : { - "accessControlledDoors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "lastEvaluatedKey" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_FindAccessControlledDoorsByOwnerDeviceWSRequest" : { + "Camera_UpdateCameraFirmwareWSRequest" : { "type" : "object", + "description" : "Request to update camera firmware.", "properties" : { - "ownerDeviceUuid" : { + "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -64890,404 +66464,368 @@ } } }, - "Component_FindAccessControlledDoorsByOwnerDeviceWSResponse" : { + "Camera_UpdateCameraFirmwareWSResponse" : { "type" : "object", + "description" : "Response containing the status of camera firmware update.", "properties" : { - "accessControlledDoors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, + "error" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Component_FindAccessControlledDoorsWSRequest" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "status" : { + "$ref" : "#/components/schemas/Camera_UpdateFirmwareWSStatus" + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindAccessControlledDoorsWSResponse" : { + "Camera_UpdateCameraHumanLoiteringConfigWSRequest" : { "type" : "object", + "description" : "Request to update human loitering configuration for a camera.", "properties" : { - "accessControlledDoors" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "rois" : { "type" : "array", + "description" : "Region of interests of the human loitering feature. NULL or empty list will disable the feature", "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" + "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true - }, - "lastEvaluatedKey" : { - "type" : "string", - "nullable" : true } } }, - "Component_FindAccessControlledElevatorLandingShadowsByLocationWSRequest" : { + "Camera_UpdateCameraHumanLoiteringWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating camera human loitering configuration.", "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindAccessControlledElevatorLandingShadowsByLocationWSResponse" : { + "Camera_UpdateCameraInactivityConfigWSRequest" : { "type" : "object", + "description" : "Request to update inactivity detection configuration for a camera.", "properties" : { - "lastEvaluatedKey" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "shadows" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLandingShadow" - }, + "objectType" : { + "$ref" : "#/components/schemas/InactivityObjectTypeEnum" + }, + "roi" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, + "thresholdMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Inactivity duration in milliseconds that generates timeline events. Must be positive when configuring the feature. NULL will disable the feature.", "nullable" : true } } }, - "Component_FindAccessControlledElevatorLandingShadowsWSRequest" : { + "Camera_UpdateCameraInactivityWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating camera inactivity detection configuration.", "properties" : { - "lastEvaluatedKey" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindAccessControlledElevatorLandingShadowsWSResponse" : { + "Camera_UpdateCameraLineCrossingThresholdsWSRequest" : { "type" : "object", + "description" : "Request to update line crossing thresholds for a camera.", "properties" : { - "lastEvaluatedKey" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "shadows" : { + "directions" : { "type" : "array", + "description" : "Set of crossing directions to monitor.", "items" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLandingShadow" + "$ref" : "#/components/schemas/CrossingDirectionEnum" }, - "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorLandingsByLocationWSRequest" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "inverted" : { + "type" : "boolean", + "description" : "By default, INGRESS events occur when the following condition is met for the following line types: an entity moves from top -> bottom when a horizontal line is defined, an entity moves from left -> right when a vertical line is defined, an entity moves from top-left -> bottom-right when an upwards sloping line is defined, and an entity moves from top-right to bottom-left when a downwards sloping line is defined. Setting this value to true will switch INGRESS to EGRESS events and vice-versa.", + "example" : false, "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "objectType" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "pointA" : { + "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" + }, + "pointB" : { + "$ref" : "#/components/schemas/Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" } } }, - "Component_FindAccessControlledElevatorLandingsByLocationWSResponse" : { + "Camera_UpdateCameraLineCrossingThresholdsWSRequest_Coordinate" : { "type" : "object", + "description" : "(X,Y) coordinate expressed as a percentage of the camera's resolution.Minimum range is 0.1 and maximum range is 0.9. Leaving this value as null will disable line-crossing.", "properties" : { - "accessControlledElevatorLandings" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - }, + "x" : { + "type" : "number", + "format" : "float", + "description" : "Value ranges from 0.1 to 0.9", + "example" : 0.5, "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", + "y" : { + "type" : "number", + "format" : "float", + "description" : "Value ranges from 0.1 to 0.9", + "example" : 0.5, "nullable" : true } } }, - "Component_FindAccessControlledElevatorLandingsWSRequest" : { + "Camera_UpdateCameraLineCrossingThresholdsWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating camera line crossing thresholds.", "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorLandingsWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledElevatorLandings" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_FindAccessControlledElevatorsByLocationWSRequest" : { + "Camera_UpdateCameraV2WSRequest" : { "type" : "object", + "description" : "Request to update camera information V2 with partial update support.", "properties" : { - "lastEvaluatedKey" : { + "customData" : { "type" : "string", + "description" : "Custom data for the camera", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "customDataUpdated" : { + "type" : "boolean", + "description" : "Whether custom data was updated", + "example" : false, "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "deleted" : { + "type" : "boolean", + "description" : "Whether the camera is deleted", + "example" : false, "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorsByLocationWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledElevators" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledElevator" - }, + }, + "deletedUpdated" : { + "type" : "boolean", + "description" : "Whether deleted status was updated", + "example" : false, "nullable" : true }, - "lastEvaluatedKey" : { + "description" : { "type" : "string", + "description" : "Description of the camera", + "example" : "Camera monitoring the front entrance", "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorsByOwnerDeviceWSRequest" : { - "type" : "object", - "properties" : { - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "descriptionUpdated" : { + "type" : "boolean", + "description" : "Whether description was updated", + "example" : false, "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorsByOwnerDeviceWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledElevators" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledElevator" + }, + "directionRadians" : { + "type" : "number", + "format" : "float", + "description" : "Direction in radians", + "example" : 1.5708, + "nullable" : true + }, + "directionRadiansUpdated" : { + "type" : "boolean", + "description" : "Whether direction radians was updated", + "example" : false, + "nullable" : true + }, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Mapping of device facets to names", + "nullable" : true }, + "description" : "Mapping of device facets to names", "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorsWSRequest" : { - "type" : "object", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", + }, + "facetNameMapUpdated" : { + "type" : "boolean", + "description" : "Whether facet name map was updated", + "example" : false, "nullable" : true }, - "maxPageSize" : { + "floorNumber" : { "type" : "integer", "format" : "int32", + "description" : "Floor number", + "example" : 1, "nullable" : true - } - } - }, - "Component_FindAccessControlledElevatorsWSResponse" : { - "type" : "object", - "properties" : { - "accessControlledElevators" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlledElevator" - }, + }, + "floorNumberUpdated" : { + "type" : "boolean", + "description" : "Whether floor number was updated", + "example" : false, "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate", + "example" : 37.7749, "nullable" : true - } - } - }, - "Component_FindAllComponentShadowsWSRequest" : { - "type" : "object", - "properties" : { - "componentUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Component_FindAllComponentShadowsWSResponse" : { - "type" : "object", - "properties" : { - "acuComponentShadowMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ComponentShadowType" - }, + }, + "latitudeUpdated" : { + "type" : "boolean", + "description" : "Whether latitude was updated", + "example" : false, "nullable" : true - } - } - }, - "Component_FindComponentEventsByAccessControlledDoorWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledDoorUuid" : { + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", + "locationUuidUpdated" : { + "type" : "boolean", + "description" : "Whether location UUID was updated", + "example" : false, "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate", + "example" : -122.4194, "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "longitudeUpdated" : { + "type" : "boolean", + "description" : "Whether longitude was updated", + "example" : false, "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsByAccessControlledDoorWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, + "mummified" : { + "type" : "boolean", + "description" : "Whether the camera is mummified", + "example" : false, "nullable" : true }, - "error" : { + "mummifiedUpdated" : { "type" : "boolean", + "description" : "Whether mummified status was updated", + "example" : false, "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Name of the camera", + "example" : "Front Door Camera", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "nameUpdated" : { + "type" : "boolean", + "description" : "Whether name was updated", + "example" : false, "nullable" : true - } - } - }, - "Component_FindComponentEventsByAccessControlledElevatorWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevatorUuid" : { + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", + "policyUuidUpdated" : { + "type" : "boolean", + "description" : "Whether policy UUID was updated", + "example" : false, "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "limit" : { - "type" : "integer", - "format" : "int32", + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether sub-locations hierarchy key was updated", + "example" : false, "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Component_FindComponentEventsByAccessControlledElevatorWSResponse" : { + "Camera_UpdateCameraV2WSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating camera information V2.", "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -65302,612 +66840,593 @@ } } }, - "Component_FindComponentEventsByApiTokenWSRequest" : { + "Camera_UpdateCameraWSRequest" : { "type" : "object", + "description" : "Request to update camera information (deprecated).", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "limit" : { - "type" : "integer", - "format" : "int32", + "camera" : { + "$ref" : "#/components/schemas/Camera_CameraBackwardsCompatUpdateType" + } + } + }, + "Camera_UpdateCameraWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of updating camera information (deprecated).", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "tokenUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindComponentEventsByApiTokenWSResponse" : { + "Camera_UpdateCamerasBulkV2WSRequest" : { "type" : "object", + "description" : "Request to update multiple cameras in bulk V2.", "properties" : { - "componentEvents" : { + "cameraBulkDetails" : { "type" : "array", + "description" : "List of camera bulk update details", "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "$ref" : "#/components/schemas/Camera_UpdateCameraV2WSRequest" }, "nullable" : true } } }, - "Component_FindComponentEventsByComponentWSRequest" : { + "Camera_UpdateConfigWSRequest" : { "type" : "object", + "description" : "Request to update camera configuration settings.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "nullable" : true + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" } } }, - "Component_FindComponentEventsByComponentWSResponse" : { + "Camera_UpdateFirmwareWSStatus" : { + "type" : "string", + "description" : "Status of the firmware update operation", + "enum" : [ "ALREADY_ON_THE_LATEST_FIRMWARE", "DEVICE_ON_A_SPECIAL_FIRMWARE_AND_CANNOT_BE_UPDATED", "UPDATE_STARTED", "UNABLE_TO_REACH_DEVICE", "FIRMWARE_UPDATE_ALREADY_IN_PROGESS", "DEVICE_NOT_AUTHROIZED" ] + }, + "Camera_UpdateVideoWallWSRequest" : { "type" : "object", + "description" : "Request to update a video wall configuration.", "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true + "videoWall" : { + "$ref" : "#/components/schemas/VideoWallType" } } }, - "Component_FindComponentEventsByCorrelationWSRequest" : { + "Camera_UpdateVideoWallWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating a video wall configuration.", "properties" : { - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindComponentEventsByCorrelationWSResponse" : { + "Camera_UpdateWifiWSRequest" : { "type" : "object", + "description" : "Request to update WiFi settings for one or more cameras.", "properties" : { - "componentEvents" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "cameraUuids" : { "type" : "array", + "description" : "List of camera UUIDs to update WiFi settings for", "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "WiFi network password", + "example" : "password123", + "nullable" : true + }, + "ssid" : { + "type" : "string", + "description" : "WiFi network SSID", + "example" : "MyWiFiNetwork", + "nullable" : true } } }, - "Component_FindComponentEventsByCredentialHexValueWSRequest" : { + "Camera_UpdateWifiWSResponse" : { "type" : "object", + "description" : "Response containing the status of WiFi update operations for each camera.", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "credentialHexValue" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "status" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "description" : "Mapping of camera UUIDs to WiFi update success status", + "nullable" : true + }, + "description" : "Mapping of camera UUIDs to WiFi update success status", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindComponentEventsByCredentialHexValueWSResponse" : { + "Camera_VideoWallSummaryType" : { "type" : "object", + "description" : "Summary information for a video wall.", "properties" : { - "componentEvents" : { + "deviceList" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true - } - } - }, - "Component_FindComponentEventsByCredentialUuidWSRequest" : { - "type" : "object", - "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", + }, + "displayName" : { + "type" : "string", "nullable" : true }, - "createdBeforeMs" : { + "numShares" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Number of shares for the video wall", + "example" : 5, "nullable" : true }, - "credentialUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "othersCanEdit" : { + "type" : "boolean", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "ownerUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "settings" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true }, "nullable" : true + }, + "shared" : { + "type" : "boolean", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Component_FindComponentEventsByCredentialUuidWSResponse" : { + "CancelLoopingAudioPlaybackActionRecordType" : { "type" : "object", "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "statusMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/AudioGatewayStatusEnum" }, "nullable" : true } } }, - "Component_FindComponentEventsByCredentialValueWSRequest" : { + "CancelLoopingAudioPlaybackActionType" : { "type" : "object", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "credentialValue" : { - "type" : "string", - "nullable" : true - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "typeFilter" : { + "_audioDevices" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true - } - } - }, - "Component_FindComponentEventsByCredentialValueWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { + }, + "audioDevices" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true } } }, - "Component_FindComponentEventsByLocationWSRequest" : { + "CancelledAccessStateOverride" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "cancelledDoorStateOverride" : { + "$ref" : "#/components/schemas/AccessStateOverride" + } + } + } ], + "nullable" : true, "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" }, - "createdBeforeMs" : { + "requestedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "type" : { + "$ref" : "#/components/schemas/ManualAccessStateChangeEnum" + } + } + }, + "ChangeComponentCompositeAccessStateActionType" : { + "type" : "object", + "properties" : { + "accessState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "alwaysCreateOverrideIfNoFirstIn" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsByLocationWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsByOwnerDeviceWSRequest" : { - "type" : "object", - "properties" : { - "createdAfterMs" : { + "expirationStrategy" : { + "$ref" : "#/components/schemas/AccessStateOverrideExpirationStrategyEnum" + }, + "expireTimeDelaySeconds" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "createdBeforeMs" : { + "expireTimeOfDayLocalSeconds" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "limit" : { + "useFirstInRulesIfPossible" : { + "type" : "boolean", + "nullable" : true + }, + "version" : { "type" : "integer", "format" : "int32", - "nullable" : true + "nullable" : true, + "readOnly" : true + } + } + }, + "ChangeComponentCompositeAccessStateRecordType" : { + "type" : "object", + "properties" : { + "accessState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "ownerDeviceUuid" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "madeChange" : { + "type" : "boolean", + "nullable" : true + }, + "succeeded" : { + "type" : "boolean", + "nullable" : true + }, + "usedFirstIn" : { + "type" : "boolean", + "nullable" : true + }, + "willExpireAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Component_FindComponentEventsByOwnerDeviceWSResponse" : { + "ChangeTypeEnum" : { + "type" : "string", + "description" : "Change type enum for exposing to OpenAPI component schemas", + "enum" : [ "REFRESH", "DELETE", "CREATE", "UPDATE" ] + }, + "ChatFollowUpActionEnum" : { + "type" : "string", + "enum" : [ "NOTIFY_USERS", "UNKNOWN" ] + }, + "ChatPrivacy" : { "type" : "object", "properties" : { - "componentEvents" : { + "permissionGroupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "permittedPrincipalUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true + }, + "visibility" : { + "$ref" : "#/components/schemas/ChatVisibilityEnum" } } }, - "Component_FindComponentEventsBySupportAuthorityWSRequest" : { + "ChatQueryFilter" : { "type" : "object", + "description" : "Optional field for filtering chat records.", "properties" : { - "createdAfterMs" : { + "afterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "createdBeforeMs" : { + "beforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "supportAuthorityUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "typeFilter" : { + "responseTypes" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "$ref" : "#/components/schemas/ResponseTypeEnum" }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsBySupportAuthorityWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { + "nullable" : true, + "uniqueItems" : true + }, + "responseTypesStr" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventType" + "type" : "string", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true } } }, - "Component_FindComponentEventsByUserWSRequest" : { + "ChatRecord" : { "type" : "object", + "description" : "Chat record used for a selective update.", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", + "attributedOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "automatedPromptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "contextId" : { + "type" : "string", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "extra" : { + "type" : "string", "nullable" : true }, - "userUuid" : { + "llmInfo" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Component_FindComponentEventsByUserWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsForCurrentUserWSRequest" : { - "type" : "object", - "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "principalUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "limit" : { + "privacy" : { + "$ref" : "#/components/schemas/ChatPrivacy" + }, + "queriedAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsForCurrentUserWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true - } - } - }, - "Component_FindComponentEventsForOrgDashboardWSRequest" : { - "type" : "object", - "properties" : { - "componentCompositeFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "query" : { + "type" : "string", "nullable" : true }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "requestedBy" : { + "$ref" : "#/components/schemas/RequestedBy" }, - "createdBeforeMs" : { + "respondedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", + "response" : { + "type" : "string", "nullable" : true }, - "reverseSearch" : { - "type" : "boolean", - "nullable" : true + "responseType" : { + "$ref" : "#/components/schemas/ResponseTypeEnum" }, - "typeFilter" : { + "timeline" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "$ref" : "#/components/schemas/QueryTimelineEvent" }, "nullable" : true }, - "userFilter" : { + "toolingTimeline" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/QueryTool" }, "nullable" : true - } - } - }, - "Component_FindComponentEventsForOrgDashboardWSResponse" : { - "type" : "object", - "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Component_FindComponentEventsForVideoIntercomWSRequest" : { + "ChatVisibilityEnum" : { + "type" : "string", + "enum" : [ "PUBLIC", "ORG_WIDE", "SELECT_USERS", "PRIVATE" ] + }, + "ChatbotConfig" : { "type" : "object", + "description" : "Rhombus MIND configuration to update.", "properties" : { - "accessControlledDoorUuid" : { + "apiKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "LLM API key used by the chatbot service", "nullable" : true }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "billingType" : { + "$ref" : "#/components/schemas/ChatbotConfigBillingTypeEnum" }, - "createdBeforeMs" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", + "description" : "Epoch timestamp in milliseconds when this config was created", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "executionStrategy" : { + "$ref" : "#/components/schemas/ChatbotExecutionStrategyEnum" }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "lastUpdatedByPrincipal" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "videoIntercomUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "description" : "Indicator if the provided LLM API key is valid", + "nullable" : true + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch timestamp in milliseconds when this config was last updated", + "nullable" : true } - } + }, + "required" : [ "billingType" ] }, - "Component_FindComponentEventsForVideoIntercomWSResponse" : { + "ChatbotConfigBillingTypeEnum" : { + "type" : "string", + "description" : "Billing type", + "enum" : [ "SELF_MANAGED", "MANAGED", "TRIAL" ] + }, + "ChatbotExecutionStrategyEnum" : { + "type" : "string", + "description" : "Execution strategy for chat queries. Defaults to MIND_CHATGPT if not specified.", + "enum" : [ "MIND_CHATGPT", "DIRECT_CHATGPT", "DIRECT_CLAUDE" ] + }, + "Chatbot_BaseAutomatedPromptWSResponse" : { "type" : "object", + "description" : "Response object for creating, updating or retrieving chatbot automation settings.", "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -65916,677 +67435,686 @@ "type" : "string", "nullable" : true }, + "settings" : { + "$ref" : "#/components/schemas/AutomatedPrompt" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" : { + "Chatbot_BaseChatWSResponse" : { "type" : "object", - "description" : "Component seekpoints search for access controlled door", + "description" : "Response object for retrieving or updating a chat record.", "properties" : { - "accessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "chat" : { + "$ref" : "#/components/schemas/ChatRecord" }, - "durationSec" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "startTimeSecEpochExclusive" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true - } - } - }, - "Component_FindComponentSeekPointsByAccessControlledDoorWSResponse" : { - "type" : "object", - "properties" : { - "seekpoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" - }, + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" : { + "Chatbot_BaseChatbotConfigWSResponse" : { "type" : "object", - "description" : "Component seekpoints search for access controlled doors", + "description" : "Response object for creating, updating or retrieving Rhombus MIND config.", "properties" : { - "accessControlledDoorUuidList" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "config" : { + "$ref" : "#/components/schemas/ChatbotConfig" }, - "durationSec" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "sortResponse" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "startTimeSecEpochExclusive" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindComponentSeekPointsByAccessControlledDoorsWSResponse" : { + "Chatbot_CreateAutomatedPromptWSRequest" : { "type" : "object", + "description" : "Request object for creating chatbot automation settings.", "properties" : { - "seekpoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" - }, - "nullable" : true + "settings" : { + "$ref" : "#/components/schemas/AutomatedPrompt" } - } + }, + "required" : [ "settings" ] }, - "Component_FindComponentSeekPointsByComponentWSRequest" : { + "Chatbot_CreateChatbotConfigWSRequest" : { "type" : "object", + "description" : "Request object for creating Rhombus MIND config.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "startTimeSecEpochExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "config" : { + "$ref" : "#/components/schemas/ChatbotConfig" } - } + }, + "required" : [ "config" ] }, - "Component_FindComponentSeekPointsByComponentWSResponse" : { + "Chatbot_DeleteAutomatedPromptWSRequest" : { "type" : "object", + "description" : "Request object for deleting chatbot automation settings.", "properties" : { - "seekpoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" - }, + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "promptUuid" ] }, - "Component_FindComponentSeekPointsByLocationWSRequest" : { + "Chatbot_DeleteChatRecordWSRequest" : { "type" : "object", + "description" : "Request object for deleting a chat record.", "properties" : { - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "locationUuid" : { + "recordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "startTimeSecEpochExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } - } + }, + "required" : [ "recordUuid" ] }, - "Component_FindComponentSeekPointsByLocationWSResponse" : { + "Chatbot_DeleteChatbotConfigWSRequest" : { + "type" : "object", + "description" : "Request object for deleting Rhombus MIND config." + }, + "Chatbot_DeleteChatbotConversationWSRequest" : { "type" : "object", + "description" : "Request object for deleting a user's conversation with Rhombus MIND.", "properties" : { - "seekpoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" - }, + "contextId" : { + "type" : "string", + "description" : "Context identifier of the conversation to delete.", "nullable" : true } - } + }, + "required" : [ "contextId" ] }, - "Component_FindComponentSeekPointsByOwnerDeviceWSRequest" : { + "Chatbot_GetAutomatedPromptChatHistoryWSRequest" : { "type" : "object", - "description" : "Component seekpoints search for owner device", + "description" : "Request object for retrieving chat history for a given automated prompt.", "properties" : { - "durationSec" : { + "lastEvaluatedKey" : { + "type" : "string", + "nullable" : true + }, + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "ownerDeviceUuid" : { + "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "startTimeSecEpochExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } - } + }, + "required" : [ "promptUuid" ] }, - "Component_FindComponentSeekPointsByOwnerDeviceWSResponse" : { + "Chatbot_GetAutomatedPromptWSRequest" : { "type" : "object", + "description" : "Request object for retrieving chatbot automation settings.", "properties" : { - "seekpoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" - }, + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "promptUuid" ] }, - "Component_FindComponentSeekPointsByUserWSRequest" : { + "Chatbot_GetAutomatedPromptsForOrgWSResponse" : { "type" : "object", + "description" : "Response object for retrieving chatbot automation settings for an org.", "properties" : { - "durationSec" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "startTimeSecEpochExclusive" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userUuid" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Pagination key to resume a paginated query.", "nullable" : true - } - } - }, - "Component_FindComponentSeekPointsByUserWSResponse" : { - "type" : "object", - "properties" : { - "seekpoints" : { + }, + "settingsList" : { "type" : "array", + "description" : "List of chatbot automation settings for this org.", "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" + "$ref" : "#/components/schemas/AutomatedPrompt" }, "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_FindComponentShadowsByOwnerDeviceWSRequest" : { + "Chatbot_GetChatHistoryByContextIdWSRequest" : { "type" : "object", + "description" : "Request object for retrieving a user's chat history for a given conversation with Rhombus MIND.", "properties" : { - "ownerDeviceUuid" : { + "contextId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Context ID to get chat history for.", "nullable" : true + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + }, + "required" : [ "contextId" ] + }, + "Chatbot_GetChatHistoryWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving a user's entire chat history with Rhombus MIND.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ChatQueryFilter" + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" } } }, - "Component_FindComponentShadowsByOwnerDeviceWSResponse" : { + "Chatbot_GetChatHistoryWSResponse" : { "type" : "object", + "description" : "Response object for retrieving an entity's chat history with Rhombus MIND.", "properties" : { - "componentShadows" : { + "chatHistory" : { "type" : "array", + "description" : "An entity's chat history with Rhombus MIND.", "items" : { - "$ref" : "#/components/schemas/ComponentShadowType" + "$ref" : "#/components/schemas/ChatRecord" }, "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Pagination key to resume a paginated query.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_FindComponentsByOwnerDeviceWSRequest" : { + "Chatbot_GetChatRecordWSRequest" : { "type" : "object", + "description" : "Request object for retrieving a chat record.", "properties" : { - "ownerDeviceUuid" : { + "recordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "recordUuid" ] }, - "Component_FindComponentsByOwnerDeviceWSResponse" : { + "Chatbot_GetChatbotConfigWSRequest" : { "type" : "object", + "description" : "Request object for retrieving Rhombus MIND config." + }, + "Chatbot_GetChatbotConversationsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving a user's conversations with Rhombus MIND.", "properties" : { - "components" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BaseComponentType" - }, - "nullable" : true + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" } } }, - "Component_FindDistinctOriginatorCredentialReceivedEventsByAccessControlledDoorWSRequest" : { + "Chatbot_GetChatbotConversationsWSResponse" : { "type" : "object", + "description" : "Response object for retrieving a user's conversations with Rhombus MIND.", "properties" : { - "accessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "activityFilter" : { + "conversations" : { "type" : "array", + "description" : "List of a user's conversations.", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/ContextRecord" }, "nullable" : true }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "credSourceFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CredentialSourceEnumType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "originatorTypeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" - }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Pagination key to resume a paginated query.", "nullable" : true }, - "userFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindDistinctOriginatorCredentialReceivedEventsByAccessControlledDoorWSResponse" : { + "Chatbot_GetPublicChatRecordWSRequest" : { "type" : "object", + "description" : "Request object for retrieving a publicly viewable chat record.", "properties" : { - "events" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Component_AggregatedCredentialReceivedEventInfo" - }, + "chatId" : { + "type" : "string", + "description" : "Base64-encoded chat record UUID.", + "nullable" : true + }, + "orgId" : { + "type" : "string", + "description" : "Base64-encoded org UUID.", "nullable" : true } - } + }, + "required" : [ "chatId", "orgId" ] }, - "Component_FindDistinctOriginatorCredentialReceivedEventsByLocationWSRequest" : { + "Chatbot_GetRemainingTrialCreditsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving the current org's remaining trial credits for MIND." + }, + "Chatbot_GetRemainingTrialCreditsWSResponse" : { "type" : "object", + "description" : "Response object for retrieving the current org's remaining trial credits for MIND.", "properties" : { - "activityFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true - }, - "componentCompositeFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { + "remainingTrialCredits" : { "type" : "integer", "format" : "int64", + "description" : "The current org's remaining trial credits for MIND.", "nullable" : true - }, - "credSourceFilter" : { + } + } + }, + "Chatbot_GetSharedChatRecordsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving chat records shared with the current user.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ChatQueryFilter" + } + } + }, + "Chatbot_GetSharedChatRecordsWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving chat records shared with the current user.", + "properties" : { + "chatRecords" : { "type" : "array", + "description" : "List of chat records shared with the current user.", "items" : { - "$ref" : "#/components/schemas/CredentialSourceEnumType" + "$ref" : "#/components/schemas/ChatRecord" }, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "originatorTypeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindDistinctOriginatorCredentialReceivedEventsByLocationWSResponse" : { + "Chatbot_GetTokenUsageHistoryWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving the current org's LLM token usage history." + }, + "Chatbot_GetTokenUsageHistoryWSResponse" : { "type" : "object", + "description" : "Response object for retrieving the current org's LLM token usage history.", "properties" : { - "events" : { + "usageHistory" : { "type" : "array", + "description" : "The current org's LLM token usage history; one entry per (year, month, model) bucket.", "items" : { - "$ref" : "#/components/schemas/Component_AggregatedCredentialReceivedEventInfo" + "$ref" : "#/components/schemas/TokenUsageStats" }, "nullable" : true } } }, - "Component_FindMinimalStateAccessControlledDoorsByLocationWSRequest" : { + "Chatbot_InterruptChatWSRequest" : { "type" : "object", + "description" : "Request object for interrupting a chat record.", "properties" : { - "lastEvaluatedKey" : { + "recordUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "locationUuid" : { + } + }, + "required" : [ "recordUuid" ] + }, + "Chatbot_ShareAutomatedPromptResponseWSRequest" : { + "type" : "object", + "description" : "Request object for updating the visibility of an automated prompt response.", + "properties" : { + "chatUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "privacy" : { + "$ref" : "#/components/schemas/ChatPrivacy" } - } + }, + "required" : [ "chatUuid", "privacy" ] }, - "Component_FindMinimalStateAccessControlledDoorsByLocationWSResponse" : { + "Chatbot_SubmitChatWSRequest" : { "type" : "object", + "description" : "Request object for submitting a query to Rhombus MIND.", "properties" : { - "accessControlledDoors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Component_MinimalStateAccessControlledDoor" - }, + "contextId" : { + "type" : "string", + "description" : "Uuid used to track the current conversation with Rhombus MIND.", "nullable" : true }, - "lastEvaluatedKey" : { + "conversationName" : { + "type" : "string", + "description" : "The name of the conversation if this query is the start of a new conversation. If not specified, the conversation will be named after the first query.", + "nullable" : true + }, + "query" : { "type" : "string", + "description" : "The query to submit to Rhombus MIND.", + "nullable" : true + }, + "voiceMode" : { + "type" : "boolean", + "description" : "Whether the query was submitted via voice mode.", "nullable" : true } - } + }, + "required" : [ "contextId", "query" ] }, - "Component_FindMinimalStateAccessControlledDoorsWSRequest" : { + "Chatbot_SubmitChatWSResponse" : { "type" : "object", + "description" : "Response object for submitting a query to Rhombus MIND.", + "nullable" : true, "properties" : { - "lastEvaluatedKey" : { + "chatRecordUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindMinimalStateAccessControlledDoorsWSResponse" : { + "Chatbot_SubmitCreateReportWSRequest" : { "type" : "object", + "description" : "Request object for submitting a report query to Rhombus MIND.", "properties" : { - "accessControlledDoors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Component_MinimalStateAccessControlledDoor" - }, + "contextId" : { + "type" : "string", + "description" : "Uuid used to track the current conversation with Rhombus MIND.", "nullable" : true }, - "lastEvaluatedKey" : { + "conversationName" : { + "type" : "string", + "description" : "The name of the conversation if this query is the start of a new conversation. If not specified, the conversation will be named after the first query.", + "nullable" : true + }, + "query" : { "type" : "string", + "description" : "The query to submit to Rhombus MIND.", "nullable" : true } - } + }, + "required" : [ "contextId", "query" ] }, - "Component_FindPaginatedComponentEventsByAccessControlledDoorWSRequest" : { + "Chatbot_SubmitCreateReportWSResponse" : { "type" : "object", + "description" : "Response object for submitting a report query to Rhombus MIND.", "properties" : { - "accessControlledDoorUuid" : { + "chatRecordUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Chatbot_SubmitFillFormWSRequest" : { + "type" : "object", + "description" : "Request object for asking Rhombus MIND to fill in a form the user already has open.", + "properties" : { + "contextId" : { + "type" : "string", + "description" : "Uuid used to track the current exchange with Rhombus MIND. Refinements to the same form should reuse it so MIND can tell which fields the latest instruction is about.", "nullable" : true }, - "reverseSearch" : { - "type" : "boolean", + "conversationName" : { + "type" : "string", + "description" : "The name of the conversation if this fill is the start of a new conversation. If not specified, the conversation will be named after the first query.", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "query" : { + "type" : "string", + "description" : "What the user asked for, in their own words.", "nullable" : true }, - "userFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "target" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The form to fill: its id, title, the exact fields MIND may fill, and any values the form already holds. MIND may only fill fields declared here.", "nullable" : true }, + "description" : "The form to fill: its id, title, the exact fields MIND may fill, and any values the form already holds. MIND may only fill fields declared here.", "nullable" : true } - } + }, + "required" : [ "contextId", "query", "target" ] }, - "Component_FindPaginatedComponentEventsByAccessControlledDoorWSResponse" : { + "Chatbot_SubmitFillFormWSResponse" : { "type" : "object", - "description" : "Request object for getting list of component events for the specified door with pagination support.", + "description" : "Response object for asking Rhombus MIND to fill in a form.", "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, + "chatRecordUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastEvaluatedKey" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_FindPaginatedComponentEventsWSRequest" : { + "Chatbot_SubmitTestPromptWSRequest" : { "type" : "object", - "description" : "Request object for getting list of component events in organization with pagination support.", + "description" : "Request object for submitting a test prompt with Rhombus MIND.", "properties" : { - "componentCompositeFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "responseTemplate" : { + "type" : "string", + "description" : "Template for Rhombus MIND to follow when generating a response.", "nullable" : true }, - "lastEvaluatedKey" : { + "testPrompt" : { "type" : "string", + "description" : "Prompt to test with Rhombus MIND.", "nullable" : true - }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + } + }, + "required" : [ "testPrompt" ] + }, + "Chatbot_SubmitTestPromptWSResponse" : { + "type" : "object", + "description" : "Response object for submitting a test prompt with Rhombus MIND.", + "properties" : { + "chatUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "reverseSearch" : { + "error" : { "type" : "boolean", "nullable" : true }, - "typeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userFilter" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_FindPaginatedComponentEventsWSResponse" : { + "Chatbot_UpdateAutomatedPromptWSRequest" : { "type" : "object", - "description" : "Request object for getting list of component events in organization with pagination support.", + "description" : "Request object for updating chatbot automation settings.", "properties" : { - "componentEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, - "nullable" : true - }, - "lastEvaluatedKey" : { - "type" : "string", - "nullable" : true + "selectiveUpdate" : { + "$ref" : "#/components/schemas/AutomatedPrompt" } - } + }, + "required" : [ "selectiveUpdate" ] }, - "Component_GetAccessControlledDoorLabelsForOrgWSRequest" : { - "type" : "object" + "Chatbot_UpdateChatRecordWSRequest" : { + "type" : "object", + "description" : "Request object for selectively updating a chat record.", + "properties" : { + "chat" : { + "$ref" : "#/components/schemas/ChatRecord" + } + }, + "required" : [ "chat" ] }, - "Component_GetAccessControlledDoorLabelsForOrgWSResponse" : { + "Chatbot_UpdateChatbotConfigWSRequest" : { "type" : "object", + "description" : "Request object for updating Rhombus MIND config.", "properties" : { - "accessControlledDoorLabels" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "nullable" : true + "config" : { + "$ref" : "#/components/schemas/ChatbotConfig" } - } + }, + "required" : [ "config" ] }, - "Component_GetAccessControlledElevatorLandingLabelsForOrgWSRequest" : { - "type" : "object" + "Chatbot_UpdateChatbotConversationWSRequest" : { + "type" : "object", + "description" : "Request object for selectively updating a user's conversation with Rhombus MIND.", + "properties" : { + "selectiveUpdate" : { + "$ref" : "#/components/schemas/ContextRecordSelectiveUpdate" + } + } }, - "Component_GetAccessControlledElevatorLandingLabelsForOrgWSResponse" : { + "Chatbot_UpdateChatbotConversationsWSResponse" : { "type" : "object", + "description" : "Response object for updating a user's conversation with Rhombus MIND.", "properties" : { - "accessControlledElevatorLandingLabels" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, + "conversation" : { + "$ref" : "#/components/schemas/ContextRecord" + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_GetCurrentExpectedAccessControlledDoorStateWSRequest" : { + "Chatbot_VerifyJobScheduledWSRequest" : { "type" : "object", - "description" : "Determines the expected door state based on the current time and current door configuration", + "description" : "Request object for rescheduling an automated prompt that became inactive.", "properties" : { - "accessControlledDoorUuid" : { + "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -66594,133 +68122,156 @@ "nullable" : true } }, - "required" : [ "accessControlledDoorUuid" ] + "required" : [ "promptUuid" ] }, - "Component_GetCurrentExpectedAccessControlledDoorStateWSResponse" : { + "Chatbot_VerifyJobScheduledWSResponse" : { "type" : "object", + "description" : "Response object for rescheduling an automated prompt that became inactive.", "properties" : { - "activeDoorState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "activeDoorStateSource" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" - }, - "defaultDoorStateSource" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" - }, - "defaultState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "doorStateIfFirstInRequired" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "doorStateIfFirstInSatisfied" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "doorStateSourceIfFirstInRequired" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + "error" : { + "type" : "boolean", + "nullable" : true }, - "doorStateSourceIfFirstInSatisfied" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "firstInRequirementEnabled" : { - "type" : "boolean", + "scheduleExpression" : { + "type" : "string", + "description" : "Schedule expression when this automated prompt will trigger.", "nullable" : true }, - "firstInRequirementSatisfied" : { - "type" : "boolean", + "scheduleTimezone" : { + "type" : "string", + "description" : "Timezone the schedule expression is in.", "nullable" : true }, - "nextNearestSchedule" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeNextNearestSchedule" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_GetCurrentExpectedAccessControlledElevatorLandingStateWSRequest" : { + "Chatbot_report_AddAIReportTimelineEventWSRequest" : { "type" : "object", - "description" : "Determines the expected access state based on the current time and current elevator landing configuration", + "description" : "Request object for adding a timeline event to an AI report", "properties" : { - "accessControlledElevatorLandingUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/QueryStatusEnum" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds for the timeline event", + "nullable" : true } - }, - "required" : [ "accessControlledElevatorLandingUuid" ] + } }, - "Component_GetCurrentExpectedAccessControlledElevatorLandingStateWSResponse" : { + "Chatbot_report_BaseAIReportGroupWSResponse" : { "type" : "object", + "description" : "Response object for retrieving or updating an AI report group", "properties" : { - "accessStateIfFirstInRequired" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "accessStateIfFirstInSatisfied" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "accessStateSourceIfFirstInRequired" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" - }, - "accessStateSourceIfFirstInSatisfied" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" - }, - "activeAccessState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "activeAccessStateSource" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + "error" : { + "type" : "boolean", + "nullable" : true }, - "defaultDoorStateSource" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "defaultState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + "group" : { + "$ref" : "#/components/schemas/AIReportGroup" }, - "firstInRequirementEnabled" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Chatbot_report_BaseAIReportWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving or updating an AI report", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "firstInRequirementSatisfied" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "nextNearestSchedule" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeNextNearestSchedule" + "report" : { + "$ref" : "#/components/schemas/AIReport" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_GetFullAccessControlledDoorShadowWSRequest" : { + "Chatbot_report_CreateReportWSRequest" : { "type" : "object", + "description" : "Request object for generating an AI report.", "properties" : { - "accessControlledDoorUuid" : { + "params" : { + "$ref" : "#/components/schemas/AIReportGenerateParams" + }, + "privacy" : { + "$ref" : "#/components/schemas/ChatPrivacy" + } + }, + "required" : [ "params", "privacy" ] + }, + "Chatbot_report_CreateReportWSResponse" : { + "type" : "object", + "description" : "Response object for generating an AI report.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_GetFullAccessControlledDoorShadowWSResponse" : { + "Chatbot_report_DeleteAIReportGroupWSRequest" : { "type" : "object", + "description" : "Request object for deleting an AI report group", "properties" : { - "doorComponentShadowMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ComponentShadowType" - }, + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "doorShadow" : { - "$ref" : "#/components/schemas/AccessControlledDoorShadow" } } }, - "Component_GetOrCreateDevicePhysicalPortConfigWSRequest" : { + "Chatbot_report_DeleteAIReportWSRequest" : { "type" : "object", + "description" : "Request object for deleting an AI report", "properties" : { - "ownerDeviceUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -66729,1629 +68280,1406 @@ } } }, - "Component_GetOrCreateDevicePhysicalPortConfigWSResponse" : { + "Chatbot_report_GetAIReportGroupsByOrgWSRequest" : { "type" : "object", + "description" : "Request object for retrieving AI report groups by organization", "properties" : { - "detectedInvalidPortConfigs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InvalidPhysicalPortConfigType" - }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + } + }, + "Chatbot_report_GetAIReportGroupsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving AI report groups by organization UUID", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceComponents" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "groups" : { "type" : "array", + "description" : "List of AI reports", "items" : { - "$ref" : "#/components/schemas/BaseComponentType" + "$ref" : "#/components/schemas/AIReportGroup" }, "nullable" : true }, - "devicePhysicalPortConfig" : { - "$ref" : "#/components/schemas/DevicePhysicalPortConfigType" + "lastEvaluatedKey" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Component_MinimalStateAccessControlledDoor" : { + "Chatbot_report_GetAIReportWSRequest" : { "type" : "object", + "description" : "Request object for retrieving an AI report", "properties" : { - "door" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, - "shadow" : { - "$ref" : "#/components/schemas/AccessControlledDoorShadow" + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Component_RemoveAccessControlledDoorLabelWSRequest" : { + "Chatbot_report_GetAIReportsByGroupWSRequest" : { "type" : "object", + "description" : "Request object for retrieving AI reports by group", "properties" : { - "accessControlledDoorUuid" : { + "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "label" : { - "type" : "string", - "nullable" : true + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" } } }, - "Component_RemoveAccessControlledDoorLabelWSResponse" : { - "type" : "object" - }, - "Component_RemoveAccessControlledElevatorLandingLabelWSRequest" : { + "Chatbot_report_GetAIReportsByGroupWSResponse" : { "type" : "object", + "description" : "Response object for retrieving AI reports by group", "properties" : { - "accessControlledElevatorLandingUuid" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "label" : { + "lastEvaluatedKey" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "reports" : { + "type" : "array", + "description" : "List of AI reports", + "items" : { + "$ref" : "#/components/schemas/AIReport" + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Component_RemoveAccessControlledElevatorLandingLabelWSResponse" : { - "type" : "object" + "Chatbot_report_GetAIReportsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving AI reports by organization", + "properties" : { + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + } }, - "Component_UpdateAccessControlledDoorWSRequest" : { + "Chatbot_report_GetAIReportsByOrgWSResponse" : { "type" : "object", + "description" : "Response object for retrieving AI reports by organization", "properties" : { - "accessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "ajarTimeSec" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "lastEvaluatedKey" : { + "$ref" : "#/components/schemas/DynamoPageRequest" }, - "associatedFaceDetectionCameras" : { + "reports" : { "type" : "array", + "description" : "List of AI reports", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/AIReport" }, - "nullable" : true, - "uniqueItems" : true - }, - "defaultState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "directionRadians" : { - "type" : "number", - "format" : "float", "nullable" : true }, - "doorStateToScheduleUuidMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "dpiComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Chatbot_report_UpdateAIReportWSRequest" : { + "type" : "object", + "description" : "Request object for updating an AI report", + "properties" : { + "report" : { + "$ref" : "#/components/schemas/AIReport" + } + } + }, + "CheckCondition" : { + "type" : "object", + "nullable" : true, + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/OPERATOREnum" }, - "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { - "type" : "boolean", + "value" : { + "type" : "string", "nullable" : true - }, - "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + } + } + }, + "ClaimKey" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "entry" : { + "$ref" : "#/components/schemas/ClaimKeyEntry" + }, + "migratedRenewal" : { + "type" : "boolean", + "nullable" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "claimEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", "nullable" : true }, - "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "claimStartDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date/time when claiming of licenses represented by this claim key started.", "nullable" : true }, - "forcedOpenEnabled" : { - "type" : "boolean", + "createdOn" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "forcedOpenTimeSec" : { - "type" : "integer", - "format" : "int32", + "endDate" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "geofenceEnabled" : { - "type" : "boolean", - "nullable" : true + "expirationEmailState" : { + "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" }, - "geofenceRadius" : { - "type" : "number", - "format" : "double", + "gracePeriodEndDate" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", + "maskedClaimCode" : { + "type" : "string", + "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "ownerOrgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuid" : { + "renewedByClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "proximityUnlockSettings" : { - "$ref" : "#/components/schemas/ProximityUnlockSettingsType" - }, - "readerComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true + "requestId" : { + "type" : "string", + "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", + "nullable" : true }, - "relayComponents" : { + "returnHistory" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" + "$ref" : "#/components/schemas/ClaimKeyReturnEvent" }, - "nullable" : true, - "uniqueItems" : true - }, - "relockAfterOpenTimeMs" : { - "type" : "integer", - "format" : "int32", "nullable" : true }, - "remoteUnlockEnabled" : { + "state" : { + "$ref" : "#/components/schemas/ClaimKeyStateEnum" + }, + "trial" : { "type" : "boolean", "nullable" : true }, - "rexComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true + "type" : { + "$ref" : "#/components/schemas/ClaimKeyTypeEnum" }, - "unlockTimeSec" : { - "type" : "integer", - "format" : "int32", + "updatedOn" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "unlockTimeSecRex" : { - "type" : "integer", - "format" : "int32", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "waveToUnlockSettings" : { - "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, - "Component_UpdateAccessControlledDoorWSResponse" : { + "ClaimKeyEntry" : { "type" : "object", + "nullable" : true, "properties" : { - "accessControlledDoor" : { - "$ref" : "#/components/schemas/AccessControlledDoorType" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "productQuantities" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "nullable" : true } } }, - "Component_UpdateAccessControlledElevatorLandingWSRequest" : { + "ClaimKeyExpirationEmailStateEnum" : { + "type" : "string", + "enum" : [ "NINETY_DAY_EMAIL_SUCCEEDED", "NINETY_DAY_EMAIL_FAILED", "SIXTY_DAY_EMAIL_SUCCEEDED", "SIXTY_DAY_EMAIL_FAILED", "FOURTY_FIVE_DAY_EMAIL_SUCCEEDED", "FOURTY_FIVE_DAY_EMAIL_FAILED", "THIRTY_DAY_EMAIL_SUCCEEDED", "THIRTY_DAY_EMAIL_FAILED", "TWENTY_ONE_DAY_EMAIL_SUCCEEDED", "TWENTY_ONE_DAY_EMAIL_FAILED", "FOURTEEN_DAY_EMAIL_SUCCEEDED", "FOURTEEN_DAY_EMAIL_FAILED", "TEN_DAY_EMAIL_SUCCEEDED", "TEN_DAY_EMAIL_FAILED", "FIVE_DAY_EMAIL_SUCCEEDED", "FIVE_DAY_EMAIL_FAILED", "FOUR_DAY_EMAIL_SUCCEEDED", "FOUR_DAY_EMAIL_FAILED", "THREE_DAY_EMAIL_SUCCEEDED", "THREE_DAY_EMAIL_FAILED", "TWO_DAY_EMAIL_SUCCEEDED", "TWO_DAY_EMAIL_FAILED", "ONE_DAY_EMAIL_SUCCEEDED", "ONE_DAY_EMAIL_FAILED", "ZERO_DAY_EMAIL_SUCCEEDED", "ZERO_DAY_EMAIL_FAILED", "GRACE_PERIOD_EMAILS_IN_PROGRESS", "GRACE_PERIOD_EMAILS_COMPLETED", "UNKNOWN" ] + }, + "ClaimKeyReturnEvent" : { "type" : "object", "properties" : { - "accessControlledElevatorLandingUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "accessStateToScheduleUuidMap" : { + "returnedProductQuantities" : { "type" : "object", "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : "integer", + "format" : "int32", "nullable" : true }, "nullable" : true }, - "associatedCameras" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + } + } + }, + "ClaimKeySearchFilter" : { + "type" : "object", + "properties" : { + "excludeUnclaimed" : { + "type" : "boolean", + "nullable" : true + }, + "excludedStates" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/ClaimKeyStateEnum" }, "nullable" : true, "uniqueItems" : true }, - "associatedFaceDetectionCameras" : { + "includedStates" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/ClaimKeyStateEnum" }, "nullable" : true, "uniqueItems" : true - }, - "defaultAccessState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "geofenceEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "geofenceRadius" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "remoteUnlockEnabled" : { - "type" : "boolean", - "nullable" : true } } }, - "Component_UpdateAccessControlledElevatorLandingWSResponse" : { + "ClaimKeyStateEnum" : { + "type" : "string", + "enum" : [ "CREATED", "CLAIMING_PENDING", "CLAIMING_IN_PROGRESS", "CLAIMING_FAILED", "CLAIMED", "EXPIRED_UNCLAIMED", "EXPIRED", "RETURNED", "RENEWED" ] + }, + "ClaimKeyTypeEnum" : { + "type" : "string", + "enum" : [ "NEW", "RENEWAL" ] + }, + "ClientEnum" : { + "type" : "string", + "enum" : [ "DEVICE", "MOBILE", "BROWSER", "BROWSER_V2", "BROWSER_PARTNER", "MOBILE_PARTNER", "ANONYMOUS", "SHARE_ANONYMOUS", "SHARE_ANONYMOUS_V2", "SHARE_RAW", "SHARE_SSO", "TV_API", "DOOR_STATION_API", "API", "API_TOKEN", "API_OAUTH_TOKEN", "FEDERATED_TOKEN", "PARTNER_API", "PARTNER_API_TOKEN", "PARTNER_API_OAUTH_TOKEN", "KEYPAD_API", "INTERNAL_SALESFORCE", "RHOMBUS_KEY_MOBILE", "KIOSK_CONSOLE", "KIOSK_IOS_API", "CHATBOT" ] + }, + "ClimateActivityEventType" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "climateThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "accessControlledElevatorLanding" : { - "$ref" : "#/components/schemas/AccessControlledElevatorLanding" - }, - "error" : { - "type" : "boolean", + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "ClimateEventType" : { + "type" : "object", + "description" : "List of climate events for the sensor", + "properties" : { + "alertActivities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, "nullable" : true }, - "errorMsg" : { + "baseStationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "batteryPercentage" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Component_UpdateAccessControlledElevatorWSRequest" : { - "type" : "object", - "properties" : { - "accessControlledElevatorUuid" : { + }, + "bleDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "bleRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "associatedFaceDetectionCameras" : { + "closeBaseStations" : { "type" : "array", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "directionRadians" : { + "co2" : { "type" : "number", "format" : "float", "nullable" : true }, - "elevatorLandingReferenceUpdates" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ElevatorLandingReference" - }, + "ethanol" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "elevatorLandingReferences" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ElevatorLandingReference" - }, + "heatIndexDegF" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true + "heatIndexRangeWarning" : { + "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" }, - "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { - "type" : "boolean", + "humidity" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "iaq" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "geofenceEnabled" : { - "type" : "boolean", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "geofenceRadius" : { + "pm25" : { "type" : "number", - "format" : "double", + "format" : "float", "nullable" : true }, - "latitude" : { + "probeTempC" : { "type" : "number", - "format" : "double", + "format" : "float", "nullable" : true }, - "longitude" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "tampered" : { + "type" : "boolean", + "nullable" : true + }, + "temp" : { "type" : "number", - "format" : "double", + "format" : "float", "nullable" : true }, - "name" : { - "type" : "string", + "thcDetected" : { + "type" : "boolean", "nullable" : true }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "thcPercent" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "proximityUnlockSettings" : { - "$ref" : "#/components/schemas/ProximityUnlockSettingsType" + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "readerComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true + "tvoc" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "remoteUnlockEnabled" : { + "vapeSmokeDetected" : { "type" : "boolean", "nullable" : true }, - "unlockTimeSec" : { - "type" : "integer", - "format" : "int32", + "vapeSmokePercent" : { + "type" : "number", + "format" : "float", "nullable" : true - }, - "waveToUnlockSettings" : { - "$ref" : "#/components/schemas/WaveToUnlockSettingsType" } } }, - "Component_UpdateAccessControlledElevatorWSResponse" : { + "ClimatePolicyType" : { "type" : "object", + "description" : "List of climate policies using the schedule", "properties" : { - "accessControlledElevator" : { - "$ref" : "#/components/schemas/AccessControlledElevator" - }, - "error" : { - "type" : "boolean", + "backoffAlertSecs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { + "defaultTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClimateTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "name" : { "type" : "string", "nullable" : true - } - } - }, - "Component_UpdateIntegratedDoorPositionIndicatorWSRequest" : { - "type" : "object", - "properties" : { - "componentUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { - "type" : "string", + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClimateScheduledTriggerType" + }, "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" - }, - "port" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" - } - } - }, - "Component_UpdateIntegratedDoorPositionIndicatorWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" - } - } - }, - "Component_UpdateIntegratedDoorRelayWSRequest" : { - "type" : "object", - "properties" : { - "componentUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "port" : { - "$ref" : "#/components/schemas/DoorRelayPortType" } } }, - "Component_UpdateIntegratedDoorRelayWSResponse" : { + "ClimateScheduledTriggerType" : { "type" : "object", "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedDoorRelayType" + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClimateTriggerType" + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Component_UpdateIntegratedGenericButtonWSRequest" : { + "ClimateSettings" : { "type" : "object", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "alert_window_minutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "mode" : { - "$ref" : "#/components/schemas/ButtonModeEnum" + "smoke_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "name" : { - "type" : "string", + "thc_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/ButtonPortType" - } - } - }, - "Component_UpdateIntegratedGenericButtonWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericButtonType" + "vape_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true } } }, - "Component_UpdateIntegratedGenericInputWSRequest" : { + "ClimateSettingsSelectiveUpdate" : { "type" : "object", + "description" : "Update Sensor Climate settings", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "alert_window_minutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "name" : { - "type" : "string", + "smoke_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" + "thc_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/AuxiliaryInputPortType" + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true + }, + "vape_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true } } }, - "Component_UpdateIntegratedGenericInputWSResponse" : { + "ClimateTriggerType" : { "type" : "object", "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericInputType" + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true } } }, - "Component_UpdateIntegratedGenericRelaySteadyStateWSRequest" : { + "Climate_ClimateHealthDetailsEnum" : { + "type" : "string", + "description" : "Detailed health status enumeration for climate sensors.", + "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] + }, + "Climate_ClimateHealthEnum" : { + "type" : "string", + "description" : "Health status enumeration for climate sensors.", + "enum" : [ "GREEN", "RED" ] + }, + "Climate_DeleteEnvironmentalGatewayWSRequest" : { "type" : "object", + "description" : "Request to delete an environmental gateway.", "properties" : { - "componentUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "steadyState" : { - "$ref" : "#/components/schemas/GenericRelayStateEnumType" - } - } - }, - "Component_UpdateIntegratedGenericRelaySteadyStateWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericRelayType" + "mummify" : { + "type" : "boolean", + "description" : "Whether to mummify the gateway instead of deleting it", + "example" : false, + "nullable" : true } } }, - "Component_UpdateIntegratedGenericRelayTransientStateWSRequest" : { + "Climate_DeleteEnvironmentalGatewayWSResponse" : { "type" : "object", + "description" : "Response indicating the result of deleting an environmental gateway.", "properties" : { - "activate" : { + "error" : { "type" : "boolean", "nullable" : true }, - "componentUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" }, - "deviceUuid" : { + "warningMsg" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "durationMs" : { - "type" : "integer", - "format" : "int32", "nullable" : true } } }, - "Component_UpdateIntegratedGenericRelayTransientStateWSResponse" : { + "Climate_GetClimateEventsForSensorWSRequest" : { "type" : "object", + "description" : "Request to retrieve climate events for an environmental sensor.", "properties" : { - "success" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds after which events should be retrieved", + "example" : 1640991600000, "nullable" : true - } - } - }, - "Component_UpdateIntegratedGenericRelayWSRequest" : { - "type" : "object", - "properties" : { - "componentUuid" : { + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds before which events should be retrieved", + "example" : 1640995200000, + "nullable" : true + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of events to return", + "example" : 100, + "nullable" : true + }, + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "port" : { - "$ref" : "#/components/schemas/AuxiliaryRelayPortType" - } - } - }, - "Component_UpdateIntegratedGenericRelayWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedGenericRelayType" } } }, - "Component_UpdateIntegratedRequestToExitWSRequest" : { + "Climate_GetClimateEventsForSensorWSResponse" : { "type" : "object", + "description" : "Response containing climate events for an environmental sensor.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "climateEvents" : { + "type" : "array", + "description" : "List of climate events for the sensor", + "items" : { + "$ref" : "#/components/schemas/ClimateEventType" + }, "nullable" : true }, - "intentOnly" : { + "error" : { "type" : "boolean", "nullable" : true }, - "intentOnlyEvents" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" - }, - "port" : { - "$ref" : "#/components/schemas/RequestToExitPortType" - } - } - }, - "Component_UpdateIntegratedRequestToExitWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/IntegratedRequestToExitType" } } }, - "Component_UpdateOsdpReaderWSRequest" : { + "Climate_GetClimateSensorConfigWSRequest" : { "type" : "object", + "description" : "Request to retrieve configuration for an environmental sensor.", "properties" : { - "componentUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Climate_GetClimateSensorConfigWSResponse" : { + "type" : "object", + "description" : "Response containing configuration for an environmental sensor.", + "properties" : { + "config" : { + "$ref" : "#/components/schemas/IClimateUserConfig" }, - "disableCardReader" : { - "type" : "boolean", - "nullable" : true - }, - "disableKeypad" : { + "error" : { "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "port" : { - "$ref" : "#/components/schemas/OsdpReaderPortType" - }, - "remoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_UpdateOsdpReaderWSResponse" : { + "Climate_GetEnvironmentalGatewayShadowsWSRequest" : { "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/OsdpDoorReaderType" - } - } + "description" : "Request to retrieve environmental gateway shadows." }, - "Component_UpdateRhombusOsdpReaderWSRequest" : { + "Climate_GetEnvironmentalGatewayShadowsWSResponse" : { "type" : "object", + "description" : "Response containing environmental gateway shadows.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "disableCardReader" : { - "type" : "boolean", + "environmentalGatewayShadows" : { + "type" : "array", + "description" : "List of environmental gateway shadows", + "items" : { + "$ref" : "#/components/schemas/EnvironmentalGatewayShadowType" + }, "nullable" : true }, - "disableWaveToUnlock" : { + "error" : { "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "port" : { - "$ref" : "#/components/schemas/OsdpReaderPortType" - }, - "remoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Component_UpdateRhombusOsdpReaderWSResponse" : { - "type" : "object", - "properties" : { - "component" : { - "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" - } - } - }, - "Component_UpdateWiegandReaderWSRequest" : { + "Climate_GetEventsForEnvironmentalGatewayWSRequest" : { "type" : "object", + "description" : "Request to retrieve events for an environmental gateway.", "properties" : { - "buzzerPort" : { - "$ref" : "#/components/schemas/WiegandOutputPortType" + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds after which events should be retrieved", + "example" : 1640991600000, + "nullable" : true }, - "componentUuid" : { + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds before which events should be retrieved", + "example" : 1640995200000, + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "csnEndian" : { - "$ref" : "#/components/schemas/WiegandCredentialEndianEnumType" - }, - "d0Port" : { - "$ref" : "#/components/schemas/WiegandDataPortType" - }, - "d1Port" : { - "$ref" : "#/components/schemas/WiegandDataPortType" - }, - "disableCardReader" : { - "type" : "boolean", - "nullable" : true - }, - "disableKeypad" : { - "type" : "boolean", - "nullable" : true - }, - "gledPort" : { - "$ref" : "#/components/schemas/WiegandOutputPortType" - }, - "name" : { + "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "remoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to return per page", + "example" : 50, "nullable" : true - }, - "rledPort" : { - "$ref" : "#/components/schemas/WiegandOutputPortType" - }, - "tamperPort" : { - "$ref" : "#/components/schemas/WiegandInputPortType" } } }, - "Component_UpdateWiegandReaderWSResponse" : { + "Climate_GetEventsForEnvironmentalGatewayWSResponse" : { "type" : "object", + "description" : "Response containing events for an environmental gateway.", "properties" : { - "component" : { - "$ref" : "#/components/schemas/WiegandDoorReaderType" + "events" : { + "type" : "array", + "description" : "List of climate events for the environmental gateway", + "items" : { + "$ref" : "#/components/schemas/E50ClimateEventType" + }, + "nullable" : true + }, + "lastEvaluatedKey" : { + "type" : "string", + "nullable" : true } } }, - "ConnectAudioDeviceToPhoneNumberActionType" : { + "Climate_GetMinimalClimateStatesWSRequest" : { + "type" : "object", + "description" : "Request to retrieve minimal climate state information for all environmental sensors." + }, + "Climate_GetMinimalClimateStatesWSResponse" : { "type" : "object", + "description" : "Response containing minimal climate state information for environmental sensors.", "properties" : { - "audioDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "climateStates" : { + "type" : "array", + "description" : "List of minimal climate state information", + "items" : { + "$ref" : "#/components/schemas/Climate_MinimalClimateStateType" + }, "nullable" : true }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "doorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "optionalGreeting" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "phoneNumber" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "ConnectionStatusEnum" : { - "type" : "string", - "enum" : [ "ONLINE", "OFFLINE", "UNKNOWN" ] - }, - "ConnectivityStatus" : { - "type" : "string", - "description" : "Current connection status of the shared camera", - "enum" : [ "GREEN", "RED" ] + "Climate_GetMinimalEnvironmentalGatewayStatesWSRequest" : { + "type" : "object", + "description" : "Request to retrieve minimal environmental gateway states." }, - "Consignee" : { + "Climate_GetMinimalEnvironmentalGatewayStatesWSResponse" : { "type" : "object", + "description" : "Response containing minimal environmental gateway states.", "properties" : { - "address1" : { - "type" : "string", - "nullable" : true - }, - "address2" : { - "type" : "string", - "nullable" : true - }, - "address3" : { - "type" : "string", - "nullable" : true - }, - "city" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "companyName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "contactName" : { + "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, - "country" : { - "type" : "string", + "minimalEnvironmentalGatewayStates" : { + "type" : "array", + "description" : "List of minimal environmental gateway states", + "items" : { + "$ref" : "#/components/schemas/Climate_MinimalEnvironmentalGatewayStateType" + }, "nullable" : true }, - "phoneNumber" : { - "type" : "string", - "nullable" : true - }, - "postalCode" : { - "type" : "string", - "nullable" : true - }, - "state" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "ContentDisposition" : { + "Climate_MinimalClimateStateType" : { "type" : "object", + "description" : "Minimal climate state information for environmental sensors.", "properties" : { - "attachment" : { - "type" : "boolean", + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device facet UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "charset" : { - "type" : "object", - "nullable" : true, - "properties" : { - "registered" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "creationDate" : { - "type" : "string", - "format" : "date-time", + "batteryPercent" : { + "type" : "integer", + "format" : "int32", + "description" : "Battery percentage of the environmental sensor", + "example" : 85, "nullable" : true }, - "filename" : { - "type" : "string", + "calibrating" : { + "type" : "boolean", + "description" : "Whether the sensor is currently calibrating", + "example" : false, "nullable" : true }, - "formData" : { - "type" : "boolean", + "closestBaseStation" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "inline" : { - "type" : "boolean", + "co2" : { + "type" : "number", + "format" : "float", + "description" : "CO2 measurement", + "example" : 450.0, "nullable" : true }, - "modificationDate" : { - "type" : "string", - "format" : "date-time", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Creation timestamp in milliseconds", + "example" : 1640995200000, "nullable" : true }, - "name" : { - "type" : "string", + "ethanol" : { + "type" : "number", + "format" : "float", + "description" : "Ethanol measurement", + "example" : 5.2, "nullable" : true }, - "readDate" : { + "firmwareVersion" : { "type" : "string", - "format" : "date-time", + "description" : "Firmware version", + "example" : "1.2.3", "nullable" : true }, - "size" : { + "floorNumber" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Floor number", + "example" : 2, "nullable" : true }, - "type" : { - "type" : "string", + "health" : { + "$ref" : "#/components/schemas/Climate_ClimateHealthEnum" + }, + "healthDetails" : { + "$ref" : "#/components/schemas/Climate_ClimateHealthDetailsEnum" + }, + "heatIndexDegF" : { + "type" : "number", + "format" : "double", + "description" : "Heat index in degrees Fahrenheit", + "example" : 85.2, "nullable" : true - } - } - }, - "ContextRecord" : { - "type" : "object", - "properties" : { - "automated" : { - "type" : "boolean", + }, + "heatIndexRangeWarning" : { + "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" + }, + "humidity" : { + "type" : "number", + "format" : "float", + "description" : "Relative humidity percentage", + "example" : 45.2, "nullable" : true }, - "contextId" : { - "type" : "string", + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "iaq" : { + "type" : "number", + "format" : "float", + "description" : "Indoor Air Quality index", + "example" : 85.5, "nullable" : true }, - "expiresAtMs" : { + "lastSeenSec" : { "type" : "integer", "format" : "int64", + "description" : "Last seen timestamp in seconds", + "example" : 1640995200, "nullable" : true }, - "name" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate", + "example" : 37.7749, "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "principalUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate", + "example" : -122.4194, "nullable" : true }, - "queriedAtMs" : { - "type" : "integer", - "format" : "int64", + "name" : { + "type" : "string", + "description" : "Name of the environmental sensor", + "example" : "Office Climate Sensor", "nullable" : true - } - } - }, - "ContextRecordSelectiveUpdate" : { - "type" : "object", - "properties" : { - "realTarget" : { - "$ref" : "#/components/schemas/ContextRecord" }, - "updatedFieldNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "pm25" : { + "type" : "number", + "format" : "float", + "description" : "PM2.5 particulate matter measurement", + "example" : 12.3, "nullable" : true - } - } - }, - "CountingActivityEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "countingThreshold" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" - } - } - }, - "CredentialCapabilityEnum" : { - "type" : "string", - "enum" : [ "MULTI_FACTOR_AUTH", "PASSWORDLESS", "USERNAMELESS" ] - }, - "CredentialEntry" : { - "type" : "object", - "discriminator" : { - "propertyName" : "credSource" - }, - "nullable" : true, - "oneOf" : [ { - "$ref" : "#/components/schemas/CredentialEntryBleWave" - } ], - "properties" : { - "credSource" : { - "$ref" : "#/components/schemas/CredentialSourceEnumType" }, - "credentialId" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firstInEligible" : { + "probeConnected" : { "type" : "boolean", + "description" : "Whether the probe is connected", + "example" : true, "nullable" : true }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - } - } - }, - "CredentialEntryBleWave" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "finalRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "firstRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "firstRssiAtIntentElapsed" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "lostAtIntentElapsed" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "lostAtRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "maxRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "maxRssiAtIntentElapsed" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sessionFirstRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sessionFirstRssiAtElapsed" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sessionLostAtElapsed" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sessionLostAtRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sessionMaxRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "sessionMaxRssiAtElapsed" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "credSource" : { - "$ref" : "#/components/schemas/CredentialSourceEnumType" + "probeTempC" : { + "type" : "number", + "format" : "float", + "description" : "Temperature probe measurement in Celsius", + "example" : 24.1, + "nullable" : true }, - "credentialId" : { + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firstInEligible" : { - "type" : "boolean", + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the environmental sensor", + "example" : "ES-123456789", "nullable" : true }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "Signal strength of the environmental sensor", + "example" : 85, + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "temperatureCelcius" : { + "type" : "number", + "format" : "float", + "description" : "Temperature in Celsius", + "example" : 23.5, + "nullable" : true + }, + "thcPercent" : { + "type" : "number", + "format" : "float", + "description" : "THC percentage measurement", + "example" : 0.8, + "nullable" : true + }, + "tvoc" : { + "type" : "number", + "format" : "float", + "description" : "Total Volatile Organic Compounds (TVOC) measurement", + "example" : 125.5, + "nullable" : true + }, + "vapePercent" : { + "type" : "number", + "format" : "float", + "description" : "Vape percentage measurement", + "example" : 2.1, + "nullable" : true } } }, - "CredentialQueryFilter" : { + "Climate_MinimalEnvironmentalGatewayStateType" : { "type" : "object", - "description" : "Filter criteria for finding credential history", + "description" : "Minimal environmental gateway state information.", "properties" : { - "credTypeFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "lastUsedAccessControlledDoorUuidFilter" : { + "activities" : { "type" : "array", + "description" : "List of detected activities", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/ActivityEnum" }, - "nullable" : true, - "uniqueItems" : true - }, - "lastUsedAfterFilter" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "lastUsedBeforeFilter" : { + "airQualityIndex" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Air quality index value", + "example" : 45, "nullable" : true }, - "lastUsedLocationUuidFilter" : { + "airQualityIndexPollutant" : { + "$ref" : "#/components/schemas/AirQualityIndexPollutantEnum" + }, + "alertTriggers" : { "type" : "array", + "description" : "List of alert triggers", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/ActivityEnum" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "workflowStatusFilter" : { + "associatedCameras" : { "type" : "array", + "description" : "List of associated camera device facet UUIDs", "items" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "CredentialReceivedEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "accessGrantOrRevocationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "activeDoorLockdownState" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" - }, - "activeLockdownPlanUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "appName" : { - "type" : "string", - "nullable" : true - }, - "appOS" : { - "type" : "string", - "nullable" : true - }, - "appVersion" : { - "type" : "string", - "nullable" : true - }, - "authDecisionSource" : { - "$ref" : "#/components/schemas/AuthDecisionSourceEnum" - }, - "authDecisionUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "authWaitTimeMs" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "authWaitTimeMsTotal" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "authenticationResult" : { - "$ref" : "#/components/schemas/AccessControlAuthenticationResultEnumType" - }, - "authorizationResult" : { - "$ref" : "#/components/schemas/AccessControlAuthorizationResultEnumType" - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "credSource" : { - "$ref" : "#/components/schemas/CredentialSourceEnumType" - }, - "credentialHexValue" : { - "type" : "string", - "nullable" : true - }, - "credentialUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "credentialValue" : { - "type" : "string", - "nullable" : true - }, - "credentialValueLengthBits" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "credentials" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CredentialEntry" - }, - "nullable" : true - }, - "deviceModel" : { - "type" : "string", - "nullable" : true - }, - "managedCredentialUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "satisfiesFirstInSettingsUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "userAgent" : { - "type" : "string", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", + "calibrating" : { + "type" : "boolean", + "description" : "Whether the gateway is currently calibrating", + "example" : false, "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "ch2oPpb" : { + "type" : "number", + "format" : "float", + "description" : "Formaldehyde measurement in parts per billion", + "example" : 15.7, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "co2Ppm" : { + "type" : "integer", + "format" : "int32", + "description" : "CO2 measurement in parts per million", + "example" : 450, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "coConcentration" : { + "type" : "number", + "format" : "double", + "description" : "Carbon monoxide concentration", + "example" : 2.1, "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "connected" : { + "type" : "boolean", + "description" : "Whether the gateway is connected", + "example" : true, "nullable" : true }, - "timestampMs" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", + "description" : "Creation timestamp in milliseconds", + "example" : 1640995200000, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "defaultInterfaceMac" : { + "type" : "string", + "description" : "Default interface MAC address", + "example" : "00:1A:2B:3C:4D:5E", + "nullable" : true }, - "uuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "CredentialSourceEnumType" : { - "type" : "string", - "enum" : [ "UNKNOWN", "NFC", "BLE_WAVE", "BLE", "WIEGAND", "REMOTE", "REMOTE_ADMIN", "UNK_3P_OSDP", "APERIO_NFC", "APERIO_LF", "APERIO_KEYPAD", "KEYPAD_WIEGAND", "KEYPAD_OSDP", "BLE_PROX" ] - }, - "CroppedPermyriadRect" : { - "type" : "object", - "properties" : { - "height" : { - "type" : "integer", - "format" : "int32", - "nullable" : true }, - "width" : { - "type" : "integer", - "format" : "int32", + "externalIPAddress" : { + "type" : "string", + "description" : "External IP address", + "example" : "203.0.113.1", "nullable" : true }, - "x" : { - "type" : "integer", - "format" : "int32", + "falsePositiveConfidencePercent" : { + "type" : "number", + "format" : "float", + "description" : "False positive confidence percentage", + "example" : 5.2, "nullable" : true }, - "y" : { - "type" : "integer", - "format" : "int32", + "firmwareVersion" : { + "type" : "string", + "description" : "Firmware version", + "example" : "2.1.5", "nullable" : true - } - } - }, - "CrossingCountsType" : { - "type" : "object", - "description" : "List of crossing counts", - "properties" : { - "egressCount" : { + }, + "floorNumber" : { "type" : "integer", "format" : "int32", + "description" : "Floor number", + "example" : 2, "nullable" : true }, - "ingressCount" : { - "type" : "integer", - "format" : "int32", + "healthDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "heatIndexDegF" : { + "type" : "number", + "format" : "double", + "description" : "Heat index in degrees Fahrenheit", + "example" : 85.2, "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "heatIndexRangeWarning" : { + "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "iaq" : { + "type" : "number", + "format" : "float", + "description" : "Indoor Air Quality index", + "example" : 85.5, "nullable" : true - } - } - }, - "CrossingDirectionEnum" : { - "type" : "string", - "enum" : [ "INGRESS", "EGRESS" ] - }, - "CrossingObjectEnum" : { - "type" : "string", - "enum" : [ "HUMAN", "VEHICLE", "FACE", "LPR", "POSE", "CLIP_EMBED", "UNKNOWN" ] - }, - "CustomCredential" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "bitGroupValues" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "nullable" : true - }, - "customFormatName" : { - "type" : "string", - "nullable" : true - }, - "format" : { - "$ref" : "#/components/schemas/WiegandFormatEnumType" - }, - "naturalId" : { + }, + "lanAddresses" : { + "type" : "array", + "description" : "List of LAN IP addresses", + "items" : { "type" : "string", + "description" : "List of LAN IP addresses", "nullable" : true }, - "numBits" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate", + "example" : 37.7749, "nullable" : true }, - "lastUsedAccessControlledDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "leakDetected" : { + "type" : "boolean", + "description" : "Whether a leak is detected", + "example" : false, "nullable" : true }, - "lastUsedAtMillis" : { - "type" : "integer", - "format" : "int64", + "leakProbePresent" : { + "type" : "boolean", + "description" : "Whether leak probe is present", + "example" : true, "nullable" : true }, - "lastUsedLocationUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lowercaseHexValue" : { - "type" : "string", - "nullable" : true, - "readOnly" : true + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate", + "example" : -122.4194, + "nullable" : true }, - "managedCredUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Name of the environmental gateway", + "example" : "Main Office Gateway", "nullable" : true }, - "note" : { - "type" : "string", + "nc0p5" : { + "type" : "number", + "format" : "float", + "description" : "Number concentration 0.5 measurement", + "example" : 120.5, + "nullable" : true + }, + "nc10p0" : { + "type" : "number", + "format" : "float", + "description" : "Number concentration 10.0 measurement", + "example" : 15.3, + "nullable" : true + }, + "nc1p0" : { + "type" : "number", + "format" : "float", + "description" : "Number concentration 1.0 measurement", + "example" : 85.2, + "nullable" : true + }, + "nc2p5" : { + "type" : "number", + "format" : "float", + "description" : "Number concentration 2.5 measurement", + "example" : 45.8, + "nullable" : true + }, + "nc4p0" : { + "type" : "number", + "format" : "float", + "description" : "Number concentration 4.0 measurement", + "example" : 32.1, + "nullable" : true + }, + "noxIdx" : { + "type" : "number", + "format" : "float", + "description" : "Nitrogen Oxides index", + "example" : 88.2, "nullable" : true }, "orgUuid" : { @@ -68361,133 +69689,166 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", + "pm10p0" : { + "type" : "number", + "format" : "float", + "description" : "PM10.0 particulate matter measurement", + "example" : 18.9, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + "pm1p0" : { + "type" : "number", + "format" : "float", + "description" : "PM1.0 particulate matter measurement", + "example" : 8.5, + "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "pm2p5" : { + "type" : "number", + "format" : "float", + "description" : "PM2.5 particulate matter measurement", + "example" : 12.3, "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "pm4p0" : { + "type" : "number", + "format" : "float", + "description" : "PM4.0 particulate matter measurement", + "example" : 15.7, "nullable" : true }, - "uuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "value" : { - "type" : "string", + "pressure" : { + "type" : "number", + "format" : "float", + "description" : "Pressure measurement", + "example" : 1013.25, "nullable" : true }, - "workflowStatus" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" - } - } - }, - "CustomFootageSeekPointType" : { - "type" : "object", - "description" : "List of custom footage seek points to create", - "properties" : { - "color" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" + "probeTempC" : { + "type" : "number", + "format" : "float", + "description" : "Temperature probe measurement in Celsius", + "example" : 24.5, + "nullable" : true }, - "description" : { + "relHumid" : { + "type" : "number", + "format" : "float", + "description" : "Relative humidity percentage", + "example" : 45.2, + "nullable" : true + }, + "serialNumber" : { "type" : "string", - "description" : "Custom activity display description, maximum 100 characters", - "maxLength" : 100, + "description" : "Serial number of the environmental gateway", + "example" : "EG-123456789", "nullable" : true }, - "displayOverlay" : { - "type" : "boolean", - "description" : "Whether to display this seekpoint as an overlay in Console", + "smokeConfidencePercent" : { + "type" : "number", + "format" : "float", + "description" : "Smoke detection confidence percentage", + "example" : 92.8, "nullable" : true }, - "name" : { + "smokeTobaccoConfidencePercent" : { + "type" : "number", + "format" : "float", + "description" : "Smoke tobacco detection confidence percentage", + "example" : 88.1, + "nullable" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Custom activity display name, maximum 32 characters", - "maxLength" : 32, + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "tempC" : { + "type" : "number", + "format" : "float", + "description" : "Temperature in Celsius", + "example" : 23.5, + "nullable" : true + }, + "tempProbePresent" : { + "type" : "boolean", + "description" : "Whether temperature probe is present", + "example" : true, "nullable" : true }, "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "UNIX MS timestamp", - "minimum" : 0, + "description" : "Timestamp in milliseconds", + "example" : 1640995200000, "nullable" : true - } - }, - "required" : [ "name", "timestampMs" ] - }, - "CustomImageElement" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "height" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "imageUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "width" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, - "x" : { - "type" : "integer", - "format" : "int32", + "typPartSize" : { + "type" : "number", + "format" : "float", + "description" : "Typical particle size measurement", + "example" : 2.8, "nullable" : true }, - "y" : { - "type" : "integer", - "format" : "int32", + "vapeConfidencePercent" : { + "type" : "number", + "format" : "float", + "description" : "Vape detection confidence percentage", + "example" : 85.5, + "nullable" : true + }, + "vapeDetected" : { + "type" : "boolean", + "description" : "Whether vape is detected", + "example" : false, + "nullable" : true + }, + "vapeThcConfidencePercent" : { + "type" : "number", + "format" : "float", + "description" : "Vape THC detection confidence percentage", + "example" : 72.3, + "nullable" : true + }, + "vocIdx" : { + "type" : "number", + "format" : "float", + "description" : "Volatile Organic Compounds index", + "example" : 125.5, "nullable" : true } } }, - "CustomLLMActionType" : { + "Climate_RebootEnvironmentalGatewayWSRequest" : { "type" : "object", + "description" : "Request to reboot an environmental gateway.", "properties" : { - "deviceActivityEvents" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEventData" - }, - "nullable" : true - }, + "environmentalGatewayUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "deviceFacetUuids" : { + } + } + }, + "Climate_UpdateClimateSensorDetailsWSRequest" : { + "type" : "object", + "description" : "Request to update details for an environmental sensor.", + "properties" : { + "associatedCameras" : { "type" : "array", + "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", "format" : "DeviceFacetUuid", @@ -68497,271 +69858,107 @@ }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "associatedCamerasUpdated" : { + "type" : "boolean", "nullable" : true }, - "promptUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "deleted" : { + "type" : "boolean", + "description" : "Whether the environmental sensor is deleted", + "example" : false, "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - }, - "CustomLLMEventRuleTriggerType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "deviceFacetUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true - }, - "promptUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" - } - } - }, - "CustomRuleAction" : { - "type" : "object", - "properties" : { - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "deletedUpdated" : { + "type" : "boolean", "nullable" : true }, - "path" : { + "description" : { "type" : "string", + "description" : "Description of the environmental sensor", + "example" : "Temperature and humidity sensor in main office", "nullable" : true - } - } - }, - "CustomTextElement" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "color" : { - "type" : "string", - "nullable" : true - }, - "content" : { - "type" : "string", - "nullable" : true - }, - "maxWidth" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "style" : { - "type" : "string", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, - "x" : { - "type" : "integer", - "format" : "int32", + "descriptionUpdated" : { + "type" : "boolean", "nullable" : true }, - "y" : { + "floorNumber" : { "type" : "integer", "format" : "int32", - "nullable" : true - } - } - }, - "CustomerShipmentCategoryEnum" : { - "type" : "string", - "enum" : [ "RMA", "PURCHASE_ORDER", "TRIAL", "UNKNOWN" ] - }, - "CustomerShipmentEmailStateEnum" : { - "type" : "string", - "enum" : [ "SHIPPING_CONFIRMATION_SUCCESS", "SHIPPING_CONFIRMATION_FAILURE", "SHIPPING_SHIPPED_SUCCESS", "SHIPPING_SHIPPED_FAILURE", "UNKNOWN" ] - }, - "CustomerShipmentStateEnum" : { - "type" : "string", - "enum" : [ "CREATED", "SHIPPED", "DELIVERED", "RETURN_REGISTERED", "RETURN_SENT", "RETURN_DELIVERED", "COMPLETE", "UNKNOWN" ] - }, - "CustomerShipmentType" : { - "type" : "object", - "description" : "List of customer shipments", - "properties" : { - "ait-aitTrackingNumber" : { - "type" : "string", - "nullable" : true - }, - "ait-carrierTrackingNumber" : { - "type" : "string", - "nullable" : true - }, - "ait-depositorOrderNumber" : { - "type" : "string", - "nullable" : true - }, - "ait-destinationAddress" : { - "type" : "string", + "description" : "Floor number where the environmental sensor is located", + "example" : 1, "nullable" : true }, - "ait-isIngramDistributorShipment" : { + "floorNumberUpdated" : { "type" : "boolean", "nullable" : true }, - "ait-shipmentDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "ait-shippedItems" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ShippedItemType" - }, - "nullable" : true - }, - "interchangeControlNumber" : { - "type" : "string", - "nullable" : true - }, - "lastStateUpdateSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "rhombus-additionalEmails" : { - "type" : "string", - "nullable" : true - }, - "rhombus-chosenCarrierName" : { - "type" : "string", - "nullable" : true - }, - "rhombus-claimKeyToLicenseMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the environmental sensor", + "example" : 37.7749, "nullable" : true }, - "rhombus-claimKeyToLicenseMapV2" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SalesforceLicenseStartDateTimeAndEndDateTime" - }, - "nullable" : true - }, + "latitudeUpdated" : { + "type" : "boolean", "nullable" : true }, - "rhombus-customerEmails" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rhombus-customerName" : { - "type" : "string", + "locationUuidUpdated" : { + "type" : "boolean", "nullable" : true }, - "rhombus-orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the environmental sensor", + "example" : -122.4194, "nullable" : true }, - "rhombus-partnerOrgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "longitudeUpdated" : { + "type" : "boolean", "nullable" : true }, - "rhombus-purchaseOrderNumber" : { + "name" : { "type" : "string", + "description" : "Name of the environmental sensor", + "example" : "Main Office Sensor", "nullable" : true }, - "rhombus-rmaReturnTrackingNumber" : { - "type" : "string", + "nameUpdated" : { + "type" : "boolean", "nullable" : true }, - "rhombus-rmaUuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rhombus-rmaUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "policyUuidUpdated" : { + "type" : "boolean", "nullable" : true }, - "rhombus-salesForceOpportunityId" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "rhombus-zendeskTicketNumber" : { - "type" : "string", + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", "nullable" : true }, - "shipmentCategory" : { - "$ref" : "#/components/schemas/CustomerShipmentCategoryEnum" - }, - "shipmentEmailState" : { - "$ref" : "#/components/schemas/CustomerShipmentEmailStateEnum" - }, - "shipmentState" : { - "$ref" : "#/components/schemas/CustomerShipmentStateEnum" - }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -68771,30 +69968,9 @@ } } }, - "Customer_AcceptUsagePolicyRequest" : { - "type" : "object", - "description" : "Request object for accepting the usage policy for the current user." - }, - "Customer_AcceptUsagePolicyResponse" : { - "type" : "object", - "description" : "Response object for accepting the usage policy for the current user." - }, - "Customer_DeleteNotificationSnoozeSettingWSRequest" : { - "type" : "object", - "description" : "Request object for deleting notification snooze settings for a specific entity.", - "properties" : { - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Customer_DeleteNotificationSnoozeSettingWSResponse" : { + "Climate_UpdateClimateSensorDetailsWSResponse" : { "type" : "object", - "description" : "Response object for deleting notification snooze settings.", + "description" : "Response indicating the result of updating environmental sensor details.", "properties" : { "error" : { "type" : "boolean", @@ -68810,197 +69986,156 @@ } } }, - "Customer_GetCurrentPartnerUserWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving details about the current authenticated partner user." - }, - "Customer_GetCurrentPartnerUserWSResponse" : { + "Climate_UpdateEnvironmentalGatewayDetailsWSRequest" : { "type" : "object", - "description" : "Response object containing details about the current authenticated partner user.", + "description" : "Request to update details for an environmental gateway.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "flags" : { - "type" : "object", - "additionalProperties" : { + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device facet UUIDs", + "items" : { "type" : "string", - "description" : "Map of user-specific flags and settings", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "description" : "Map of user-specific flags and settings", "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/PartnerNotificationSettingsType" - }, - "notificationSettingsV2" : { - "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" + "associatedCamerasUpdated" : { + "type" : "boolean", + "description" : "Whether the associated cameras have been updated", + "example" : false, + "nullable" : true }, - "permissionGroupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "deleted" : { + "type" : "boolean", + "description" : "Whether the environmental gateway is deleted", + "example" : false, "nullable" : true }, - "user" : { - "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" + "deletedUpdated" : { + "type" : "boolean", + "description" : "Whether the deleted status has been updated", + "example" : false, + "nullable" : true }, - "warningMsg" : { + "description" : { "type" : "string", + "description" : "Description of the environmental gateway", + "example" : "Environmental monitoring gateway in main office", "nullable" : true - } - } - }, - "Customer_GetCurrentRhombusKeyUserWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving RhombusKey user configuration and details for the current user." - }, - "Customer_GetCurrentRhombusKeyUserWSResponse" : { - "type" : "object", - "description" : "Response object containing RhombusKey user configuration, user details, and organization summary details.", - "properties" : { - "orgDetails" : { - "$ref" : "#/components/schemas/User_RhombusKeyOrgDetailsType" - }, - "rhombusKeyConfig" : { - "$ref" : "#/components/schemas/RhombusKeyAppConfigType" }, - "user" : { - "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" - } - } - }, - "Customer_GetCurrentUserConsoleOrgsForContextSwitchWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving organizations that the current user can context switch into for Console." - }, - "Customer_GetCurrentUserConsoleOrgsForContextSwitchWSResponse" : { - "type" : "object", - "description" : "Response object containing the list of organizations available for context switching in Console.", - "properties" : { - "orgs" : { - "type" : "array", - "description" : "List of organizations that the user can context switch into", - "items" : { - "$ref" : "#/components/schemas/Customer_SelectableOrgForContextSwitch" - }, + "descriptionUpdated" : { + "type" : "boolean", + "description" : "Whether the description has been updated", + "example" : false, "nullable" : true - } - } - }, - "Customer_GetCurrentUserRhombusKeyOrgsForContextSwitchWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving organizations that the current user can context switch into for Rhombus Key." - }, - "Customer_GetCurrentUserRhombusKeyOrgsForContextSwitchWSResponse" : { - "type" : "object", - "description" : "Response object containing the list of organizations available for context switching in Rhombus Key.", - "properties" : { - "orgs" : { - "type" : "array", - "description" : "List of organizations that the user can context switch into", - "items" : { - "$ref" : "#/components/schemas/Customer_SelectableOrgForContextSwitch" - }, + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the environmental gateway is located", + "example" : 1, "nullable" : true - } - } - }, - "Customer_GetCurrentUserSessionsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving the list of active sessions for the current user." - }, - "Customer_GetCurrentUserSessionsWSResponse" : { - "type" : "object", - "description" : "Response object containing the list of active sessions for the current user.", - "properties" : { - "error" : { + }, + "floorNumberUpdated" : { "type" : "boolean", + "description" : "Whether the floor number has been updated", + "example" : false, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the environmental gateway", + "example" : 37.7749, "nullable" : true }, - "sessions" : { - "type" : "array", - "description" : "List of active sessions for the current user", - "items" : { - "$ref" : "#/components/schemas/SessionInfoWSType" - }, + "latitudeUpdated" : { + "type" : "boolean", + "description" : "Whether the latitude has been updated", + "example" : false, "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Customer_GetCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving detailed information about the current authenticated user." - }, - "Customer_GetCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response object containing detailed information about the current authenticated user.", - "properties" : { - "customizations" : { - "$ref" : "#/components/schemas/UserCustomizationsType" }, - "error" : { + "locationUuidUpdated" : { "type" : "boolean", + "description" : "Whether the location UUID has been updated", + "example" : false, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the environmental gateway", + "example" : -122.4194, "nullable" : true }, - "flags" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of user-specific flags and settings", - "nullable" : true - }, - "description" : "Map of user-specific flags and settings", + "longitudeUpdated" : { + "type" : "boolean", + "description" : "Whether the longitude has been updated", + "example" : false, "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/UserNotificationSettingsV3Type" + "name" : { + "type" : "string", + "description" : "Name of the environmental gateway", + "example" : "Main Office Gateway", + "nullable" : true }, - "notificationSettingsV2" : { - "$ref" : "#/components/schemas/UserNotificationSettingsV4Type" + "nameUpdated" : { + "type" : "boolean", + "description" : "Whether the name has been updated", + "example" : false, + "nullable" : true }, - "permissionGroupUuid" : { + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "user" : { - "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" + "policyUuidUpdated" : { + "type" : "boolean", + "description" : "Whether the policy UUID has been updated", + "example" : false, + "nullable" : true }, - "warningMsg" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, + "nullable" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Customer_GetDashboardStatusWSResponse" : { + "Climate_UpdateEnvironmentalGatewayDetailsWSResponse" : { "type" : "object", - "description" : "Response object containing dashboard status and information for the current user.", + "description" : "Response indicating the result of updating environmental gateway details.", "properties" : { - "dashboardStatus" : { - "$ref" : "#/components/schemas/DashboardStatus" - }, "error" : { "type" : "boolean", "nullable" : true @@ -69015,241 +70150,203 @@ } } }, - "Customer_GetDashboardstatusWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving dashboard status and information for the current user." - }, - "Customer_GetRhombusKeyConfigForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving the RhombusKey mobile app configuration for the current user." - }, - "Customer_GetRhombusKeyConfigForCurrentUserWSResponse" : { + "ClipAccessSettings" : { "type" : "object", - "description" : "Response object containing the RhombusKey mobile app configuration for the current user.", + "description" : "Visibility setting for the clip", "properties" : { - "userRhombusKeyConfig" : { - "$ref" : "#/components/schemas/RhombusKeyAppConfigType" + "allowedRoles" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "allowedUsers" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "visibility" : { + "$ref" : "#/components/schemas/ClipVisibilityEnum" } } }, - "Customer_GetUserSnoozedNotificationSettingsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving current and planned user notification snooze details." - }, - "Customer_GetUserSnoozedNotificationSettingsWSResponse" : { + "ClipBoundingBoxType" : { "type" : "object", - "description" : "Response object containing current and planned user notification snooze details.", "properties" : { - "error" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "alert" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "bottom" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "snoozedForAllNotificationsIntervals" : { - "type" : "array", - "description" : "List of intervals when all notifications are snoozed", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, + "confidence" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "snoozedForComponentCompositesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of component composite UUIDs to their snooze notification intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of component composite UUIDs to their snooze notification intervals", + "croppedImageLocator" : { + "type" : "string", "nullable" : true }, - "snoozedForDevicesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device UUIDs to their snooze notification intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of device UUIDs to their snooze notification intervals", - "nullable" : true + "customActivityColor" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, - "snoozedForLocationsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of location UUIDs to their snooze notification intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of location UUIDs to their snooze notification intervals", + "customActivityDescription" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "customActivityDisplayName" : { "type" : "string", "nullable" : true - } - } - }, - "Customer_LogoutAllOtherCurrentUserSessionsRequest" : { - "type" : "object", - "description" : "Request object for logging out all other active sessions for the current user." - }, - "Customer_LogoutAllOtherCurrentUserSessionsResponse" : { - "type" : "object", - "description" : "Response object for logging out all other active sessions for the current user." - }, - "Customer_SelectableOrgForContextSwitch" : { - "type" : "object", - "description" : "List of organizations that the user can context switch into", - "properties" : { - "companyThumbnailLogoUrl" : { - "type" : "string", + }, + "dwelling" : { + "type" : "boolean", "nullable" : true }, - "orgName" : { + "faceName" : { "type" : "string", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "inMotion" : { + "type" : "boolean", "nullable" : true }, - "rhombusKeyLogoUrl" : { - "type" : "string", + "keypointsV2" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PointType" + }, "nullable" : true }, - "userName" : { - "type" : "string", + "left" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Customer_SetFlagWSRequest" : { - "type" : "object", - "description" : "Request object for storing a flag or setting for the current user.", - "properties" : { - "flagName" : { + }, + "licensePlate" : { "type" : "string", - "description" : "Name of the flag to set", - "example" : "feature_enabled", "nullable" : true }, - "flagValue" : { - "type" : "string", - "description" : "Value to set for the flag", - "example" : "true", + "loudness" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Customer_SetFlagWSResponse" : { - "type" : "object", - "description" : "Response object for storing a flag or setting for the current user.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "objectId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { + "pose" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "relativeSecond" : { + "type" : "number", + "format" : "float", "nullable" : true - } - } - }, - "Customer_SnoozeAllNotificationsWSRequest" : { - "type" : "object", - "description" : "Request object for snoozing all user notifications for the current user.", - "properties" : { - "durationSec" : { + }, + "right" : { "type" : "integer", - "format" : "int64", - "description" : "Duration in seconds for the snooze period", - "example" : 3600, + "format" : "int32", "nullable" : true }, - "scheduledTimestampSec" : { + "sensorValType" : { + "$ref" : "#/components/schemas/SensorValType" + }, + "stableTrackId" : { "type" : "integer", - "format" : "int64", - "description" : "Scheduled timestamp in seconds when the snooze should start", - "example" : 1640995200, + "format" : "int32", "nullable" : true - } - } - }, - "Customer_SnoozeAllNotificationsWSResponse" : { - "type" : "object", - "description" : "Response object for snoozing all user notifications for the current user.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "toastOrderIdInfo" : { + "$ref" : "#/components/schemas/ToastOrderIdType" + }, + "top" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { + "unidentifiedFaceId" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "vehicleName" : { "type" : "string", "nullable" : true } } }, - "Customer_SnoozeNotificationsWSRequest" : { + "ClipDevice" : { "type" : "object", - "description" : "Request object for snoozing user notifications for specific entities.", + "description" : "A device contributing to a spliced clip.", + "nullable" : true, "properties" : { - "componentCompositeUuids" : { - "type" : "array", - "description" : "List of component composite UUIDs to snooze notifications for", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "device" : { + "$ref" : "#/components/schemas/TimelineEntryDevice" }, - "deviceUuids" : { + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + } + } + }, + "ClipEntryStatusEnum" : { + "type" : "string", + "description" : "Availability of the clip on a clip timeline entry.", + "enum" : [ "PENDING", "READY", "FAILED" ] + }, + "ClipGroupType" : { + "type" : "object", + "description" : "List of clip groups for the organization", + "properties" : { + "clips" : { "type" : "array", - "description" : "List of device UUIDs to snooze notifications for", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/SharedClipV2Type" }, "nullable" : true }, - "durationSec" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Duration in seconds for the snooze period", - "example" : 3600, "nullable" : true }, - "locationUuids" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "isShared" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "sharedGroups" : { "type" : "array", - "description" : "List of location UUIDs to snooze notifications for", "items" : { "type" : "string", "format" : "RUUID", @@ -69259,572 +70356,674 @@ }, "nullable" : true }, - "scheduledTimestampSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Scheduled timestamp in seconds when the snooze should start", - "example" : 1640995200, - "nullable" : true - } - } - }, - "Customer_SnoozeNotificationsWSResponse" : { - "type" : "object", - "description" : "Response object for snoozing user notifications for specific entities.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "title" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Customer_UpdateCurrentPartnerWSRequest" : { + "ClipGroupWithDetailsType" : { "type" : "object", - "description" : "Request object for updating details and information for the current authenticated partner user.", + "description" : "Detailed information about the clip group", "properties" : { - "bypassSaml" : { - "type" : "boolean", - "description" : "Whether to bypass SAML authentication for this user", - "example" : false, + "clips" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SharedClipWithDetailsType" + }, "nullable" : true }, - "mfaEnabled" : { - "type" : "boolean", - "description" : "Whether multi-factor authentication is enabled for the user", - "example" : true, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "name" : { + "description" : { "type" : "string", - "description" : "Name of the partner user", - "example" : "John Doe", "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/PartnerNotificationSettingsType" + "isShared" : { + "type" : "boolean", + "nullable" : true }, - "permissionGroupUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "smsPhoneNumbers" : { + "sharedGroups" : { "type" : "array", - "description" : "List of SMS phone numbers for the user", "items" : { "type" : "string", - "description" : "List of SMS phone numbers for the user", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "summaryEmailEnabled" : { - "type" : "boolean", - "description" : "Whether summary emails are enabled for the user", - "example" : false, - "nullable" : true - } - } - }, - "Customer_UpdateCurrentPartnerWSResponse" : { - "type" : "object", - "description" : "Response object for updating details and information for the current authenticated partner user.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "title" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Customer_UpdateCurrentUserWSRequest" : { + "ClipMetaDataType" : { "type" : "object", - "description" : "Request object for updating details and information for the current authenticated user.", "properties" : { - "dashboardCustomizations" : { - "$ref" : "#/components/schemas/DashboardCustomizations" + "activitySeekPoints" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true }, - "mfaEnabled" : { - "type" : "boolean", - "description" : "Whether multi-factor authentication is enabled for the user", - "example" : true, + "activitySeekPointsV2" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipSeekPointType" + }, "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the user", - "example" : "John Doe", + "activitySeekPointsV3" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipSeekPointV2Type" + }, "nullable" : true }, - "notificationIntervalsV2" : { + "boundingBoxes" : { "type" : "array", - "description" : "List of notification intervals for the user", "items" : { - "$ref" : "#/components/schemas/NotificationIntervalV2Type" + "$ref" : "#/components/schemas/ClipBoundingBoxType" }, "nullable" : true }, - "smsPhoneNumbers" : { + "clipLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "mGrids" : { "type" : "array", - "description" : "List of SMS phone numbers for the user", "items" : { "type" : "string", - "description" : "List of SMS phone numbers for the user", "nullable" : true }, "nullable" : true }, - "summaryEmailEnabled" : { - "type" : "boolean", - "description" : "Whether summary emails are enabled for the user", - "example" : false, - "nullable" : true - } - } - }, - "Customer_UpdateCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response object for updating details and information for the current authenticated user.", - "properties" : { - "error" : { - "type" : "boolean", + "soundSignificantLufs" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "startTime" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "thumbnailLocationV2" : { "type" : "string", "nullable" : true } } }, - "Customer_UpdateDashboardCustomizationsWSRequest" : { + "ClipSeekPointType" : { "type" : "object", - "description" : "Request object for updating dashboard customization settings for the current user.", "properties" : { - "fullCamera" : { - "type" : "string", - "description" : "Full camera configuration", - "example" : "single", - "nullable" : true + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "fullCameraUpdated" : { + "alert" : { "type" : "boolean", - "description" : "Whether the full camera has been updated", - "example" : false, "nullable" : true }, - "halfCamera" : { + "bottom" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "faceName" : { "type" : "string", - "description" : "Half camera configuration", - "example" : "split", "nullable" : true }, - "halfCameraUpdated" : { - "type" : "boolean", - "description" : "Whether the half camera has been updated", - "example" : true, + "keypointsV2" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PointType" + }, "nullable" : true }, - "layout" : { - "type" : "string", - "description" : "Dashboard layout configuration", - "example" : "grid", + "left" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "layoutUpdated" : { - "type" : "boolean", - "description" : "Whether the layout has been updated", - "example" : true, + "licensePlate" : { + "type" : "string", "nullable" : true }, - "rememberedLocation" : { + "pose" : { "type" : "string", - "description" : "Remembered location for the user", - "example" : "Main Office", "nullable" : true }, - "rememberedLocationUpdated" : { - "type" : "boolean", - "description" : "Whether the remembered location has been updated", - "example" : false, + "relativeSecond" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "report" : { - "type" : "string", - "description" : "Report configuration", - "example" : "daily", + "right" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "reportUpdated" : { - "type" : "boolean", - "description" : "Whether the report has been updated", - "example" : true, + "top" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "videoWall" : { + "unidentifiedFaceId" : { "type" : "string", - "description" : "Video wall configuration", - "example" : "4x4", "nullable" : true }, - "videoWallUpdated" : { - "type" : "boolean", - "description" : "Whether the video wall has been updated", - "example" : false, + "vehicleName" : { + "type" : "string", "nullable" : true } } }, - "Customer_UpdateDashboardCustomizationsWSResponse" : { + "ClipSeekPointV2Type" : { "type" : "object", - "description" : "Response object for updating dashboard customization settings for the current user.", + "description" : "List of seek points for the clip", "properties" : { - "error" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "alert" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "customActivityColor" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" + }, + "customActivityDescription" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "customActivityDisplayName" : { "type" : "string", "nullable" : true - } - } - }, - "Customer_UpdateFrontendCustomizationsWSRequest" : { - "type" : "object", - "description" : "Request object for updating frontend customization settings for the current user.", - "properties" : { - "customizations" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of frontend customization settings and their values", - "nullable" : true - }, - "description" : "Map of frontend customization settings and their values", + }, + "dcao" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Customer_UpdateFrontendCustomizationsWSResponse" : { - "type" : "object", - "description" : "Response object for updating frontend customization settings for the current user.", - "properties" : { - "error" : { + }, + "dwelling" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "faceName" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "id" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "inMotion" : { + "type" : "boolean", + "nullable" : true + }, + "licensePlate" : { "type" : "string", "nullable" : true - } - } - }, - "Customer_UpdateRhombusKeyPreferencesForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request object for updating the RhombusKey mobile app preferences for the current user.", - "properties" : { - "favoriteAccessControlledDoorUuids" : { - "type" : "array", - "description" : "List of favorite access controlled door UUIDs for the user", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + }, + "loudness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "favoriteAccessControlledDoorUuidsUpdated" : { - "type" : "boolean", - "description" : "Whether the favorite access controlled door UUIDs have been updated", - "example" : true, + "pose" : { + "type" : "string", + "nullable" : true + }, + "relativeSecond" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "sensorValType" : { + "$ref" : "#/components/schemas/SensorValType" + }, + "stableTrackId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "toastOrderIdInfo" : { + "$ref" : "#/components/schemas/ToastOrderIdType" + }, + "tu" : { + "type" : "string", + "nullable" : true + }, + "unidentifiedFaceId" : { + "type" : "string", + "nullable" : true + }, + "vehicleName" : { + "type" : "string", "nullable" : true } } }, - "Customer_UpdateRhombusKeyPreferencesForCurrentUserWSResponse" : { - "type" : "object", - "description" : "Response object for updating the RhombusKey mobile app preferences for the current user.", - "properties" : { - "userRhombusKeyConfig" : { - "$ref" : "#/components/schemas/RhombusKeyAppConfigType" - } - } + "ClipStatusEnum" : { + "type" : "string", + "enum" : [ "INITIATING", "UPLOADING", "RENDERING", "FAILED", "COMPLETE", "OFFLINE", "DELETED", "UNKNOWN" ] }, - "DailyFirstInReset" : { + "ClipTimelineEntry" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "minuteOfDay" : { - "type" : "integer", - "format" : "int64", + "clipKey" : { + "type" : "string", + "description" : "Storage key of the copied clip, assigned when the source clip is copied. Caller-supplied value is ignored. Null when the status is not READY or when the entry is redacted.", + "nullable" : true + }, + "clipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "devices" : { + "type" : "array", + "description" : "The devices from which the clip was spliced, each with its location when the entry was created.", + "items" : { + "$ref" : "#/components/schemas/ClipDevice" + }, "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/ClipEntryStatusEnum" } } } ], + "description" : "A timeline entry containing a video clip.", "nullable" : true, "properties" : { - "type" : { - "$ref" : "#/components/schemas/FirstInResetEnum" - } - } - }, - "DaoOutcomeEnum" : { - "type" : "string", - "description" : "The result of the ALM-related action.", - "enum" : [ "SUCCESS", "BAD_REQUEST", "NO_SUCH_ENTITY", "ALREADY_EXISTS", "STALE_UPDATE", "CONCURRENCY_ERROR", "INTERNAL_ERROR", "UNKNOWN" ] - }, - "DashboardCustomizations" : { - "type" : "object", - "description" : "Dashboard customization settings for the user", - "properties" : { - "fullCamera" : { - "type" : "string", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, - "halfCamera" : { + "createdBy" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "layout" : { + "imageKey" : { "type" : "string", + "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", "nullable" : true }, - "rememberedLocation" : { + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "report" : { + "reportUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "videoWall" : { + "systemGenerated" : { + "type" : "boolean", + "description" : "Whether the entry was generated by the system rather than created by a user.", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/TimelineEntryTypeEnum" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "DashboardHealthStatusIndicationEnum" : { + "ClipVisibilityEnum" : { "type" : "string", - "enum" : [ "GREEN", "YELLOW", "RED" ] + "description" : "Use accessSettings instead", + "enum" : [ "PRIVATE", "ROLE_RESTRICTED", "ORG_WIDE" ] }, - "DashboardStatus" : { + "CloudArchivingStrategyEnum" : { + "type" : "string", + "enum" : [ "WEEKLY_SCHEDULED", "CONTINUOUS" ] + }, + "Co2SensorType" : { "type" : "object", - "description" : "Dashboard status and information for the current user", "properties" : { - "camerasDown" : { + "co2Ppm" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "camerasDownByLocation" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "relHumid" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "camerasUp" : { - "type" : "integer", - "format" : "int32", + "tempC" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "healthStatusIndicator" : { - "$ref" : "#/components/schemas/DashboardHealthStatusIndicationEnum" + "timestampSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "ColorEnum" : { + "type" : "string", + "description" : "Set of colors to filter by", + "enum" : [ "BLACK", "BLUE", "BROWN", "GRAYWHITE", "GREEN", "ORANGE", "PINK", "PURPLE", "RED", "YELLOW", "UNKNOWN" ] + }, + "Common_devices_CalibrateFloorplanProjectionWSRequest" : { + "type" : "object", + "description" : "Request to calibrate floorplan projection for a device.", + "properties" : { + "cameraImagePointsPermyriad" : { + "type" : "array", + "description" : "List of camera image points in permyriad coordinates", + "items" : { + "type" : "array", + "description" : "List of camera image points in permyriad coordinates", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "List of camera image points in permyriad coordinates", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true }, - "healthStatusMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationCameraStatus" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", + "floorplanImagePointsPermyriad" : { + "type" : "array", + "description" : "List of floorplan image points in permyriad coordinates", + "items" : { + "type" : "array", + "description" : "List of floorplan image points in permyriad coordinates", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "List of floorplan image points in permyriad coordinates", "nullable" : true }, "nullable" : true }, "nullable" : true - }, - "totalCameras" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Common_devices_CalibrateFloorplanProjectionWSResponse" : { + "type" : "object", + "description" : "Response containing the calibrated floorplan projection homography.", + "properties" : { + "homography" : { + "type" : "array", + "description" : "3x3 homography matrix for floorplan projection", + "items" : { + "type" : "array", + "description" : "3x3 homography matrix for floorplan projection", + "items" : { + "type" : "number", + "format" : "double", + "description" : "3x3 homography matrix for floorplan projection", + "nullable" : true + }, + "nullable" : true + }, "nullable" : true - }, - "totalClimateSensors" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Common_devices_DeviceUptimeWindowsType" : { + "type" : "object", + "description" : "Uptime windows for a single device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "totalDoorSensors" : { - "type" : "integer", - "format" : "int32", + "uptimeWindows" : { + "type" : "array", + "description" : "List of uptime windows for the device within the requested range", + "items" : { + "$ref" : "#/components/schemas/TimeWindowSeconds" + }, + "nullable" : true + } + } + }, + "Common_devices_GetBoundingBoxesWSRequest" : { + "type" : "object", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "totalLocations" : { + "durationSecs" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "totalProximitySensors" : { + "startTimeSec" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true } } }, - "DataSourceEnum" : { - "type" : "string", - "enum" : [ "ACCESS_CONTROL_EVENTS", "BANDWIDTH_USAGE", "CAMERA_EVENTS", "CAMERAS", "CLIMATE_SENSOR_EVENTS", "CLIPS", "COMPONENT_EVENTS", "CROWD", "CUSTOM_LLM_EVENTS", "ENTITIES", "ENVIRONMENTAL_GATEWAY_EVENTS", "FACES", "LICENSE_PLATE_RECOGNITION", "LINE_CROSSING", "LOCATIONS", "MOTION", "OCCUPANCY", "PEOPLE", "POLICY_ALERTS", "VEHICLES" ] - }, - "DateRangeFilter" : { + "Common_devices_GetBoundingBoxesWSResponse" : { "type" : "object", - "description" : "Optional date range filter to limit search results.", "properties" : { - "localEndDateRangeEnd" : { - "type" : "string", - "description" : "End of the date range to filter local end date. This date is inclusive.", + "error" : { + "type" : "boolean", "nullable" : true }, - "localEndDateRangeStart" : { + "errorMsg" : { "type" : "string", - "description" : "Start of the date range to filter local end date. This date is inclusive.", "nullable" : true }, - "localStartDateRangeEnd" : { - "type" : "string", - "description" : "End of the date range to filter local start date. This date is inclusive.", + "footageBoundingBoxes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FootageBoundingBoxType" + }, "nullable" : true }, - "localStartDateRangeStart" : { + "warningMsg" : { "type" : "string", - "description" : "Start of the date range to filter local start date. This date is inclusive.", "nullable" : true } } }, - "DeleteSharedLiveVideoStreamForDeviceResponse" : { - "type" : "object" - }, - "DemographicsHourlyBucket" : { + "Common_devices_GetCameraOrDoorbellCameraSeekpointsWSRequest" : { "type" : "object", - "description" : "Hourly demographics buckets", "properties" : { - "ageDistribution" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "nullable" : true + "activitySet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "genderDistribution" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "nullable" : true - }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "hourBucket" : { + "durationSecs" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "orgGroupKey" : { - "type" : "string", + "includeAnyMotion" : { + "type" : "boolean", "nullable" : true }, - "totalDetections" : { + "seekpointDurationIntervalSecs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "startTimeSec" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, - "Demographics_GetDemographicsDataWSRequest" : { + "Common_devices_GetFullDeviceStateWSRequest" : { "type" : "object", - "description" : "Request for demographics data.", "properties" : { - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds", - "nullable" : true - }, - "groupUuid" : { + "deviceUuid" : { "type" : "string", - "description" : "Device group UUID", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds", + "force" : { + "type" : "boolean", "nullable" : true } } }, - "Demographics_GetDemographicsDataWSResponse" : { + "Common_devices_GetMediaUrisWSRequest" : { "type" : "object", - "description" : "Response containing demographics data.", "properties" : { - "buckets" : { - "type" : "array", - "description" : "Hourly demographics buckets", - "items" : { - "$ref" : "#/components/schemas/DemographicsHourlyBucket" - }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Developer_CreateEventListenerWSRequest" : { + "Common_devices_GetMinimalDeviceStateListWSRequest" : { "type" : "object", - "description" : "Request object for creating an event listener.", "properties" : { - "eventListner" : { - "$ref" : "#/components/schemas/EventListenerType" + "includeMummified" : { + "type" : "boolean", + "nullable" : true } } }, - "Developer_CreateEventListenerWSResponse" : { + "Common_devices_GetPresenceWindowsWSRequest" : { "type" : "object", - "description" : "Response object for creating an event listener.", + "description" : "Request to get stored video information for a device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds", + "example" : 3600, + "nullable" : true + }, + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, + "nullable" : true + } + } + }, + "Common_devices_GetPresenceWindowsWSResponse" : { + "type" : "object", + "description" : "Response containing stored video information for a device.", "properties" : { "error" : { "type" : "boolean", @@ -69834,11 +71033,17 @@ "type" : "string", "nullable" : true }, - "eventListenerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "presenceWindows" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of presence types to their time windows", + "items" : { + "$ref" : "#/components/schemas/TimeWindowSeconds" + }, + "nullable" : true + }, + "description" : "Map of presence types to their time windows", "nullable" : true }, "warningMsg" : { @@ -69847,22 +71052,35 @@ } } }, - "Developer_DeleteEventListenerWSRequest" : { + "Common_devices_GetSeekpointsWSRequest" : { "type" : "object", - "description" : "Request object for deleting an event listener.", + "description" : "General seekpoints search request parameters", "properties" : { - "eventListenerUuid" : { + "deviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "durationSecs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "includeAnyMotion" : { + "type" : "boolean", + "nullable" : true + }, + "startTimeSec" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Developer_DeleteEventListenerWSResponse" : { + "Common_devices_GetSeekpointsWSResponse" : { "type" : "object", - "description" : "Response object for deleting an event listener.", "properties" : { "error" : { "type" : "boolean", @@ -69872,19 +71090,54 @@ "type" : "string", "nullable" : true }, + "footageSeekPoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FootageSeekPointV2Type" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Developer_GetAllEventListenersWSRequest" : { + "Common_devices_GetUptimeWindowsForOrgWSRequest" : { "type" : "object", - "description" : "Request object for retrieving a list of all event listeners." + "description" : "Request to get uptime windows for many devices in a single call.", + "properties" : { + "deviceUuids" : { + "type" : "array", + "description" : "Optional list of device UUIDs to include. When omitted or empty, all devices of the endpoint's type in the organization are included.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds since epoch", + "example" : 1643673600000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds since epoch", + "example" : 1640995200000, + "nullable" : true + } + } }, - "Developer_GetAllEventListenersWSResponse" : { + "Common_devices_GetUptimeWindowsForOrgWSResponse" : { "type" : "object", - "description" : "Response object containing a list of all event listeners.", + "description" : "Response containing uptime windows for many devices.", "properties" : { "error" : { "type" : "boolean", @@ -69894,11 +71147,11 @@ "type" : "string", "nullable" : true }, - "eventListeners" : { + "uptimeByDevice" : { "type" : "array", - "description" : "List of all event listeners", + "description" : "Uptime windows per device", "items" : { - "$ref" : "#/components/schemas/EventListenerType" + "$ref" : "#/components/schemas/Common_devices_DeviceUptimeWindowsType" }, "nullable" : true }, @@ -69908,9 +71161,9 @@ } } }, - "Developer_GetEventListenersForDeviceWSRequest" : { + "Common_devices_GetUptimeWindowsWSRequest" : { "type" : "object", - "description" : "Request object for retrieving a list of event listeners for a specific device.", + "description" : "Request to get uptime information for a device.", "properties" : { "deviceUuid" : { "type" : "string", @@ -69918,12 +71171,26 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds since epoch", + "example" : 1643673600000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds since epoch", + "example" : 1640995200000, + "nullable" : true } } }, - "Developer_GetEventListenersForDeviceWSResponse" : { + "Common_devices_GetUptimeWindowsWSResponse" : { "type" : "object", - "description" : "Response object containing a list of event listeners for a specific device.", + "description" : "Response containing uptime information for a device.", "properties" : { "error" : { "type" : "boolean", @@ -69933,11 +71200,11 @@ "type" : "string", "nullable" : true }, - "eventListeners" : { + "uptimeWindows" : { "type" : "array", - "description" : "List of event listeners for the specified device", + "description" : "List of uptime windows for the device", "items" : { - "$ref" : "#/components/schemas/EventListenerType" + "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, @@ -69947,372 +71214,238 @@ } } }, - "DeviceActivityRuleTriggerType" : { + "Common_devices_RebootDeviceWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/SimpleDeviceActivityEventType" - }, - "componentCompositeUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "componentUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "deviceLabels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "deviceUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "locationUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Response indicating the result of rebooting a device.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + "result" : { + "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse_RebootResult" } } }, - "DeviceAssignableLicenseGroupStats" : { + "Common_devices_RebootDeviceWSResponse_RebootResult" : { + "type" : "string", + "description" : "Result of the reboot operation", + "enum" : [ "REBOOT_SENT", "DEVICE_OFFLINE" ] + }, + "Common_devices_UpdateConfigWSResponse" : { "type" : "object", + "description" : "Response indicating the result of updating device configuration.", "properties" : { - "assignedCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "deviceLicenseFamilyStats" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyStats" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "lastEndDate" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", - "description" : "The closest past date on which licenses belonging to the group expired.", - "nullable" : true - }, - "nearExpirationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, - "nextEndDate" : { + "warningMsg" : { "type" : "string", - "format" : "date-time", - "description" : "The closest future date on which licenses belonging to the group will expire.", - "nullable" : true - }, - "stateStats" : { - "$ref" : "#/components/schemas/LicenseStateStats" - }, - "totalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group.", "nullable" : true } } }, - "DeviceCatalogItem" : { + "Common_devices_UpdateDeviceDetailsWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "cloudArchiveDays" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "licenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" - }, - "licenseType" : { - "$ref" : "#/components/schemas/LicenseEnum" - } - } - } ], - "nullable" : true, "properties" : { - "durationMonths" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "productCode" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "DeviceDisabledHealthTrackingInfo" : { + "Common_devices_rawstream_CreateRawHttpStreamWSRequest" : { "type" : "object", - "description" : "List of organization devices for which health tracking is disabled.", + "description" : "Request to create a raw HTTP stream for a device.", "properties" : { "deviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "reEnableCondition" : { - "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" + "rawStreamName" : { + "type" : "string", + "description" : "Name for the raw stream", + "example" : "my_raw_stream", + "nullable" : true + }, + "streamType" : { + "$ref" : "#/components/schemas/StreamTypeEnum" } } }, - "DeviceEventRecordType" : { + "Common_devices_rawstream_CreateRawHttpStreamWSResponse" : { "type" : "object", + "description" : "Response containing raw HTTP stream URLs for a device.", "properties" : { - "activities" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "componentCompositeUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "componentUuid" : { + "lanAudioUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "LAN audio URL for the raw stream", + "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/audio", "nullable" : true }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "deviceUuid" : { + "lanVideoLowResUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "LAN low resolution video URL for the raw stream", + "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/video_low", "nullable" : true }, - "eventUuid" : { + "lanVideoUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "LAN video URL for the raw stream", + "example" : "http://ip-192-168-0-1.lan.rhombussystems.com/video", "nullable" : true }, - "hardwareVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "locationUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Common_devices_rawstream_DeleteRawHttpStreamWSRequest" : { + "type" : "object", + "description" : "Request to delete raw HTTP streams for a device.", + "properties" : { + "customPathPart" : { + "type" : "string", + "description" : "Custom path part to identify specific stream", + "example" : "my_stream", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "DeviceFacetEnum" : { - "type" : "string", - "format" : "DeviceFacet", - "description" : "facet information for media", - "enum" : [ "", "v0", "v1", "v2", "v3", "a0", "v4", "v5", "v6", "v7", "v8", "v9", "v10", "v11", "v12", "v13", "v14", "v15", "v16", "v17", "v18", "v19", "v20", "v21", "v22", "v23", "v24", "v25", "v26", "v27", "v28", "v29", "v30", "v31", "v32", "v33", "v34", "v35", "v36", "v37", "v38", "v39", "v40", "v41", "v42", "v43", "v44", "v45", "v46", "v47", "v48", "v49", "v50", "v51", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "a10", "a11", "a12", "a13", "a14", "a15", "a16", "a17", "a18", "a19", "a20", "a21", "a22", "a23", "a24", "a25", "a26", "a27", "a28", "a29", "a30", "a31", "a32", "a33", "a34", "a35", "a36", "a37", "a38", "a39", "a40", "a41", "a42", "a43", "a44", "a45", "a46", "a47", "a48", "a49", "a50", "a51" ], - "example" : "v0, a0" - }, - "DeviceFeatureEnum" : { - "type" : "string", - "enum" : [ "COLOR_SEARCH", "FACE_RECOGNITION", "LICENSE_PLATE_RECOGNITION", "PEOPLE_COUNTING", "PPE_DETECTION", "UNUSUAL_BEHAVIOR_DETECTION", "VEHICLE_COUNTING", "CAMERA_ENTERPRISE_CLOUD_ARCHIVING", "TIMELAPSE", "VISUAL_TAMPER", "REGION_CROSSING", "OCCUPANCY_COUNTING", "CUSTOM_EVENTS", "LOITER", "AUDIO_AI_ANALYTICS", "AUDIO_ENTERPRISE_CLOUD_ARCHIVING", "AUDIO_SPEAKER_ENABLED", "BADGE_READER_ENTERPRISE_CLOUD_ARCHIVING", "OBJECT_SEARCH", "UNKNOWN" ] - }, - "DeviceHealthStatusDetailsEnum" : { - "type" : "string", - "enum" : [ "DISCONNECTED", "FIRMWARE_BEHIND", "NOT_RECORDING", "LINK_SPEED_LOW", "MALFUNCTIONING_MODULES", "CALIBRATING", "DELAYED", "NONE" ] - }, - "DeviceIntegrationSettings" : { + "Common_devices_rawstream_DeleteRawHttpStreamWSResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response indicating the result of deleting raw HTTP streams.", "properties" : { - "latitude" : { - "type" : "number", - "format" : "double", + "error" : { + "type" : "boolean", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "DeviceIntegrationType" : { + "Common_devices_rawstream_FindAllRawHttpStreamsWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "deviceSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DeviceIntegrationSettings" - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request to retrieve all raw HTTP streams." + }, + "Common_devices_rawstream_FindAllRawHttpStreamsWSResponse" : { + "type" : "object", + "description" : "Response containing all raw HTTP streams.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "rawHttpStreams" : { + "type" : "array", + "description" : "List of all raw HTTP streams", + "items" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_LanSpecificRawStreamType" }, "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "userUuid" : { + } + } + }, + "Common_devices_rawstream_GetRawHttpStreamsWSRequest" : { + "type" : "object", + "description" : "Request to retrieve raw HTTP streams for a device.", + "properties" : { + "deviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "DeviceLicenseFamilyEnum" : { - "type" : "string", - "enum" : [ "CAMERA", "CAMERA_MS", "VIDEO_INTERCOM", "AUDIO_GATEWAY", "ENVIRONMENTAL_SENSOR", "ENVIRONMENTAL_GATEWAY" ] - }, - "DeviceLicenseFamilyStats" : { + "Common_devices_rawstream_GetRawHttpStreamsWSResponse" : { "type" : "object", + "description" : "Response containing raw HTTP streams for a device.", "properties" : { - "assignedCount" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceLicenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" - }, - "lastEndDate" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", - "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, - "nearExpirationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently close to expiration.", + "rawHttpStreams" : { + "type" : "array", + "description" : "List of raw HTTP streams", + "items" : { + "$ref" : "#/components/schemas/Common_devices_rawstream_LanSpecificRawStreamType" + }, "nullable" : true }, - "nextEndDate" : { + "warningMsg" : { "type" : "string", - "format" : "date-time", - "description" : "The closest future date on which licenses belonging to the group will expire.", - "nullable" : true - }, - "stateStats" : { - "$ref" : "#/components/schemas/LicenseStateStats" - }, - "totalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group.", "nullable" : true } } }, - "DeviceLicenseType" : { + "Common_devices_rawstream_LanSpecificRawStreamType" : { "type" : "object", - "description" : "List of device licenses available for the client organization", + "description" : "List of raw HTTP streams", "properties" : { - "claimKeyUuid" : { + "audioPath" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdOn" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdBy" : { + "type" : "string", + "nullable" : true + }, + "customPathPart" : { "type" : "string", - "format" : "date-time", "nullable" : true }, "deviceType" : { @@ -70320,99 +71453,196 @@ }, "deviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "features" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LicenseFeature" - }, - "nullable" : true, - "uniqueItems" : true - }, - "firstAssignedDate" : { + "lanAudioUrl" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "licenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" - }, - "licenseToUnassignEmailState" : { - "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" - }, - "licenseType" : { - "$ref" : "#/components/schemas/LicenseEnum" + "lanVideoLowResUrl" : { + "type" : "string", + "nullable" : true }, - "maxDeleteDate" : { + "lanVideoUrl" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "orgUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "priorClaimKeyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "productCode" : { - "type" : "string", - "nullable" : true - }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - }, - "state" : { - "$ref" : "#/components/schemas/LicenseStateEnum" - }, - "trial" : { - "type" : "boolean", - "nullable" : true + "streamType" : { + "$ref" : "#/components/schemas/StreamTypeEnum" }, - "updatedOn" : { + "videoLowResPath" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "uuid" : { + "videoPath" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "DeviceOrientationEnum" : { + "ComponentBaseEnumType" : { "type" : "string", - "enum" : [ "CEILING", "FLOOR", "WALL", "WALL_CROOKED", "INDETERMINATE" ] + "enum" : [ "reader", "dpi", "relay", "rex", "aux", "aperio", "schlage", "button" ] }, - "DevicePhysicalPortConfigType" : { + "ComponentCompositeEnumType" : { + "type" : "string", + "enum" : [ "AccessControlledDoor", "AccessControlledElevator", "AccessControlledElevatorLanding" ] + }, + "ComponentCompositeEnumType_Minimal" : { + "type" : "string", + "enum" : [ "AccessControlledDoor", "AccessControlledElevator", "AccessControlledElevatorLanding" ] + }, + "ComponentCompositeEventOriginator" : { "type" : "object", - "properties" : { - "boardMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BoardPhysicalPortConfigType" + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeName" : { + "type" : "string", + "nullable" : true + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "correlationId" : { + "type" : "string", + "nullable" : true + }, + "eventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" + } + } + }, + "ComponentCompositeShadowEnum" : { + "type" : "string", + "enum" : [ "AccessControlledDoorShadow", "AccessControlledElevatorLandingShadow" ] + }, + "ComponentEnumType" : { + "type" : "string", + "enum" : [ "RhombusOsdpDoorReader", "OsdpDoorReader", "WiegandDoorReader", "IntegratedDoorPositionIndicator", "IntegratedRequestToExit", "IntegratedDoorRelay", "IntegratedGenericRelay", "IntegratedGenericInput", "IntegratedGenericButton", "SchlageInputButton", "AperioActivatorButton", "AperioGateway", "AperioRs485Gateway", "AperioDoorExtension", "AperioDoorRelay", "AperioDoorPositionIndicator", "AperioDoorReader", "AperioRs485DoorReader", "AperioRs485DoorRelay", "AperioRs485DoorPositionIndicator", "AperioRs485DoorRequestToExit", "AperioRs485DoorExtension", "AperioDoorRequestToExit", "SchlageRs485Gateway", "SchlageRs485DoorExtension", "SchlageRs485DoorRelay", "SchlageRs485DoorPositionIndicator", "SchlageRs485DoorReader", "SchlageRs485DoorRequestToExit" ] + }, + "ComponentEventEnumType" : { + "type" : "string", + "description" : "Limits results to only contain the specified type of events, if applicable", + "enum" : [ "DoorbellEvent", "DoorReaderStateChangeEvent", "DoorRelayStateChangeEvent", "DoorPositionIndicatorStateChangeEvent", "RequestToExitStateChangeEvent", "CredentialReceivedEvent", "ButtonEvent", "GenericInputStateChangeEvent", "GenericRelayStateChangeEvent", "AccessControlUnitTamperEvent", "AccessControlUnitLocationLockdownStateEvent", "DoorLocationLockdownStateEvent", "PanicButtonEvent", "AccessControlUnitBatteryStateChangeEvent", "WaveToUnlockIntentExpiredEvent", "DoorStateChangeEvent", "DoorAuthFirstInStateEvent", "DoorScheduleFirstInStateEvent", "AccessControlUnitDoorFirstInStateEvent", "AperioDoorExtensionStateEvent", "AperioActivatorStateEvent", "AperioKeyCylinderStateEvent", "AperioDoorModeEvent", "AperioDoorHandleStateEvent", "AperioGatewayStateEvent", "AperioGatewayConnectionStateChangeEvent", "AperioDtcEvent", "AperioTamperStateEvent", "IntercomTalkEvent", "SchlageDoorExtensionStateEvent", "SchlageRs485GatewayStateEvent", "SchlageRs485GatewayConnectionStateChangeEvent" ] + }, + "ComponentEventType" : { + "type" : "object", + "description" : "List of component events for the doorbell camera", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DoorbellEventType" + }, { + "$ref" : "#/components/schemas/DoorReaderStateChangeEventType" + }, { + "$ref" : "#/components/schemas/DoorRelayStateChangeEventType" + }, { + "$ref" : "#/components/schemas/DoorPositionIndicatorStateChangeEventType" + }, { + "$ref" : "#/components/schemas/RequestToExitStateChangeEventType" + }, { + "$ref" : "#/components/schemas/CredentialReceivedEventType" + }, { + "$ref" : "#/components/schemas/ButtonEventType" + }, { + "$ref" : "#/components/schemas/GenericInputStateChangeEventType" + }, { + "$ref" : "#/components/schemas/GenericRelayStateChangeEventType" + }, { + "$ref" : "#/components/schemas/AccessControlUnitTamperEventType" + }, { + "$ref" : "#/components/schemas/AccessControlUnitLocationLockdownStateEventType" + }, { + "$ref" : "#/components/schemas/DoorLocationLockdownStateEventType" + }, { + "$ref" : "#/components/schemas/PanicButtonEventType" + }, { + "$ref" : "#/components/schemas/AccessControlUnitBatteryStateChangeEventType" + }, { + "$ref" : "#/components/schemas/WaveToUnlockIntentExpiredEvent" + }, { + "$ref" : "#/components/schemas/DoorStateChangeEvent" + }, { + "$ref" : "#/components/schemas/DoorAuthFirstInStateEvent" + }, { + "$ref" : "#/components/schemas/DoorScheduleFirstInStateEvent" + }, { + "$ref" : "#/components/schemas/AccessControlUnitDoorFirstInStateEvent" + }, { + "$ref" : "#/components/schemas/AperioDtcEvent" + }, { + "$ref" : "#/components/schemas/AperioDoorExtensionStateEvent" + }, { + "$ref" : "#/components/schemas/AperioActivatorStateEvent" + }, { + "$ref" : "#/components/schemas/AperioDoorModeEvent" + }, { + "$ref" : "#/components/schemas/AperioDoorHandleStateEvent" + }, { + "$ref" : "#/components/schemas/AperioKeyCylinderStateEvent" + }, { + "$ref" : "#/components/schemas/IntercomTalkEventType" + }, { + "$ref" : "#/components/schemas/SchlageDoorExtensionStateEvent" + } ], + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAtMillis" : { + "correlationId" : { + "type" : "string", + "nullable" : true + }, + "createdAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "orgUuid" : { "type" : "string", "format" : "RUUID", @@ -70427,87 +71657,110 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedAtMillis" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "DeviceSchedule" : { + "ComponentReferenceType" : { "type" : "object", "properties" : { - "invertSchedule" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduleUuid" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ComponentReferenceType_Minimal" : { + "type" : "object", + "properties" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "unscheduledMessage" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "DeviceStatusEnum" : { - "type" : "string", - "enum" : [ "RED", "ORANGE", "YELLOW", "GREEN" ] - }, - "DeviceTargetScopeEnum" : { - "type" : "string", - "enum" : [ "ORG", "LOCATION", "DEVICE" ] - }, - "DeviceTypeEnum" : { + "ComponentRelayOutputTypeEnum" : { "type" : "string", - "enum" : [ "BLE_TRACKER", "CAMERA", "DOOR_SENSOR", "ENVIRONMENTAL_SENSOR", "OCCUPANCY_SENSOR", "AUDIO_GATEWAY", "EXECUTABLE", "BADGE_READER", "DOOR_CONTROLLER", "BLE_BUTTON", "IO_BOARD", "ENVIRONMENTAL_GATEWAY", "NVR", "ROBOT", "UNKNOWN" ] + "enum" : [ "TRANSIENT", "STEADY" ] }, - "DeviceTypeV2" : { + "ComponentSeekPointType" : { "type" : "object", - "description" : "List of all client devices", + "description" : "List of component seekpoints for the doorbell camera", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "customData" : { + "componentCompositeUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "description" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true + "customActivityColor" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, - "hardwareId" : { + "customActivityDescription" : { "type" : "string", "nullable" : true }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "mummified" : { - "type" : "boolean", + "customActivityDisplayName" : { + "type" : "string", "nullable" : true }, - "name" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "orgUuid" : { @@ -70517,26 +71770,35 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pending" : { - "type" : "boolean", + "originalEvent" : { + "type" : "object", "nullable" : true }, - "policyUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "unregisteredEmailSent" : { - "type" : "boolean", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { @@ -70548,3269 +71810,4039 @@ } } }, - "DeviceVideoSettingsSelectiveUpdate" : { + "ComponentShadowEnumType" : { + "type" : "string", + "enum" : [ "DoorReaderShadow", "DoorRelayShadow", "DoorPositionIndicatorShadow", "RequestToExitShadow", "GenericRelayShadow", "GenericInputShadow", "GenericButtonShadow", "AperioGatewayShadow", "AperioDoorExtensionShadow", "SchlageGatewayShadow", "SchlageDoorExtensionShadow" ] + }, + "ComponentShadowType" : { "type" : "object", - "description" : "Update selective video settings", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DoorReaderShadowType" + }, { + "$ref" : "#/components/schemas/DoorRelayShadowType" + }, { + "$ref" : "#/components/schemas/DoorPositionIndicatorShadowType" + }, { + "$ref" : "#/components/schemas/RequestToExitShadowType" + }, { + "$ref" : "#/components/schemas/GenericInputShadowType" + }, { + "$ref" : "#/components/schemas/IntegratedDoorRelayType" + }, { + "$ref" : "#/components/schemas/GenericRelayShadowType" + }, { + "$ref" : "#/components/schemas/GenericButtonShadowType" + }, { + "$ref" : "#/components/schemas/AperioGatewayShadow" + }, { + "$ref" : "#/components/schemas/AperioDoorExtensionShadow" + }, { + "$ref" : "#/components/schemas/SchlageGatewayShadow" + }, { + "$ref" : "#/components/schemas/SchlageDoorExtensionShadow" + } ], "properties" : { - "alert_rate_limit_human_only" : { - "$ref" : "#/components/schemas/BurstyRateLimit" - }, - "alert_rate_limit_motion_only" : { - "$ref" : "#/components/schemas/BurstyRateLimit" + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "alert_rate_limit_vehicle_only" : { - "$ref" : "#/components/schemas/BurstyRateLimit" + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "ir_double_tap" : { - "type" : "boolean", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ir_filter_mode" : { - "$ref" : "#/components/schemas/IRModesEnum" + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "ir_leds_mode" : { - "$ref" : "#/components/schemas/IRModesEnum" + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Device_config_GetConfigWSRequest" : { + "Component_AddAccessControlledDoorLabelWSRequest" : { "type" : "object", - "description" : "Request object for retrieving a device's configuration.", "properties" : { - "deviceUuid" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "label" : { + "type" : "string", + "nullable" : true } } }, - "Device_config_GetFacetedUserConfigWSResponse" : { + "Component_AddAccessControlledDoorLabelWSResponse" : { + "type" : "object" + }, + "Component_AddAccessControlledElevatorLandingLabelWSRequest" : { "type" : "object", - "description" : "Response object containing a device's faceted user configuration.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "accessControlledElevatorLandingUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "label" : { "type" : "string", "nullable" : true } } }, - "Device_config_UpdateFacetedUserConfigWSRequest" : { + "Component_AddAccessControlledElevatorLandingLabelWSResponse" : { + "type" : "object" + }, + "Component_AggregatedCredentialReceivedEventInfo" : { "type" : "object", - "description" : "Request object for updating a device's faceted user configuration.", "properties" : { - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" + "firstEvent" : { + "$ref" : "#/components/schemas/CredentialReceivedEventType" + }, + "lastEvent" : { + "$ref" : "#/components/schemas/CredentialReceivedEventType" + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "Device_config_settings_ExternalAudioSettingsSelectiveUpdate" : { + "Component_ApplyAccessControlledDoorStateOverrideWSRequest" : { "type" : "object", - "description" : "Update Audio settings", + "description" : "Door state overrides are temporary changes to door's lock/unlock state even if otherwise scheduled. They can be superseded or cancelled at anytime.", "properties" : { - "audio_aec_via_software" : { - "type" : "boolean", + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_ai_disabled" : { - "type" : "boolean", - "nullable" : true + "doorAuthFirstInState" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" }, - "audio_external_mic_boost" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "doorScheduleFirstInState" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" }, - "audio_external_mic_volume" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "expireEarlyMode" : { + "$ref" : "#/components/schemas/EarlyExpireModeEnum" }, - "audio_external_speaker_volume" : { + "expiresAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "A millisecond epoch time that represents when the override will end if not ended earlier by a regular schedule interval. Cannot be longer than 24 hours and default is 24hours long", "nullable" : true }, - "audio_internal_mic_aec_enabled" : { + "followFirstInRules" : { "type" : "boolean", + "description" : "Default is false if not specified, the door state override will ignore schedule first-in requirements (if applicable) if false", "nullable" : true }, - "audio_internal_mic_boost" : { + "startDelaySeconds" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "Default is 0 if not specified, determines how long to wait before applying the override", "nullable" : true }, - "audio_internal_mic_volume" : { - "type" : "integer", - "format" : "int32", + "state" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + } + }, + "required" : [ "accessControlledDoorUuid", "state" ] + }, + "Component_ApplyAccessControlledDoorStateOverrideWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoor" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + } + } + }, + "Component_ApplyAccessControlledElevatorLandingAccessStateOverrideWSRequest" : { + "type" : "object", + "description" : "Elevator landing state overrides are temporary changes to landings's lock/unlock state even if otherwise scheduled. They can be superseded or cancelled at anytime.", + "properties" : { + "accessControlledElevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_internal_speaker_volume" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "accessScheduleFirstInState" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" }, - "audio_min_echo_amplitude" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "authFirstInState" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" }, - "audio_playback_gain_percent" : { + "expireEarlyMode" : { + "$ref" : "#/components/schemas/EarlyExpireModeEnum" + }, + "expiresAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "A millisecond epoch time that represents when the override will end if not ended earlier by a regular schedule interval. Cannot be longer than 24 hours and default is 24hours long", "nullable" : true }, - "audio_record" : { + "followFirstInRules" : { "type" : "boolean", + "description" : "Default is false if not specified, the elevator landing state override will ignore schedule first-in requirements (if applicable) if false", "nullable" : true }, - "audio_supported" : { - "type" : "boolean", + "startDelaySeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Default is 0 if not specified, determines how long to wait before applying the override", "nullable" : true }, - "audio_use_external_mic" : { - "type" : "boolean", + "state" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + } + }, + "required" : [ "accessControlledElevatorLandingUuid", "state" ] + }, + "Component_ApplyAccessControlledElevatorLandingAccessStateOverrideWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + } + } + }, + "Component_CancelAccessControlledDoorStateOverrideWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "audio_use_external_speaker" : { - "type" : "boolean", + } + }, + "required" : [ "accessControlledDoorUuid" ] + }, + "Component_CancelAccessControlledDoorStateOverrideWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoor" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + } + } + }, + "Component_CancelAccessControlledElevatorLandingAccessStateOverrideWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "audio_use_internal_speaker" : { - "type" : "boolean", + } + }, + "required" : [ "accessControlledElevatorLandingUuid" ] + }, + "Component_CancelAccessControlledElevatorLandingAccessStateOverrideWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + } + } + }, + "Component_CreateAccessControlledDoorSeekpointsWSRequest" : { + "type" : "object", + "properties" : { + "doorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "device_mic_enabled" : { - "type" : "boolean", + "seekPoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CustomFootageSeekPointType" + }, "nullable" : true - }, - "device_near_audio_silenced" : { + } + } + }, + "Component_CreateAccessControlledDoorSeekpointsWSResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "device_speaker_enabled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "frontendEqualizerHighShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerLowShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking1" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking2" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking3" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "successMsg" : { + "type" : "string", + "nullable" : true }, - "frontendNoiseSuppression" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Component_CreateAccessControlledDoorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoor" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", + "accessControlledDoorLabels" : { + "type" : "array", + "items" : { + "type" : "string", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true } } }, - "Device_config_settings_ExternalDeviceSettingsSelectiveUpdate" : { + "Component_CreateAccessControlledDoorWSResponse" : { "type" : "object", "properties" : { - "ai_license_invalid" : { - "type" : "boolean", - "nullable" : true + "accessControlledDoor" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" }, - "bandwidth_reports_disabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "firmware_dev_settings" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "led_mode_blink_period_ms" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Component_CreateAccessControlledElevatorLandingWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { - "type" : "boolean", - "nullable" : true + "accessControlledElevatorLandingLabels" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Component_CreateAccessControlledElevatorLandingWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, - "lightweight_detection_disabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "live_license_invalid" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "media_ttl_minutes" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Component_CreateAccessControlledElevatorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevator" : { + "$ref" : "#/components/schemas/AccessControlledElevator" + } + } + }, + "Component_CreateAccessControlledElevatorWSResponse" : { + "type" : "object", + "nullable" : true, + "properties" : { + "accessControlledElevator" : { + "$ref" : "#/components/schemas/AccessControlledElevator" }, - "on_demand_license_invalid" : { + "error" : { "type" : "boolean", "nullable" : true }, - "scanner_agent_disabled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_CreateAperioDoorInfo" : { + "type" : "object", + "description" : "The Aperio-assigned ID of the door(s) and the Aperio-assigned ID of their lock device.", + "properties" : { + "aperioDoorDeviceId" : { + "type" : "string", "nullable" : true }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "aperioDoorId" : { + "type" : "string", "nullable" : true } } }, - "Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate" : { + "Component_CreateAperioDoorsWSRequest" : { "type" : "object", - "description" : "Update Door Controller settings", "properties" : { - "autocomponentize_readers" : { - "type" : "boolean", + "aperioGatewayComponentId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "autoregister_readers" : { - "type" : "boolean", + "doors" : { + "type" : "array", + "description" : "The Aperio-assigned ID of the door(s) and the Aperio-assigned ID of their lock device.", + "items" : { + "$ref" : "#/components/schemas/Component_CreateAperioDoorInfo" + }, "nullable" : true }, - "flip_display_orientation" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pressure_switch_tamper_normally_open" : { - "type" : "boolean", + } + }, + "required" : [ "aperioGatewayComponentId", "doors", "ownerDeviceUuid" ] + }, + "Component_CreateAperioDoorsWSResponse" : { + "type" : "object", + "properties" : { + "doors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + }, "nullable" : true }, - "proximity_sensor_tamper_disabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "proximity_sensor_tamper_distance_threshold" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true + "failedDoors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Device_config_settings_ExternalReadableAudioSettings" : { + "Component_CreateAperioGatewayWSRequest" : { "type" : "object", "properties" : { - "audio_aec_via_software" : { - "type" : "boolean", - "nullable" : true - }, - "audio_ai_disabled" : { - "type" : "boolean", + "aperioGatewayId" : { + "type" : "string", + "description" : "The Aperio-assigned ID of the gateway, given as a hex string, e.g. \"034AB5\".", "nullable" : true }, - "audio_analysis_enabled" : { + "includeAperioDoors" : { "type" : "boolean", + "default" : false, + "description" : "If enabled, also creates Aperio doors with this request.", "nullable" : true }, - "audio_external_mic_boost" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "audio_external_mic_volume" : { - "type" : "integer", - "format" : "int32", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "aperioGatewayId", "ownerDeviceUuid" ] + }, + "Component_CreateAperioGatewayWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/AperioGateway" }, - "audio_external_speaker_volume" : { - "type" : "integer", - "format" : "int32", + "doors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + }, "nullable" : true }, - "audio_internal_mic_aec_enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "audio_internal_mic_boost" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "audio_internal_mic_volume" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audio_internal_speaker_volume" : { - "type" : "integer", - "format" : "int32", + "failedDoors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + }, "nullable" : true }, - "audio_min_echo_amplitude" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "audio_playback_gain_percent" : { + } + } + }, + "Component_CreateAperioRs485DoorInfo" : { + "type" : "object", + "description" : "Where each lock sits on the hub's line, and what kind of lock it is.", + "properties" : { + "eacAddress" : { "type" : "integer", "format" : "int32", + "description" : "Where the lock answers on its hub's RS-485 line, 0x01 to 0xFF. The hub's base address comes from its DIP switches and its locks are addressed from there: a hub based at 0x01 has locks at 0x01, 0x11, 0x21 and so on.", + "example" : 17, "nullable" : true }, - "audio_record" : { - "type" : "boolean", - "nullable" : true - }, - "audio_supported" : { - "type" : "boolean", + "model" : { + "$ref" : "#/components/schemas/AperioLockModelEnum" + } + }, + "required" : [ "eacAddress" ] + }, + "Component_CreateAperioRs485DoorsWSRequest" : { + "type" : "object", + "properties" : { + "aperioGatewayComponentId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_use_external_mic" : { - "type" : "boolean", + "doors" : { + "type" : "array", + "description" : "Where each lock sits on the hub's line, and what kind of lock it is.", + "items" : { + "$ref" : "#/components/schemas/Component_CreateAperioRs485DoorInfo" + }, "nullable" : true }, - "audio_use_external_speaker" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "audio_use_internal_speaker" : { - "type" : "boolean", + } + }, + "required" : [ "aperioGatewayComponentId", "doors", "ownerDeviceUuid" ] + }, + "Component_CreateAperioRs485DoorsWSResponse" : { + "type" : "object", + "properties" : { + "doors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + }, "nullable" : true }, - "device_mic_enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "device_near_audio_silenced" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "device_speaker_enabled" : { - "type" : "boolean", + "failedDoors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Component_FailedRs485Door" + }, "nullable" : true }, - "frontendEqualizerHighShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerLowShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking1" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking2" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking3" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendNoiseSuppression" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Device_config_settings_ExternalReadableButtonSettings" : { + "Component_CreateAperioRs485GatewayWSResponse" : { "type" : "object", "properties" : { - "button_emergency_onsite_contact" : { - "$ref" : "#/components/schemas/EmergencyContact" + "component" : { + "$ref" : "#/components/schemas/AperioRs485Gateway" }, - "button_test_mode_enabled" : { + "error" : { "type" : "boolean", "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Device_config_settings_ExternalReadableDeviceSettings" : { + "Component_CreateIntegratedDoorPositionIndicatorWSRequest" : { "type" : "object", "properties" : { - "ai_license_invalid" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "bandwidth_reports_disabled" : { - "type" : "boolean", - "nullable" : true + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" }, - "cloud_archive_days" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "cloud_archive_upload_schedule" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" - }, - "nullable" : true - }, - "cloud_archive_upload_schedule_inverted" : { - "type" : "boolean", - "nullable" : true - }, - "cloud_archive_upload_schedule_uuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firmware_dev_settings" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "port" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" + } + } + }, + "Component_CreateIntegratedDoorPositionIndicatorWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" + } + } + }, + "Component_CreateIntegratedDoorRelayWSRequest" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", "nullable" : true }, - "led_mode_blink_period_ms" : { - "type" : "integer", - "format" : "int64", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { - "type" : "boolean", - "nullable" : true + "port" : { + "$ref" : "#/components/schemas/DoorRelayPortType" + } + } + }, + "Component_CreateIntegratedDoorRelayWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedDoorRelayType" + } + } + }, + "Component_CreateIntegratedGenericButtonWSRequest" : { + "type" : "object", + "properties" : { + "mode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" }, - "lightweight_detection_disabled" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "live_license_invalid" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "max_event_duration_ms" : { - "type" : "integer", - "format" : "int32", + "port" : { + "$ref" : "#/components/schemas/ButtonPortType" + } + } + }, + "Component_CreateIntegratedGenericButtonWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericButtonType" + } + } + }, + "Component_CreateIntegratedGenericInputWSRequest" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", "nullable" : true }, - "media_ttl_minutes" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" }, - "on_demand_license_invalid" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scanner_agent_disabled" : { - "type" : "boolean", + "port" : { + "$ref" : "#/components/schemas/AuxiliaryInputPortType" + } + } + }, + "Component_CreateIntegratedGenericInputWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericInputType" + } + } + }, + "Component_CreateIntegratedGenericRelayWSRequest" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", "nullable" : true }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "port" : { + "$ref" : "#/components/schemas/AuxiliaryRelayPortType" }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" + "steadyState" : { + "$ref" : "#/components/schemas/GenericRelayStateEnumType" } } }, - "Device_config_settings_ExternalReadableDeviceVideoSettings" : { + "Component_CreateIntegratedGenericRelayWSResponse" : { "type" : "object", "properties" : { - "alert_rate_limit_human_only" : { - "$ref" : "#/components/schemas/BurstyRateLimit" - }, - "alert_rate_limit_motion_only" : { - "$ref" : "#/components/schemas/BurstyRateLimit" - }, - "alert_rate_limit_vehicle_only" : { - "$ref" : "#/components/schemas/BurstyRateLimit" - }, - "ir_double_tap" : { - "type" : "boolean", - "nullable" : true - }, - "ir_filter_mode" : { - "$ref" : "#/components/schemas/IRModesEnum" - }, - "ir_leds_mode" : { - "$ref" : "#/components/schemas/IRModesEnum" + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericRelayType" } } }, - "Device_config_settings_ExternalReadableDoorControllerSettings" : { + "Component_CreateIntegratedRequestToExitWSRequest" : { "type" : "object", "properties" : { - "autocomponentize_readers" : { + "intentOnly" : { "type" : "boolean", "nullable" : true }, - "autoregister_readers" : { + "intentOnlyEvents" : { "type" : "boolean", "nullable" : true }, - "flip_display_orientation" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "pressure_switch_tamper_normally_open" : { - "type" : "boolean", - "nullable" : true + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" }, - "proximity_sensor_tamper_disabled" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "proximity_sensor_tamper_distance_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true + "port" : { + "$ref" : "#/components/schemas/RequestToExitPortType" } } }, - "Device_config_settings_ExternalReadableVideoSettings" : { + "Component_CreateIntegratedRequestToExitWSResponse" : { "type" : "object", "properties" : { - "ai_dewarp_config" : { - "$ref" : "#/components/schemas/CameraAiDewarpConfigType" - }, - "behavior_detection" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedRequestToExitType" + } + } + }, + "Component_CreateOsdpReaderWSRequest" : { + "type" : "object", + "properties" : { + "allowUnencrypted" : { "type" : "boolean", "nullable" : true }, - "blocked_debounce_time_ms" : { - "type" : "integer", - "format" : "int32", + "disableCardReader" : { + "type" : "boolean", "nullable" : true }, - "blocked_threshold" : { - "type" : "number", - "format" : "float", + "disableKeypad" : { + "type" : "boolean", "nullable" : true }, - "char_threshold" : { - "type" : "number", - "format" : "float", + "name" : { + "type" : "string", "nullable" : true }, - "color_detection" : { + "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "con_human_filter" : { - "type" : "integer", - "format" : "int32", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "con_vehicle_filter" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "port" : { + "$ref" : "#/components/schemas/OsdpReaderPortType" }, - "cross_counting" : { + "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true + } + } + }, + "Component_CreateOsdpReaderWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/OsdpDoorReaderType" + } + } + }, + "Component_CreateRhombusOsdpReaderWSRequest" : { + "type" : "object", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "cross_counting_settings" : { - "$ref" : "#/components/schemas/CameraCrossCountingSettingsType" - }, - "custom_events" : { + "disableCardReader" : { "type" : "boolean", "nullable" : true }, - "dewarpMode" : { - "$ref" : "#/components/schemas/CameraDewarpModeEnum" + "disableWaveToUnlock" : { + "type" : "boolean", + "nullable" : true }, - "disabled_schedule" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" - }, + "name" : { + "type" : "string", "nullable" : true }, - "disabled_schedule_inverted" : { + "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "disabled_schedule_uuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dwell_reset_ttl_ms" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "dwell_time_ms" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "port" : { + "$ref" : "#/components/schemas/OsdpReaderPortType" }, - "engagement_counting" : { + "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true + } + } + }, + "Component_CreateRhombusOsdpReaderWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" + } + } + }, + "Component_CreateSchlageRs485DoorInfo" : { + "type" : "object", + "description" : "Where each lock sits on the gateway's line, and which family of lock it is.", + "properties" : { + "apmFamily" : { + "$ref" : "#/components/schemas/SchlageApmFamilyEnum" }, - "exposure_level" : { + "rs485Address" : { "type" : "integer", "format" : "int32", + "description" : "The lock's APM address on its gateway's RS-485 line, 0x00 to 0xFE. 0xAA is the broadcast address and never names a lock.", + "example" : 18, "nullable" : true - }, - "face_ai_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "face_counting" : { - "type" : "boolean", + } + }, + "required" : [ "rs485Address" ] + }, + "Component_CreateSchlageRs485DoorsWSRequest" : { + "type" : "object", + "properties" : { + "doors" : { + "type" : "array", + "description" : "Where each lock sits on the gateway's line, and which family of lock it is.", + "items" : { + "$ref" : "#/components/schemas/Component_CreateSchlageRs485DoorInfo" + }, "nullable" : true }, - "face_counting_nonunique" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "face_id_ai_threshold" : { - "type" : "number", - "format" : "float", + "schlageGatewayComponentId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "face_match_threshold" : { - "type" : "number", - "format" : "float", + } + }, + "required" : [ "doors", "ownerDeviceUuid", "schlageGatewayComponentId" ] + }, + "Component_CreateSchlageRs485DoorsWSResponse" : { + "type" : "object", + "properties" : { + "doors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + }, "nullable" : true }, - "face_recognition" : { + "error" : { "type" : "boolean", "nullable" : true }, - "fisheye_display_mode" : { - "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "floorplan_homography" : { + "failedDoors" : { "type" : "array", "items" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true + "$ref" : "#/components/schemas/Component_FailedRs485Door" }, "nullable" : true }, - "hdr_enabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Component_CreateSchlageRs485GatewayWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/SchlageRs485Gateway" }, - "high_res_detection" : { + "error" : { "type" : "boolean", "nullable" : true }, - "human_detection" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "human_loitering" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Component_CreateWiegandReaderWSRequest" : { + "type" : "object", + "properties" : { + "buzzerPort" : { + "$ref" : "#/components/schemas/WiegandOutputPortType" }, - "human_loitering_settings" : { - "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" - }, - "img_brightness" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "csnEndian" : { + "$ref" : "#/components/schemas/WiegandCredentialEndianEnumType" }, - "img_contrast" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "d0Port" : { + "$ref" : "#/components/schemas/WiegandDataPortType" }, - "img_saturation" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "d1Port" : { + "$ref" : "#/components/schemas/WiegandDataPortType" }, - "img_sharpness" : { - "type" : "integer", - "format" : "int32", + "disableCardReader" : { + "type" : "boolean", "nullable" : true }, - "licenseplate_detection" : { + "disableKeypad" : { "type" : "boolean", "nullable" : true }, - "lpr_ai_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true + "gledPort" : { + "$ref" : "#/components/schemas/WiegandOutputPortType" }, - "max_detections_per_frame" : { - "type" : "integer", - "format" : "int32", + "name" : { + "type" : "string", "nullable" : true }, - "metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" - }, - "motion_grid_disabled" : { + "otherReaderUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "motion_grid_window_sec" : { - "type" : "integer", - "format" : "int32", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "motion_lightweight_disabled" : { + "remoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "motion_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "motor_config" : { - "$ref" : "#/components/schemas/CameraMotorConfigType" - }, - "mounting_direction" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + "rledPort" : { + "$ref" : "#/components/schemas/WiegandOutputPortType" }, - "new_motion_feature_flag" : { - "type" : "boolean", + "tamperPort" : { + "$ref" : "#/components/schemas/WiegandInputPortType" + } + } + }, + "Component_CreateWiegandReaderWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/WiegandDoorReaderType" + } + } + }, + "Component_DeleteAccessControlledDoorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "night_exposure_level" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_DeleteAccessControlledDoorWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoor" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" + } + } + }, + "Component_DeleteAccessControlledElevatorLandingWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "night_img_brightness" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_DeleteAccessControlledElevatorLandingWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + } + } + }, + "Component_DeleteAccessControlledElevatorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "night_img_contrast" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_DeleteAccessControlledElevatorWSResponse" : { + "type" : "object", + "nullable" : true, + "properties" : { + "accessControlledElevator" : { + "$ref" : "#/components/schemas/AccessControlledElevator" + } + } + }, + "Component_DeleteComponentWSRequest" : { + "type" : "object", + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "night_img_saturation" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_DeleteComponentWSResponse" : { + "type" : "object" + }, + "Component_DeleteComponentsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "night_img_sharpness" : { + } + } + }, + "Component_DeleteComponentsByOwnerDeviceWSResponse" : { + "type" : "object" + }, + "Component_FailedRs485Door" : { + "type" : "object", + "properties" : { + "address" : { "type" : "integer", "format" : "int32", + "description" : "The address the caller asked for, so the failure can be matched to a row. The EAC address for Aperio, the APM address for Schlage.", "nullable" : true }, - "night_metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" + "door" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" }, - "night_sensor_gain_max" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "string", + "description" : "Failure message", "nullable" : true }, - "night_shutter_time_max" : { - "type" : "integer", - "format" : "int32", + "status" : { + "$ref" : "#/components/schemas/OpStatusEnum" + } + } + }, + "Component_FindAccessControlledDoorShadowsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "night_shutter_time_min" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "obj_ai_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindAccessControlledDoorShadowsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "object_search" : { - "type" : "boolean", + "shadows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorShadow" + }, "nullable" : true - }, - "occupancy_counting" : { - "type" : "boolean", + } + } + }, + "Component_FindAccessControlledDoorShadowsWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "people_counting" : { - "type" : "boolean", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true - }, - "person_ai_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindAccessControlledDoorShadowsWSResponse" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "person_reidentification" : { - "type" : "boolean", + "shadows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorShadow" + }, "nullable" : true - }, - "pose_detection" : { - "type" : "boolean", + } + } + }, + "Component_FindAccessControlledDoorsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "ppe_detection" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "privacy_window_polygons" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" - }, + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true - }, - "privacy_windows" : { + } + } + }, + "Component_FindAccessControlledDoorsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoors" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PermyriadRect" + "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, - "ptz_config" : { - "$ref" : "#/components/schemas/CameraPTZConfigType" - }, - "region_for_occupancy" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest_groups" : { + "lastEvaluatedKey" : { + "type" : "string", + "nullable" : true + } + } + }, + "Component_FindAccessControlledDoorsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Component_FindAccessControlledDoorsByOwnerDeviceWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoors" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/RegionOfInterestGroup" + "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true - }, - "resolution" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" - }, - "rotation" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "rtsp_encoder" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "segment_max_bytes" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindAccessControlledDoorsWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "sensor_gain_max" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "shared_fov" : { + } + } + }, + "Component_FindAccessControlledDoorsWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoors" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/AccessControlledDoorType" }, "nullable" : true }, - "shutter_time_max" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "shutter_time_min" : { - "type" : "integer", - "format" : "int32", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "snapshot_height" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindAccessControlledElevatorLandingShadowsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "snapshot_interval_secs" : { - "type" : "integer", - "format" : "int32", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "target_ai_fps" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "thumbstrip_disabled" : { - "type" : "boolean", + } + } + }, + "Component_FindAccessControlledElevatorLandingShadowsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "tile_views" : { + "shadows" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/DewarpedView" + "$ref" : "#/components/schemas/AccessControlledElevatorLandingShadow" }, "nullable" : true - }, - "timelapse" : { - "type" : "boolean", - "nullable" : true - }, - "upload_all_detections" : { - "type" : "boolean", - "nullable" : true - }, - "use_onboard_ai" : { - "type" : "boolean", - "nullable" : true - }, - "use_onboard_lpr" : { - "type" : "boolean", - "nullable" : true - }, - "use_pilot_face_id" : { - "type" : "boolean", - "nullable" : true - }, - "vehicle_ai_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindAccessControlledElevatorLandingShadowsWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "vehicle_counting" : { - "type" : "boolean", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true - }, - "vehicle_detection" : { - "type" : "boolean", + } + } + }, + "Component_FindAccessControlledElevatorLandingShadowsWSResponse" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "video_ai_disabled" : { - "type" : "boolean", + "shadows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLandingShadow" + }, "nullable" : true - }, - "video_persist_disabled" : { - "type" : "boolean", + } + } + }, + "Component_FindAccessControlledElevatorLandingsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "visual_tamper_config" : { - "$ref" : "#/components/schemas/CameraVisualTamperConfigType" - }, - "wdr_enabled" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wdr_strength" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "zero_motion_video_bitrate_percent" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindAccessControlledElevatorLandingsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLandings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + }, "nullable" : true }, - "zero_motion_video_quality" : { - "type" : "integer", - "format" : "int32", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true } } }, - "Device_config_settings_ExternalVideoResolution" : { + "Component_FindAccessControlledElevatorLandingsWSRequest" : { "type" : "object", "properties" : { - "height" : { - "type" : "integer", - "format" : "int32", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "width" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true } } }, - "Device_config_settings_ExternalVideoSettingsSelectiveUpdate" : { + "Component_FindAccessControlledElevatorLandingsWSResponse" : { "type" : "object", - "description" : "Update Video Settings", "properties" : { - "blocked_debounce_time_ms" : { - "type" : "integer", - "format" : "int32", + "accessControlledElevatorLandings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" + }, "nullable" : true }, - "blocked_threshold" : { - "type" : "number", - "format" : "float", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "char_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindAccessControlledElevatorsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "custom_events" : { - "type" : "boolean", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dewarpMode" : { - "$ref" : "#/components/schemas/CameraDewarpModeEnum" - }, - "disabled_schedule" : { + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Component_FindAccessControlledElevatorsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevators" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + "$ref" : "#/components/schemas/AccessControlledElevator" }, "nullable" : true }, - "disabled_schedule_inverted" : { - "type" : "boolean", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "disabled_schedule_uuid" : { + } + } + }, + "Component_FindAccessControlledElevatorsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "dwell_reset_ttl_ms" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Component_FindAccessControlledElevatorsByOwnerDeviceWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevators" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlledElevator" + }, "nullable" : true - }, - "dwell_time_ms" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Component_FindAccessControlledElevatorsWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "exposure_level" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "fisheye_display_mode" : { - "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" - }, - "floorplan_homography" : { + } + } + }, + "Component_FindAccessControlledElevatorsWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevators" : { "type" : "array", "items" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true + "$ref" : "#/components/schemas/AccessControlledElevator" }, "nullable" : true }, - "hdr_enabled" : { - "type" : "boolean", - "nullable" : true - }, - "high_res_detection" : { - "type" : "boolean", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "human_detection" : { - "type" : "boolean", + } + } + }, + "Component_FindAllComponentShadowsWSRequest" : { + "type" : "object", + "properties" : { + "componentUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Component_FindAllComponentShadowsWSResponse" : { + "type" : "object", + "properties" : { + "acuComponentShadowMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ComponentShadowType" + }, "nullable" : true - }, - "human_loitering" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentEventsByAccessControlledDoorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "human_loitering_settings" : { - "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" - }, - "img_brightness" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "img_contrast" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "img_saturation" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "img_sharpness" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true - }, - "max_detections_per_frame" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindComponentEventsByAccessControlledDoorWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true }, - "metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" + "error" : { + "type" : "boolean", + "nullable" : true }, - "motor_config" : { - "$ref" : "#/components/schemas/CameraMotorConfigType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "mounting_direction" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Component_FindComponentEventsByAccessControlledElevatorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "night_exposure_level" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "night_img_brightness" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "night_img_contrast" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "night_img_saturation" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsByAccessControlledElevatorWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true }, - "night_img_sharpness" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "night_metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "night_sensor_gain_max" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Component_FindComponentEventsByApiTokenWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "night_shutter_time_max" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "night_shutter_time_min" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "object_search" : { - "type" : "boolean", - "nullable" : true - }, - "occupancy_counting" : { - "type" : "boolean", - "nullable" : true - }, - "person_reidentification" : { - "type" : "boolean", + "tokenUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "privacy_window_polygons" : { + "typeFilter" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" + "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true - }, - "privacy_windows" : { + } + } + }, + "Component_FindComponentEventsByApiTokenWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PermyriadRect" + "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true - }, - "ptz_config" : { - "$ref" : "#/components/schemas/CameraPTZConfigType" - }, - "region_for_occupancy" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest_groups" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RegionOfInterestGroup" - }, + } + } + }, + "Component_FindComponentEventsByComponentWSRequest" : { + "type" : "object", + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "resolution" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" - }, - "rotation" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "rtsp_encoder" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "segment_max_bytes" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "sensor_gain_max" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true - }, - "shared_fov" : { + } + } + }, + "Component_FindComponentEventsByComponentWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true - }, - "shutter_time_max" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindComponentEventsByCorrelationWSRequest" : { + "type" : "object", + "properties" : { + "correlationId" : { + "type" : "string", "nullable" : true }, - "shutter_time_min" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "snapshot_height" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "snapshot_interval_secs" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "tile_views" : { + "typeFilter" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/DewarpedView" + "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true - }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true + } + } + }, + "Component_FindComponentEventsByCorrelationWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true + } + } + }, + "Component_FindComponentEventsByCredentialHexValueWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "upload_all_detections" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "use_onboard_lpr" : { - "type" : "boolean", + "credentialHexValue" : { + "type" : "string", "nullable" : true }, - "vehicle_detection" : { - "type" : "boolean", + "limit" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "video_ai_disabled" : { - "type" : "boolean", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsByCredentialHexValueWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsByCredentialUuidWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "video_persist_disabled" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "wdr_enabled" : { - "type" : "boolean", + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wdr_strength" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "zero_motion_video_bitrate_percent" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true } } }, - "Device_config_settings_IntRange" : { + "Component_FindComponentEventsByCredentialUuidWSResponse" : { "type" : "object", "properties" : { - "max" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "min" : { - "type" : "integer", - "format" : "int32", + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true } } }, - "Device_config_settings_VideoConfigurationDefault" : { + "Component_FindComponentEventsByCredentialValueWSRequest" : { "type" : "object", - "description" : "Map of hardware variations to default video configurations", "properties" : { - "humanDetection" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "resolution" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" - }, - "segmentMaxBytes" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "sensorGainMax" : { - "type" : "integer", - "format" : "int32", + "credentialValue" : { + "type" : "string", "nullable" : true }, - "shutterTimeMin" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "vehicleDetection" : { - "type" : "boolean", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true } } }, - "Device_config_settings_VideoConfigurationOption" : { + "Component_FindComponentEventsByCredentialValueWSResponse" : { "type" : "object", - "description" : "Map of hardware variations to available video configuration options", "properties" : { - "maxBitrateRange" : { - "$ref" : "#/components/schemas/Device_config_settings_IntRange" - }, - "maxZoomPercent" : { - "type" : "integer", - "format" : "int32", + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true - }, - "resolution" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" - }, - "wdrRange" : { - "$ref" : "#/components/schemas/Device_config_settings_IntRange" } } }, - "Device_config_userconfig_ExternalReadableFacetedUserConfig" : { + "Component_FindComponentEventsByGuestPassWSRequest" : { "type" : "object", - "description" : "Device's faceted user configuration", "properties" : { - "audioFacetSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableAudioSettings" - }, + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "buttonSettings" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableButtonSettings" - }, - "climateSettings" : { - "$ref" : "#/components/schemas/ClimateSettings" - }, - "deviceSettings" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDeviceSettings" + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "deviceUuid" : { + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceVideoSettings" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDeviceVideoSettings" - }, - "doorControllerSettings" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDoorControllerSettings" - }, - "doorReaderSettings" : { - "$ref" : "#/components/schemas/DoorReaderSettings" - }, - "doorSensorSettings" : { - "$ref" : "#/components/schemas/DoorSensorSettings" + "limit" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "environmentalGatewaySettings" : { - "$ref" : "#/components/schemas/EnvironmentalGatewaySettings" + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsByGuestPassWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "lastModified" : { + "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "metricsAgentSettings" : { - "$ref" : "#/components/schemas/MetricsAgentSettings" + "limit" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "robotSettings" : { - "$ref" : "#/components/schemas/RobotSettings" - }, - "tamperSettings" : { - "$ref" : "#/components/schemas/TamperSettings" - }, - "thirdPartyCameraSettings" : { - "$ref" : "#/components/schemas/ThirdPartyCameraSettings" - }, - "videoDoorbellSettings" : { - "$ref" : "#/components/schemas/VideoDoorbellSettings" - }, - "videoFacetSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableVideoSettings" + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, "nullable" : true } } }, - "Device_config_userconfig_ExternalUpdateableFacetedUserConfig" : { + "Component_FindComponentEventsByLocationWSResponse" : { "type" : "object", - "description" : "Configuration updates to apply to the device", "properties" : { - "audioFacetSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalAudioSettingsSelectiveUpdate" + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" }, - "description" : "Update Audio settings", + "nullable" : true + } + } + }, + "Component_FindComponentEventsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "buttonSettings" : { - "$ref" : "#/components/schemas/ButtonSettingsSelectiveUpdate" - }, - "climateSettings" : { - "$ref" : "#/components/schemas/ClimateSettingsSelectiveUpdate" + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "deviceSettings" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalDeviceSettingsSelectiveUpdate" + "limit" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "deviceUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceVideoSettings" : { - "$ref" : "#/components/schemas/DeviceVideoSettingsSelectiveUpdate" - }, - "doorControllerSettings" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate" - }, - "doorReaderSettings" : { - "$ref" : "#/components/schemas/DoorReaderSettingsSelectiveUpdate" - }, - "doorSensorSettings" : { - "$ref" : "#/components/schemas/DoorSensorSettingsSelectiveUpdate" - }, - "environmentalGatewaySettings" : { - "$ref" : "#/components/schemas/EnvironmentalGatewaySettingsSelectiveUpdate" - }, - "metricsAgentSettings" : { - "$ref" : "#/components/schemas/MetricsAgentSettingsSelectiveUpdate" - }, - "robotSettings" : { - "$ref" : "#/components/schemas/RobotSettingsSelectiveUpdate" - }, - "tamperSettings" : { - "$ref" : "#/components/schemas/TamperSettingsSelectiveUpdate" - }, - "videoDoorbellSettings" : { - "$ref" : "#/components/schemas/VideoDoorbellSettingsSelectiveUpdate" - }, - "videoFacetSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoSettingsSelectiveUpdate" + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "description" : "Update Video Settings", "nullable" : true } } }, - "Device_config_userconfig_IExternalReadableAudioVideoUserConfig" : { + "Component_FindComponentEventsByOwnerDeviceWSResponse" : { "type" : "object", - "description" : "Doorbell camera configuration settings", "properties" : { - "ai_dewarp_config" : { - "$ref" : "#/components/schemas/CameraAiDewarpConfigType" - }, - "ai_license_invalid" : { - "type" : "boolean", - "nullable" : true - }, - "audio_aec_via_software" : { - "type" : "boolean", - "nullable" : true - }, - "audio_ai_disabled" : { - "type" : "boolean", - "nullable" : true - }, - "audio_analysis_enabled" : { - "type" : "boolean", + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true - }, - "audio_external_mic_boost" : { + } + } + }, + "Component_FindComponentEventsBySupportAuthorityWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_external_mic_volume" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_external_speaker_volume" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "audio_internal_mic_aec_enabled" : { - "type" : "boolean", + "supportAuthorityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_internal_mic_boost" : { + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsBySupportAuthorityWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsByUserWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_internal_mic_volume" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_internal_speaker_volume" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "audio_min_echo_amplitude" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true }, - "audio_playback_gain_percent" : { + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Component_FindComponentEventsByUserWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentEventsForCurrentUserWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_record" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "audio_supported" : { - "type" : "boolean", + "limit" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "audio_use_external_mic" : { - "type" : "boolean", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true - }, - "audio_use_external_speaker" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentEventsForCurrentUserWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true - }, - "audio_use_internal_speaker" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentEventsForOrgDashboardWSRequest" : { + "type" : "object", + "properties" : { + "componentCompositeFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "bandwidth_reports_disabled" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "behavior_detection" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "blocked_debounce_time_ms" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "blocked_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "char_threshold" : { - "type" : "number", - "format" : "float", + "reverseSearch" : { + "type" : "boolean", "nullable" : true }, - "cloud_archive_days" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true }, - "cloud_archive_upload_schedule" : { + "userFilter" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true - }, - "cloud_archive_upload_schedule_inverted" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentEventsForOrgDashboardWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true - }, - "cloud_archive_upload_schedule_uuid" : { + } + } + }, + "Component_FindComponentEventsForVideoIntercomWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "color_detection" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "con_human_filter" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "con_vehicle_filter" : { + "limit" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "cross_counting" : { - "type" : "boolean", - "nullable" : true - }, - "cross_counting_settings" : { - "$ref" : "#/components/schemas/CameraCrossCountingSettingsType" - }, - "custom_events" : { - "type" : "boolean", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true }, - "deviceUuid" : { + "videoIntercomUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "device_mic_enabled" : { - "type" : "boolean", - "nullable" : true - }, - "device_near_audio_silenced" : { - "type" : "boolean", - "nullable" : true - }, - "device_speaker_enabled" : { - "type" : "boolean", - "nullable" : true - }, - "dewarpMode" : { - "$ref" : "#/components/schemas/CameraDewarpModeEnum" - }, - "disabled_schedule" : { + } + } + }, + "Component_FindComponentEventsForVideoIntercomWSResponse" : { + "type" : "object", + "properties" : { + "componentEvents" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, - "disabled_schedule_inverted" : { + "error" : { "type" : "boolean", "nullable" : true }, - "disabled_schedule_uuid" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" : { + "type" : "object", + "description" : "Component seekpoints search for access controlled door", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dwell_reset_ttl_ms" : { + "durationSec" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "dwell_time_ms" : { + "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true - }, - "engagement_counting" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentSeekPointsByAccessControlledDoorWSResponse" : { + "type" : "object", + "properties" : { + "seekpoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentSeekPointType" + }, + "nullable" : true + } + } + }, + "Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" : { + "type" : "object", + "description" : "Component seekpoints search for access controlled doors", + "properties" : { + "accessControlledDoorUuidList" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "exposure_level" : { + "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "face_ai_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "face_counting" : { - "type" : "boolean", - "nullable" : true - }, - "face_counting_nonunique" : { + "sortResponse" : { "type" : "boolean", "nullable" : true }, - "face_id_ai_threshold" : { - "type" : "number", - "format" : "float", + "startTimeSecEpochExclusive" : { + "type" : "integer", + "format" : "int64", "nullable" : true - }, - "face_match_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "face_recognition" : { - "type" : "boolean", - "nullable" : true - }, - "firmware_dev_settings" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "fisheye_display_mode" : { - "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" - }, - "floorplan_homography" : { + } + } + }, + "Component_FindComponentSeekPointsByAccessControlledDoorsWSResponse" : { + "type" : "object", + "properties" : { + "seekpoints" : { "type" : "array", "items" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true + "$ref" : "#/components/schemas/ComponentSeekPointType" }, "nullable" : true - }, - "frontendEqualizerHighShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerLowShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking1" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking2" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking3" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendNoiseSuppression" : { - "type" : "boolean", - "nullable" : true - }, - "hdr_enabled" : { - "type" : "boolean", - "nullable" : true - }, - "high_res_detection" : { - "type" : "boolean", - "nullable" : true - }, - "human_detection" : { - "type" : "boolean", - "nullable" : true - }, - "human_loitering" : { - "type" : "boolean", - "nullable" : true - }, - "human_loitering_settings" : { - "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" - }, - "img_brightness" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "img_contrast" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "img_saturation" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindComponentSeekPointsByComponentWSRequest" : { + "type" : "object", + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "img_sharpness" : { + "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "lastModified" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "led_mode_blink_period_ms" : { + "startTimeSecEpochExclusive" : { "type" : "integer", "format" : "int64", "nullable" : true - }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { - "type" : "boolean", - "nullable" : true - }, - "licenseplate_detection" : { - "type" : "boolean", - "nullable" : true - }, - "lightweight_detection_disabled" : { - "type" : "boolean", - "nullable" : true - }, - "live_license_invalid" : { - "type" : "boolean", - "nullable" : true - }, - "lpr_ai_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindComponentSeekPointsByComponentWSResponse" : { + "type" : "object", + "properties" : { + "seekpoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentSeekPointType" + }, "nullable" : true - }, - "max_detections_per_frame" : { + } + } + }, + "Component_FindComponentSeekPointsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "max_event_duration_ms" : { - "type" : "integer", - "format" : "int32", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "media_ttl_minutes" : { + "startTimeSecEpochExclusive" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true - }, - "metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" - }, - "motion_grid_disabled" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentSeekPointsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "seekpoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentSeekPointType" + }, "nullable" : true - }, - "motion_grid_window_sec" : { + } + } + }, + "Component_FindComponentSeekPointsByOwnerDeviceWSRequest" : { + "type" : "object", + "description" : "Component seekpoints search for owner device", + "properties" : { + "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "motion_lightweight_disabled" : { - "type" : "boolean", - "nullable" : true - }, - "motion_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "motor_config" : { - "$ref" : "#/components/schemas/CameraMotorConfigType" - }, - "mounting_direction" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" - }, - "new_motion_feature_flag" : { - "type" : "boolean", - "nullable" : true - }, - "night_exposure_level" : { - "type" : "integer", - "format" : "int32", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "night_img_brightness" : { + "startTimeSecEpochExclusive" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true - }, - "night_img_contrast" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindComponentSeekPointsByOwnerDeviceWSResponse" : { + "type" : "object", + "properties" : { + "seekpoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentSeekPointType" + }, "nullable" : true - }, - "night_img_saturation" : { + } + } + }, + "Component_FindComponentSeekPointsByUserWSRequest" : { + "type" : "object", + "properties" : { + "durationSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "night_img_sharpness" : { + "startTimeSecEpochExclusive" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "night_metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" - }, - "night_sensor_gain_max" : { - "type" : "integer", - "format" : "int32", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "night_shutter_time_max" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindComponentSeekPointsByUserWSResponse" : { + "type" : "object", + "properties" : { + "seekpoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentSeekPointType" + }, "nullable" : true - }, - "night_shutter_time_min" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindComponentShadowsByComponentCompositesWSRequest" : { + "type" : "object", + "properties" : { + "componentCompositeUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Component_FindComponentShadowsByComponentCompositesWSResponse" : { + "type" : "object", + "properties" : { + "componentShadowMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ComponentShadowType" + }, "nullable" : true - }, - "obj_ai_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindComponentShadowsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "object_search" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentShadowsByOwnerDeviceWSResponse" : { + "type" : "object", + "properties" : { + "componentShadows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentShadowType" + }, "nullable" : true - }, - "occupancy_counting" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "on_demand_license_invalid" : { - "type" : "boolean", + } + } + }, + "Component_FindComponentsByOwnerDeviceWSResponse" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BaseComponentType" + }, "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Component_FindDistinctOriginatorCredentialReceivedEventsByAccessControlledDoorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "people_counting" : { - "type" : "boolean", - "nullable" : true - }, - "person_ai_threshold" : { - "type" : "number", - "format" : "float", + "activityFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, "nullable" : true }, - "person_reidentification" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "pose_detection" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "ppe_detection" : { - "type" : "boolean", + "credSourceFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CredentialSourceEnumType" + }, "nullable" : true }, - "privacy_window_polygons" : { + "originatorTypeFilter" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" + "$ref" : "#/components/schemas/EventOriginatorEnum" }, "nullable" : true }, - "privacy_windows" : { + "userFilter" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PermyriadRect" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true - }, - "ptz_config" : { - "$ref" : "#/components/schemas/CameraPTZConfigType" - }, - "region_for_occupancy" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest_groups" : { + } + } + }, + "Component_FindDistinctOriginatorCredentialReceivedEventsByAccessControlledDoorWSResponse" : { + "type" : "object", + "properties" : { + "events" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/RegionOfInterestGroup" + "$ref" : "#/components/schemas/Component_AggregatedCredentialReceivedEventInfo" }, "nullable" : true - }, - "resolution" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" - }, - "rotation" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindDistinctOriginatorCredentialReceivedEventsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "activityFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, "nullable" : true }, - "rtsp_encoder" : { - "type" : "integer", - "format" : "int32", + "componentCompositeFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "segment_max_bytes" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "sensor_gain_max" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "shared_fov" : { + "credSourceFilter" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/CredentialSourceEnumType" }, "nullable" : true }, - "shutter_time_max" : { - "type" : "integer", - "format" : "int32", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "shutter_time_min" : { - "type" : "integer", - "format" : "int32", + "originatorTypeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" + }, "nullable" : true }, - "snapshot_height" : { - "type" : "integer", - "format" : "int32", + "userFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true - }, - "snapshot_interval_secs" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindDistinctOriginatorCredentialReceivedEventsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "events" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Component_AggregatedCredentialReceivedEventInfo" + }, "nullable" : true - }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindMinimalStateAccessControlledDoorsByLocationWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "target_ai_fps" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true - }, - "thumbstrip_disabled" : { - "type" : "boolean", - "nullable" : true - }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "tile_views" : { + } + } + }, + "Component_FindMinimalStateAccessControlledDoorsByLocationWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoors" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/DewarpedView" + "$ref" : "#/components/schemas/Component_MinimalStateAccessControlledDoor" }, "nullable" : true }, - "timelapse" : { - "type" : "boolean", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "upload_all_detections" : { - "type" : "boolean", + } + } + }, + "Component_FindMinimalStateAccessControlledDoorsWSRequest" : { + "type" : "object", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "use_onboard_ai" : { - "type" : "boolean", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true - }, - "use_onboard_lpr" : { - "type" : "boolean", + } + } + }, + "Component_FindMinimalStateAccessControlledDoorsWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Component_MinimalStateAccessControlledDoor" + }, "nullable" : true }, - "use_pilot_face_id" : { - "type" : "boolean", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "vehicle_ai_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_FindPaginatedComponentEventsByAccessControlledDoorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "vehicle_counting" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "vehicle_detection" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "video_ai_disabled" : { - "type" : "boolean", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "video_persist_disabled" : { - "type" : "boolean", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "visual_tamper_config" : { - "$ref" : "#/components/schemas/CameraVisualTamperConfigType" - }, - "wdr_enabled" : { + "reverseSearch" : { "type" : "boolean", "nullable" : true }, - "wdr_strength" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "zero_motion_video_bitrate_percent" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true }, - "zero_motion_video_quality" : { - "type" : "integer", - "format" : "int32", + "userFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true } } }, - "Device_config_userconfig_IExternalReadableDoorControllerUserConfig" : { + "Component_FindPaginatedComponentEventsByAccessControlledDoorWSResponse" : { "type" : "object", - "description" : "Door controller configuration settings", + "description" : "Request object for getting list of component events for the specified door with pagination support.", "properties" : { - "ai_license_invalid" : { - "type" : "boolean", - "nullable" : true - }, - "autocomponentize_readers" : { - "type" : "boolean", - "nullable" : true - }, - "autoregister_readers" : { - "type" : "boolean", - "nullable" : true - }, - "bandwidth_reports_disabled" : { - "type" : "boolean", - "nullable" : true - }, - "cloud_archive_days" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "cloud_archive_upload_schedule" : { + "componentEvents" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, - "cloud_archive_upload_schedule_inverted" : { + "error" : { "type" : "boolean", "nullable" : true }, - "cloud_archive_upload_schedule_uuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceUuid" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "firmware_dev_settings" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, "nullable" : true }, - "flip_display_orientation" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "lastModified" : { + } + } + }, + "Component_FindPaginatedComponentEventsByOwnerDeviceWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "led_mode_blink_period_ms" : { + "createdBeforeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { - "type" : "boolean", - "nullable" : true - }, - "lightweight_detection_disabled" : { - "type" : "boolean", - "nullable" : true - }, - "live_license_invalid" : { - "type" : "boolean", - "nullable" : true - }, - "max_event_duration_ms" : { - "type" : "integer", - "format" : "int32", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "media_ttl_minutes" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "on_demand_license_invalid" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pressure_switch_tamper_normally_open" : { - "type" : "boolean", - "nullable" : true - }, - "proximity_sensor_tamper_disabled" : { + "reverseSearch" : { "type" : "boolean", "nullable" : true }, - "proximity_sensor_tamper_distance_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", + "userFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true - }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" } } }, - "Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" : { + "Component_FindPaginatedComponentEventsByOwnerDeviceWSResponse" : { "type" : "object", - "description" : "Audio/video user configuration update", + "description" : "Response object for getting list of component events for the specified owner device with pagination support.", "properties" : { - "ai_license_invalid" : { - "type" : "boolean", - "nullable" : true - }, - "audio_aec_via_software" : { - "type" : "boolean", + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true }, - "audio_ai_disabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "audio_external_mic_boost" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "audio_external_mic_volume" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audio_external_speaker_volume" : { - "type" : "integer", - "format" : "int32", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "audio_internal_mic_aec_enabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "audio_internal_mic_boost" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindPaginatedComponentEventsWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of component events in organization with pagination support.", + "properties" : { + "componentCompositeFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "audio_internal_mic_volume" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_internal_speaker_volume" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "audio_min_echo_amplitude" : { - "type" : "integer", - "format" : "int32", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "audio_playback_gain_percent" : { + "maxPageSize" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "audio_record" : { - "type" : "boolean", - "nullable" : true - }, - "audio_supported" : { - "type" : "boolean", - "nullable" : true - }, - "audio_use_external_mic" : { - "type" : "boolean", - "nullable" : true - }, - "audio_use_external_speaker" : { + "reverseSearch" : { "type" : "boolean", "nullable" : true }, - "audio_use_internal_speaker" : { - "type" : "boolean", + "typeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true }, - "bandwidth_reports_disabled" : { - "type" : "boolean", + "userFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true - }, - "blocked_debounce_time_ms" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_FindPaginatedComponentEventsWSResponse" : { + "type" : "object", + "description" : "Request object for getting list of component events in organization with pagination support.", + "properties" : { + "componentEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentEventType" + }, "nullable" : true }, - "blocked_threshold" : { - "type" : "number", - "format" : "float", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true - }, - "char_threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "Component_GetAccessControlledDoorLabelsForOrgWSRequest" : { + "type" : "object" + }, + "Component_GetAccessControlledDoorLabelsForOrgWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoorLabels" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, "nullable" : true - }, - "custom_events" : { - "type" : "boolean", + } + } + }, + "Component_GetAccessControlledElevatorLandingLabelsForOrgWSRequest" : { + "type" : "object" + }, + "Component_GetAccessControlledElevatorLandingLabelsForOrgWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLandingLabels" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, "nullable" : true - }, - "deviceUuid" : { + } + } + }, + "Component_GetCurrentExpectedAccessControlledComponentCompositeAccessStateWSRequest" : { + "type" : "object", + "description" : "Determines the expected access state based on the current time and configuration", + "properties" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "componentCompositeUuid" ] + }, + "Component_GetCurrentExpectedAccessControlledComponentCompositeAccessStateWSResponse" : { + "type" : "object", + "properties" : { + "current" : { + "$ref" : "#/components/schemas/AccessStateBlock" }, - "device_mic_enabled" : { - "type" : "boolean", - "nullable" : true - }, - "device_near_audio_silenced" : { - "type" : "boolean", - "nullable" : true - }, - "device_speaker_enabled" : { + "firstInRequirementEnabled" : { "type" : "boolean", "nullable" : true }, - "dewarpMode" : { - "$ref" : "#/components/schemas/CameraDewarpModeEnum" + "nextStateChange" : { + "$ref" : "#/components/schemas/AccessStateChange" }, - "disabled_schedule" : { + "upcomingSourceChanges" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + "$ref" : "#/components/schemas/AccessStateChange" }, "nullable" : true - }, - "disabled_schedule_inverted" : { - "type" : "boolean", - "nullable" : true - }, - "disabled_schedule_uuid" : { + } + } + }, + "Component_GetCurrentExpectedAccessControlledDoorStateWSRequest" : { + "type" : "object", + "description" : "Determines the expected door state based on the current time and current door configuration", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "accessControlledDoorUuid" ] + }, + "Component_GetCurrentExpectedAccessControlledDoorStateWSResponse" : { + "type" : "object", + "properties" : { + "activeDoorState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "dwell_reset_ttl_ms" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "activeDoorStateSource" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, - "dwell_time_ms" : { - "type" : "integer", - "format" : "int64", + "defaultDoorStateSource" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + }, + "defaultState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "doorStateIfFirstInRequired" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "doorStateIfFirstInSatisfied" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "doorStateSourceIfFirstInRequired" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + }, + "doorStateSourceIfFirstInSatisfied" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + }, + "firstInRequirementEnabled" : { + "type" : "boolean", "nullable" : true }, - "exposure_level" : { - "type" : "integer", - "format" : "int32", + "firstInRequirementSatisfied" : { + "type" : "boolean", "nullable" : true }, - "firmware_dev_settings" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "nextNearestSchedule" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeNextNearestSchedule" + } + } + }, + "Component_GetCurrentExpectedAccessControlledElevatorLandingStateWSRequest" : { + "type" : "object", + "description" : "Determines the expected access state based on the current time and current elevator landing configuration", + "properties" : { + "accessControlledElevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "accessControlledElevatorLandingUuid" ] + }, + "Component_GetCurrentExpectedAccessControlledElevatorLandingStateWSResponse" : { + "type" : "object", + "properties" : { + "accessStateIfFirstInRequired" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "fisheye_display_mode" : { - "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" + "accessStateIfFirstInSatisfied" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "floorplan_homography" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true + "accessStateSourceIfFirstInRequired" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, - "frontendEqualizerHighShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "accessStateSourceIfFirstInSatisfied" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, - "frontendEqualizerLowShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "activeAccessState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "frontendEqualizerPeaking1" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "activeAccessStateSource" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, - "frontendEqualizerPeaking2" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "defaultDoorStateSource" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, - "frontendEqualizerPeaking3" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "defaultState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "frontendNoiseSuppression" : { + "firstInRequirementEnabled" : { "type" : "boolean", "nullable" : true }, - "hdr_enabled" : { + "firstInRequirementSatisfied" : { "type" : "boolean", "nullable" : true }, - "high_res_detection" : { - "type" : "boolean", + "nextNearestSchedule" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeNextNearestSchedule" + } + } + }, + "Component_GetFullAccessControlledDoorShadowWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "human_detection" : { - "type" : "boolean", + } + } + }, + "Component_GetFullAccessControlledDoorShadowWSResponse" : { + "type" : "object", + "properties" : { + "doorComponentShadowMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ComponentShadowType" + }, "nullable" : true }, - "human_loitering" : { - "type" : "boolean", + "doorShadow" : { + "$ref" : "#/components/schemas/AccessControlledDoorShadow" + } + } + }, + "Component_GetOrCreateDevicePhysicalPortConfigWSRequest" : { + "type" : "object", + "properties" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "human_loitering_settings" : { - "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" - }, - "img_brightness" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_GetOrCreateDevicePhysicalPortConfigWSResponse" : { + "type" : "object", + "properties" : { + "detectedInvalidPortConfigs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InvalidPhysicalPortConfigType" + }, "nullable" : true }, - "img_contrast" : { - "type" : "integer", - "format" : "int32", + "deviceComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BaseComponentType" + }, "nullable" : true }, - "img_saturation" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "devicePhysicalPortConfig" : { + "$ref" : "#/components/schemas/DevicePhysicalPortConfigType" }, - "img_sharpness" : { - "type" : "integer", - "format" : "int32", + "supportedAperioLockModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AperioLockModelEnum" + }, "nullable" : true }, - "lastModified" : { - "type" : "integer", - "format" : "int64", + "supportedSchlageApmFamilies" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SchlageApmFamilyEnum" + }, "nullable" : true + } + } + }, + "Component_MinimalStateAccessControlledDoor" : { + "type" : "object", + "properties" : { + "door" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" }, - "led_mode_blink_period_ms" : { - "type" : "integer", - "format" : "int64", + "shadow" : { + "$ref" : "#/components/schemas/AccessControlledDoorShadow" + } + } + }, + "Component_RemoveAccessControlledDoorLabelWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { - "type" : "boolean", + "label" : { + "type" : "string", "nullable" : true - }, - "lightweight_detection_disabled" : { - "type" : "boolean", + } + } + }, + "Component_RemoveAccessControlledDoorLabelWSResponse" : { + "type" : "object" + }, + "Component_RemoveAccessControlledElevatorLandingLabelWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "live_license_invalid" : { - "type" : "boolean", + "label" : { + "type" : "string", "nullable" : true - }, - "max_detections_per_frame" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Component_RemoveAccessControlledElevatorLandingLabelWSResponse" : { + "type" : "object" + }, + "Component_UpdateAccessControlledDoorWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "media_ttl_minutes" : { + "ajarTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "motor_config" : { - "$ref" : "#/components/schemas/CameraMotorConfigType" + "associatedFaceDetectionCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "mounting_direction" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + "defaultState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "night_exposure_level" : { - "type" : "integer", - "format" : "int32", + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "night_img_brightness" : { - "type" : "integer", - "format" : "int32", + "doorStateToScheduleUuidMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "night_img_contrast" : { + "dpiComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "night_img_saturation" : { - "type" : "integer", - "format" : "int32", + "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { + "type" : "boolean", "nullable" : true }, - "night_img_sharpness" : { - "type" : "integer", - "format" : "int32", + "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { + "type" : "boolean", "nullable" : true }, - "night_metering_config" : { - "$ref" : "#/components/schemas/CameraMeteringConfigType" + "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true }, - "night_sensor_gain_max" : { - "type" : "integer", - "format" : "int32", + "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", "nullable" : true }, - "night_shutter_time_max" : { - "type" : "integer", - "format" : "int32", + "forcedOpenEnabled" : { + "type" : "boolean", "nullable" : true }, - "night_shutter_time_min" : { + "forcedOpenTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "object_search" : { + "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, - "occupancy_counting" : { - "type" : "boolean", + "geofenceRadius" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "on_demand_license_invalid" : { - "type" : "boolean", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "orgUuid" : { + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "person_reidentification" : { - "type" : "boolean", - "nullable" : true - }, - "privacy_window_polygons" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" - }, - "nullable" : true + "proximityUnlockSettings" : { + "$ref" : "#/components/schemas/ProximityUnlockSettingsType" }, - "privacy_windows" : { + "readerComponents" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PermyriadRect" + "$ref" : "#/components/schemas/ComponentReferenceType" }, - "nullable" : true - }, - "ptz_config" : { - "$ref" : "#/components/schemas/CameraPTZConfigType" - }, - "region_for_occupancy" : { - "$ref" : "#/components/schemas/RegionConfigType" - }, - "region_of_interest" : { - "$ref" : "#/components/schemas/RegionConfigType" + "nullable" : true, + "uniqueItems" : true }, - "region_of_interest_groups" : { + "relayComponents" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/RegionOfInterestGroup" + "$ref" : "#/components/schemas/ComponentReferenceType" }, - "nullable" : true - }, - "resolution" : { - "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" - }, - "rotation" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "rtsp_encoder" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "segment_max_bytes" : { + "relockAfterOpenTimeMs" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "sensor_gain_max" : { - "type" : "integer", - "format" : "int32", + "remoteUnlockEnabled" : { + "type" : "boolean", "nullable" : true }, - "shared_fov" : { + "rexComponents" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/ComponentReferenceType" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "shutter_time_max" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "shutter_time_min" : { - "type" : "integer", - "format" : "int32", + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", "nullable" : true }, - "snapshot_height" : { + "unlockTimeSec" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "snapshot_interval_secs" : { + "unlockTimeSecRex" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" + "waveToUnlockSettings" : { + "$ref" : "#/components/schemas/WaveToUnlockSettingsType" + } + } + }, + "Component_UpdateAccessControlledDoorWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledDoor" : { + "$ref" : "#/components/schemas/AccessControlledDoorType" }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Component_UpdateAccessControlledElevatorLandingWSRequest" : { + "type" : "object", + "properties" : { + "accessControlledElevatorLandingUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "tile_views" : { + "accessStateToScheduleUuidMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "associatedCameras" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/DewarpedView" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "upload_all_detections" : { - "type" : "boolean", - "nullable" : true + "associatedFaceDetectionCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "use_onboard_lpr" : { - "type" : "boolean", - "nullable" : true + "defaultAccessState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "vehicle_detection" : { - "type" : "boolean", + "floorNumber" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "video_ai_disabled" : { + "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, - "video_persist_disabled" : { - "type" : "boolean", + "geofenceRadius" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "wdr_enabled" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "wdr_strength" : { - "type" : "integer", - "format" : "int32", + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "zero_motion_video_bitrate_percent" : { - "type" : "integer", - "format" : "int32", + "remoteUnlockEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "Device_config_userconfig_IExternalUpdateableButtonUserConfig" : { + "Component_UpdateAccessControlledElevatorLandingWSResponse" : { "type" : "object", - "description" : "Configuration update for the button sensor", "properties" : { - "button_emergency_onsite_contact" : { - "$ref" : "#/components/schemas/EmergencyContact" + "accessControlledElevatorLanding" : { + "$ref" : "#/components/schemas/AccessControlledElevatorLanding" }, - "button_test_mode_enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "deviceUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "lastModified" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Device_config_userconfig_IExternalUpdateableDoorControllerUserConfig" : { + "Component_UpdateAccessControlledElevatorWSRequest" : { "type" : "object", - "description" : "Configuration update for the door controller", "properties" : { - "ai_license_invalid" : { - "type" : "boolean", + "accessControlledElevatorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "autocomponentize_readers" : { - "type" : "boolean", - "nullable" : true + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "autoregister_readers" : { - "type" : "boolean", - "nullable" : true + "associatedFaceDetectionCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "bandwidth_reports_disabled" : { - "type" : "boolean", + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "elevatorLandingReferenceUpdates" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ElevatorLandingReference" + }, "nullable" : true }, - "firmware_dev_settings" : { + "elevatorLandingReferences" : { "type" : "object", "additionalProperties" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/ElevatorLandingReference" }, "nullable" : true }, - "flip_display_orientation" : { + "forceAllReadersFirstInAuthRequiredLedFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "lastModified" : { - "type" : "integer", - "format" : "int64", + "forceAllReadersFirstInUnlockPendingLedFeedbackEnabled" : { + "type" : "boolean", "nullable" : true }, - "led_mode_blink_period_ms" : { - "type" : "integer", - "format" : "int64", + "forceAllReadersOtherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", "nullable" : true }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { + "forceAllReadersRemoteUnlockAudioFeedbackEnabled" : { "type" : "boolean", "nullable" : true }, - "lightweight_detection_disabled" : { + "geofenceEnabled" : { "type" : "boolean", "nullable" : true }, - "live_license_invalid" : { - "type" : "boolean", + "geofenceRadius" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "media_ttl_minutes" : { - "type" : "integer", - "format" : "int32", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "on_demand_license_invalid" : { - "type" : "boolean", + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "orgUuid" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pressure_switch_tamper_normally_open" : { - "type" : "boolean", - "nullable" : true + "proximityUnlockSettings" : { + "$ref" : "#/components/schemas/ProximityUnlockSettingsType" }, - "proximity_sensor_tamper_disabled" : { + "readerComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "remoteUnlockEnabled" : { "type" : "boolean", "nullable" : true }, - "proximity_sensor_tamper_distance_threshold" : { - "type" : "number", - "format" : "float", + "unlockTimeSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" + "waveToUnlockSettings" : { + "$ref" : "#/components/schemas/WaveToUnlockSettingsType" + } + } + }, + "Component_UpdateAccessControlledElevatorWSResponse" : { + "type" : "object", + "properties" : { + "accessControlledElevator" : { + "$ref" : "#/components/schemas/AccessControlledElevator" }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Device_health_DisableDeviceHealthTrackingWSRequest" : { + "Component_UpdateIntegratedDoorPositionIndicatorWSRequest" : { "type" : "object", - "description" : "Request object for disabling device health tracking.", "properties" : { - "deviceUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "reEnableCondition" : { - "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" + "name" : { + "type" : "string", + "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "port" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" } } }, - "Device_health_DisableDeviceHealthTrackingWSResponse" : { + "Component_UpdateIntegratedDoorPositionIndicatorWSResponse" : { "type" : "object", - "description" : "Response object for disabling device health tracking." + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedDoorPositionIndicatorType" + } + } }, - "Device_health_EnableDeviceHealthTrackingWSRequest" : { + "Component_UpdateIntegratedDoorRelayWSRequest" : { "type" : "object", - "description" : "Request object for enabling device health tracking.", "properties" : { - "deviceUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/DoorRelayPortType" } } }, - "Device_health_EnableDeviceHealthTrackingWSResponse" : { - "type" : "object", - "description" : "Response object for enabling device health tracking." - }, - "Device_health_FindDevicesWithDisabledHealthTrackingByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding devices with disabled health tracking." - }, - "Device_health_FindDevicesWithDisabledHealthTrackingByOrgWSResponse" : { + "Component_UpdateIntegratedDoorRelayWSResponse" : { "type" : "object", - "description" : "Response object for finding devices with disabled health tracking.", "properties" : { - "disabledHealthTrackingInfos" : { - "type" : "array", - "description" : "List of organization devices for which health tracking is disabled.", - "items" : { - "$ref" : "#/components/schemas/DeviceDisabledHealthTrackingInfo" - }, - "nullable" : true + "component" : { + "$ref" : "#/components/schemas/IntegratedDoorRelayType" } } }, - "Device_health_GetDeviceHealthTrackingWSRequest" : { + "Component_UpdateIntegratedGenericButtonWSRequest" : { "type" : "object", - "description" : "Request object for getting device health tracking.", "properties" : { - "deviceUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "mode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/ButtonPortType" } } }, - "Device_health_GetDeviceHealthTrackingWSResponse" : { + "Component_UpdateIntegratedGenericButtonWSResponse" : { "type" : "object", - "description" : "Response object for getting device health tracking.", "properties" : { - "enabled" : { - "type" : "boolean", - "description" : "Whether device health tracking is currently enabled for this device.", - "example" : true, - "nullable" : true - }, - "reEnableCondition" : { - "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericButtonType" } } }, - "Device_label_AddDeviceLabelWSRequest" : { + "Component_UpdateIntegratedGenericInputWSRequest" : { "type" : "object", - "description" : "Request object for adding a label to a device.", "properties" : { - "deviceUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "label" : { + "name" : { "type" : "string", - "description" : "Label to add to the device", - "example" : "Maintenance", "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "port" : { + "$ref" : "#/components/schemas/AuxiliaryInputPortType" } } }, - "Device_label_AddDeviceLabelWSResponse" : { - "type" : "object", - "description" : "Response object for adding a label to a device." - }, - "Device_label_FindDeviceLabelsByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding device labels by organization." - }, - "Device_label_FindDeviceLabelsByOrgWSResponse" : { + "Component_UpdateIntegratedGenericInputWSResponse" : { "type" : "object", - "description" : "Response object containing device labels by organization.", "properties" : { - "labelsByDevice" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device UUIDs to their associated labels", - "items" : { - "type" : "string", - "description" : "Map of device UUIDs to their associated labels", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "description" : "Map of device UUIDs to their associated labels", - "nullable" : true + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericInputType" } } }, - "Device_label_RemoveDeviceLabelWSRequest" : { + "Component_UpdateIntegratedGenericRelaySteadyStateWSRequest" : { "type" : "object", - "description" : "Request object for removing a label from a device.", "properties" : { - "deviceUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "label" : { - "type" : "string", - "description" : "Label to remove from the device.", - "example" : "Maintenance", - "nullable" : true + "steadyState" : { + "$ref" : "#/components/schemas/GenericRelayStateEnumType" } } }, - "Device_label_RemoveDeviceLabelWSResponse" : { - "type" : "object", - "description" : "Response object for removing a label from a device." - }, - "DewarpedView" : { + "Component_UpdateIntegratedGenericRelaySteadyStateWSResponse" : { "type" : "object", "properties" : { - "aspectRatio" : { - "$ref" : "#/components/schemas/AspectRatio" - }, - "pitchDegrees" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "rollDegrees" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "verticalFieldOfViewDegrees" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "yawDegrees" : { - "type" : "number", - "format" : "float", - "nullable" : true + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericRelayType" } } }, - "DiagnosticActivityEnum" : { - "type" : "string", - "enum" : [ "CAMERA_CONNECTED", "CAMERA_DISCONNECTED", "STARTUP", "GATEWAY_CONNECTED", "GATEWAY_DISCONNECTED", "UPDATE_STARTED", "UPDATE_FIRMWARE_DOWNLOADED", "UPDATE_FIRMWARE_APPLIED", "UPDATE_STARTING_REBOOT", "UPDATE_FAILED_MD5_MISMATCH", "UPDATE_FAILED_ACCESS_DENIED", "UPDATE_FAILED_MITM", "UPDATE_FAILED_CONNNECTION_REFUSED", "UPDATE_FAILED_CONNNECTION_TIMEOUT", "UPDATE_FAILED_CONNECTION_REFUSED", "UPDATE_FAILED_CONNECTION_TIMEOUT", "UPDATE_FAILED_DNS_FAILURE", "UPDATE_RUNNING", "BLE_CONNECTED", "BLE_CONNECTION_FAILED", "BLE_DISCONNECTED", "BLE_OP_SUCCESS", "BLE_OP_FAILURE", "UPLOAD_CLIP_SUCCESS", "UPLOAD_CLIP_FAILURE", "NOTIFICATION_FAILURE", "USB_FAILURE_REBOOT", "PERSISTENT_STORAGE_FAILURE", "PING", "FORCED_REBOOT", "AUTO_REBOOT", "AUDIO_HARDWARE_NOT_DETECTED", "ENCRYPTED_CONTAINER_FAILURE_CREATE", "ENCRYPTED_CONTAINER_FAILURE_OPEN", "ENCRYPTED_CONTAINER_FAILURE_MOUNT", "VIDEO_HARDWARE_FAILURE", "WIFI_NETWORK_CHANGED", "AI_ENGINE_DOWNLOADED", "AI_ENGINE_DOWNLOAD_FAILED_MD5_MISMATCH", "AI_ENGINE_CONFIGURED", "AI_ENGINE_CONFIGURATION_FAILED", "MITM_FAILURE", "SERVER_RECONNECT", "AP_CHANGED", "WATCHDOG_KILLED_AGENT", "WATCHDOG_DID_RESET", "CLIMATE_OFFLINE", "CLIMATE_ONLINE", "CLIMATE_LOW_BATTERY", "CLIMATE_PROBE_CONNECTED", "CLIMATE_PROBE_DISCONNECTED", "DOOR_OFFLINE", "DOOR_ONLINE", "DOOR_LOW_BATTERY", "OCCUPANCY_SENSOR_ONLINE", "OCCUPANCY_SENSOR_OFFLINE", "OCCUPANCY_SENSOR_LOW_BATTERY", "BUTTON_OFFLINE", "BUTTON_ONLINE", "BUTTON_LOW_BATTERY", "PROXIMITY_LOW_BATTERY", "DOOR_CONTROLLER_CONNECTED", "DOOR_CONTROLLER_DISCONNECTED", "APERIO_LOW_BATTERY", "APERIO_FLAT_BATTERY", "APERIO_OK_BATTERY", "APERIO_GW_CONNECTED", "APERIO_GW_DISCONNECTED", "BADGE_READER_CONNECTED", "BADGE_READER_DISCONNECTED", "REBOOT", "NETWORK_INTERRUPTION", "OPENPATH_WEBHOOK_FAILURE", "TOAST_WEBHOOK_FAILURE", "KISI_WEBHOOK_FAILURE", "BRIVO_WEBHOOK_FAILURE", "HALO_WEBHOOK_FAILURE", "SALTO_WEBHOOK_FAILURE", "SQUARE_WEBHOOK_FAILURE", "BUTTERFLYMX_WEBHOOK_FAILURE", "ENVOY_WEBHOOK_FAILURE", "GENEA_WEBHOOK_FAILURE", "PRODATAKEY_WEBHOOK_FAILURE", "AMT_WEBHOOK_FAILURE", "PLACEOS_WEBHOOK_FAILURE", "OMNIALERT_WEBHOOK_FAILURE", "FLIC_WEBHOOK_FAILURE", "SHELLY_WEBHOOK_FAILURE", "PIMLOC_WEBHOOK_FAILURE", "NINEONEONECELLULAR_WEBHOOK_FAILURE", "EXTERNAL_WEBHOOK_FAILURE", "CV_FAILURE", "NFC_HW_FAILURE", "CONFIG_ERROR", "HW_FAILURE", "KEYPAD_ONLINE", "KEYPAD_OFFLINE", "ALM_OVERAGE_APPROACHING", "ALM_OVERAGE_REACHED", "ALM_OVERAGE_EXCEEDED", "ALM_EXCESSIVE_VERIFICATIONS", "KIOSK_OFFLINE", "KIOSK_ONLINE", "TUNNELED_DEVICE_CONNECTED", "TUNNELED_DEVICE_DISCONNECTED", "SD_CARD_CHANGED", "SD_CARD_NOT_FOUND", "SUPERVISION_CUT_DETECTED", "SUPERVISION_SHORT_DETECTED", "SUPERVISION_INVALID_SETUP", "THIRD_PARTY_DEVICE_CONNECTED", "THIRD_PARTY_DEVICE_DISCONNECTED", "NVR_STREAMING_STATUS", "UNKNOWN" ] - }, - "DiagnosticEventType" : { + "Component_UpdateIntegratedGenericRelayTransientStateWSRequest" : { "type" : "object", - "description" : "List of diagnostic events", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/DiagnosticActivityEnum" - }, - "apMac" : { - "type" : "string", - "nullable" : true - }, - "asi" : { - "type" : "string", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "activate" : { + "type" : "boolean", "nullable" : true }, "componentUuid" : { @@ -73820,805 +75852,904 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "connectionUuid" : { + "correlationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "defaultInterface" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "defaultInterfaceMac" : { - "type" : "string", + "durationMs" : { + "type" : "integer", + "format" : "int32", "nullable" : true - }, - "deviceName" : { - "type" : "string", + } + } + }, + "Component_UpdateIntegratedGenericRelayTransientStateWSResponse" : { + "type" : "object", + "properties" : { + "success" : { + "type" : "boolean", "nullable" : true - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "deviceUuid" : { + } + } + }, + "Component_UpdateIntegratedGenericRelayWSRequest" : { + "type" : "object", + "properties" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firmwareVersion" : { + "name" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "port" : { + "$ref" : "#/components/schemas/AuxiliaryRelayPortType" + } + } + }, + "Component_UpdateIntegratedGenericRelayWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedGenericRelayType" + } + } + }, + "Component_UpdateIntegratedRequestToExitWSRequest" : { + "type" : "object", + "properties" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "reportingDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "intentOnly" : { + "type" : "boolean", "nullable" : true }, - "rssi" : { - "type" : "integer", - "format" : "int32", + "intentOnlyEvents" : { + "type" : "boolean", "nullable" : true }, - "ssid" : { + "name" : { "type" : "string", "nullable" : true }, - "timestamp" : { - "type" : "string", - "format" : "date-time", - "nullable" : true + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" }, - "uuid" : { + "port" : { + "$ref" : "#/components/schemas/RequestToExitPortType" + } + } + }, + "Component_UpdateIntegratedRequestToExitWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/IntegratedRequestToExitType" + } + } + }, + "Component_UpdateOsdpReaderWSRequest" : { + "type" : "object", + "properties" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "disableCardReader" : { + "type" : "boolean", + "nullable" : true + }, + "disableKeypad" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/OsdpReaderPortType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "DiagnosticRuleTriggerType" : { + "Component_UpdateOsdpReaderWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "deviceLabels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "deviceUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "diagnosticEvent" : { - "$ref" : "#/components/schemas/SimpleDiagnosticEventType" - }, - "locationUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } - } ], - "nullable" : true, "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + "component" : { + "$ref" : "#/components/schemas/OsdpDoorReaderType" } } }, - "DiceSettings" : { + "Component_UpdateRhombusOsdpReaderWSRequest" : { "type" : "object", "properties" : { - "enabled" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "disableCardReader" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "disableWaveToUnlock" : { + "type" : "boolean", "nullable" : true }, - "enablingUser" : { + "name" : { "type" : "string", "nullable" : true }, - "enablingUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/OsdpReaderPortType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "DiceType" : { + "Component_UpdateRhombusOsdpReaderWSResponse" : { "type" : "object", - "allOf" : [ ], - "nullable" : true, "properties" : { - "enabled" : { + "component" : { + "$ref" : "#/components/schemas/RhombusOsdpDoorReaderType" + } + } + }, + "Component_UpdateWiegandReaderWSRequest" : { + "type" : "object", + "properties" : { + "buzzerPort" : { + "$ref" : "#/components/schemas/WiegandOutputPortType" + }, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "csnEndian" : { + "$ref" : "#/components/schemas/WiegandCredentialEndianEnumType" + }, + "d0Port" : { + "$ref" : "#/components/schemas/WiegandDataPortType" + }, + "d1Port" : { + "$ref" : "#/components/schemas/WiegandDataPortType" + }, + "disableCardReader" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "disableKeypad" : { + "type" : "boolean", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "gledPort" : { + "$ref" : "#/components/schemas/WiegandOutputPortType" + }, + "name" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "rledPort" : { + "$ref" : "#/components/schemas/WiegandOutputPortType" + }, + "tamperPort" : { + "$ref" : "#/components/schemas/WiegandInputPortType" + } + } + }, + "Component_UpdateWiegandReaderWSResponse" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/WiegandDoorReaderType" + } + } + }, + "ConnectAudioDeviceToMobileAppActionType" : { + "type" : "object", + "properties" : { + "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "DisarmMonitoringRule" : { - "type" : "object", - "description" : "Rule used to manually disarm scheduled alarm policies while the monitoring mode is set to scheduled.\n", - "properties" : { - "activeAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX timestamp (in milliseconds) when this rule will go into effect.", - "nullable" : true }, - "disarmAllUntilMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The UNIX timestamp (in milliseconds) to pause all alarm policies until.", + "targetDoorStationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "disarmedAlarmPolicies" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will resume (i.e., when the pause expires).\n", + "targetUserUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will resume (i.e., when the pause expires).\n", "nullable" : true } } }, - "DiscoveredThirdPartyCameraType" : { + "ConnectAudioDeviceToPhoneNumberActionType" : { "type" : "object", - "description" : "The imported (discovered) third-party camera. This field is populated only if the RTSP URL specified in the import resulted in creation of a new discovery or an addition of a RTSP URL to an existing discovery. It is null, if the RTSP URL already existed or if the import was not successful.", "properties" : { - "codec" : { + "audioDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdOn" : { - "type" : "string", - "format" : "date-time", - "nullable" : true + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "ipAddress" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastVisibleMs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, + "optionalGreeting" : { + "type" : "string", "nullable" : true }, - "macAddress" : { + "phoneNumber" : { "type" : "string", "nullable" : true - }, - "manufacturer" : { + } + } + }, + "ConnectionStatusEnum" : { + "type" : "string", + "enum" : [ "ONLINE", "OFFLINE", "UNKNOWN" ] + }, + "ConnectivityStatus" : { + "type" : "string", + "description" : "Current connection status of the shared camera", + "enum" : [ "GREEN", "RED" ] + }, + "Consignee" : { + "type" : "object", + "properties" : { + "address1" : { "type" : "string", "nullable" : true }, - "model" : { + "address2" : { "type" : "string", "nullable" : true }, - "name" : { + "address3" : { "type" : "string", "nullable" : true }, - "onvifPassword" : { + "city" : { "type" : "string", "nullable" : true }, - "onvifProfileToken" : { + "companyName" : { "type" : "string", "nullable" : true }, - "onvifUsername" : { + "contactName" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "country" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "password" : { + "phoneNumber" : { "type" : "string", "nullable" : true }, - "rtspEndpoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RtspEndpoint" - }, - "nullable" : true, - "uniqueItems" : true - }, - "updatedOn" : { + "postalCode" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "username" : { + "state" : { "type" : "string", "nullable" : true } } }, - "DoorAjarActivityEventType" : { + "ContentDisposition" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "doorAjarThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" - } - } - }, - "DoorAuthFirstInStateEvent" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "acuEventUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "newState" : { - "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "settingsUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "source" : { - "$ref" : "#/components/schemas/FirstInSourceEnum" - }, - "stateChangedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "attachment" : { + "type" : "boolean", + "nullable" : true + }, + "charset" : { + "type" : "object", + "nullable" : true, + "properties" : { + "registered" : { + "type" : "boolean", + "nullable" : true + } } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + }, + "creationDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "correlationId" : { + "filename" : { "type" : "string", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "formData" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "inline" : { + "type" : "boolean", + "nullable" : true + }, + "modificationDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "orgUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "readDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "timestampMs" : { + "size" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "DoorEventType" : { + "ContextRecord" : { "type" : "object", - "description" : "List of door open/close events for the sensor", "properties" : { - "baseStationUuid" : { + "attributedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "batteryPercentage" : { - "type" : "integer", - "format" : "int32", + "automated" : { + "type" : "boolean", "nullable" : true }, - "bleDeviceUuid" : { + "contextId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "bleRssi" : { + "expiresAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "closeBaseStations" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "name" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/DoorStateEnum" - }, - "stateChanged" : { - "type" : "boolean", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "timestampMs" : { + "queriedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true + }, + "requestedBy" : { + "$ref" : "#/components/schemas/RequestedBy" } } }, - "DoorFirstInStateChangeEventReference" : { + "ContextRecordSelectiveUpdate" : { "type" : "object", - "nullable" : true, "properties" : { - "doorUuidToEventUuidMap" : { + "realTarget" : { + "$ref" : "#/components/schemas/ContextRecord" + }, + "updatedFieldNameMap" : { "type" : "object", "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : "boolean", "nullable" : true }, "nullable" : true - }, - "newState" : { - "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" - }, - "originatingDoorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "originatingUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "source" : { - "$ref" : "#/components/schemas/FirstInSourceEnum" - }, - "stateChangedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "DoorLocationLockdownStateEventType" : { + "CountingActivityEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "activatedLockdownPlan" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "activeLockdownPlan" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "acuEventUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "deactivatedLockdownPlan" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "followingTestPlan" : { - "type" : "boolean", - "nullable" : true - }, - "locationLockdownStateChangedAtMillis" : { + "countingThreshold" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateEnumType" } } } ], "nullable" : true, "properties" : { - "componentUuid" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "CreateAlarmActionRecordType" : { + "type" : "object", + "properties" : { + "alarmId" : { + "type" : "string", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "outcome" : { "type" : "string", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "succeeded" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "CreateAlarmActionType" : { + "type" : "object", + "properties" : { + "attachMediaToActiveAlarm" : { + "type" : "boolean", + "nullable" : true }, - "orgUuid" : { + "entryInstructions" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "exclusiveEmergencyContact" : { + "type" : "boolean", + "nullable" : true + }, + "exclusiveEntryInstructions" : { + "type" : "boolean", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "mediaDeviceUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "onsiteEmergencyContact" : { + "$ref" : "#/components/schemas/EmergencyContact" }, - "uuid" : { + "reason" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "sirenSettings" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "triggerType" : { + "$ref" : "#/components/schemas/CreateAlarmTriggerTypeEnum" } } }, - "DoorLockdownStateEnumType" : { + "CreateAlarmTriggerTypeEnum" : { "type" : "string", - "enum" : [ "LOCKED_DOWN", "ACCESS_CONTROLLED", "UNLOCKED", "UNKNOWN" ] + "enum" : [ "PANIC_BUTTON", "ALARM_INTEGRATION" ] }, - "DoorLockdownStateEventReference" : { + "CreateCoOccurrenceRuleRequest" : { "type" : "object", - "nullable" : true, "properties" : { - "activatedLockdownPlan" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "activeLockdownPlan" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "deactivatedLockdownPlan" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "doorEventUuid" : { + "orgUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "rule" : { + "$ref" : "#/components/schemas/IntelliGuardCoOccurrenceRule" } } }, - "DoorPolicyType" : { + "CreateCoOccurrenceRuleResponse" : { "type" : "object", - "description" : "List of door sensor policies using the schedule", "properties" : { - "defaultAjarThresholdSec" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "defaultTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "description" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "name" : { + "ruleUuid" : { "type" : "string", "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + } + } + }, + "CreateTailgatingRuleResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DoorScheduledTriggerType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "ruleUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "DoorPositionIndicatorEnumType" : { - "type" : "string", - "enum" : [ "integrated", "remote" ] - }, - "DoorPositionIndicatorPhysicalPortEnumType" : { + "CredentialCapabilityEnum" : { "type" : "string", - "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] + "enum" : [ "MULTI_FACTOR_AUTH", "PASSWORDLESS", "USERNAMELESS" ] }, - "DoorPositionIndicatorPortType" : { + "CredentialEntry" : { "type" : "object", + "discriminator" : { + "propertyName" : "credSource" + }, + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/CredentialEntryBleWave" + } ], "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "credSource" : { + "$ref" : "#/components/schemas/CredentialSourceEnumType" }, - "portNum" : { - "type" : "integer", - "format" : "int32", + "credentialId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "portType" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorPhysicalPortEnumType" + "firstInEligible" : { + "type" : "boolean", + "nullable" : true }, - "supervisionConfiguration" : { - "$ref" : "#/components/schemas/PortSupervisionConfigurationType" + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" } } }, - "DoorPositionIndicatorShadowType" : { + "CredentialEntryBleWave" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "state" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorStateEnumType" + "finalRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "stateUpdateEventTimestampMs" : { + "firstRssi" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "supervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" + "firstRssiAtIntentElapsed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "lostAtIntentElapsed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "lostAtRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "maxRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "maxRssiAtIntentElapsed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sessionFirstRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sessionFirstRssiAtElapsed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sessionLostAtElapsed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sessionLostAtRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sessionMaxRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sessionMaxRssiAtElapsed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } } ], "nullable" : true, "properties" : { - "componentUuid" : { + "credSource" : { + "$ref" : "#/components/schemas/CredentialSourceEnumType" + }, + "credentialId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "firstInEligible" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + } + } + }, + "CredentialQueryFilter" : { + "type" : "object", + "description" : "Filter criteria for finding credential history", + "properties" : { + "credTypeFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "nullable" : true, + "uniqueItems" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "lastUsedAccessControlledDoorUuidFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" + "lastUsedAfterFilter" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "updatedAtMillis" : { + "lastUsedBeforeFilter" : { "type" : "integer", "format" : "int64", "nullable" : true + }, + "lastUsedLocationUuidFilter" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "workflowStatusFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + }, + "nullable" : true, + "uniqueItems" : true } } }, - "DoorPositionIndicatorStateChangeEventType" : { + "CredentialReceivedEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { + "accessGrantOrRevocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "activeDoorLockdownState" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "activeLockdownPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "appName" : { + "type" : "string", + "nullable" : true + }, + "appOS" : { + "type" : "string", + "nullable" : true + }, + "appVersion" : { + "type" : "string", + "nullable" : true + }, + "authDecisionSource" : { + "$ref" : "#/components/schemas/AuthDecisionSourceEnum" + }, + "authDecisionUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "authWaitTimeMs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "authWaitTimeMsTotal" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "authenticationResult" : { + "$ref" : "#/components/schemas/AccessControlAuthenticationResultEnumType" + }, + "authorizationResult" : { + "$ref" : "#/components/schemas/AccessControlAuthorizationResultEnumType" + }, "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", @@ -74626,11 +76757,60 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "newState" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorStateEnumType" + "credSource" : { + "$ref" : "#/components/schemas/CredentialSourceEnumType" }, - "newSupervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" + "credentialHexValue" : { + "type" : "string", + "nullable" : true + }, + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "credentialValue" : { + "type" : "string", + "nullable" : true + }, + "credentialValueLengthBits" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "credentials" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CredentialEntry" + }, + "nullable" : true + }, + "deviceModel" : { + "type" : "string", + "nullable" : true + }, + "managedCredentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "satisfiesFirstInSettingsUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userAgent" : { + "type" : "string", + "nullable" : true } } } ], @@ -74673,6 +76853,14 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, "timestampMs" : { "type" : "integer", "format" : "int64", @@ -74690,89 +76878,102 @@ } } }, - "DoorPositionIndicatorStateEnumType" : { - "type" : "string", - "enum" : [ "OPEN", "CLOSED", "AJAR", "FORCED_OPEN", "ERROR", "UNKNOWN" ] - }, - "DoorReaderEnumType" : { + "CredentialSourceEnumType" : { "type" : "string", - "enum" : [ "wiegand", "osdp", "rhombus_osdp", "aperio_wireless" ] + "enum" : [ "UNKNOWN", "NFC", "BLE_WAVE", "BLE", "WIEGAND", "REMOTE", "REMOTE_ADMIN", "UNK_3P_OSDP", "APERIO_NFC", "APERIO_LF", "APERIO_KEYPAD", "SCHLAGE_NFC", "SCHLAGE_LF", "SCHLAGE_KEYPAD", "KEYPAD_WIEGAND", "KEYPAD_OSDP", "BLE_PROX", "QR_CODE" ] }, - "DoorReaderSettings" : { + "CroppedPermyriadRect" : { "type" : "object", "properties" : { - "dr_enable_audio_feedback" : { - "type" : "boolean", + "height" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "tof_max_distance" : { - "type" : "number", - "format" : "float", + "width" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "tof_min_distance" : { - "type" : "number", - "format" : "float", + "x" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "tof_min_signal_over_noise" : { - "type" : "number", - "format" : "float", + "y" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "DoorReaderSettingsSelectiveUpdate" : { + "CrossingCountsType" : { "type" : "object", - "description" : "Update Door Reader settings", + "description" : "List of crossing counts", "properties" : { - "dr_enable_audio_feedback" : { - "type" : "boolean", + "egressCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "tof_max_distance" : { - "type" : "number", - "format" : "float", + "ingressCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "tof_min_distance" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "tof_min_signal_over_noise" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "DoorReaderShadowType" : { + "CrossingDirectionEnum" : { + "type" : "string", + "enum" : [ "INGRESS", "EGRESS" ] + }, + "CrossingObjectEnum" : { + "type" : "string", + "enum" : [ "HUMAN", "VEHICLE", "FACE", "LPR", "POSE", "CLIP_EMBED", "UNKNOWN" ] + }, + "CustomCredential" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "state" : { - "$ref" : "#/components/schemas/DoorReaderStateEnumType" + "bitGroupValues" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true }, - "stateUpdateEventTimestampMs" : { + "customFormatName" : { + "type" : "string", + "nullable" : true + }, + "format" : { + "$ref" : "#/components/schemas/WiegandFormatEnumType" + }, + "naturalId" : { + "type" : "string", + "nullable" : true + }, + "numBits" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { - "componentUuid" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -74784,96 +76985,72 @@ "format" : "int64", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "ownerDeviceUuid" : { + "lastUsedAccessControlledDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" - }, - "updatedAtMillis" : { + "lastUsedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true - } - } - }, - "DoorReaderStateChangeEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "newState" : { - "$ref" : "#/components/schemas/DoorReaderStateEnumType" - }, - "reason" : { - "$ref" : "#/components/schemas/DoorReaderStateChangeReasonEnumType" - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + }, + "lastUsedLocationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "lowercaseHexValue" : { "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "nullable" : true, + "readOnly" : true }, - "locationUuid" : { + "managedCredUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "note" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { + "startDateEpochSecInclusive" : { "type" : "integer", "format" : "int64", "nullable" : true }, "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "uuid" : { "type" : "string", @@ -74881,70 +77058,114 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } } }, - "DoorReaderStateChangeReasonEnumType" : { - "type" : "string", - "enum" : [ "FIRMWARE_UPGRADE", "FORCED_REBOOT", "UNKNOWN" ] - }, - "DoorReaderStateEnumType" : { - "type" : "string", - "enum" : [ "CONNECTED", "DISCONNECTED", "UNKNOWN" ] - }, - "DoorRelayEnumType" : { - "type" : "string", - "enum" : [ "integrated", "remote" ] - }, - "DoorRelayPhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "GPIO_OUTPUT" ] - }, - "DoorRelayPortType" : { + "CustomFootageSeekPointType" : { "type" : "object", + "description" : "List of custom footage seek points to create", "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", + "color" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" + }, + "description" : { + "type" : "string", + "description" : "Custom activity display description, maximum 100 characters", + "maxLength" : 100, "nullable" : true }, - "portNum" : { - "type" : "integer", - "format" : "int32", + "displayOverlay" : { + "type" : "boolean", + "description" : "Whether to display this seekpoint as an overlay in Console", "nullable" : true }, - "portType" : { - "$ref" : "#/components/schemas/DoorRelayPhysicalPortEnumType" + "name" : { + "type" : "string", + "description" : "Custom activity display name, maximum 32 characters", + "maxLength" : 32, + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX MS timestamp", + "minimum" : 0, + "nullable" : true } - } + }, + "required" : [ "name", "timestampMs" ] }, - "DoorRelayShadowType" : { + "CustomImageElement" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "state" : { - "$ref" : "#/components/schemas/DoorRelayStateEnumType" + "height" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "stateUpdateEventTimestampMs" : { + "imageUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "width" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true } } } ], "nullable" : true, "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : { + "$ref" : "#/components/schemas/BadgeTemplateElementEnum" + }, + "x" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "createdAtMillis" : { + "y" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "nullable" : true + } + } + }, + "CustomLLMActionType" : { + "type" : "object", + "properties" : { + "deviceActivityEvents" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEventData" + }, + "nullable" : true + }, + "nullable" : true + }, + "deviceFacetUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, "orgUuid" : { @@ -74954,291 +77175,263 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" - }, - "updatedAtMillis" : { + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, - "DoorRelayStateChangeEventType" : { + "CustomLLMEventRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "componentCompositeUuid" : { + "deviceFacetUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "newState" : { - "$ref" : "#/components/schemas/DoorRelayStateEnumType" } } } ], "nullable" : true, "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "CustomRuleAction" : { + "type" : "object", + "properties" : { + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "correlationId" : { + "path" : { "type" : "string", "nullable" : true + } + } + }, + "CustomTextElement" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "color" : { + "type" : "string", + "nullable" : true + }, + "content" : { + "type" : "string", + "nullable" : true + }, + "maxWidth" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "style" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/BadgeTemplateElementEnum" }, - "createdAtMs" : { + "x" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "y" : { + "type" : "integer", + "format" : "int32", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "CustomerShipmentCategoryEnum" : { + "type" : "string", + "enum" : [ "RMA", "PURCHASE_ORDER", "TRIAL", "UNKNOWN" ] + }, + "CustomerShipmentEmailStateEnum" : { + "type" : "string", + "enum" : [ "SHIPPING_CONFIRMATION_SUCCESS", "SHIPPING_CONFIRMATION_FAILURE", "SHIPPING_SHIPPED_SUCCESS", "SHIPPING_SHIPPED_FAILURE", "UNKNOWN" ] + }, + "CustomerShipmentStateEnum" : { + "type" : "string", + "enum" : [ "CREATED", "SHIPPED", "DELIVERED", "RETURN_REGISTERED", "RETURN_SENT", "RETURN_DELIVERED", "COMPLETE", "UNKNOWN" ] + }, + "CustomerShipmentType" : { + "type" : "object", + "description" : "List of customer shipments", + "properties" : { + "ait-aitTrackingNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "ait-carrierTrackingNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "ait-depositorOrderNumber" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { + "ait-destinationAddress" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "DoorRelayStateEnumType" : { - "type" : "string", - "enum" : [ "UNLOCKED", "LOCKED", "UNKNOWN" ] - }, - "DoorScheduleExceptionType" : { - "type" : "object", - "description" : "The door schedule exception to update.", - "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX timestamp in milliseconds when exception was created.", - "nullable" : true, - "readOnly" : true }, - "defaultState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + "ait-isIngramDistributorShipment" : { + "type" : "boolean", + "nullable" : true }, - "description" : { + "ait-shipmentDate" : { "type" : "string", - "description" : "Exception description", + "format" : "date-time", "nullable" : true }, - "doorUuids" : { + "ait-shippedItems" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/ShippedItemType" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "intervals" : { - "type" : "array", - "description" : "List of intervals each specifying door state during date range. List must contain at least one element", - "items" : { - "$ref" : "#/components/schemas/LocalInterval" - }, + "interchangeControlNumber" : { + "type" : "string", "nullable" : true }, - "localEndDate" : { + "lastStateUpdateSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "rhombus-additionalEmails" : { "type" : "string", - "description" : "Exception end date in 'yyyy-MM-dd' format. End date is inclusive.", "nullable" : true }, - "localStartDate" : { + "rhombus-chosenCarrierName" : { "type" : "string", - "description" : "Exception start date in 'yyyy-MM-dd' format. Start date is inclusive.", "nullable" : true }, - "locationToDoorsMap" : { + "rhombus-claimKeyToLicenseMap" : { "type" : "object", "additionalProperties" : { "type" : "array", - "description" : "Mapping of location uuid to a list of door uuids, representing the doors assigned to each location. Map must contain at least one entry with at least one door.", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "description" : "Mapping of location uuid to a list of door uuids, representing the doors assigned to each location. Map must contain at least one entry with at least one door.", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rhombus-claimKeyToLicenseMapV2" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SalesforceLicenseStartDateTimeAndEndDateTime" + }, + "nullable" : true + }, "nullable" : true }, - "name" : { + "rhombus-customerEmails" : { "type" : "string", - "description" : "Exception name", "nullable" : true }, - "orgUuid" : { + "rhombus-customerName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX timestamp in milliseconds when exception was modified.", - "nullable" : true, - "readOnly" : true - }, - "uuid" : { + "rhombus-orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "intervals", "localEndDate", "localStartDate", "name" ] - }, - "DoorScheduleFirstInStateEvent" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "acuEventUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "newState" : { - "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "settingsUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "source" : { - "$ref" : "#/components/schemas/FirstInSourceEnum" - }, - "stateChangedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + }, + "rhombus-partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "rhombus-purchaseOrderNumber" : { "type" : "string", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "rhombus-rmaReturnTrackingNumber" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "rhombus-rmaUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rhombus-rmaUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "ownerDeviceUuid" : { + "rhombus-salesForceOpportunityId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "rhombus-zendeskTicketNumber" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "shipmentCategory" : { + "$ref" : "#/components/schemas/CustomerShipmentCategoryEnum" + }, + "shipmentEmailState" : { + "$ref" : "#/components/schemas/CustomerShipmentEmailStateEnum" + }, + "shipmentState" : { + "$ref" : "#/components/schemas/CustomerShipmentStateEnum" }, "uuid" : { "type" : "string", @@ -75249,137 +77442,75 @@ } } }, - "DoorScheduledTriggerType" : { + "Customer_AcceptUsagePolicyRequest" : { "type" : "object", - "properties" : { - "ajarThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - } - } + "description" : "Request object for accepting the usage policy for the current user." }, - "DoorSensorSettings" : { + "Customer_AcceptUsagePolicyResponse" : { "type" : "object", - "properties" : { - "ajar_threshold_enabled" : { - "type" : "boolean", - "description" : "Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).", - "nullable" : true - }, - "ajar_threshold_sec" : { - "type" : "integer", - "format" : "int32", - "description" : "Threshold value for Door Sensor Ajar state. Defaults to 30s.", - "nullable" : true - } - } + "description" : "Response object for accepting the usage policy for the current user." }, - "DoorSensorSettingsSelectiveUpdate" : { - "type" : "object", - "properties" : { - "ajar_threshold_enabled" : { - "type" : "boolean", - "description" : "Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).", - "nullable" : true - }, - "ajar_threshold_sec" : { - "type" : "integer", - "format" : "int32", - "description" : "Threshold value for Door Sensor Ajar state. Defaults to 30s.", - "nullable" : true - }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, - "nullable" : true - } - } + "Customer_CurrentUserSessionTypeEnum" : { + "type" : "string", + "description" : "USER for a regular login; SUPPORT for a support-authority session acting inside the org.", + "enum" : [ "USER", "SUPPORT" ] }, - "DoorStateChangeEvent" : { + "Customer_CurrentUserSupportSessionWSType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "newState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "source" : { - "$ref" : "#/components/schemas/AccessStateSourceEnum" - } - } - } ], + "description" : "Describes the support-authority grant behind the current session. Only present for SUPPORT sessions.", "nullable" : true, "properties" : { - "componentUuid" : { + "authorityType" : { + "$ref" : "#/components/schemas/SupportAuthorityTypeEnum" + }, + "authorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "email" : { "type" : "string", + "description" : "Email of the support user behind the session, when known.", "nullable" : true }, - "createdAtMs" : { + "expirationTimestamp" : { "type" : "integer", "format" : "int64", + "description" : "Epoch millis at which the support grant expires, if it expires.", "nullable" : true }, - "locationUuid" : { + "managedByMsp" : { + "type" : "boolean", + "description" : "True when the customer org is managed by the partner (MSP) behind the grant.", + "nullable" : true + }, + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Full name of the support user behind the session, when known.", "nullable" : true }, - "orgUuid" : { + "partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, + } + } + }, + "Customer_DeleteNotificationSnoozeSettingWSRequest" : { + "type" : "object", + "description" : "Request object for deleting notification snooze settings for a specific entity.", + "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", @@ -75389,119 +77520,132 @@ } } }, - "DoorStateEnum" : { - "type" : "string", - "description" : "Filter events by door state", - "enum" : [ "OPEN", "CLOSED", "AJAR" ] - }, - "DoorStatusEnum" : { - "type" : "string", - "description" : "Door state for door sensor webhooks", - "enum" : [ "OPEN", "CLOSED", "AJAR" ] - }, - "DoorType" : { + "Customer_DeleteNotificationSnoozeSettingWSResponse" : { "type" : "object", + "description" : "Response object for deleting notification snooze settings.", "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Door_DoorHealthDetailsEnum" : { - "type" : "string", - "description" : "Enumeration of specific health details for door sensors.", - "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] - }, - "Door_DoorHealthEnum" : { - "type" : "string", - "description" : "Enumeration of health status for door sensors.", - "enum" : [ "GREEN", "RED" ] + "Customer_GetCurrentPartnerUserWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving details about the current authenticated partner user." }, - "Door_GetDoorEventsForSensorWSRequest" : { + "Customer_GetCurrentPartnerUserWSResponse" : { "type" : "object", - "description" : "Request object for retrieving door open/close events for a door sensor.", + "description" : "Response object containing details about the current authenticated partner user.", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds to get events created after this time", - "example" : 1640995200000, + "error" : { + "type" : "boolean", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds to get events created before this time", - "example" : 1640995200000, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "limit" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of events to return", - "example" : 100, + "flags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of user-specific flags and settings", + "nullable" : true + }, + "description" : "Map of user-specific flags and settings", "nullable" : true }, - "sensorUuid" : { + "notificationSettingsV2" : { + "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" + }, + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "stateFilter" : { - "$ref" : "#/components/schemas/DoorStateEnum" + "user" : { + "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Door_GetDoorEventsForSensorWSResponse" : { + "Customer_GetCurrentRhombusKeyUserWSRequest" : { "type" : "object", - "description" : "Response object containing door open/close events for a door sensor.", + "description" : "Request object for retrieving RhombusKey user configuration and details for the current user." + }, + "Customer_GetCurrentRhombusKeyUserWSResponse" : { + "type" : "object", + "description" : "Response object containing RhombusKey user configuration, user details, and organization summary details.", "properties" : { - "doorEvents" : { + "orgDetails" : { + "$ref" : "#/components/schemas/User_RhombusKeyOrgDetailsType" + }, + "rhombusKeyConfig" : { + "$ref" : "#/components/schemas/RhombusKeyAppConfigType" + }, + "user" : { + "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" + } + } + }, + "Customer_GetCurrentUserConsoleOrgsForContextSwitchWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving organizations that the current user can context switch into for Console." + }, + "Customer_GetCurrentUserConsoleOrgsForContextSwitchWSResponse" : { + "type" : "object", + "description" : "Response object containing the list of organizations available for context switching in Console.", + "properties" : { + "orgs" : { "type" : "array", - "description" : "List of door open/close events for the sensor", + "description" : "List of organizations that the user can context switch into", "items" : { - "$ref" : "#/components/schemas/DoorEventType" + "$ref" : "#/components/schemas/Customer_SelectableOrgForContextSwitch" }, "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Door_GetMinimalDoorStatesWSRequest" : { + "Customer_GetCurrentUserRhombusKeyOrgsForContextSwitchWSRequest" : { "type" : "object", - "description" : "Request object for retrieving basic state information for all door sensors." + "description" : "Request object for retrieving organizations that the current user can context switch into for Rhombus Key." }, - "Door_GetMinimalDoorStatesWSResponse" : { + "Customer_GetCurrentUserRhombusKeyOrgsForContextSwitchWSResponse" : { "type" : "object", - "description" : "Response object containing basic state information for all door sensors.", + "description" : "Response object containing the list of organizations available for context switching in Rhombus Key.", "properties" : { - "doorStates" : { + "orgs" : { "type" : "array", - "description" : "List of minimal door state information for all door sensors", + "description" : "List of organizations that the user can context switch into", "items" : { - "$ref" : "#/components/schemas/Door_MinimalDoorStateType" + "$ref" : "#/components/schemas/Customer_SelectableOrgForContextSwitch" }, "nullable" : true - }, + } + } + }, + "Customer_GetCurrentUserSessionsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving the list of active sessions for the current user." + }, + "Customer_GetCurrentUserSessionsWSResponse" : { + "type" : "object", + "description" : "Response object containing the list of active sessions for the current user.", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -75510,281 +77654,242 @@ "type" : "string", "nullable" : true }, + "sessions" : { + "type" : "array", + "description" : "List of active sessions for the current user", + "items" : { + "$ref" : "#/components/schemas/SessionInfoWSType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Door_MinimalDoorStateType" : { + "Customer_GetCurrentUserWSRequest" : { "type" : "object", - "description" : "Minimal state information for a door sensor.", + "description" : "Request object for retrieving detailed information about the current authenticated user." + }, + "Customer_GetCurrentUserWSResponse" : { + "type" : "object", + "description" : "Response object containing detailed information about the current authenticated user.", "properties" : { - "associatedCameras" : { - "type" : "array", - "description" : "List of associated camera device facet UUIDs", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true - }, - "batteryPercent" : { - "type" : "integer", - "format" : "int32", - "description" : "Battery percentage of the door sensor", - "example" : 75, - "nullable" : true - }, - "closestBaseStation" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "customizations" : { + "$ref" : "#/components/schemas/UserCustomizationsType" }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds when the door sensor was created", - "example" : 1640995200000, + "error" : { + "type" : "boolean", "nullable" : true }, - "firmwareVersion" : { + "errorMsg" : { "type" : "string", - "description" : "Firmware version of the door sensor", - "example" : "1.2.3", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the door sensor is located", - "example" : 1, + "flags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of user-specific flags and settings", + "nullable" : true + }, + "description" : "Map of user-specific flags and settings", "nullable" : true }, - "health" : { - "$ref" : "#/components/schemas/Door_DoorHealthEnum" - }, - "healthDetails" : { - "$ref" : "#/components/schemas/Door_DoorHealthDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lastSeenSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in seconds when the door sensor was last seen", - "example" : 1640995200, - "nullable" : true + "notificationSettings" : { + "$ref" : "#/components/schemas/UserNotificationSettingsV3Type" }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the door sensor", - "example" : 37.7749, - "nullable" : true + "notificationSettingsV2" : { + "$ref" : "#/components/schemas/UserNotificationSettingsV4Type" }, - "locationUuid" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the door sensor", - "example" : -122.4194, - "nullable" : true - }, - "name" : { - "type" : "string", - "description" : "Name of the door sensor", - "example" : "Main Entrance Door", - "nullable" : true + "sessionType" : { + "$ref" : "#/components/schemas/Customer_CurrentUserSessionTypeEnum" }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "supportSession" : { + "$ref" : "#/components/schemas/Customer_CurrentUserSupportSessionWSType" }, - "sensorUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "user" : { + "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" }, - "serialNumber" : { + "warningMsg" : { "type" : "string", - "description" : "Serial number of the door sensor", - "example" : "DS123456789", - "nullable" : true - }, - "signalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "Signal strength of the door sensor", - "example" : 85, "nullable" : true - }, - "status" : { - "$ref" : "#/components/schemas/DoorStatusEnum" } } }, - "Door_UpdateDoorSensorDetailsWSRequest" : { + "Customer_GetDashboardStatusWSResponse" : { "type" : "object", - "description" : "Request object for updating details for a door sensor.", + "description" : "Response object containing dashboard status and information for the current user.", "properties" : { - "associatedCameras" : { - "type" : "array", - "description" : "List of associated camera device facet UUIDs", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true - }, - "associatedCamerasUpdated" : { - "type" : "boolean", - "description" : "Whether the associated cameras have been updated", - "example" : true, - "nullable" : true - }, - "deleted" : { - "type" : "boolean", - "description" : "Whether the door sensor is deleted", - "example" : false, - "nullable" : true + "dashboardStatus" : { + "$ref" : "#/components/schemas/DashboardStatus" }, - "deletedUpdated" : { + "error" : { "type" : "boolean", - "description" : "Whether the deleted status has been updated", - "example" : false, "nullable" : true }, - "description" : { + "errorMsg" : { "type" : "string", - "description" : "Description of the door sensor", - "example" : "Main entrance door sensor on the first floor", "nullable" : true }, - "descriptionUpdated" : { - "type" : "boolean", - "description" : "Whether the description has been updated", - "example" : false, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the door sensor is located", - "example" : 1, - "nullable" : true - }, - "floorNumberUpdated" : { + } + } + }, + "Customer_GetDashboardstatusWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving dashboard status and information for the current user." + }, + "Customer_GetRhombusKeyConfigForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving the RhombusKey mobile app configuration for the current user." + }, + "Customer_GetRhombusKeyConfigForCurrentUserWSResponse" : { + "type" : "object", + "description" : "Response object containing the RhombusKey mobile app configuration for the current user.", + "properties" : { + "userRhombusKeyConfig" : { + "$ref" : "#/components/schemas/RhombusKeyAppConfigType" + } + } + }, + "Customer_GetUserSnoozedNotificationSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving current and planned user notification snooze details." + }, + "Customer_GetUserSnoozedNotificationSettingsWSResponse" : { + "type" : "object", + "description" : "Response object containing current and planned user notification snooze details.", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether the floor number has been updated", - "example" : true, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the door sensor", - "example" : 37.7749, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "latitudeUpdated" : { - "type" : "boolean", - "description" : "Whether the latitude has been updated", - "example" : false, + "snoozedForAllNotificationsIntervals" : { + "type" : "array", + "description" : "List of intervals when all notifications are snoozed", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "snoozedForComponentCompositesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of component composite UUIDs to their snooze notification intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of component composite UUIDs to their snooze notification intervals", "nullable" : true }, - "locationUuidUpdated" : { - "type" : "boolean", - "description" : "Whether the location UUID has been updated", - "example" : true, + "snoozedForDevicesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device UUIDs to their snooze notification intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of device UUIDs to their snooze notification intervals", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the door sensor", - "example" : -122.4194, + "snoozedForLocationsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of location UUIDs to their snooze notification intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of location UUIDs to their snooze notification intervals", "nullable" : true }, - "longitudeUpdated" : { - "type" : "boolean", - "description" : "Whether the longitude has been updated", - "example" : false, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "name" : { + } + } + }, + "Customer_LogoutAllOtherCurrentUserSessionsRequest" : { + "type" : "object", + "description" : "Request object for logging out all other active sessions for the current user." + }, + "Customer_LogoutAllOtherCurrentUserSessionsResponse" : { + "type" : "object", + "description" : "Response object for logging out all other active sessions for the current user." + }, + "Customer_SelectableOrgForContextSwitch" : { + "type" : "object", + "description" : "List of organizations that the user can context switch into", + "properties" : { + "companyThumbnailLogoUrl" : { "type" : "string", - "description" : "Name of the door sensor", - "example" : "Main Entrance Door", "nullable" : true }, - "nameUpdated" : { - "type" : "boolean", - "description" : "Whether the name has been updated", - "example" : true, + "orgName" : { + "type" : "string", "nullable" : true }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuidUpdated" : { - "type" : "boolean", - "description" : "Whether the policy UUID has been updated", - "example" : false, + "rhombusKeyLogoUrl" : { + "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key has been updated", - "example" : false, + "userName" : { + "type" : "string", + "nullable" : true + } + } + }, + "Customer_SetFlagWSRequest" : { + "type" : "object", + "description" : "Request object for storing a flag or setting for the current user.", + "properties" : { + "flagName" : { + "type" : "string", + "description" : "Name of the flag to set", + "example" : "feature_enabled", "nullable" : true }, - "uuid" : { + "flagValue" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Value to set for the flag", + "example" : "true", "nullable" : true } } }, - "Door_UpdateDoorSensorDetailsWSResponse" : { + "Customer_SetFlagWSResponse" : { "type" : "object", - "description" : "Response object for updating details for a door sensor.", + "description" : "Response object for storing a flag or setting for the current user.", "properties" : { "error" : { "type" : "boolean", @@ -75800,178 +77905,231 @@ } } }, - "DoorbellEventType" : { + "Customer_SnoozeAllNotificationsWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "newSupervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } - } - } ], - "nullable" : true, + "description" : "Request object for snoozing all user notifications for the current user.", "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "correlationId" : { - "type" : "string", + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds for the snooze period", + "example" : 3600, "nullable" : true }, - "createdAtMs" : { + "scheduledTimestampSec" : { "type" : "integer", "format" : "int64", + "description" : "Scheduled timestamp in seconds when the snooze should start", + "example" : 1640995200, + "nullable" : true + } + } + }, + "Customer_SnoozeAllNotificationsWSResponse" : { + "type" : "object", + "description" : "Response object for snoozing all user notifications for the current user.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Customer_SnoozeNotificationsWSRequest" : { + "type" : "object", + "description" : "Request object for snoozing user notifications for specific entities.", + "properties" : { + "componentCompositeUuids" : { + "type" : "array", + "description" : "List of component composite UUIDs to snooze notifications for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "deviceUuids" : { + "type" : "array", + "description" : "List of device UUIDs to snooze notifications for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "timestampMs" : { + "durationSec" : { "type" : "integer", "format" : "int64", + "description" : "Duration in seconds for the snooze period", + "example" : 3600, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "locationUuids" : { + "type" : "array", + "description" : "List of location UUIDs to snooze notifications for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds when the snooze should start", + "example" : 1640995200, "nullable" : true } } }, - "Doorbellcamera_CreateRuleForDoorbellCameraWSRequest" : { + "Customer_SnoozeNotificationsWSResponse" : { "type" : "object", - "description" : "Request object for creating a rule for a doorbell camera.", + "description" : "Response object for snoozing user notifications for specific entities.", "properties" : { - "rule" : { - "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Doorbellcamera_CreateRuleForDoorbellCameraWSResponse" : { + "Customer_UpdateCurrentPartnerWSRequest" : { "type" : "object", - "description" : "Response object for creating a rule for a doorbell camera.", + "description" : "Request object for updating details and information for the current authenticated partner user.", "properties" : { - "error" : { + "bypassSaml" : { + "type" : "boolean", + "description" : "Whether to bypass SAML authentication for this user", + "example" : false, + "nullable" : true + }, + "mfaEnabled" : { "type" : "boolean", + "description" : "Whether multi-factor authentication is enabled for the user", + "example" : true, "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Name of the partner user", + "example" : "John Doe", "nullable" : true }, - "ruleUuid" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "smsPhoneNumbers" : { + "type" : "array", + "description" : "List of SMS phone numbers for the user", + "items" : { + "type" : "string", + "description" : "List of SMS phone numbers for the user", + "nullable" : true + }, + "nullable" : true + }, + "summaryEmailEnabled" : { + "type" : "boolean", + "description" : "Whether summary emails are enabled for the user", + "example" : false, "nullable" : true } } }, - "Doorbellcamera_CreateSharedLiveVideoStreamWSRequest" : { + "Customer_UpdateCurrentPartnerWSResponse" : { "type" : "object", - "description" : "Request object for creating a shared live video stream for a doorbell camera.", + "description" : "Response object for updating details and information for the current authenticated partner user.", "properties" : { - "audioGatewayUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "error" : { + "type" : "boolean", "nullable" : true }, - "doorbellCameraUuid" : { + "errorMsg" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "expirationTimeSecs" : { - "type" : "integer", - "format" : "int32", - "description" : "Add a expiration date for accessing the stream in seconds", - "example" : 86400, + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Customer_UpdateCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request object for updating details and information for the current authenticated user.", + "properties" : { + "dashboardCustomizations" : { + "$ref" : "#/components/schemas/DashboardCustomizations" }, - "invertSchedule" : { + "mfaEnabled" : { "type" : "boolean", - "description" : "If given a schedule uuid, will hide the stream during the schedule instead and show it otherwise", - "example" : false, + "description" : "Whether multi-factor authentication is enabled for the user", + "example" : true, "nullable" : true }, "name" : { "type" : "string", - "description" : "If not provided, will be named 'Unnamed'", - "example" : "Front Door Stream", + "description" : "Name of the user", + "example" : "John Doe", "nullable" : true }, - "password" : { - "type" : "string", - "description" : "Add a password to allow access to your shared stream. If null or blank password is not set.", - "example" : "mypassword123", + "notificationIntervalsV2" : { + "type" : "array", + "description" : "List of notification intervals for the user", + "items" : { + "$ref" : "#/components/schemas/NotificationIntervalV2Type" + }, "nullable" : true }, - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "smsPhoneNumbers" : { + "type" : "array", + "description" : "List of SMS phone numbers for the user", + "items" : { + "type" : "string", + "description" : "List of SMS phone numbers for the user", + "nullable" : true + }, "nullable" : true }, - "streamType" : { - "$ref" : "#/components/schemas/StreamTypeEnum" - }, - "vodEnabled" : { + "summaryEmailEnabled" : { "type" : "boolean", - "description" : "Enables recording of live footage to a VOD", - "example" : true, + "description" : "Whether summary emails are enabled for the user", + "example" : false, "nullable" : true } - }, - "required" : [ "doorbellCameraUuid", "streamType", "vodEnabled" ] + } }, - "Doorbellcamera_CreateSharedLiveVideoStreamWSResponse" : { + "Customer_UpdateCurrentUserWSResponse" : { "type" : "object", - "description" : "Response object for creating a shared live video stream for a doorbell camera.", + "description" : "Response object for updating details and information for the current authenticated user.", "properties" : { "error" : { "type" : "boolean", @@ -75981,54 +78139,93 @@ "type" : "string", "nullable" : true }, - "sharedLiveM3U8StreamUrl" : { + "warningMsg" : { "type" : "string", - "description" : "M3U8 URL for the shared live video stream", - "example" : "https://example.com/live/m3u8/stream", + "nullable" : true + } + } + }, + "Customer_UpdateDashboardCustomizationsWSRequest" : { + "type" : "object", + "description" : "Request object for updating dashboard customization settings for the current user.", + "properties" : { + "fullCamera" : { + "type" : "string", + "description" : "Full camera configuration", + "example" : "single", "nullable" : true }, - "sharedLiveVideoStreamUrl" : { + "fullCameraUpdated" : { + "type" : "boolean", + "description" : "Whether the full camera has been updated", + "example" : false, + "nullable" : true + }, + "halfCamera" : { "type" : "string", - "description" : "URL for the shared live video stream", - "example" : "https://example.com/live/video/stream", + "description" : "Half camera configuration", + "example" : "split", "nullable" : true }, - "sharedLiveVideoStreamUuid" : { + "halfCameraUpdated" : { + "type" : "boolean", + "description" : "Whether the half camera has been updated", + "example" : true, + "nullable" : true + }, + "layout" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Dashboard layout configuration", + "example" : "grid", "nullable" : true }, - "warningMsg" : { + "layoutUpdated" : { + "type" : "boolean", + "description" : "Whether the layout has been updated", + "example" : true, + "nullable" : true + }, + "rememberedLocation" : { "type" : "string", + "description" : "Remembered location for the user", + "example" : "Main Office", "nullable" : true - } - } - }, - "Doorbellcamera_DeleteDoorbellCameraWSRequest" : { - "type" : "object", - "description" : "Request object for removing a doorbell camera from the organization.", - "properties" : { - "doorbellCameraUuid" : { + }, + "rememberedLocationUpdated" : { + "type" : "boolean", + "description" : "Whether the remembered location has been updated", + "example" : false, + "nullable" : true + }, + "report" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Report configuration", + "example" : "daily", "nullable" : true }, - "mummify" : { + "reportUpdated" : { "type" : "boolean", - "description" : "Whether to mummify the doorbell camera", + "description" : "Whether the report has been updated", + "example" : true, + "nullable" : true + }, + "videoWall" : { + "type" : "string", + "description" : "Video wall configuration", + "example" : "4x4", + "nullable" : true + }, + "videoWallUpdated" : { + "type" : "boolean", + "description" : "Whether the video wall has been updated", "example" : false, "nullable" : true } - }, - "required" : [ "doorbellCameraUuid", "mummify" ] + } }, - "Doorbellcamera_DeleteDoorbellCameraWSResponse" : { + "Customer_UpdateDashboardCustomizationsWSResponse" : { "type" : "object", - "description" : "Response object for removing a doorbell camera from the organization.", + "description" : "Response object for updating dashboard customization settings for the current user.", "properties" : { "error" : { "type" : "boolean", @@ -76038,38 +78235,31 @@ "type" : "string", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest" : { + "Customer_UpdateFrontendCustomizationsWSRequest" : { "type" : "object", - "description" : "Request object for deleting a rule for a doorbell camera.", + "description" : "Request object for updating frontend customization settings for the current user.", "properties" : { - "doorbellCameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "customizations" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of frontend customization settings and their values", + "nullable" : true + }, + "description" : "Map of frontend customization settings and their values", "nullable" : true } } }, - "Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse" : { + "Customer_UpdateFrontendCustomizationsWSResponse" : { "type" : "object", - "description" : "Response object for deleting a rule for a doorbell camera.", + "description" : "Response object for updating frontend customization settings for the current user.", "properties" : { "error" : { "type" : "boolean", @@ -76085,208 +78275,261 @@ } } }, - "Doorbellcamera_DoorbellCameraOfflineLanStreamingInfo" : { + "Customer_UpdateRhombusKeyPreferencesForCurrentUserWSRequest" : { "type" : "object", - "description" : "Information for offline LAN streaming of doorbell camera content.", + "description" : "Request object for updating the RhombusKey mobile app preferences for the current user.", "properties" : { - "accessToken" : { - "type" : "string", - "description" : "Access token for offline LAN streaming", - "example" : "abc123def456", + "favoriteAccessControlledDoorUuids" : { + "type" : "array", + "description" : "List of favorite access controlled door UUIDs for the user", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "lanAddresses" : { + "favoriteAccessControlledDoorUuidsUpdated" : { + "type" : "boolean", + "description" : "Whether the favorite access controlled door UUIDs have been updated", + "example" : true, + "nullable" : true + }, + "favoriteAccessControlledElevatorUuids" : { "type" : "array", - "description" : "List of LAN addresses for offline streaming", + "description" : "List of favorite access controlled elevator UUIDs for the user", "items" : { "type" : "string", - "description" : "List of LAN addresses for offline streaming", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true + }, + "favoriteAccessControlledElevatorUuidsUpdated" : { + "type" : "boolean", + "description" : "Whether the favorite access controlled elevator UUIDs have been updated", + "example" : true, + "nullable" : true } } }, - "Doorbellcamera_ExternalDoorbellCameraComponentRuleType" : { + "Customer_UpdateRhombusKeyPreferencesForCurrentUserWSResponse" : { "type" : "object", - "description" : "External representation of a doorbell camera component rule.", + "description" : "Response object for updating the RhombusKey mobile app preferences for the current user.", "properties" : { - "action" : { - "$ref" : "#/components/schemas/RuleActionType" + "userRhombusKeyConfig" : { + "$ref" : "#/components/schemas/RhombusKeyAppConfigType" + } + } + }, + "DailyFirstInReset" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "minuteOfDay" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/FirstInResetEnum" + } + } + }, + "DailyMinuteIntervalType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "minuteOfDayStartInclusive" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "doorbellCameraComponentUuid" : { + "minuteOfDayStopExclusive" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "DaoOutcomeEnum" : { + "type" : "string", + "description" : "The result of the ALM-related action.", + "enum" : [ "SUCCESS", "BAD_REQUEST", "NO_SUCH_ENTITY", "ALREADY_EXISTS", "STALE_UPDATE", "CONCURRENCY_ERROR", "INTERNAL_ERROR", "UNKNOWN" ] + }, + "DashboardCustomizations" : { + "type" : "object", + "description" : "Dashboard customization settings for the user", + "properties" : { + "fullCamera" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorbellCameraUuid" : { + "halfCamera" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ruleFilters" : { - "$ref" : "#/components/schemas/RuleFilterType" + "layout" : { + "type" : "string", + "nullable" : true }, - "ruleName" : { + "rememberedLocation" : { "type" : "string", - "description" : "Name of the rule", - "example" : "Motion Detection Rule", "nullable" : true }, - "ruleUuid" : { + "report" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "triggerActivity" : { - "$ref" : "#/components/schemas/ActivityEnum" + "videoWall" : { + "type" : "string", + "nullable" : true } } }, - "Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest" : { + "DashboardHealthStatusIndicationEnum" : { + "type" : "string", + "enum" : [ "GREEN", "YELLOW", "RED" ] + }, + "DashboardStatus" : { "type" : "object", - "description" : "Request object for retrieving component events for a doorbell camera.", + "description" : "Dashboard status and information for the current user", "properties" : { - "createdAfterMs" : { + "camerasDown" : { "type" : "integer", - "format" : "int64", - "description" : "Returns events created after (exclusive) the specified millisecond epoch timestamp", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "createdBeforeMs" : { + "camerasDownByLocation" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "camerasUp" : { "type" : "integer", - "format" : "int64", - "description" : "Returns events created before (exclusive) the specified millisecond epoch timestamp", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "doorbellCameraUuid" : { + "healthStatusIndicator" : { + "$ref" : "#/components/schemas/DashboardHealthStatusIndicationEnum" + }, + "healthStatusMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "limit" : { + "locationCameraStatus" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "totalCameras" : { "type" : "integer", "format" : "int32", - "description" : "Limits the number of returned events to the latest LIMIT events. Maximum value is 100.", - "example" : 50, "nullable" : true }, - "typeFilter" : { - "type" : "array", - "description" : "Limits results to only contain the specified type of events, if applicable", - "items" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "nullable" : true - } - }, - "required" : [ "doorbellCameraUuid", "limit" ] - }, - "Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse" : { - "type" : "object", - "description" : "Response object containing component events for a doorbell camera.", - "properties" : { - "componentEvents" : { - "type" : "array", - "description" : "List of component events for the doorbell camera", - "items" : { - "$ref" : "#/components/schemas/ComponentEventType" - }, + "totalClimateSensors" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "error" : { - "type" : "boolean", + "totalDoorSensors" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "totalLocations" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "totalProximitySensors" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest" : { + "DataRetentionSettingsType" : { "type" : "object", - "description" : "Request object for retrieving component seekpoints for a doorbell camera.", + "nullable" : true, "properties" : { - "doorbellCameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "durationSec" : { + "faceEventRetentionDays" : { "type" : "integer", "format" : "int32", - "description" : "Duration in seconds for the seekpoint query", - "example" : 3600, "nullable" : true }, - "startTimeSecEpochExclusive" : { + "licensePlateEventRetentionDays" : { "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds epoch (exclusive) for the seekpoint query", - "example" : 1640995200, + "format" : "int32", "nullable" : true } } }, - "Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse" : { + "DataSourceEnum" : { + "type" : "string", + "enum" : [ "ACCESS_CONTROL_EVENTS", "BANDWIDTH_USAGE", "CAMERA_EVENTS", "CAMERAS", "CLIMATE_SENSOR_EVENTS", "CLIPS", "COMPONENT_EVENTS", "CROWD", "CUSTOM_LLM_EVENTS", "ENTITIES", "ENVIRONMENTAL_GATEWAY_EVENTS", "FACES", "LICENSE_PLATE_RECOGNITION", "LINE_CROSSING", "LOCATIONS", "MOTION", "OCCUPANCY", "PEOPLE", "POLICY_ALERTS", "VEHICLES" ] + }, + "DateRangeFilter" : { "type" : "object", - "description" : "Response object containing component seekpoints for a doorbell camera.", + "description" : "Optional date range filter to limit search results.", "properties" : { - "error" : { - "type" : "boolean", + "localEndDateRangeEnd" : { + "type" : "string", + "description" : "End of the date range to filter local end date. This date is inclusive.", "nullable" : true }, - "errorMsg" : { + "localEndDateRangeStart" : { "type" : "string", + "description" : "Start of the date range to filter local end date. This date is inclusive.", "nullable" : true }, - "seekpoints" : { - "type" : "array", - "description" : "List of component seekpoints for the doorbell camera", - "items" : { - "$ref" : "#/components/schemas/ComponentSeekPointType" - }, + "localStartDateRangeEnd" : { + "type" : "string", + "description" : "End of the date range to filter local start date. This date is inclusive.", "nullable" : true }, - "warningMsg" : { + "localStartDateRangeStart" : { "type" : "string", + "description" : "Start of the date range to filter local start date. This date is inclusive.", "nullable" : true } } }, - "Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest" : { + "DeleteCoOccurrenceRuleRequest" : { "type" : "object", - "description" : "Request object for finding shared live video streams for a doorbell camera.", "properties" : { - "doorbellCameraUuid" : { + "orgUuid" : { + "type" : "string", + "nullable" : true + }, + "ruleUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Doorbellcamera_FindSharedLiveVideoStreamsWSResponse" : { + "DeleteCoOccurrenceRuleResponse" : { "type" : "object", - "description" : "Response object containing shared live video streams for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", @@ -76295,163 +78538,196 @@ "errorMsg" : { "type" : "string", "nullable" : true - }, - "sharedLiveVideoStreams" : { - "type" : "array", - "description" : "List of shared live video streams for the doorbell camera", - "items" : { - "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" - }, + } + } + }, + "DeleteSharedLiveVideoStreamForDeviceResponse" : { + "type" : "object" + }, + "DeleteTailgatingRuleResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { + "errorMsg" : { "type" : "string", "nullable" : true } } }, - "Doorbellcamera_GetDoorbellCameraConfigWSResponse" : { + "DemographicsHourlyBucket" : { "type" : "object", - "description" : "Response object containing doorbell camera configuration.", + "description" : "Hourly demographics buckets", "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableAudioVideoUserConfig" + "ageDistribution" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "nullable" : true + }, + "nullable" : true }, - "error" : { - "type" : "boolean", + "genderDistribution" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "hourBucket" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", "nullable" : true + }, + "totalDetections" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Doorbellcamera_GetDoorbellCameraFullStateWSResponse" : { + "Demographics_GetDemographicsDataWSRequest" : { "type" : "object", - "description" : "Response object containing detailed state information for a doorbell camera.", + "description" : "Request for demographics data.", "properties" : { - "fullState" : { - "$ref" : "#/components/schemas/FullDeviceStateType" + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "nullable" : true } } }, - "Doorbellcamera_GetDoorbellCameraMediaUrisWSResponse" : { + "Demographics_GetDemographicsDataWSResponse" : { "type" : "object", - "description" : "Response object containing media URIs for doorbell camera footage and audio.", + "description" : "Response containing demographics data.", "properties" : { - "lanCheckUrls" : { + "buckets" : { "type" : "array", - "description" : "List of LAN check URLs to verify device availability on local network", + "description" : "Hourly demographics buckets", "items" : { - "type" : "string", - "description" : "List of LAN check URLs to verify device availability on local network", - "nullable" : true + "$ref" : "#/components/schemas/DemographicsHourlyBucket" }, "nullable" : true - }, - "lanLiveH264Uris" : { - "type" : "array", - "description" : "List of LAN URIs for live H.264 video streams", - "items" : { + } + } + }, + "DeployRobotAction" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "mapUuid" : { "type" : "string", - "description" : "List of LAN URIs for live H.264 video streams", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "lanLiveMpdUris" : { - "type" : "array", - "description" : "List of LAN URIs for live MPD streams", - "items" : { - "type" : "string", - "description" : "List of LAN URIs for live MPD streams", - "nullable" : true + "navType" : { + "$ref" : "#/components/schemas/NavigationTypeEnum" }, - "nullable" : true - }, - "lanLiveOpusUris" : { - "type" : "array", - "description" : "List of LAN URIs for live Opus audio streams", - "items" : { - "type" : "string", - "description" : "List of LAN URIs for live Opus audio streams", - "nullable" : true + "pose" : { + "$ref" : "#/components/schemas/Pose" }, - "nullable" : true - }, - "lanVodM3u8UrisTemplates" : { - "type" : "array", - "description" : "List of LAN URI templates for VOD M3U8 streams", - "items" : { + "routeUuid" : { "type" : "string", - "description" : "List of LAN URI templates for VOD M3U8 streams", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "lanVodMpdUrisTemplates" : { - "type" : "array", - "description" : "List of LAN URI templates for VOD MPD streams", - "items" : { + "waypointUuid" : { "type" : "string", - "description" : "List of LAN URI templates for VOD MPD streams", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "nullable" : true - }, - "wanLiveH264Uri" : { + } + } + } ], + "nullable" : true, + "properties" : { + "deviceUuid" : { "type" : "string", - "description" : "WAN URI for live H.264 video stream", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wanLiveMpdUri" : { - "type" : "string", - "description" : "WAN URI for live MPD stream", + "type" : { + "$ref" : "#/components/schemas/RobotActionTypeEnum" + } + } + }, + "DetectionFeedbackReasonEnum" : { + "type" : "string", + "description" : "Why the detection is being reported", + "enum" : [ "FALSE_POSITIVE", "MISSED_DETECTION", "OTHER" ] + }, + "Developer_CreateEventListenerWSRequest" : { + "type" : "object", + "description" : "Request object for creating an event listener.", + "properties" : { + "eventListner" : { + "$ref" : "#/components/schemas/EventListenerType" + } + } + }, + "Developer_CreateEventListenerWSResponse" : { + "type" : "object", + "description" : "Response object for creating an event listener.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "wanLiveOpusUri" : { + "errorMsg" : { "type" : "string", - "description" : "WAN URI for live Opus audio stream", "nullable" : true }, - "wanVodM3u8UriTemplate" : { + "eventListenerUuid" : { "type" : "string", - "description" : "WAN URI template for VOD M3U8 streams", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wanVodMpdUriTemplate" : { + "warningMsg" : { "type" : "string", - "description" : "WAN URI template for VOD MPD streams", "nullable" : true } } }, - "Doorbellcamera_GetDoorbellCameraMinimalStateListWSResponse" : { + "Developer_DeleteEventListenerWSRequest" : { "type" : "object", - "description" : "Response object containing basic state information for all doorbell cameras.", + "description" : "Request object for deleting an event listener.", "properties" : { - "minimalStates" : { - "type" : "array", - "description" : "List of minimal state information for doorbell cameras", - "items" : { - "$ref" : "#/components/schemas/MinimalObservableDeviceStateType" - }, + "eventListenerUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving offline LAN streaming information for doorbell cameras." - }, - "Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSResponse" : { + "Developer_DeleteEventListenerWSResponse" : { "type" : "object", - "description" : "Response object containing offline LAN streaming information for doorbell cameras.", + "description" : "Response object for deleting an event listener.", "properties" : { "error" : { "type" : "boolean", @@ -76461,41 +78737,20 @@ "type" : "string", "nullable" : true }, - "info" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Doorbellcamera_DoorbellCameraOfflineLanStreamingInfo" - }, - "description" : "Map of doorbell camera UUIDs to their offline LAN streaming information", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest" : { + "Developer_GetAllEventListenersWSRequest" : { "type" : "object", - "description" : "Request object for retrieving rules for all doorbell cameras in an organization." + "description" : "Request object for retrieving a list of all event listeners." }, - "Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse" : { + "Developer_GetAllEventListenersWSResponse" : { "type" : "object", - "description" : "Response object containing rules for all doorbell cameras in an organization.", + "description" : "Response object containing a list of all event listeners.", "properties" : { - "doorbellCameraUuidToRulesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of doorbell camera UUIDs to their component rules", - "items" : { - "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" - }, - "nullable" : true - }, - "description" : "Map of doorbell camera UUIDs to their component rules", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -76504,17 +78759,25 @@ "type" : "string", "nullable" : true }, + "eventListeners" : { + "type" : "array", + "description" : "List of all event listeners", + "items" : { + "$ref" : "#/components/schemas/EventListenerType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Doorbellcamera_GetRulesForDoorbellCameraWSRequest" : { + "Developer_GetEventListenersForDeviceWSRequest" : { "type" : "object", - "description" : "Request object for retrieving all rules for a doorbell camera.", + "description" : "Request object for retrieving a list of event listeners for a specific device.", "properties" : { - "doorbellCameraUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -76523,9 +78786,9 @@ } } }, - "Doorbellcamera_GetRulesForDoorbellCameraWSResponse" : { + "Developer_GetEventListenersForDeviceWSResponse" : { "type" : "object", - "description" : "Response object containing all rules for a doorbell camera.", + "description" : "Response object containing a list of event listeners for a specific device.", "properties" : { "error" : { "type" : "boolean", @@ -76535,11 +78798,11 @@ "type" : "string", "nullable" : true }, - "rules" : { + "eventListeners" : { "type" : "array", - "description" : "List of component rules for the doorbell camera", + "description" : "List of event listeners for the specified device", "items" : { - "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" + "$ref" : "#/components/schemas/EventListenerType" }, "nullable" : true }, @@ -76549,160 +78812,314 @@ } } }, - "Doorbellcamera_RebootDoorbellCameraWSRequest" : { + "DeviceActivityRuleTriggerType" : { "type" : "object", - "description" : "Request object for rebooting a doorbell camera.", - "properties" : { - "doorbellCameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/SimpleDeviceActivityEventType" + }, + "componentCompositeUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "componentUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "deviceLabels" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "deviceUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "locationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } } - }, - "required" : [ "doorbellCameraUuid" ] - }, - "Doorbellcamera_UpdateDoorbellCameraConfigWSRequest" : { - "type" : "object", - "description" : "Request object for updating doorbell camera configuration.", + } ], + "nullable" : true, "properties" : { - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, - "Doorbellcamera_UpdateDoorbellCameraDetailsWSRequest" : { + "DeviceAssignableLicenseGroupStats" : { "type" : "object", - "description" : "Request object for updating hardware details of a doorbell camera.", "properties" : { - "associatedCameras" : { + "assignedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "assignedLicenseStateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "deviceLicenseFamilyStats" : { "type" : "array", - "description" : "Optional list of associated camera device facet UUIDs", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/DeviceLicenseFamilyStats" }, "nullable" : true }, - "description" : { + "lastEndDate" : { "type" : "string", - "description" : "Optional description for the doorbell camera", + "format" : "date-time", + "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nearExpirationCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "description" : "Optional direction in radians for the doorbell camera", + "nextEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, - "floorNumber" : { + "stateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group.", + "nullable" : true + } + } + }, + "DeviceCatalogItem" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "cloudArchiveDays" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "licenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + }, + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" + } + } + } ], + "nullable" : true, + "properties" : { + "durationMonths" : { "type" : "integer", "format" : "int32", - "description" : "Optional floor number where the doorbell camera is located", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Optional latitude coordinate of the doorbell camera", + "productCode" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + } + } + }, + "DeviceDisabledHealthTrackingInfo" : { + "type" : "object", + "description" : "List of organization devices for which health tracking is disabled.", + "properties" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Optional longitude coordinate of the doorbell camera", + "reEnableCondition" : { + "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" + } + } + }, + "DeviceEventRecordType" : { + "type" : "object", + "properties" : { + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, "nullable" : true }, - "name" : { + "componentCompositeUuid" : { "type" : "string", - "description" : "Optional name for the doorbell camera", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key has been updated", - "example" : false, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Doorcontroller_CreateDoorControllerRuleWSRequest" : { - "type" : "object", - "description" : "Request object for creating a rule owned by a door controller.", - "properties" : { - "doorControllerUuid" : { + }, + "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rule" : { - "$ref" : "#/components/schemas/RuleType" + "hardwareVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Doorcontroller_CreateDoorControllerRuleWSResponse" : { + "DeviceFacetEnum" : { + "type" : "string", + "format" : "DeviceFacet", + "description" : "facet information for media", + "enum" : [ "", "v0", "v1", "v2", "v3", "a0", "v4", "v5", "v6", "v7", "v8", "v9", "v10", "v11", "v12", "v13", "v14", "v15", "v16", "v17", "v18", "v19", "v20", "v21", "v22", "v23", "v24", "v25", "v26", "v27", "v28", "v29", "v30", "v31", "v32", "v33", "v34", "v35", "v36", "v37", "v38", "v39", "v40", "v41", "v42", "v43", "v44", "v45", "v46", "v47", "v48", "v49", "v50", "v51", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "a10", "a11", "a12", "a13", "a14", "a15", "a16", "a17", "a18", "a19", "a20", "a21", "a22", "a23", "a24", "a25", "a26", "a27", "a28", "a29", "a30", "a31", "a32", "a33", "a34", "a35", "a36", "a37", "a38", "a39", "a40", "a41", "a42", "a43", "a44", "a45", "a46", "a47", "a48", "a49", "a50", "a51" ], + "example" : "v0, a0" + }, + "DeviceFeatureEnum" : { + "type" : "string", + "enum" : [ "COLOR_SEARCH", "FACE_RECOGNITION", "LICENSE_PLATE_RECOGNITION", "PEOPLE_COUNTING", "PPE_DETECTION", "UNUSUAL_BEHAVIOR_DETECTION", "VEHICLE_COUNTING", "CAMERA_ENTERPRISE_CLOUD_ARCHIVING", "TIMELAPSE", "VISUAL_TAMPER", "REGION_CROSSING", "OCCUPANCY_COUNTING", "CUSTOM_EVENTS", "LOITER", "PEOPLE_TRACKING", "REIDENTIFICATION", "INACTIVITY_DETECTION", "AUDIO_AI_ANALYTICS", "AUDIO_ENTERPRISE_CLOUD_ARCHIVING", "AUDIO_SPEAKER_ENABLED", "BADGE_READER_ENTERPRISE_CLOUD_ARCHIVING", "OBJECT_SEARCH", "UNKNOWN" ] + }, + "DeviceHealthStatusDetailsEnum" : { + "type" : "string", + "enum" : [ "DISCONNECTED", "FIRMWARE_BEHIND", "NOT_RECORDING", "LINK_SPEED_LOW", "MALFUNCTIONING_MODULES", "CALIBRATING", "DELAYED", "NONE" ] + }, + "DeviceIntegrationSettings" : { "type" : "object", - "description" : "Response object for creating a rule owned by a door controller.", + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "rule" : { - "$ref" : "#/components/schemas/RuleType" - }, - "warningMsg" : { + "name" : { "type" : "string", "nullable" : true } } }, - "Doorcontroller_DeleteDoorControllerRuleWSRequest" : { + "DeviceIntegrationType" : { "type" : "object", - "description" : "Request object for deleting a rule owned by a door controller.", + "allOf" : [ { + "type" : "object", + "properties" : { + "deviceSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DeviceIntegrationSettings" + }, + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "doorControllerUuid" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ruleUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -76711,404 +79128,305 @@ } } }, - "Doorcontroller_DeleteDoorControllerRuleWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a rule owned by a door controller." + "DeviceLicenseFamilyEnum" : { + "type" : "string", + "enum" : [ "CAMERA", "CAMERA_MS", "VIDEO_INTERCOM", "AUDIO_GATEWAY", "ENVIRONMENTAL_SENSOR", "ENVIRONMENTAL_GATEWAY" ] }, - "Doorcontroller_DeleteDoorControllerWSRequest" : { + "DeviceLicenseFamilyStats" : { "type" : "object", - "description" : "Request object for removing a door controller from the organization.", "properties" : { - "doorControllerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "assignedCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "mummify" : { - "type" : "boolean", - "description" : "Whether to mummify the door controller", - "example" : false, + "assignedLicenseStateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "deviceLicenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + }, + "lastEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true - } - }, - "required" : [ "doorControllerUuid", "mummify" ] - }, - "Doorcontroller_DeleteDoorControllerWSResponse" : { - "type" : "object", - "description" : "Response object for removing a door controller from the organization.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "nearExpirationCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, - "errorMsg" : { + "nextEndDate" : { "type" : "string", + "format" : "date-time", + "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" + "stateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" }, - "warningMsg" : { - "type" : "string", + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group.", "nullable" : true } } }, - "Doorcontroller_DoorControllerDiscoveredAperioDoor" : { + "DeviceLicenseType" : { "type" : "object", - "description" : "Discovered Aperio door device information.", + "description" : "List of device licenses available for the client organization", "properties" : { - "gatewayId" : { + "claimKeyUuid" : { "type" : "string", - "description" : "Identifier for the associated Aperio gateway", - "example" : "gateway_67890", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "id" : { + "createdOn" : { "type" : "string", - "description" : "Unique identifier for the Aperio door", - "example" : "door_12345", + "format" : "date-time", "nullable" : true }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the door was last seen", - "example" : 1640995200000, - "nullable" : true - } - } - }, - "Doorcontroller_DoorControllerDiscoveredAperioGateway" : { - "type" : "object", - "description" : "Discovered Aperio gateway device information.", - "properties" : { - "id" : { + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { "type" : "string", - "description" : "Unique identifier for the Aperio gateway", - "example" : "gateway_12345", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ipAddress" : { + "features" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseFeature" + }, + "nullable" : true, + "uniqueItems" : true + }, + "firstAssignedDate" : { "type" : "string", - "description" : "IP address of the Aperio gateway", - "example" : "192.168.1.100", + "format" : "date-time", "nullable" : true }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the gateway was last seen", - "example" : 1640995200000, + "licenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + }, + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "maxDeleteDate" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "model" : { + "orgUuid" : { "type" : "string", - "description" : "Model of the Aperio gateway", - "example" : "AH-GW-01", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "protocolVersion" : { + "ownerOrgUuid" : { "type" : "string", - "description" : "Protocol version of the Aperio gateway", - "example" : "2.1", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Doorcontroller_DoorControllerDiscoveredReaderType" : { - "type" : "object", - "description" : "List of discovered readers", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredRhombusReaderType" - }, { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredThirdPartyReaderType" - } ], - "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "description" : "Board number for the reader connection", - "example" : 1, + }, + "priorClaimKeyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the reader was last seen", - "example" : 1640995200000, + "productCode" : { + "type" : "string", "nullable" : true }, - "online" : { + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { "type" : "boolean", - "description" : "Whether the reader is currently online", - "example" : true, "nullable" : true }, - "portNum" : { - "type" : "integer", - "format" : "int32", - "description" : "Port number for the reader connection", - "example" : 0, + "updatedOn" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" : { + "DeviceOrientationEnum" : { "type" : "string", - "description" : "Enumeration of discovered reader types.", - "enum" : [ "RHOMBUS", "THIRD_PARTY" ] + "enum" : [ "CEILING", "FLOOR", "WALL", "WALL_CROOKED", "INDETERMINATE" ] }, - "Doorcontroller_DoorControllerDiscoveredRhombusReaderType" : { + "DevicePhysicalPortConfigType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the Rhombus reader", - "example" : "RR-12345678", - "nullable" : true - } - } - } ], - "description" : "Discovered Rhombus reader information.", - "nullable" : true, "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "description" : "Board number for the reader connection", - "example" : 1, + "boardMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BoardPhysicalPortConfigType" + }, "nullable" : true }, - "lastSeenMs" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the reader was last seen", - "example" : 1640995200000, "nullable" : true }, - "online" : { - "type" : "boolean", - "description" : "Whether the reader is currently online", - "example" : true, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "portNum" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "updatedAtMillis" : { "type" : "integer", - "format" : "int32", - "description" : "Port number for the reader connection", - "example" : 0, + "format" : "int64", + "nullable" : true + } + } + }, + "DeviceSchedule" : { + "type" : "object", + "properties" : { + "invertSchedule" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "unscheduledMessage" : { + "type" : "string", + "nullable" : true } } }, - "Doorcontroller_DoorControllerDiscoveredThirdPartyReaderType" : { + "DeviceServiceEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "model" : { + "deviceUuid" : { "type" : "string", - "format" : "byte", - "description" : "Model identifier for the third-party reader", - "example" : "MQ==", - "nullable" : true - }, - "serialNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Serial number of the third-party reader", - "example" : 12345, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "vendorCode" : { - "type" : "array", - "description" : "Vendor code for the third-party reader", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Vendor code for the third-party reader", - "nullable" : true - }, + "serviceName" : { + "type" : "string", "nullable" : true } } } ], - "description" : "Discovered third-party reader information.", "nullable" : true, "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "description" : "Board number for the reader connection", - "example" : 1, - "nullable" : true - }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the reader was last seen", - "example" : 1640995200000, - "nullable" : true - }, - "online" : { - "type" : "boolean", - "description" : "Whether the reader is currently online", - "example" : true, - "nullable" : true - }, - "portNum" : { - "type" : "integer", - "format" : "int32", - "description" : "Port number for the reader connection", - "example" : 0, - "nullable" : true - }, "type" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" + "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, - "Doorcontroller_DoorControllerStateType" : { + "DeviceStatusEnum" : { + "type" : "string", + "enum" : [ "RED", "ORANGE", "YELLOW", "GREEN" ] + }, + "DeviceTargetScopeEnum" : { + "type" : "string", + "enum" : [ "ORG", "LOCATION", "DEVICE" ] + }, + "DeviceTypeEnum" : { + "type" : "string", + "enum" : [ "BLE_TRACKER", "CAMERA", "DOOR_SENSOR", "ENVIRONMENTAL_SENSOR", "OCCUPANCY_SENSOR", "AUDIO_GATEWAY", "EXECUTABLE", "BADGE_READER", "DOOR_CONTROLLER", "BLE_BUTTON", "IO_BOARD", "ENVIRONMENTAL_GATEWAY", "NVR", "ROBOT", "UNKNOWN" ] + }, + "DeviceTypeV2" : { "type" : "object", - "description" : "State information for a door controller including discovered devices and configuration.", + "description" : "List of all client devices", "properties" : { - "configUpdatedAtMs" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when configuration was last updated", - "example" : 1640995200000, - "nullable" : true - }, - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "defaultInterface" : { - "type" : "string", - "description" : "Default network interface of the door controller", - "example" : "eth0", "nullable" : true }, - "defaultInterfaceMac" : { + "customData" : { "type" : "string", - "description" : "MAC address of the default interface", - "example" : "00:11:22:33:44:55", "nullable" : true }, "deleted" : { "type" : "boolean", - "description" : "Whether the door controller is deleted", - "example" : false, "nullable" : true }, "description" : { "type" : "string", - "description" : "Description of the door controller", - "example" : "Controls access to the main entrance", - "nullable" : true - }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "description" : "Direction in radians for the door controller", - "example" : 1.5708, - "nullable" : true - }, - "discoveredAperioDoors" : { - "type" : "array", - "description" : "List of discovered Aperio doors", - "items" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredAperioDoor" - }, - "nullable" : true - }, - "discoveredAperioGateways" : { - "type" : "array", - "description" : "List of discovered Aperio gateways", - "items" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredAperioGateway" - }, "nullable" : true }, - "discoveredReaders" : { - "type" : "array", - "description" : "List of discovered readers", - "items" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderType" + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true }, "nullable" : true }, - "firmwareVersion" : { + "hardwareId" : { "type" : "string", - "description" : "Firmware version of the door controller", - "example" : "2.1.0", - "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the door controller is located", - "example" : 1, - "nullable" : true - }, - "grantsUpdatedAtMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when grants were last updated", - "example" : 1640995200000, "nullable" : true }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "lanAddresses" : { - "type" : "array", - "description" : "List of LAN addresses for the door controller", - "items" : { - "type" : "string", - "description" : "List of LAN addresses for the door controller", - "nullable" : true - }, + "mummified" : { + "type" : "boolean", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the door controller", - "example" : 34.0522, + "name" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the door controller", - "example" : -118.2437, - "nullable" : true - }, - "name" : { - "type" : "string", - "description" : "Name of the door controller", - "example" : "Main Entrance Controller", + "pending" : { + "type" : "boolean", "nullable" : true }, "policyUuid" : { @@ -77120,22 +79438,14 @@ }, "serialNumber" : { "type" : "string", - "description" : "Serial number of the door controller", - "example" : "DC-12345678", "nullable" : true }, - "state" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "State information for the door controller", - "nullable" : true - }, - "description" : "State information for the door controller", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "unregisteredEmailSent" : { + "type" : "boolean", + "nullable" : true }, "uuid" : { "type" : "string", @@ -77143,70 +79453,47 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "wanAddress" : { - "type" : "string", - "description" : "WAN address of the door controller", - "example" : "203.0.113.1", - "nullable" : true } } }, - "Doorcontroller_GetDoorControllerConfigWSResponse" : { + "DeviceVideoSettingsSelectiveUpdate" : { "type" : "object", - "description" : "Response object containing door controller configuration.", + "description" : "Update selective video settings", "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableDoorControllerUserConfig" + "alert_rate_limit_human_only" : { + "$ref" : "#/components/schemas/BurstyRateLimit" }, - "error" : { + "alert_rate_limit_motion_only" : { + "$ref" : "#/components/schemas/BurstyRateLimit" + }, + "alert_rate_limit_vehicle_only" : { + "$ref" : "#/components/schemas/BurstyRateLimit" + }, + "ir_double_tap" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "ir_filter_mode" : { + "$ref" : "#/components/schemas/IRModesEnum" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Doorcontroller_GetDoorControllerRuleWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a specific rule owned by a door controller.", - "properties" : { - "doorControllerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "ir_leds_mode" : { + "$ref" : "#/components/schemas/IRModesEnum" }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true } } }, - "Doorcontroller_GetDoorControllerRuleWSResponse" : { - "type" : "object", - "description" : "Response object containing a specific rule owned by a door controller.", - "properties" : { - "rule" : { - "$ref" : "#/components/schemas/RuleType" - } - } - }, - "Doorcontroller_GetDoorControllerRulesWSRequest" : { + "Device_config_GetConfigWSRequest" : { "type" : "object", - "description" : "Request object for retrieving all rules owned by a door controller.", + "description" : "Request object for retrieving a device's configuration.", "properties" : { - "doorControllerUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -77215,10 +79502,13 @@ } } }, - "Doorcontroller_GetDoorControllerRulesWSResponse" : { + "Device_config_GetFacetedUserConfigWSResponse" : { "type" : "object", - "description" : "Response object containing all rules owned by a door controller.", + "description" : "Response object containing a device's faceted user configuration.", "properties" : { + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" + }, "error" : { "type" : "boolean", "nullable" : true @@ -77227,3945 +79517,3089 @@ "type" : "string", "nullable" : true }, - "rules" : { - "type" : "array", - "description" : "List of rules owned by the door controller", - "items" : { - "$ref" : "#/components/schemas/RuleType" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Doorcontroller_GetDoorControllerStateListWSRequest" : { + "Device_config_UpdateFacetedUserConfigWSRequest" : { "type" : "object", - "description" : "Request object for retrieving state information for all door controllers in an organization." + "description" : "Request object for updating a device's faceted user configuration.", + "properties" : { + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" + } + } }, - "Doorcontroller_GetDoorControllerStateListWSResponse" : { + "Device_config_settings_ExternalAudioSettingsSelectiveUpdate" : { "type" : "object", - "description" : "Response object containing state information for all door controllers in an organization.", + "description" : "Update Audio settings", "properties" : { - "error" : { + "audio_aec_via_software" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "audio_ai_disabled" : { + "type" : "boolean", "nullable" : true }, - "stateList" : { - "type" : "array", - "description" : "List of door controller state information", - "items" : { - "$ref" : "#/components/schemas/Doorcontroller_DoorControllerStateType" - }, + "audio_external_mic_boost" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "audio_external_mic_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Doorcontroller_RegisterDiscoveredRhombusReaderWSRequest" : { - "type" : "object", - "description" : "Request object for registering a Rhombus reader discovered by a door controller.", - "properties" : { - "boardNum" : { + }, + "audio_external_speaker_volume" : { "type" : "integer", "format" : "int32", - "description" : "Board number for the reader connection", - "example" : 1, "nullable" : true }, - "doorControllerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audio_internal_mic_aec_enabled" : { + "type" : "boolean", "nullable" : true }, - "portNum" : { + "audio_internal_mic_boost" : { "type" : "integer", "format" : "int32", - "description" : "Port number for the reader connection", - "example" : 0, "nullable" : true }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the discovered Rhombus reader", - "example" : "RR-12345678", + "audio_internal_mic_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Doorcontroller_RegisterDiscoveredRhombusReaderWSResponse" : { - "type" : "object", - "description" : "Response object for registering a Rhombus reader discovered by a door controller." - }, - "Doorcontroller_UpdateDoorControllerConfigWSRequest" : { - "type" : "object", - "description" : "Request object for updating door controller configuration.", - "properties" : { - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableDoorControllerUserConfig" - } - } - }, - "Doorcontroller_UpdateDoorControllerDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for updating details for a door controller.", - "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the door controller", - "example" : "Controls access to the main entrance", + }, + "audio_internal_speaker_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "description" : "Direction in radians for the door controller", - "example" : 1.5708, + "audio_min_echo_amplitude" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "floorNumber" : { + "audio_playback_gain_percent" : { "type" : "integer", "format" : "int32", - "description" : "Floor number where the door controller is located", - "example" : 1, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the door controller", - "example" : 34.0522, + "audio_record" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audio_supported" : { + "type" : "boolean", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the door controller", - "example" : -118.2437, + "audio_use_external_mic" : { + "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the door controller", - "example" : "Main Entrance Controller", + "audio_use_external_speaker" : { + "type" : "boolean", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "uuid" ] - }, - "Doorcontroller_UpdateDoorControllerDetailsWSResponse" : { - "type" : "object", - "description" : "Response object for updating details for a door controller.", - "properties" : { - "error" : { + "audio_use_internal_speaker" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "device_mic_enabled" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Doorcontroller_UpdateDoorControllerRuleWSRequest" : { - "type" : "object", - "description" : "Request object for updating a rule owned by a door controller.", - "properties" : { - "doorControllerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "device_near_audio_silenced" : { + "type" : "boolean", "nullable" : true }, - "rule" : { - "$ref" : "#/components/schemas/RuleType" - } - } - }, - "Doorcontroller_UpdateDoorControllerRuleWSResponse" : { - "type" : "object", - "description" : "Response object for updating a rule owned by a door controller.", - "properties" : { - "rule" : { - "$ref" : "#/components/schemas/RuleType" - } - } - }, - "DropboxSettingsV2" : { - "type" : "object", - "description" : "Dropbox integration settings to update", - "properties" : { - "accessToken" : { - "type" : "string", + "device_speaker_enabled" : { + "type" : "boolean", "nullable" : true }, - "accountEmail" : { - "type" : "string", - "nullable" : true + "frontendEqualizerHighShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "accountName" : { - "type" : "string", - "nullable" : true + "frontendEqualizerLowShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "enabled" : { - "type" : "boolean", - "nullable" : true + "frontendEqualizerPeaking1" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "frontendEqualizerPeaking2" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "enablingUser" : { - "type" : "string", + "frontendEqualizerPeaking3" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendNoiseSuppression" : { + "type" : "boolean", "nullable" : true }, - "enablingUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true } } }, - "DtcInfo" : { + "Device_config_settings_ExternalDeviceSettingsSelectiveUpdate" : { "type" : "object", - "nullable" : true, "properties" : { - "code" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "failing" : { + "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, - "hasFailed" : { + "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, - "testCompleted" : { + "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, - "time" : { - "type" : "integer", - "format" : "int64", + "cloud_ai_stream_enabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "DwellEventType" : { - "type" : "object", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" }, - "deviceLabels" : { - "type" : "array", - "items" : { + "firmware_dev_settings" : { + "type" : "object", + "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "dwellStartTimeMs" : { + "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "locationLabels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_stealth_mode" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lightweight_detection_disabled" : { + "type" : "boolean", "nullable" : true }, - "regionUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "live_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "media_ttl_minutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "thumbnailUri" : { - "type" : "string", + "on_demand_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "scanner_agent_disabled" : { + "type" : "boolean", "nullable" : true }, - "trackId" : { + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true - } - } - }, - "DwellStrategyEnum" : { - "type" : "string", - "enum" : [ "NONE", "DURATION", "TIME_ABSOLUTE", "EVENT", "MANUAL", "UNKNOWN" ] - }, - "DynamoPageRequest" : { - "type" : "object", - "description" : "Pagination request for retrieving similar face events", - "properties" : { - "lastEvaluatedKey" : { - "type" : "string", - "nullable" : true }, - "maxPageSize" : { + "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true } } }, - "E50ClimateEventType" : { + "Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate" : { "type" : "object", - "description" : "List of climate events for the environmental gateway", + "description" : "Update Door Controller settings", "properties" : { - "activities" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, + "autocomponentize_readers" : { + "type" : "boolean", "nullable" : true }, - "alertTriggerThresholds" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, + "autoregister_readers" : { + "type" : "boolean", "nullable" : true }, - "alertTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, + "flip_display_orientation" : { + "type" : "boolean", "nullable" : true }, - "carbonMonoSense" : { - "$ref" : "#/components/schemas/COSensorType" - }, - "clipMetaData" : { - "$ref" : "#/components/schemas/ClipMetaDataType" - }, - "co2Sense" : { - "$ref" : "#/components/schemas/Co2SensorType" - }, - "derivedValues" : { - "$ref" : "#/components/schemas/E50DerivedValuesType" - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "mdns_advertise_enabled" : { + "type" : "boolean", "nullable" : true }, - "firmwareVersion" : { - "type" : "string", + "mdns_discover_enabled" : { + "type" : "boolean", "nullable" : true }, - "formaSense" : { - "$ref" : "#/components/schemas/FormaSensorType" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "peer_address_mode" : { + "$ref" : "#/components/schemas/PeerAddressModeEnum" }, - "leakProbe" : { - "$ref" : "#/components/schemas/LeakProbeType" + "peer_channel_mode" : { + "$ref" : "#/components/schemas/PeerChannelModeEnum" }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "pressure_switch_tamper_normally_open" : { + "type" : "boolean", "nullable" : true }, - "pmSense" : { - "$ref" : "#/components/schemas/PmSensorType" - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "proximity_sensor_tamper_disabled" : { + "type" : "boolean", "nullable" : true }, - "pressSense" : { - "$ref" : "#/components/schemas/PressureSensorType" - }, - "tempProbe" : { - "$ref" : "#/components/schemas/TempProbeType" - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "proximity_sensor_tamper_distance_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true } } }, - "E50DerivedValuesType" : { + "Device_config_settings_ExternalReadableAudioSettings" : { "type" : "object", "properties" : { - "airQualityIndex" : { + "audio_aec_via_software" : { + "type" : "boolean", + "nullable" : true + }, + "audio_ai_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "audio_analysis_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "airQualityIndexPollutant" : { - "$ref" : "#/components/schemas/AirQualityIndexPollutantEnum" + "audio_external_mic_volume" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "calibrating" : { + "audio_external_speaker_volume" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, - "deviceOrientation" : { - "$ref" : "#/components/schemas/DeviceOrientationEnum" + "audio_internal_mic_boost" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "falsePositiveConfidencePercent" : { - "type" : "number", - "format" : "float", + "audio_internal_mic_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "heatIndexDegF" : { - "type" : "number", - "format" : "double", + "audio_internal_speaker_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "heatIndexRangeWarning" : { - "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" + "audio_min_echo_amplitude" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "indoorAirQuality" : { - "type" : "number", - "format" : "float", + "audio_playback_gain_percent" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "malfunctioningModules" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "audio_record" : { + "type" : "boolean", "nullable" : true }, - "smokeConfidencePercent" : { - "type" : "number", - "format" : "float", + "audio_supported" : { + "type" : "boolean", "nullable" : true }, - "smokeThcConfidencePercent" : { - "type" : "number", - "format" : "float", + "audio_use_external_mic" : { + "type" : "boolean", "nullable" : true }, - "smokeTobaccoConfidencePercent" : { - "type" : "number", - "format" : "float", + "audio_use_external_speaker" : { + "type" : "boolean", "nullable" : true }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + "audio_use_internal_speaker" : { + "type" : "boolean", "nullable" : true }, - "tvoc" : { - "type" : "number", - "format" : "float", + "device_mic_enabled" : { + "type" : "boolean", "nullable" : true }, - "vapeConfidencePercent" : { - "type" : "number", - "format" : "float", + "device_near_audio_silenced" : { + "type" : "boolean", "nullable" : true }, - "vapeDetected" : { + "device_speaker_enabled" : { "type" : "boolean", "nullable" : true }, - "vapeThcConfidencePercent" : { - "type" : "number", - "format" : "float", + "frontendEqualizerHighShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerLowShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking1" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking2" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking3" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendNoiseSuppression" : { + "type" : "boolean", "nullable" : true } } }, - "EarlyExpireModeEnum" : { - "type" : "string", - "enum" : [ "SCHEDULED_CHANGE", "STEADY_STATE_CHANGE", "OFF" ] - }, - "ElevatorLandingReference" : { + "Device_config_settings_ExternalReadableButtonSettings" : { "type" : "object", "properties" : { - "elevatorLandingUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "button_emergency_onsite_contact" : { + "$ref" : "#/components/schemas/EmergencyContact" }, - "relayComponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ComponentReferenceType" - }, - "nullable" : true, - "uniqueItems" : true + "button_test_mode_enabled" : { + "type" : "boolean", + "nullable" : true } } }, - "EmailSettings" : { + "Device_config_settings_ExternalReadableDeviceSettings" : { "type" : "object", "properties" : { - "emailAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "ai_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "enabled" : { + "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { + "cloud_ai_smart_crop_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "cloud_ai_stream_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "cloud_archive_days" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "cloud_archive_upload_schedule" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + }, "nullable" : true }, - "enablingUserUuid" : { + "cloud_archive_upload_schedule_inverted" : { + "type" : "boolean", + "nullable" : true + }, + "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Embedding" : { - "type" : "object", - "description" : "Returns the generated embedding or null if the embedding could not be generated. If image contains multiple faces, only the first generated embedding is returned.", - "properties" : { - "embeddingComparisonType" : { - "type" : "string", + }, + "firmware_dev_settings" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "embeddingConfidence" : { - "type" : "number", - "format" : "float", + "led_mode_blink_period_ms" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "embeddingEncodingType" : { - "$ref" : "#/components/schemas/EmbeddingEncodingTypeEnum" + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" }, - "encodedEmbedding" : { - "type" : "string", + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_stealth_mode" : { + "type" : "boolean", "nullable" : true - } - } - }, - "EmbeddingEncodingTypeEnum" : { - "type" : "string", - "enum" : [ "Q_8_24", "IEEE_754" ] - }, - "EmergencyContact" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the emergency contact.", + }, + "lightweight_detection_disabled" : { + "type" : "boolean", "nullable" : true }, - "phoneNumber" : { - "type" : "string", - "description" : "The phone number for this emergency contact.", + "live_license_invalid" : { + "type" : "boolean", "nullable" : true - } - }, - "required" : [ "name", "phoneNumber" ] - }, - "EmergencyContactPolicy" : { - "type" : "object", - "description" : "Emergency contacts that may be notified after threat detection occurs at this zone.\n", - "nullable" : true, - "properties" : { - "emergencyContacts" : { - "type" : "array", - "description" : "The emergency contacts eligible to be notified under this configuration.", - "items" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, + }, + "max_event_duration_ms" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "media_ttl_minutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - }, - "required" : [ "emergencyContacts", "scheduleUuid" ] - }, - "EmergencyResponseContactsIntervalType" : { - "type" : "object", - "properties" : { - "emergencyContactList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, + }, + "on_demand_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "minuteOfWeekStart" : { + "scanner_agent_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "storage_target_free_megabytes" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "minuteOfWeekStop" : { + "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" } } }, - "EmergencyResponseContactsScheduleType" : { + "Device_config_settings_ExternalReadableDeviceVideoSettings" : { "type" : "object", "properties" : { - "deviceUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "alert_rate_limit_human_only" : { + "$ref" : "#/components/schemas/BurstyRateLimit" }, - "emergencyContactList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, - "nullable" : true + "alert_rate_limit_motion_only" : { + "$ref" : "#/components/schemas/BurstyRateLimit" }, - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "alert_rate_limit_vehicle_only" : { + "$ref" : "#/components/schemas/BurstyRateLimit" + }, + "ir_double_tap" : { + "type" : "boolean", "nullable" : true + }, + "ir_filter_mode" : { + "$ref" : "#/components/schemas/IRModesEnum" + }, + "ir_leds_mode" : { + "$ref" : "#/components/schemas/IRModesEnum" } } }, - "EnableDisableAudioRecordActionRecordType" : { + "Device_config_settings_ExternalReadableDoorControllerSettings" : { "type" : "object", "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "autocomponentize_readers" : { + "type" : "boolean", "nullable" : true }, - "enable" : { + "autoregister_readers" : { "type" : "boolean", "nullable" : true }, - "succeeded" : { + "flip_display_orientation" : { "type" : "boolean", "nullable" : true - } - } - }, - "EnableDisableAudioRecordActionType" : { - "type" : "object", - "properties" : { - "audioDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "mdns_advertise_enabled" : { + "type" : "boolean", "nullable" : true }, - "enable" : { + "mdns_discover_enabled" : { "type" : "boolean", "nullable" : true - } - } - }, - "EntityEnum" : { - "type" : "string", - "description" : "Entity object for exposing to OpenAPI component schemas", - "enum" : [ "ALARM_MONITORING_LOCATION_SETTINGS", "ALARM_MONITORING_LICENSE", "DEVICE", "LOCATION", "POLICY", "POLICY_ALERT", "POLICY_ADDENDUM", "POLICY_PAUSE", "USER", "CAMERA_USER_CONFIG", "ORG", "USER_PERMISSION_GROUP", "PARTNER_PERMISSION_GROUP", "VIDEO_WALL", "SHARED_CLIPS", "SAVED_CLIPS", "SHARED_STREAMS", "SPLICED_CLIPS", "TIMELAPSE", "AUDIT_EVENTS", "DIAGNOSTIC_EVENTS", "CAMERA_STATE", "CLIMATE_STATE", "DOOR_STATE", "NVR_STATE", "OCCUPANCY_STATE", "PROXIMITY_STATE", "AUDIO_STATE", "CAMERA", "NVR", "DOOR_SENSOR", "CLIMATE_SENSOR", "PROXIMITY_SENSOR", "BOUNDING_BOX", "SEEK_POINT", "SENSOR_SEEK_POINT", "SCHEDULE", "FACE_EVENT", "DEVICE_SHADOW", "THREAT_CASE", "KEYPAD", "COMPONENT_DOOR_READER_SHADOW", "COMPONENT_DOOR_RELAY_SHADOW", "COMPONENT_DOOR_POSITION_INDICATOR_SHADOW", "COMPONENT_APERIO_GATEWAY_SHADOW", "COMPONENT_APERIO_DOOR_EXT_SHADOW", "COMPONENT_REQUEST_TO_EXIT_SHADOW", "COMPONENT_GENERIC_RELAY_SHADOW", "COMPONENT_GENERIC_INPUT_SHADOW", "COMPONENT_GENERIC_BUTTON_SHADOW", "ACCESS_CONTROLLED_DOOR_SHADOW", "ACCESS_CONTROLLED_DOOR", "ACCESS_CONTROLLED_ELEVATOR_SHADOW", "ACCESS_CONTROLLED_ELEVATOR", "ACCESS_CONTROLLED_ELEVATOR_LANDING_SHADOW", "ACCESS_CONTROLLED_ELEVATOR_LANDING", "COMPONENT_SEEKPOINT", "VEHICLE_EVENT", "DEVICE_INTEGRATION", "SHELLY_INTEGRATION", "THIRD_PARTY_CAMERA_DISCOVERY", "THIRD_PARTY_CAMERA_ASSIGNMENT", "THIRD_PARTY_CAMERA_CREDENTIAL", "CHATBOT_QUERY", "KEYPAD_COMMAND", "PRIORITY_DETECTION", "LIVE_DETECTION", "LIVE_OCCUPANCY", "UNKNOWN" ] - }, - "EntityTag" : { - "type" : "object", - "nullable" : true, - "properties" : { - "value" : { - "type" : "string", + }, + "peer_address_mode" : { + "$ref" : "#/components/schemas/PeerAddressModeEnum" + }, + "peer_channel_mode" : { + "$ref" : "#/components/schemas/PeerChannelModeEnum" + }, + "pressure_switch_tamper_normally_open" : { + "type" : "boolean", "nullable" : true }, - "weak" : { + "proximity_sensor_tamper_disabled" : { "type" : "boolean", "nullable" : true + }, + "proximity_sensor_tamper_distance_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true } } }, - "EnvironmentalGatewaySettings" : { + "Device_config_settings_ExternalReadableVideoSettings" : { "type" : "object", "properties" : { - "data_measurement_interval_sec" : { - "type" : "integer", - "format" : "int64", + "ai_dewarp_config" : { + "$ref" : "#/components/schemas/CameraAiDewarpConfigType" + }, + "behavior_detection" : { + "type" : "boolean", "nullable" : true }, - "data_upload_interval_sec" : { + "blocked_debounce_time_ms" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "false_positive_confidence_threshold" : { + "blocked_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, - "leak_detection_threshold" : { + "char_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, - "leak_detector_present" : { + "color_detection" : { "type" : "boolean", "nullable" : true }, - "moist_detection_threshold" : { - "type" : "number", - "format" : "float", + "con_human_filter" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "smoke_confidence_threshold" : { - "type" : "number", - "format" : "float", + "con_vehicle_filter" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "smoke_thc_confidence_threshold" : { - "type" : "number", - "format" : "float", + "cross_counting" : { + "type" : "boolean", "nullable" : true }, - "smoke_tobacco_confidence_threshold" : { - "type" : "number", - "format" : "float", + "cross_counting_settings" : { + "$ref" : "#/components/schemas/CameraCrossCountingSettingsType" + }, + "custom_events" : { + "type" : "boolean", "nullable" : true }, - "vape_alert_backoff_sec" : { - "type" : "integer", - "format" : "int64", + "dewarpMode" : { + "$ref" : "#/components/schemas/CameraDewarpModeEnum" + }, + "disabled_schedule" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + }, "nullable" : true }, - "vape_confidence_threshold" : { - "type" : "number", - "format" : "float", + "disabled_schedule_inverted" : { + "type" : "boolean", "nullable" : true }, - "vape_thc_confidence_threshold" : { - "type" : "number", - "format" : "float", + "disabled_schedule_uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "EnvironmentalGatewaySettingsSelectiveUpdate" : { - "type" : "object", - "description" : "Update Environmental Sensor settings", - "properties" : { - "data_measurement_interval_sec" : { + }, + "dwell_reset_ttl_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "data_upload_interval_sec" : { + "dwell_time_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "false_positive_confidence_threshold" : { - "type" : "number", - "format" : "float", + "engagement_counting" : { + "type" : "boolean", "nullable" : true }, - "leak_detection_threshold" : { + "exposure_level" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "face_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, - "leak_detector_present" : { + "face_counting" : { "type" : "boolean", "nullable" : true }, - "moist_detection_threshold" : { - "type" : "number", - "format" : "float", + "face_counting_nonunique" : { + "type" : "boolean", "nullable" : true }, - "smoke_confidence_threshold" : { + "face_id_ai_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, - "smoke_thc_confidence_threshold" : { + "face_match_threshold" : { "type" : "number", "format" : "float", "nullable" : true }, - "smoke_tobacco_confidence_threshold" : { - "type" : "number", - "format" : "float", + "face_recognition" : { + "type" : "boolean", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", + "fisheye_display_mode" : { + "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" + }, + "floorplan_homography" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, "nullable" : true }, "nullable" : true }, - "vape_alert_backoff_sec" : { - "type" : "integer", - "format" : "int64", + "h265_realtime_encoding_enabled" : { + "type" : "boolean", "nullable" : true }, - "vape_confidence_threshold" : { - "type" : "number", - "format" : "float", + "h265_vod_encoding_enabled" : { + "type" : "boolean", "nullable" : true }, - "vape_thc_confidence_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - } - } - }, - "EnvironmentalGatewayShadowType" : { - "type" : "object", - "description" : "List of environmental gateway shadows", - "properties" : { - "activeAlertTriggers" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, + "hdr_enabled" : { + "type" : "boolean", "nullable" : true }, - "apMac" : { - "type" : "string", + "high_res_detection" : { + "type" : "boolean", "nullable" : true }, - "carbonMonoSense" : { - "$ref" : "#/components/schemas/COSensorType" - }, - "co2Sense" : { - "$ref" : "#/components/schemas/Co2SensorType" + "human_detection" : { + "type" : "boolean", + "nullable" : true }, - "connected" : { + "human_loitering" : { "type" : "boolean", "nullable" : true }, - "connectionTimestampMs" : { + "human_loitering_settings" : { + "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" + }, + "img_brightness" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "connectionUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "img_contrast" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "defaultInterface" : { - "type" : "string", + "img_saturation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "defaultInterfaceMac" : { - "type" : "string", + "img_sharpness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "derivedValues" : { - "$ref" : "#/components/schemas/E50DerivedValuesType" + "inactivity_settings" : { + "$ref" : "#/components/schemas/CameraInactivitySettingsType" }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "licenseplate_detection" : { + "type" : "boolean", "nullable" : true }, - "disconnectTimestampMs" : { - "type" : "integer", - "format" : "int64", + "lpr_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "externalIPAddress" : { - "type" : "string", + "max_detections_per_frame" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "firmwareUpdateInProgress" : { + "metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" + }, + "motion_grid_disabled" : { "type" : "boolean", "nullable" : true }, - "firmwareUpdateTimeMs" : { + "motion_grid_window_sec" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "firmwareVersion" : { - "type" : "string", + "motion_lightweight_disabled" : { + "type" : "boolean", "nullable" : true }, - "formaSense" : { - "$ref" : "#/components/schemas/FormaSensorType" + "motion_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "hardwareUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "motor_config" : { + "$ref" : "#/components/schemas/CameraMotorConfigType" + }, + "mounting_direction" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + }, + "new_motion_feature_flag" : { + "type" : "boolean", "nullable" : true }, - "internalWanAddress" : { - "type" : "string", + "night_exposure_level" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "jumpHostUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "night_img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "lanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "night_img_contrast" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "leakProbe" : { - "$ref" : "#/components/schemas/LeakProbeType" + "night_img_saturation" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "night_img_sharpness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "pmSense" : { - "$ref" : "#/components/schemas/PmSensorType" + "night_metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" }, - "pressSense" : { - "$ref" : "#/components/schemas/PressureSensorType" + "night_sensor_gain_max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "prevConnected" : { - "type" : "boolean", + "night_shutter_time_max" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "prevConnectedUpdateTimestampMs" : { + "night_shutter_time_min" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "region" : { - "type" : "string", + "obj_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "secondaryLanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "object_search" : { + "type" : "boolean", "nullable" : true }, - "ssid" : { - "type" : "string", + "occupancy_count_high_threshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "state" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "nullable" : true - }, + "occupancy_count_low_threshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "stateUpdatedTimestampMs" : { - "type" : "integer", - "format" : "int64", + "occupancy_counting" : { + "type" : "boolean", "nullable" : true }, - "tempProbe" : { - "$ref" : "#/components/schemas/TempProbeType" + "people_counting" : { + "type" : "boolean", + "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "people_tracking" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "person_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "wanAddress" : { - "type" : "string", + "person_reidentification" : { + "type" : "boolean", "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "pose_detection" : { + "type" : "boolean", "nullable" : true - } - } - }, - "EnvoyCustomField" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", + }, + "ppe_detection" : { + "type" : "boolean", "nullable" : true }, - "value" : { - "type" : "string", + "privacy_window_polygons" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, "nullable" : true - } - } - }, - "EnvoyDelivery" : { - "type" : "object", - "properties" : { - "carrier" : { - "$ref" : "#/components/schemas/EnvoyDeliveryInfo" }, - "carrierInfo" : { - "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + "privacy_windows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PermyriadRect" + }, + "nullable" : true }, - "deliveryArea" : { - "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + "ptz_config" : { + "$ref" : "#/components/schemas/CameraPTZConfigType" }, - "deliveryAreaInfo" : { - "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + "ptz_home" : { + "$ref" : "#/components/schemas/CameraPtzHome" }, - "locationId" : { - "type" : "string", + "record_on_motion" : { + "type" : "boolean", "nullable" : true }, - "pickedUpAt" : { - "type" : "string", - "nullable" : true + "region_for_occupancy" : { + "$ref" : "#/components/schemas/RegionConfigType" }, - "pickedUpBy" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" + "region_of_interest" : { + "$ref" : "#/components/schemas/RegionConfigType" }, - "receivedTimestampMs" : { - "type" : "integer", - "format" : "int64", + "region_of_interest_groups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionOfInterestGroup" + }, "nullable" : true }, - "recipient" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" + "resolution" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" }, - "status" : { - "type" : "string", - "nullable" : true - } - } - }, - "EnvoyDeliveryInfo" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "nullable" : true - } - } - }, - "EnvoyExpectedGuest" : { - "type" : "object", - "properties" : { - "expectedArrivalAt" : { - "type" : "string", + "rotation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "expectedArrivalTimestampMs" : { + "rtsp_encoder" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "host" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" - }, - "invitee" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" - }, - "locationId" : { - "type" : "string", - "nullable" : true - } - } - }, - "EnvoyGuest" : { - "type" : "object", - "properties" : { - "agreementsStatus" : { - "type" : "string", + "segment_max_bytes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "email" : { - "type" : "string", + "sensor_gain_max" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "fullName" : { - "type" : "string", + "shared_fov" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "host" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" - }, - "locationId" : { - "type" : "string", + "shutter_time_max" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "notes" : { - "type" : "string", + "shutter_time_min" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "signedInAt" : { - "type" : "string", + "snapshot_height" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "signedInTimestampMs" : { + "snapshot_interval_secs" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "signedOutAt" : { - "type" : "string", + "target_ai_fps" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "signedOutTimestampMs" : { - "type" : "integer", - "format" : "int64", + "thumbstrip_disabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "EnvoyInvite" : { - "type" : "object", - "properties" : { - "customFields" : { + }, + "tile_views" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/EnvoyCustomField" + "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, - "expectedArrivalAt" : { - "type" : "string", + "timelapse" : { + "type" : "boolean", "nullable" : true }, - "expectedDepartureAt" : { - "type" : "string", + "upload_all_detections" : { + "type" : "boolean", "nullable" : true }, - "flowId" : { - "type" : "string", + "use_onboard_ai" : { + "type" : "boolean", "nullable" : true }, - "hostEmployeeId" : { - "type" : "string", + "use_onboard_lpr" : { + "type" : "boolean", "nullable" : true }, - "inviteId" : { - "type" : "string", + "use_pilot_face_id" : { + "type" : "boolean", "nullable" : true }, - "invitee" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" + "vehicle_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "locationId" : { - "type" : "string", + "vehicle_counting" : { + "type" : "boolean", "nullable" : true }, - "notes" : { - "type" : "string", + "vehicle_detection" : { + "type" : "boolean", "nullable" : true }, - "sendEmailToInvitee" : { + "video_ai_disabled" : { "type" : "boolean", "nullable" : true - } - } - }, - "EnvoyLocation" : { - "type" : "object", - "properties" : { - "id" : { + }, + "video_persist_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "visual_tamper_config" : { + "$ref" : "#/components/schemas/CameraVisualTamperConfigType" + }, + "wdr_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "wdr_strength" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "name" : { - "type" : "string", + "zero_motion_video_bitrate_percent" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "zero_motion_video_quality" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "EnvoyLocationInfoType" : { + "Device_config_settings_ExternalVideoResolution" : { "type" : "object", - "nullable" : true, "properties" : { - "assignedCameraList" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "height" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "locationName" : { - "type" : "string", + "width" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "EnvoyPersonInfo" : { + "Device_config_settings_ExternalVideoSettingsSelectiveUpdate" : { "type" : "object", + "description" : "Update Video Settings", "properties" : { - "email" : { - "type" : "string", + "blocked_debounce_time_ms" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "id" : { - "type" : "string", + "blocked_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "locationIds" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "char_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "locations" : { + "custom_events" : { + "type" : "boolean", + "nullable" : true + }, + "dewarpMode" : { + "$ref" : "#/components/schemas/CameraDewarpModeEnum" + }, + "disabled_schedule" : { "type" : "array", "items" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, - "name" : { - "type" : "string", + "disabled_schedule_inverted" : { + "type" : "boolean", "nullable" : true }, - "type" : { + "disabled_schedule_uuid" : { "type" : "string", - "nullable" : true - } - } - }, - "EnvoySettings" : { - "type" : "object", - "description" : "Envoy visitor management integration settings to update", - "properties" : { - "createSeekPoints" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "dwell_reset_ttl_ms" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "enabledTimestampMs" : { + "dwell_time_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "exposure_level" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "enablingUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "fisheye_display_mode" : { + "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" + }, + "floorplan_homography" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, "nullable" : true }, - "envoyIntegrationInstalled" : { + "h265_realtime_encoding_enabled" : { "type" : "boolean", "nullable" : true }, - "indexFaces" : { + "h265_vod_encoding_enabled" : { "type" : "boolean", "nullable" : true }, - "locationInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/EnvoyLocationInfoType" - }, + "hdr_enabled" : { + "type" : "boolean", "nullable" : true }, - "migrated" : { + "high_res_detection" : { "type" : "boolean", "nullable" : true }, - "refreshToken" : { - "type" : "string", + "human_detection" : { + "type" : "boolean", "nullable" : true }, - "saveClips" : { + "human_loitering" : { "type" : "boolean", "nullable" : true - } - } - }, - "EnvoyType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "envoyIntegrationInstalled" : { - "type" : "boolean", - "nullable" : true - }, - "envoyUserSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/EnvoyUserSettings" - }, - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "locationInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/EnvoyLocationInfoType" - }, - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "enabled" : { - "type" : "boolean", + }, + "human_loitering_settings" : { + "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" + }, + "img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "img_contrast" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "img_saturation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "img_sharpness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "inactivity_settings" : { + "$ref" : "#/components/schemas/CameraInactivitySettingsType" + }, + "max_detections_per_frame" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "EnvoyUserSettings" : { - "type" : "object", - "nullable" : true, - "properties" : { - "guestsEnabled" : { - "type" : "boolean", + }, + "metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" + }, + "motor_config" : { + "$ref" : "#/components/schemas/CameraMotorConfigType" + }, + "mounting_direction" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + }, + "night_exposure_level" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "packagesEnabled" : { - "type" : "boolean", + "night_img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "EpochSecondsProvisioner" : { - "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StaticEpochSecondsProvisioner" - } ], - "properties" : { - "type" : { - "type" : "string" - } - }, - "required" : [ "type" ] - }, - "ErrorCodeOrMessageEnum" : { - "type" : "string", - "enum" : [ "BADGE_READER_UNKNOWN", "DEAD_OR_MISSING_BATTERY", "DOORBELL_BUTTON_ISSUE", "ERROR_2", "ERROR_4", "ERROR_5", "ERROR_24", "ERROR_28", "ERROR_30", "ERROR_39", "ERROR_74", "ERROR_84", "FOREIGN_HARDWARE", "BAD_SD_BLOCKS", "NEVER_LEFT_BUSY_STATE", "HARDWARE_DAMAGE", "HEAVY_HARDWARE_DAMAGE", "WATER_DAMAGE", "VIDEO_HARDWARE_FAILURE", "ENCRYPTED_CONTAINER_FAILURE_CREATE", "ENCRYPTED_CONTAINER_FAILURE_OPEN", "ENCRYPTED_CONTAINER_FAILURE_MOUNT", "LIGHT_SENSOR", "SD_CARD_UNKOWN", "SD_CARD_READER_BROKEN", "POWER_ISSUES", "RS485_ISSUE", "CUT_FILTER", "QUALITY_OR_PERFORMANCE", "NETWORK_ISSUES", "UNKNOWN", "ILLEGIBLE_SERIAL_COMM", "NO_SERIAL_COMM", "COSMETIC_DAMAGE", "FIRMWARE_REFLASH_REQUIRED", "IR_RING_OVERHEATED", "REGISTERED_SENSOR", "UNDISCOVERED_ISSUE", "FOCUS_ISSUES", "POTENTIAL_MANUFACTURING_DEFECT", "NO_FAULT_FOUND", "FDT_COMMAND_LINE_ERROR", "KERNEL_PANIC", "GET_DTB_FAILED", "BOOTS_TO_AMBOOT" ] - }, - "Ethernettester_GetEthernetTesterConfigWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving Ethernet tester configuration.", - "properties" : { - "version" : { - "type" : "string", - "description" : "Version of the Ethernet tester configuration", - "example" : "1.0", + }, + "night_img_contrast" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Ethernettester_GetEthernetTesterConfigWSResponse" : { - "type" : "object", - "description" : "Response object containing Ethernet tester configuration.", - "properties" : { - "configJson" : { - "type" : "string", - "description" : "JSON configuration for the Ethernet tester", - "example" : "{\"testMode\":\"ping\",\"targetHost\":\"192.168.1.1\"}", + }, + "night_img_saturation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "error" : { + "night_img_sharpness" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "night_metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" + }, + "night_sensor_gain_max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "night_shutter_time_max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "night_shutter_time_min" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "object_search" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "occupancy_count_high_threshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "occupancy_count_low_threshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "EventCount" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "number", + }, + "occupancy_counting" : { + "type" : "boolean", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "people_tracking" : { + "type" : "boolean", "nullable" : true - } - } - }, - "EventListenerType" : { - "type" : "object", - "description" : "List of event listeners for the specified device", - "properties" : { - "activities" : { + }, + "person_reidentification" : { + "type" : "boolean", + "nullable" : true + }, + "privacy_window_polygons" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/RegionPolygonType" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "clientCertificate" : { + "privacy_windows" : { "type" : "array", "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true + "$ref" : "#/components/schemas/PermyriadRect" }, "nullable" : true }, - "clientKey" : { + "ptz_config" : { + "$ref" : "#/components/schemas/CameraPTZConfigType" + }, + "ptz_home" : { + "$ref" : "#/components/schemas/CameraPtzHome" + }, + "record_on_motion" : { + "type" : "boolean", + "nullable" : true + }, + "region_for_occupancy" : { + "$ref" : "#/components/schemas/RegionConfigType" + }, + "region_of_interest" : { + "$ref" : "#/components/schemas/RegionConfigType" + }, + "region_of_interest_groups" : { "type" : "array", "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true + "$ref" : "#/components/schemas/RegionOfInterestGroup" }, "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "resolution" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" + }, + "rotation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "hostname" : { - "type" : "string", + "rtsp_encoder" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "segment_max_bytes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "trustedCertificate" : { + "sensor_gain_max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "shared_fov" : { "type" : "array", "items" : { "type" : "string", - "format" : "byte", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "uri" : { - "type" : "string", + "shutter_time_max" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "EventOriginatorEnum" : { - "type" : "string", - "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "COMPONENT_COMPOSITE_EVENT", "UNKNOWN" ] - }, - "EventOriginatorEnum_Minimal" : { - "type" : "string", - "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "COMPONENT_COMPOSITE_EVENT", "UNKNOWN" ] - }, - "Event_CreateSharedClipGroupWSRequest" : { - "type" : "object", - "description" : "Request object for creating a shared clip group.", - "properties" : { - "expirationTimeSecs" : { + "shutter_time_min" : { "type" : "integer", "format" : "int32", - "description" : "Expiration time in seconds for the shared clip group", - "example" : 86400, "nullable" : true }, - "plaintextPassword" : { - "type" : "string", - "description" : "Optional password for accessing the shared clip group", - "example" : "mypassword123", + "snapshot_height" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "title" : { - "type" : "string", - "description" : "Title for the shared clip group", - "example" : "Security Incident - Main Entrance", + "snapshot_interval_secs" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "uuids" : { + "tile_views" : { "type" : "array", - "description" : "List of UUIDs for clips to include in the shared group", "items" : { - "$ref" : "#/components/schemas/Event_RuuidWrapper" + "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true - } - } - }, - "Event_CreateSharedClipGroupWSResponse" : { - "type" : "object", - "description" : "Response object for creating a shared clip group.", - "properties" : { - "error" : { + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true + }, + "upload_all_detections" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "use_onboard_lpr" : { + "type" : "boolean", "nullable" : true }, - "shareUrl" : { - "type" : "string", - "description" : "URL for accessing the shared clip group", - "example" : "https://share.rhombus.com/clips/abc123", + "vehicle_detection" : { + "type" : "boolean", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "video_ai_disabled" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "video_persist_disabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_DeleteAlertMonitoringThreatCaseByStatusWSRequest" : { - "type" : "object", - "description" : "Request object for deleting alert monitoring threat cases by status.", - "properties" : { - "status" : { - "$ref" : "#/components/schemas/ThreatCaseStatusEnum" - } - } - }, - "Event_DeleteAlertMonitoringThreatCaseByStatusWSResponse" : { - "type" : "object", - "description" : "Response object for deleting alert monitoring threat cases by status.", - "properties" : { - "error" : { + }, + "wdr_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "wdr_strength" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "zero_motion_video_bitrate_percent" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Event_DeleteAlertMonitoringThreatCaseWSRequest" : { + "Device_config_settings_IntRange" : { "type" : "object", - "description" : "Request object for deleting alert monitoring threat cases.", "properties" : { - "threatCaseUuids" : { - "type" : "array", - "description" : "List of threat case UUIDs to delete", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "min" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Event_DeleteAlertMonitoringThreatCaseWSResponse" : { + "Device_config_settings_VideoConfigurationDefault" : { "type" : "object", - "description" : "Response object for deleting alert monitoring threat cases.", + "description" : "Map of hardware variations to default video configurations", "properties" : { - "error" : { + "humanDetection" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "resolution" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" + }, + "segmentMaxBytes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "sensorGainMax" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_DeleteSavedClipWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a saved clip.", - "properties" : { - "savedClipUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "shutterTimeMin" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "vehicleDetection" : { + "type" : "boolean", "nullable" : true } } }, - "Event_DeleteSavedClipWSResponse" : { + "Device_config_settings_VideoConfigurationOption" : { "type" : "object", - "description" : "Response object for deleting a saved clip.", + "description" : "Map of hardware variations to available video configuration options", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "maxBitrateRange" : { + "$ref" : "#/components/schemas/Device_config_settings_IntRange" }, - "errorMsg" : { - "type" : "string", + "maxZoomPercent" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "resolution" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" + }, + "wdrRange" : { + "$ref" : "#/components/schemas/Device_config_settings_IntRange" } } }, - "Event_DeleteSharedClipGroupWSRequest" : { + "Device_config_userconfig_ExternalReadableFacetedUserConfig" : { "type" : "object", - "description" : "Request object for deleting a shared clip group.", + "description" : "Device's faceted user configuration", "properties" : { - "uuid" : { + "audioFacetSettings" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableAudioSettings" + }, + "nullable" : true + }, + "buttonSettings" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableButtonSettings" + }, + "climateSettings" : { + "$ref" : "#/components/schemas/ClimateSettings" + }, + "deviceSettings" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDeviceSettings" + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Event_DeleteSharedClipGroupWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a shared clip group.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "deviceVideoSettings" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDeviceVideoSettings" + }, + "doorControllerSettings" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableDoorControllerSettings" + }, + "doorReaderSettings" : { + "$ref" : "#/components/schemas/DoorReaderSettings" + }, + "doorSensorSettings" : { + "$ref" : "#/components/schemas/DoorSensorSettings" + }, + "environmentalGatewaySettings" : { + "$ref" : "#/components/schemas/EnvironmentalGatewaySettings" + }, + "lastModified" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "metricsAgentSettings" : { + "$ref" : "#/components/schemas/MetricsAgentSettings" + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "robotSettings" : { + "$ref" : "#/components/schemas/RobotSettings" + }, + "tamperSettings" : { + "$ref" : "#/components/schemas/TamperSettings" + }, + "thirdPartyCameraSettings" : { + "$ref" : "#/components/schemas/ThirdPartyCameraSettings" + }, + "videoDoorbellSettings" : { + "$ref" : "#/components/schemas/VideoDoorbellSettings" + }, + "videoFacetSettings" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalReadableVideoSettings" + }, "nullable" : true } } }, - "Event_DismissAllPolicyAlertsForDeviceWSRequest" : { + "Device_config_userconfig_ExternalUpdateableFacetedUserConfig" : { "type" : "object", - "description" : "Request object for dismissing all policy alerts for specific devices.", + "description" : "Configuration updates to apply to the device", "properties" : { - "deviceUuids" : { - "type" : "array", - "description" : "List of device UUIDs to dismiss alerts for", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "audioFacetSettings" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalAudioSettingsSelectiveUpdate" }, - "nullable" : true - } - } - }, - "Event_DismissAllPolicyAlertsForDeviceWSResponse" : { - "type" : "object", - "description" : "Response object for dismissing all policy alerts for specific devices.", - "properties" : { - "error" : { - "type" : "boolean", + "description" : "Update Audio settings", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "buttonSettings" : { + "$ref" : "#/components/schemas/ButtonSettingsSelectiveUpdate" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_DismissAllPolicyAlertsWSRequest" : { - "type" : "object", - "description" : "Request object for dismissing all policy alerts." - }, - "Event_DismissAllPolicyAlertsWSResponse" : { - "type" : "object", - "description" : "Response object for dismissing all policy alerts.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "climateSettings" : { + "$ref" : "#/components/schemas/ClimateSettingsSelectiveUpdate" }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "deviceSettings" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalDeviceSettingsSelectiveUpdate" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_DismissPolicyAlertWSRequest" : { - "type" : "object", - "description" : "Request object for dismissing a policy alert.", - "properties" : { - "alertUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Event_DismissPolicyAlertWSResponse" : { - "type" : "object", - "description" : "Response object for dismissing a policy alert.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "deviceVideoSettings" : { + "$ref" : "#/components/schemas/DeviceVideoSettingsSelectiveUpdate" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_DismissPolicyAlertsWSRequest" : { - "type" : "object", - "description" : "Request object for dismissing multiple policy alerts.", - "properties" : { - "alertUuids" : { - "type" : "array", - "description" : "List of policy alert UUIDs to dismiss", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "doorControllerSettings" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalDoorControllerSettingsSelectiveUpdate" + }, + "doorReaderSettings" : { + "$ref" : "#/components/schemas/DoorReaderSettingsSelectiveUpdate" + }, + "doorSensorSettings" : { + "$ref" : "#/components/schemas/DoorSensorSettingsSelectiveUpdate" + }, + "environmentalGatewaySettings" : { + "$ref" : "#/components/schemas/EnvironmentalGatewaySettingsSelectiveUpdate" + }, + "metricsAgentSettings" : { + "$ref" : "#/components/schemas/MetricsAgentSettingsSelectiveUpdate" + }, + "robotSettings" : { + "$ref" : "#/components/schemas/RobotSettingsSelectiveUpdate" + }, + "tamperSettings" : { + "$ref" : "#/components/schemas/TamperSettingsSelectiveUpdate" + }, + "videoDoorbellSettings" : { + "$ref" : "#/components/schemas/VideoDoorbellSettingsSelectiveUpdate" + }, + "videoFacetSettings" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoSettingsSelectiveUpdate" }, + "description" : "Update Video Settings", "nullable" : true } } }, - "Event_DismissPolicyAlertsWSResponse" : { + "Device_config_userconfig_IExternalReadableAudioVideoUserConfig" : { "type" : "object", - "description" : "Response object for dismissing multiple policy alerts.", + "description" : "Doorbell camera configuration settings", "properties" : { - "error" : { + "ai_dewarp_config" : { + "$ref" : "#/components/schemas/CameraAiDewarpConfigType" + }, + "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "audio_aec_via_software" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "audio_ai_disabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_FrontendCell" : { - "type" : "object", - "description" : "Represents a cell in the motion grid with column and row coordinates.", - "properties" : { - "col" : { + }, + "audio_analysis_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "audio_external_mic_boost" : { "type" : "integer", "format" : "int32", - "description" : "Column coordinate of the cell", - "example" : 5, "nullable" : true }, - "row" : { + "audio_external_mic_volume" : { "type" : "integer", "format" : "int32", - "description" : "Row coordinate of the cell", - "example" : 3, "nullable" : true - } - } - }, - "Event_GetAlertMonitoringThreatCaseWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a specific alert monitoring threat case.", - "properties" : { - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "audio_external_speaker_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetAlertMonitoringThreatCaseWSResponse" : { - "type" : "object", - "description" : "Response object containing a specific alert monitoring threat case.", - "properties" : { - "error" : { + }, + "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "audio_internal_mic_boost" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "threatCase" : { - "$ref" : "#/components/schemas/AlertMonitoringThreatCaseType" + "audio_internal_mic_volume" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "audio_internal_speaker_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetAlertMonitoringThreatCasesWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving alert monitoring threat cases with filtering and pagination options.", - "properties" : { - "afterTimestampMs" : { + }, + "audio_min_echo_amplitude" : { "type" : "integer", - "format" : "int64", - "description" : "Filter for threat cases after this timestamp", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "beforeTimestampMs" : { + "audio_playback_gain_percent" : { "type" : "integer", - "format" : "int64", - "description" : "Filter for threat cases before this timestamp", - "example" : 1641081600000, + "format" : "int32", "nullable" : true }, - "deviceFilter" : { - "type" : "array", - "description" : "List of device UUIDs to filter by", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "audio_record" : { + "type" : "boolean", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", + "audio_supported" : { + "type" : "boolean", "nullable" : true }, - "lastTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Last timestamp for pagination", - "example" : 1640995200000, + "audio_use_external_mic" : { + "type" : "boolean", "nullable" : true }, - "lastUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audio_use_external_speaker" : { + "type" : "boolean", "nullable" : true }, - "locationFilter" : { - "type" : "array", - "description" : "List of location UUIDs to filter by", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "audio_use_internal_speaker" : { + "type" : "boolean", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "bandwidth_reports_disabled" : { + "type" : "boolean", "nullable" : true }, - "maxResults" : { + "behavior_detection" : { + "type" : "boolean", + "nullable" : true + }, + "blocked_debounce_time_ms" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of results to return", - "example" : 100, "nullable" : true }, - "mostRecent" : { - "type" : "boolean", - "description" : "Whether to return only the most recent threat cases", - "example" : true, + "blocked_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "statusFilter" : { - "type" : "array", - "description" : "List of threat case statuses to filter by", - "items" : { - "$ref" : "#/components/schemas/ThreatCaseStatusEnum" - }, + "char_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true - } - } - }, - "Event_GetAlertMonitoringThreatCasesWSResponse" : { - "type" : "object", - "description" : "Response object containing alert monitoring threat cases with pagination information.", - "properties" : { - "error" : { + }, + "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "cloud_ai_stream_enabled" : { + "type" : "boolean", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", + "cloud_archive_days" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "threatCases" : { + "cloud_archive_upload_schedule" : { "type" : "array", - "description" : "List of threat cases matching the request criteria", "items" : { - "$ref" : "#/components/schemas/AlertMonitoringThreatCaseType" + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "cloud_archive_upload_schedule_inverted" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetClipWithProgressWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a specific clip with progress information.", - "properties" : { - "clipUuid" : { + }, + "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "clipUuid" ] - }, - "Event_GetClipWithProgressWSResponse" : { - "type" : "object", - "description" : "Response object containing a specific clip with progress information.", - "properties" : { - "clip" : { - "$ref" : "#/components/schemas/Event_SavedClipWithProgressType" }, - "error" : { + "color_detection" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "con_human_filter" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetClipsWithProgressWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving clips with progress information and filtering options.", - "properties" : { - "deviceUuidFilters" : { - "type" : "array", - "description" : "Device uuids to filter clips by.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "con_vehicle_filter" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "excludeAlertMonitoringClips" : { + "cross_counting" : { "type" : "boolean", - "default" : false, - "description" : "Filter to exclude clips created for alarm monitoring verification.", "nullable" : true }, - "filterByPrivate" : { + "cross_counting_settings" : { + "$ref" : "#/components/schemas/CameraCrossCountingSettingsType" + }, + "custom_events" : { "type" : "boolean", - "default" : false, - "description" : "Filter to only include private clips in the result.", "nullable" : true }, - "locationUuidFilters" : { - "type" : "array", - "description" : "Location uuids to filter clips by.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pageSize" : { - "type" : "integer", - "format" : "int32", - "default" : 100, - "description" : "Page size", - "maximum" : 200, - "minimum" : 1, + "device_mic_enabled" : { + "type" : "boolean", "nullable" : true }, - "pageToken" : { - "type" : "string", - "description" : "Page token received from the previous search request.", - "example" : "next_page_token_123", + "device_near_audio_silenced" : { + "type" : "boolean", "nullable" : true }, - "searchFilter" : { - "type" : "string", - "description" : "Search filter for clips", - "example" : "motion detected", + "device_speaker_enabled" : { + "type" : "boolean", "nullable" : true }, - "sortField" : { - "type" : "string", - "description" : "Field to sort clips by", - "example" : "timestamp", + "dewarpMode" : { + "$ref" : "#/components/schemas/CameraDewarpModeEnum" + }, + "disabled_schedule" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + }, "nullable" : true }, - "sortOrder" : { - "type" : "string", - "description" : "Sort order (asc or desc)", - "example" : "desc", + "disabled_schedule_inverted" : { + "type" : "boolean", "nullable" : true }, - "timestampFilterField" : { + "disabled_schedule_uuid" : { "type" : "string", - "description" : "Timestamp to filter clips by (either clip creation date or clip footage date).", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMsAfter" : { + "dwell_reset_ttl_ms" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp to find clips after this time.", - "example" : 1640995200000, "nullable" : true }, - "timestampMsBefore" : { + "dwell_time_ms" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp to find clips before this time", - "example" : 1641081600000, - "nullable" : true - } - }, - "required" : [ "pageSize" ] - }, - "Event_GetClipsWithProgressWSResponse" : { - "type" : "object", - "description" : "Response object containing clips with progress information.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "engagement_counting" : { + "type" : "boolean", "nullable" : true }, - "pageToken" : { - "type" : "string", - "description" : "Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.", + "exposure_level" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "savedClips" : { - "type" : "array", - "description" : "List of saved clips with progress information", - "items" : { - "$ref" : "#/components/schemas/Event_SavedClipWithProgressType" - }, + "face_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetExpiringPolicyAlertsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving expiring policy alerts.", - "properties" : { - "expiresBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Epoch timestamp in milliseconds. Used to find policy alerts that expire before this timestamp.\n", + "face_counting" : { + "type" : "boolean", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", + "face_counting_nonunique" : { + "type" : "boolean", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - }, - "required" : [ "expiresBeforeMs" ] - }, - "Event_GetExpiringPolicyAlertsWSResponse" : { - "type" : "object", - "description" : "Response object containing a list of expiring policy alerts.", - "properties" : { - "error" : { - "type" : "boolean", + "face_id_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "face_match_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Key used to resume pagination, if applicable", + "face_recognition" : { + "type" : "boolean", "nullable" : true }, - "policyAlerts" : { - "type" : "array", - "description" : "List of expiring policy alerts", - "items" : { - "$ref" : "#/components/schemas/BasePolicyAlertType" + "firmware_dev_settings" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true }, "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetMotionGridCountsWSResponse" : { - "type" : "object", - "description" : "Response object containing motion grid counts for a device.", - "properties" : { - "countGrid" : { + "fisheye_display_mode" : { + "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" + }, + "floorplan_homography" : { "type" : "array", - "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", "items" : { "type" : "array", - "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", "items" : { - "type" : "integer", - "format" : "int32", - "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", + "type" : "number", + "format" : "double", "nullable" : true }, "nullable" : true }, "nullable" : true }, - "error" : { + "frontendEqualizerHighShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerLowShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking1" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking2" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking3" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "h265_realtime_encoding_enabled" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetMotionGridWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving motion grid data for a device.", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "h265_vod_encoding_enabled" : { + "type" : "boolean", "nullable" : true }, - "endTimeUtcSecs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time as a UNIX timestamp in seconds", - "example" : 1641081600, + "hdr_enabled" : { + "type" : "boolean", "nullable" : true }, - "startTimeUtcSecs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time as a UNIX timestamp in seconds", - "example" : 1640995200, + "high_res_detection" : { + "type" : "boolean", "nullable" : true - } - }, - "required" : [ "deviceUuid", "endTimeUtcSecs", "startTimeUtcSecs" ] - }, - "Event_GetMotionGridWSResponse" : { - "type" : "object", - "description" : "Response object containing motion grid data for a device.", - "properties" : { - "error" : { + }, + "human_detection" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "human_loitering" : { + "type" : "boolean", "nullable" : true }, - "motionCells" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of timestamps to motion grid cells", - "items" : { - "$ref" : "#/components/schemas/Event_FrontendCell" - }, - "nullable" : true - }, - "description" : "Map of timestamps to motion grid cells", + "human_loitering_settings" : { + "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" + }, + "img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "img_contrast" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetPolicyAlertCountWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving the count of policy alerts.", - "properties" : { - "maxResultsSize" : { + }, + "img_saturation" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of results to count", - "example" : 1000, "nullable" : true - } - } - }, - "Event_GetPolicyAlertCountWSResponse" : { - "type" : "object", - "description" : "Response object containing the count of policy alerts.", - "properties" : { - "count" : { + }, + "img_sharpness" : { "type" : "integer", "format" : "int32", - "description" : "Count of policy alerts", - "example" : 42, "nullable" : true }, - "error" : { - "type" : "boolean", + "inactivity_settings" : { + "$ref" : "#/components/schemas/CameraInactivitySettingsType" + }, + "lastModified" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "led_mode_blink_period_ms" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_stealth_mode" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetPolicyAlertDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving detailed information about a policy alert.", - "properties" : { - "policyAlertUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "licenseplate_detection" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetPolicyAlertDetailsWSResponse" : { - "type" : "object", - "description" : "Response object containing detailed information about a policy alert.", - "properties" : { - "error" : { + }, + "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "live_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "policyAlert" : { - "$ref" : "#/components/schemas/PolicyAlertWithDetailsType" + "lpr_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "max_detections_per_frame" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetPolicyAlertGroupsForDeviceWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving policy alert groups for a specific device.", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "max_event_duration_ms" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "lastTimestampMs" : { + "media_ttl_minutes" : { "type" : "integer", - "format" : "int64", - "description" : "Last timestamp for pagination (required with LastUuid)", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "lastUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" + }, + "motion_grid_disabled" : { + "type" : "boolean", "nullable" : true }, - "maxResults" : { + "motion_grid_window_sec" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of results to return", - "example" : 100, "nullable" : true - } - } - }, - "Event_GetPolicyAlertGroupsForDeviceWSResponse" : { - "type" : "object", - "description" : "Response object containing policy alert groups for a specific device.", - "properties" : { - "error" : { + }, + "motion_lightweight_disabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "motion_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "policyAlertGroups" : { - "type" : "array", - "description" : "List of policy alert groups for the device", - "items" : { - "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" - }, - "nullable" : true + "motor_config" : { + "$ref" : "#/components/schemas/CameraMotorConfigType" }, - "warningMsg" : { - "type" : "string", + "mounting_direction" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + }, + "new_motion_feature_flag" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetPolicyAlertGroupsForLocationWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving policy alert groups for a specific location.", - "properties" : { - "lastTimestampMs" : { + }, + "night_exposure_level" : { "type" : "integer", - "format" : "int64", - "description" : "Last timestamp for pagination", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "lastUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "night_img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "night_img_contrast" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "maxResults" : { + "night_img_saturation" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of results to return", - "example" : 100, - "nullable" : true - } - } - }, - "Event_GetPolicyAlertGroupsForLocationWSResponse" : { - "type" : "object", - "description" : "Response object containing policy alert groups for a specific location.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "night_img_sharpness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "policyAlertGroups" : { - "type" : "array", - "description" : "List of policy alert groups for the location", - "items" : { - "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" - }, - "nullable" : true + "night_metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetPolicyAlertGroupsV2WSRequest" : { - "type" : "object", - "description" : "Request object for retrieving policy alert groups V2 with pagination options.", - "properties" : { - "lastTimestampMs" : { + "night_sensor_gain_max" : { "type" : "integer", - "format" : "int64", - "description" : "Last timestamp for pagination", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "lastUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "night_shutter_time_max" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "maxResults" : { + "night_shutter_time_min" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of results to return", - "example" : 100, - "nullable" : true - } - } - }, - "Event_GetPolicyAlertGroupsV2WSResponse" : { - "type" : "object", - "description" : "Response object containing policy alert groups V2.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "obj_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "policyAlertGroups" : { - "type" : "array", - "description" : "List of policy alert groups V2", - "items" : { - "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" - }, + "object_search" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "occupancy_count_high_threshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetPolicyAlertV2WSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a specific policy alert V2.", - "properties" : { - "policyAlertUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "occupancy_count_low_threshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetPolicyAlertV2WSResponse" : { - "type" : "object", - "description" : "Response object containing a specific policy alert V2.", - "properties" : { - "error" : { + }, + "occupancy_counting" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "on_demand_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "policyAlert" : { - "$ref" : "#/components/schemas/PolicyAlertV2Type" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetPolicyAlertWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a specific policy alert.", - "properties" : { - "policyAlertUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Event_GetPolicyAlertWSResponse" : { - "type" : "object", - "description" : "Response object containing a specific policy alert.", - "properties" : { - "error" : { + }, + "people_counting" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "people_tracking" : { + "type" : "boolean", "nullable" : true }, - "policyAlert" : { - "$ref" : "#/components/schemas/BasePolicyAlertType" + "person_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "person_reidentification" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetPolicyAlertsV2WSRequest" : { - "type" : "object", - "description" : "Request object for retrieving policy alerts V2 with filtering and pagination options.", - "properties" : { - "afterTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter for alerts after this timestamp", - "example" : 1640995200000, + }, + "pose_detection" : { + "type" : "boolean", "nullable" : true }, - "beforeTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter for alerts before this timestamp", - "example" : 1641081600000, + "ppe_detection" : { + "type" : "boolean", "nullable" : true }, - "deviceFilter" : { + "privacy_window_polygons" : { "type" : "array", - "description" : "List of device UUIDs to filter by", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/RegionPolygonType" }, "nullable" : true }, - "lastTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Last timestamp for pagination", - "example" : 1640995200000, + "privacy_windows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PermyriadRect" + }, "nullable" : true }, - "lastUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "ptz_config" : { + "$ref" : "#/components/schemas/CameraPTZConfigType" }, - "locationFilter" : { - "type" : "array", - "description" : "List of location UUIDs to filter by", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "ptz_home" : { + "$ref" : "#/components/schemas/CameraPtzHome" }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of results to return", - "example" : 100, - "nullable" : true - } - } - }, - "Event_GetPolicyAlertsV2WSResponse" : { - "type" : "object", - "description" : "Response object containing policy alerts V2 with filtering and pagination options.", - "properties" : { - "error" : { + "record_on_motion" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "region_for_occupancy" : { + "$ref" : "#/components/schemas/RegionConfigType" }, - "oldestPolicyAlert" : { - "$ref" : "#/components/schemas/PolicyAlertV2Type" + "region_of_interest" : { + "$ref" : "#/components/schemas/RegionConfigType" }, - "policyAlerts" : { + "region_of_interest_groups" : { "type" : "array", - "description" : "List of policy alerts V2 matching the request criteria", "items" : { - "$ref" : "#/components/schemas/PolicyAlertV2Type" + "$ref" : "#/components/schemas/RegionOfInterestGroup" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "resolution" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" + }, + "rotation" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetPolicyAlertsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving policy alerts with filtering and pagination options.", - "properties" : { - "accessControlledDoorFilter" : { - "type" : "array", - "description" : "Filter including chosen Access Controlled Doors", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + }, + "rtsp_encoder" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "afterTimestampMs" : { + "segment_max_bytes" : { "type" : "integer", - "format" : "int64", - "description" : "Enter starting timestamp interval in UNIX ms", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "beforeTimestampMs" : { + "sensor_gain_max" : { "type" : "integer", - "format" : "int64", - "description" : "Enter ending timestamp interval in UNIX ms", - "example" : 1641081600000, + "format" : "int32", "nullable" : true }, - "deviceFilter" : { + "shared_fov" : { "type" : "array", - "description" : "Filter including chosen Devices", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "lastTimestampMs" : { + "shutter_time_max" : { "type" : "integer", - "format" : "int64", - "description" : "Search with last known TimestampMs (Required for Pagination)", - "example" : 1640995200000, + "format" : "int32", "nullable" : true }, - "lastUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "shutter_time_min" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "locationFilter" : { - "type" : "array", - "description" : "Filter any locations you would like to include", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "snapshot_height" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "maxResults" : { + "snapshot_interval_secs" : { "type" : "integer", "format" : "int32", - "description" : "Set a max result limit", - "example" : 100, - "nullable" : true - } - } - }, - "Event_GetPolicyAlertsWSResponse" : { - "type" : "object", - "description" : "Response object containing a list of policy alerts.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" }, - "policyAlerts" : { - "type" : "array", - "description" : "List of policy alerts matching the request criteria", - "items" : { - "$ref" : "#/components/schemas/BasePolicyAlertType" - }, + "storage_target_free_megabytes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetSavedClipCountWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving the count of saved clips with filtering options.", - "properties" : { - "deviceFilter" : { - "type" : "array", - "description" : "List of device UUIDs to filter clips by", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "storage_target_free_space_permyriad" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "endTimeMs" : { + "target_ai_fps" : { "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for filtering clips", - "example" : 1641081600000, + "format" : "int32", "nullable" : true }, - "locationFilter" : { + "thumbstrip_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "tile_views" : { "type" : "array", - "description" : "List of location UUIDs to filter clips by", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds for filtering clips", - "example" : 1640995200000, - "nullable" : true - } - } - }, - "Event_GetSavedClipCountWSResponse" : { - "type" : "object", - "description" : "Response object containing the count of saved clips.", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int64", - "description" : "Count of org-wide saved clips matching the filter criteria", - "example" : 42, + "timelapse" : { + "type" : "boolean", "nullable" : true }, - "error" : { + "upload_all_detections" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "use_onboard_ai" : { + "type" : "boolean", "nullable" : true }, - "privateCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Count of private saved clips matching the filter criteria", - "example" : 10, + "use_onboard_lpr" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetSavedClipDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving detailed information about a saved clip.", - "properties" : { - "clipUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Event_GetSavedClipDetailsWSResponse" : { - "type" : "object", - "description" : "Response object containing detailed information about a saved clip.", - "properties" : { - "error" : { + "use_pilot_face_id" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "vehicle_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "savedClip" : { - "$ref" : "#/components/schemas/SavedClipWithDetailsType" - }, - "warningMsg" : { - "type" : "string", + "vehicle_counting" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetSavedClipsByExternalTransactionIdWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving saved clips by external transaction ID.", - "properties" : { - "externalTransactionId" : { - "type" : "string", - "description" : "External transaction ID to search for saved clips", - "example" : "txn_123456789", + }, + "vehicle_detection" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetSavedClipsByExternalTransactionIdWSResponse" : { - "type" : "object", - "description" : "Response object containing saved clips by external transaction ID.", - "properties" : { - "error" : { + }, + "video_ai_disabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "video_persist_disabled" : { + "type" : "boolean", "nullable" : true }, - "savedClips" : { - "type" : "array", - "description" : "List of saved clips matching the external transaction ID", - "items" : { - "$ref" : "#/components/schemas/SavedClipV2Type" - }, + "visual_tamper_config" : { + "$ref" : "#/components/schemas/CameraVisualTamperConfigType" + }, + "wdr_enabled" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "wdr_strength" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetSavedClipsV2WSRequest" : { - "type" : "object", - "description" : "Request object for retrieving saved clips with pagination.", - "properties" : { - "maxPageSize" : { + }, + "zero_motion_video_bitrate_percent" : { "type" : "integer", "format" : "int32", - "description" : "Set max results returned. Note: in future this will be defaulted to 100", - "example" : 100, "nullable" : true }, - "pageTimestampMs" : { + "zero_motion_video_quality" : { "type" : "integer", - "format" : "int64", - "description" : "Timestamp start to specify page of up to 100 saved clips", - "example" : 1640995200000, + "format" : "int32", "nullable" : true } } }, - "Event_GetSavedClipsV2WSResponse" : { + "Device_config_userconfig_IExternalReadableDoorControllerUserConfig" : { "type" : "object", - "description" : "Response object containing saved clips with pagination.", + "description" : "Door controller configuration settings", "properties" : { - "error" : { + "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "autocomponentize_readers" : { + "type" : "boolean", "nullable" : true }, - "lastEvaluatedTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp of the last evaluated clip for pagination", + "autoregister_readers" : { + "type" : "boolean", "nullable" : true }, - "savedClips" : { - "type" : "array", - "description" : "List of saved clips", - "items" : { - "$ref" : "#/components/schemas/SavedClipV2Type" - }, + "bandwidth_reports_disabled" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "cloud_ai_smart_crop_enabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetSavedClipsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving saved clips (deprecated)." - }, - "Event_GetSavedClipsWSResponse" : { - "type" : "object", - "description" : "Response object containing saved clips (deprecated).", - "properties" : { - "error" : { + }, + "cloud_ai_stream_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "cloud_archive_days" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "savedClips" : { + "cloud_archive_upload_schedule" : { "type" : "array", - "description" : "List of saved clips", "items" : { - "$ref" : "#/components/schemas/SavedClipV2Type" + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "cloud_archive_upload_schedule_inverted" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetSharedClipGroupDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving detailed information about a shared clip group.", - "properties" : { - "uuid" : { + }, + "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Event_GetSharedClipGroupDetailsWSResponse" : { - "type" : "object", - "description" : "Response object containing detailed information about a shared clip group.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sharedClipGroup" : { - "$ref" : "#/components/schemas/SharedClipGroupWithDetailsType" + "firmware_dev_settings" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "flip_display_orientation" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_GetSharedClipGroupsV2WSRequest" : { - "type" : "object", - "description" : "Request object for retrieving shared clip groups with date filtering.", - "properties" : { - "createdAfterMs" : { + }, + "lastModified" : { "type" : "integer", "format" : "int64", - "description" : "Filter for clip groups created after this timestamp", - "example" : 1640995200000, "nullable" : true }, - "createdBeforeMs" : { + "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", - "description" : "Filter for clip groups created before this timestamp", - "example" : 1641081600000, "nullable" : true - } - } - }, - "Event_GetSharedClipGroupsV2WSResponse" : { - "type" : "object", - "description" : "Response object containing shared clip groups with date filtering.", - "properties" : { - "error" : { + }, + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_stealth_mode" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "lightweight_detection_disabled" : { + "type" : "boolean", "nullable" : true }, - "sharedClipGroups" : { - "type" : "array", - "description" : "List of shared clip groups", - "items" : { - "$ref" : "#/components/schemas/SharedClipGroupWrapperV2Type" - }, + "live_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "max_event_duration_ms" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_GetSharedClipGroupsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving shared clip groups (deprecated)." - }, - "Event_GetSharedClipGroupsWSResponse" : { - "type" : "object", - "description" : "Response object containing shared clip groups (deprecated).", - "properties" : { - "error" : { + }, + "mdns_advertise_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "mdns_discover_enabled" : { + "type" : "boolean", "nullable" : true }, - "sharedClipGroups" : { - "type" : "array", - "description" : "List of shared clip groups", - "items" : { - "$ref" : "#/components/schemas/SharedClipGroupWrapperType" - }, + "media_ttl_minutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetSplicedClipsInProgressWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving spliced clips in progress (deprecated)." - }, - "Event_GetSplicedClipsInProgressWSResponse" : { - "type" : "object", - "description" : "Response object containing spliced clips in progress (deprecated).", - "properties" : { - "error" : { + "on_demand_license_invalid" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "splicedClips" : { - "type" : "array", - "description" : "List of spliced clips currently in progress", - "items" : { - "$ref" : "#/components/schemas/SplicedClipType" - }, - "nullable" : true + "peer_address_mode" : { + "$ref" : "#/components/schemas/PeerAddressModeEnum" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_GetUnhealthyDeviceAlertsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving unhealthy device alerts." - }, - "Event_GetUnhealthyDeviceAlertsWSResponse" : { - "type" : "object", - "description" : "Response object containing unhealthy device alerts.", - "properties" : { - "error" : { + "peer_channel_mode" : { + "$ref" : "#/components/schemas/PeerChannelModeEnum" + }, + "pressure_switch_tamper_normally_open" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "proximity_sensor_tamper_disabled" : { + "type" : "boolean", "nullable" : true }, - "unhealthyDeviceAlerts" : { - "type" : "array", - "description" : "List of unhealthy device alerts", - "items" : { - "$ref" : "#/components/schemas/UnHealthyDeviceAlertType" - }, + "proximity_sensor_tamper_distance_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_MuteNotificationsForDevicetWSRequest" : { - "type" : "object", - "description" : "Request object for muting notifications for a specific device.", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "storage_target_free_megabytes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "durationSec" : { + "storage_target_free_space_permyriad" : { "type" : "integer", "format" : "int32", - "description" : "Duration to mute notifications in seconds", - "example" : 3600, "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" } } }, - "Event_MuteNotificationsForDevicetWSResponse" : { + "Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" : { "type" : "object", - "description" : "Response object for muting notifications for a specific device.", + "description" : "Audio/video user configuration update", "properties" : { - "error" : { + "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "audio_aec_via_software" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "audio_ai_disabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_PolicyAlertGroupV2" : { - "type" : "object", - "description" : "Group of policy alerts V2 with time range information.", - "properties" : { - "endTime" : { + }, + "audio_external_mic_boost" : { "type" : "integer", - "format" : "int64", - "description" : "End time of the alert group (descending chronological order)", - "example" : 1641081600000, + "format" : "int32", "nullable" : true }, - "policyAlerts" : { - "type" : "array", - "description" : "List of policy alerts V2 in the group", - "items" : { - "$ref" : "#/components/schemas/PolicyAlertV2Type" - }, + "audio_external_mic_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "startTime" : { + "audio_external_speaker_volume" : { "type" : "integer", - "format" : "int64", - "description" : "Start time of the alert group (descending chronological order)", - "example" : 1640995200000, + "format" : "int32", "nullable" : true - } - } - }, - "Event_ReportBadPolicyAlertWSRequest" : { - "type" : "object", - "description" : "Request object for reporting a bad policy alert.", - "properties" : { - "policyAlert" : { - "$ref" : "#/components/schemas/PolicyAlertV2Type" - } - } - }, - "Event_ReportBadPolicyAlertWSResponse" : { - "type" : "object", - "description" : "Response object for reporting a bad policy alert.", - "properties" : { - "error" : { + }, + "audio_internal_mic_aec_enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "audio_internal_mic_boost" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Event_RuuidWrapper" : { - "type" : "object", - "description" : "Wrapper object containing UUIDs for alerts and events.", - "properties" : { - "alertUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audio_internal_mic_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "eventUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Event_SavePolicyAlertWSRequest" : { - "type" : "object", - "description" : "Request object for saving a policy alert as a clip.", - "properties" : { - "alertUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audio_internal_speaker_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "fisheyePresentationMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device UUIDs to dewarped view configurations for fisheye cameras", - "items" : { - "$ref" : "#/components/schemas/DewarpedView" - }, - "nullable" : true - }, - "description" : "Map of device UUIDs to dewarped view configurations for fisheye cameras", + "audio_min_echo_amplitude" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "savedClipDescription" : { - "type" : "string", - "description" : "Description for the saved clip", - "example" : "Motion detected at main entrance", + "audio_playback_gain_percent" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "savedClipTitle" : { - "type" : "string", - "description" : "Title for the saved clip", - "example" : "Security Incident - Motion Detected", + "audio_record" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_SavePolicyAlertWSResponse" : { - "type" : "object", - "description" : "Response object for saving a policy alert as a clip.", - "properties" : { - "error" : { + }, + "audio_supported" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "audio_use_external_mic" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "audio_use_external_speaker" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_SavedClipWithProgressType" : { - "type" : "object", - "description" : "Saved clip with progress information for processing operations.", - "properties" : { - "accessSettings" : { - "$ref" : "#/components/schemas/ClipAccessSettings" }, - "alterMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlteredView" - }, - "nullable" : true - }, + "audio_use_internal_speaker" : { + "type" : "boolean", "nullable" : true }, - "analyzed" : { + "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, - "byteCount" : { + "blocked_debounce_time_ms" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "clipLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" + "blocked_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "clipLocationV2" : { - "type" : "string", + "char_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "consoleDelete" : { + "cloud_ai_smart_crop_enabled" : { "type" : "boolean", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "cloud_ai_stream_enabled" : { + "type" : "boolean", "nullable" : true }, - "currentOperation" : { - "type" : "string", - "description" : "Current operation being performed on the clip", - "example" : "Processing video", + "custom_events" : { + "type" : "boolean", "nullable" : true }, - "description" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "devicePresentationOrder" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "device_mic_enabled" : { + "type" : "boolean", "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "device_near_audio_silenced" : { + "type" : "boolean", "nullable" : true }, - "deviceUuidMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, + "device_speaker_enabled" : { + "type" : "boolean", "nullable" : true }, - "deviceUuids" : { + "dewarpMode" : { + "$ref" : "#/components/schemas/CameraDewarpModeEnum" + }, + "disabled_schedule" : { "type" : "array", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, - "durationSec" : { - "type" : "integer", - "format" : "int32", + "disabled_schedule_inverted" : { + "type" : "boolean", "nullable" : true }, - "externalTransactionId" : { + "disabled_schedule_uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "fisheyeHardware" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "dwell_reset_ttl_ms" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "fisheyeMap" : { + "dwell_time_ms" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "exposure_level" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DewarpedView" - }, + "type" : "string", "nullable" : true }, "nullable" : true }, - "integrationUploadList" : { + "fisheye_display_mode" : { + "$ref" : "#/components/schemas/FisheyeDisplayModeEnum" + }, + "floorplan_homography" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true }, "nullable" : true }, - "isMonitoringClip" : { + "frontendEqualizerHighShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerLowShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking1" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking2" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendEqualizerPeaking3" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" + }, + "frontendNoiseSuppression" : { "type" : "boolean", "nullable" : true }, - "isVendorClip" : { + "h265_realtime_encoding_enabled" : { "type" : "boolean", "nullable" : true }, - "lastUpdatedSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Last update timestamp in seconds", - "example" : 1640995200, + "h265_vod_encoding_enabled" : { + "type" : "boolean", "nullable" : true }, - "mountingDirection" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "hdr_enabled" : { + "type" : "boolean", "nullable" : true }, - "percentComplete" : { - "type" : "integer", - "format" : "int32", - "description" : "Percentage of completion for the current operation", - "example" : 75, + "high_res_detection" : { + "type" : "boolean", "nullable" : true }, - "sendToSharedStorage" : { + "human_detection" : { "type" : "boolean", "nullable" : true }, - "sha256Hex" : { - "type" : "string", + "human_loitering" : { + "type" : "boolean", "nullable" : true }, - "sourceAlertUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "human_loitering_settings" : { + "$ref" : "#/components/schemas/CameraHumanLoiteringSettingsType" + }, + "img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/ClipStatusEnum" + "img_contrast" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" + "img_saturation" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "thumbnailLocationV2" : { - "type" : "string", + "img_sharpness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "timestampMs" : { + "inactivity_settings" : { + "$ref" : "#/components/schemas/CameraInactivitySettingsType" + }, + "lastModified" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "title" : { - "type" : "string", + "led_mode_blink_period_ms" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_stealth_mode" : { + "type" : "boolean", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lightweight_detection_disabled" : { + "type" : "boolean", "nullable" : true }, - "videoResolution" : { - "$ref" : "#/components/schemas/Resolution" - } - } - }, - "Event_SearchMotionGridWSRequest" : { - "type" : "object", - "description" : "Request object for searching motion grid data.", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "live_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "endTimeUtcSecs" : { + "max_detections_per_frame" : { "type" : "integer", - "format" : "int64", - "description" : "End time as a UNIX timestamp in seconds", - "example" : 1641081600, + "format" : "int32", "nullable" : true }, - "searchCells" : { - "type" : "array", - "description" : "List of motion grid cells to include in the search", - "items" : { - "$ref" : "#/components/schemas/Event_FrontendCell" - }, + "media_ttl_minutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "startTimeUtcSecs" : { + "metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" + }, + "motor_config" : { + "$ref" : "#/components/schemas/CameraMotorConfigType" + }, + "mounting_direction" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + }, + "night_exposure_level" : { "type" : "integer", - "format" : "int64", - "description" : "Start time as a UNIX timestamp in seconds", - "example" : 1640995200, - "nullable" : true - } - }, - "required" : [ "deviceUuid", "endTimeUtcSecs", "searchCells", "startTimeUtcSecs" ] - }, - "Event_SearchMotionGridWSResponse" : { - "type" : "object", - "description" : "Response object containing motion grid search results.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "night_img_brightness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "timeUtcSecsList" : { - "type" : "array", - "description" : "List of timestamps where motion was detected in the specified cells", - "items" : { - "type" : "integer", - "format" : "int64", - "description" : "List of timestamps where motion was detected in the specified cells", - "nullable" : true - }, + "night_img_contrast" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "night_img_saturation" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "Event_SearchMotionGridWithActivitiesWSRequest" : { - "type" : "object", - "description" : "Request object for searching motion grid data with activity information.", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + }, + "night_img_sharpness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "endTimeUtcSecs" : { + "night_metering_config" : { + "$ref" : "#/components/schemas/CameraMeteringConfigType" + }, + "night_sensor_gain_max" : { "type" : "integer", - "format" : "int64", - "description" : "End time as a UNIX timestamp in seconds", - "example" : 1641081600, + "format" : "int32", "nullable" : true }, - "searchCells" : { - "type" : "array", - "description" : "List of motion grid cells to include in the search", - "items" : { - "$ref" : "#/components/schemas/Event_FrontendCell" - }, + "night_shutter_time_max" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "startTimeUtcSecs" : { + "night_shutter_time_min" : { "type" : "integer", - "format" : "int64", - "description" : "Start time as a UNIX timestamp in seconds", - "example" : 1640995200, + "format" : "int32", "nullable" : true - } - }, - "required" : [ "deviceUuid", "endTimeUtcSecs", "searchCells", "startTimeUtcSecs" ] - }, - "Event_SearchMotionGridWithActivitiesWSResponse" : { - "type" : "object", - "description" : "Response object containing motion grid search results with activity information.", - "properties" : { - "error" : { + }, + "object_search" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "occupancy_count_high_threshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "occupancy_count_low_threshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "occupancy_counting" : { + "type" : "boolean", + "nullable" : true + }, + "on_demand_license_invalid" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timeUtcSecsToActivityMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity" + "people_tracking" : { + "type" : "boolean", + "nullable" : true + }, + "person_reidentification" : { + "type" : "boolean", + "nullable" : true + }, + "privacy_window_polygons" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionPolygonType" }, - "description" : "Map of timestamps to motion grid activities", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "privacy_windows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PermyriadRect" + }, "nullable" : true - } - } - }, - "Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId" : { - "type" : "object", - "description" : "Activity information with object ID.", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" }, - "objectId" : { + "ptz_config" : { + "$ref" : "#/components/schemas/CameraPTZConfigType" + }, + "ptz_home" : { + "$ref" : "#/components/schemas/CameraPtzHome" + }, + "record_on_motion" : { + "type" : "boolean", + "nullable" : true + }, + "region_for_occupancy" : { + "$ref" : "#/components/schemas/RegionConfigType" + }, + "region_of_interest" : { + "$ref" : "#/components/schemas/RegionConfigType" + }, + "region_of_interest_groups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionOfInterestGroup" + }, + "nullable" : true + }, + "resolution" : { + "$ref" : "#/components/schemas/Device_config_settings_ExternalVideoResolution" + }, + "rotation" : { "type" : "integer", "format" : "int32", - "description" : "Object ID associated with the activity", - "example" : 123, "nullable" : true - } - } - }, - "Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity" : { - "type" : "object", - "description" : "Motion grid activity information for a specific timestamp.", - "properties" : { - "activities" : { + }, + "rtsp_encoder" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "segment_max_bytes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sensor_gain_max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "shared_fov" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "activitiesWithId" : { + "shutter_time_max" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "shutter_time_min" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "snapshot_height" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "snapshot_interval_secs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "storage_target_free_megabytes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "storage_target_free_space_permyriad" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "tile_views" : { "type" : "array", - "description" : "List of activities with object IDs", "items" : { - "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId" + "$ref" : "#/components/schemas/DewarpedView" }, "nullable" : true }, - "bestTimestampMs" : { + "upload_all_detections" : { + "type" : "boolean", + "nullable" : true + }, + "use_onboard_lpr" : { + "type" : "boolean", + "nullable" : true + }, + "vehicle_detection" : { + "type" : "boolean", + "nullable" : true + }, + "video_ai_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "video_persist_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "wdr_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "wdr_strength" : { "type" : "integer", - "format" : "int64", - "description" : "Best timestamp in milliseconds for the activity", - "example" : 1640995200000, + "format" : "int32", + "nullable" : true + }, + "zero_motion_video_bitrate_percent" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Event_UnSavePolicyAlertWSRequest" : { + "Device_config_userconfig_IExternalUpdateableButtonUserConfig" : { "type" : "object", - "description" : "Request object for unsaving a policy alert (deprecated).", + "description" : "Configuration update for the button sensor", "properties" : { - "alertUuid" : { + "button_emergency_onsite_contact" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, + "button_test_mode_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "savedClipUuid" : { + "lastModified" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -81174,232 +82608,202 @@ } } }, - "Event_UnSavePolicyAlertWSResponse" : { + "Device_config_userconfig_IExternalUpdateableDoorControllerUserConfig" : { "type" : "object", - "description" : "Response object for unsaving a policy alert (deprecated).", + "description" : "Configuration update for the door controller", "properties" : { - "error" : { + "ai_license_invalid" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "autocomponentize_readers" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "autoregister_readers" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_UpdatePolicyAlertTextDescriptionWSRequest" : { - "type" : "object", - "description" : "Request object for updating the text description of a policy alert.", - "properties" : { - "alertUuid" : { + }, + "bandwidth_reports_disabled" : { + "type" : "boolean", + "nullable" : true + }, + "cloud_ai_smart_crop_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "cloud_ai_stream_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "textDescription" : { - "type" : "string", - "description" : "Text description for the policy alert", - "example" : "Motion detected at main entrance", + "firmware_dev_settings" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true - } - } - }, - "Event_UpdatePolicyAlertTextDescriptionWSResponse" : { - "type" : "object", - "description" : "Response object for updating the text description of a policy alert.", - "properties" : { - "error" : { + }, + "flip_display_orientation" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "lastModified" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "led_mode_blink_period_ms" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Event_UpdateSavedClipWSRequest" : { - "type" : "object", - "description" : "Request object for updating a saved clip.", - "properties" : { - "accessSettings" : { - "$ref" : "#/components/schemas/ClipAccessSettings" }, - "description" : { - "type" : "string", - "description" : "Updated description for the saved clip", - "example" : "Updated description of the security incident", - "nullable" : true + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" }, - "savedClipUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" }, - "title" : { - "type" : "string", - "description" : "Updated title for the saved clip", - "example" : "Updated Security Incident", + "led_stealth_mode" : { + "type" : "boolean", "nullable" : true - } - }, - "required" : [ "savedClipUuid" ] - }, - "Event_UpdateSavedClipWSResponse" : { - "type" : "object", - "description" : "Response object for updating a saved clip.", - "properties" : { - "error" : { + }, + "lightweight_detection_disabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "live_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "mdns_advertise_enabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Event_UpdateSharedClipGroupWSRequest" : { - "type" : "object", - "description" : "Request object for updating a shared clip group.", - "properties" : { - "description" : { - "type" : "string", - "description" : "Description for the shared clip group", - "example" : "Updated description of the security incident", + }, + "mdns_discover_enabled" : { + "type" : "boolean", "nullable" : true }, - "expirationTimeSecs" : { + "media_ttl_minutes" : { "type" : "integer", "format" : "int32", - "nullable" : true, - "writeOnly" : true + "nullable" : true }, - "plaintextPassword" : { - "type" : "string", - "description" : "Password for accessing the shared clip group", - "example" : "newpassword123", + "on_demand_license_invalid" : { + "type" : "boolean", "nullable" : true }, - "sharedClipUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "title" : { - "type" : "string", - "description" : "Title for the shared clip group", - "example" : "Updated Security Incident", - "nullable" : true - } - } - }, - "Event_UpdateSharedClipGroupWSResponse" : { - "type" : "object", - "description" : "Response object for updating a shared clip group.", - "properties" : { - "error" : { + "peer_address_mode" : { + "$ref" : "#/components/schemas/PeerAddressModeEnum" + }, + "peer_channel_mode" : { + "$ref" : "#/components/schemas/PeerChannelModeEnum" + }, + "pressure_switch_tamper_normally_open" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "proximity_sensor_tamper_disabled" : { + "type" : "boolean", "nullable" : true }, - "shareUrl" : { - "type" : "string", - "description" : "URL for accessing the updated shared clip group", - "example" : "https://share.rhombus.com/clips/abc123", + "proximity_sensor_tamper_distance_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "storage_target_free_megabytes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "storage_target_free_space_permyriad" : { + "type" : "integer", + "format" : "int32", "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" } } }, - "Event_groups_CreateClipGroupWSRequest" : { + "Device_health_DisableDeviceHealthTrackingWSRequest" : { "type" : "object", - "description" : "Request object for creating a clip group.", + "description" : "Request object for disabling device health tracking.", "properties" : { - "description" : { - "type" : "string", - "description" : "Description for the clip group", - "example" : "Motion detected at main entrance", - "nullable" : true - }, - "title" : { + "deviceUuid" : { "type" : "string", - "description" : "Title for the clip group", - "example" : "Security Incident - Main Entrance", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuids" : { - "type" : "array", - "description" : "List of UUIDs for clips to include in the group", - "items" : { - "$ref" : "#/components/schemas/Event_RuuidWrapper" - }, - "nullable" : true + "reEnableCondition" : { + "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" } } }, - "Event_groups_CreateClipGroupWSResponse" : { + "Device_health_DisableDeviceHealthTrackingWSResponse" : { "type" : "object", - "description" : "Response object for creating a clip group.", + "description" : "Response object for disabling device health tracking." + }, + "Device_health_EnableDeviceHealthTrackingWSRequest" : { + "type" : "object", + "description" : "Request object for enabling device health tracking.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "uuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "warningMsg" : { - "type" : "string", + } + } + }, + "Device_health_EnableDeviceHealthTrackingWSResponse" : { + "type" : "object", + "description" : "Response object for enabling device health tracking." + }, + "Device_health_FindDevicesWithDisabledHealthTrackingByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding devices with disabled health tracking." + }, + "Device_health_FindDevicesWithDisabledHealthTrackingByOrgWSResponse" : { + "type" : "object", + "description" : "Response object for finding devices with disabled health tracking.", + "properties" : { + "disabledHealthTrackingInfos" : { + "type" : "array", + "description" : "List of organization devices for which health tracking is disabled.", + "items" : { + "$ref" : "#/components/schemas/DeviceDisabledHealthTrackingInfo" + }, "nullable" : true } } }, - "Event_groups_DeleteClipGroupWSRequest" : { + "Device_health_GetDeviceHealthTrackingWSRequest" : { "type" : "object", - "description" : "Request object for deleting a clip group.", + "description" : "Request object for getting device health tracking.", "properties" : { - "uuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -81408,675 +82812,566 @@ } } }, - "Event_groups_DeleteClipGroupWSResponse" : { + "Device_health_GetDeviceHealthTrackingWSResponse" : { "type" : "object", - "description" : "Response object for deleting a clip group.", + "description" : "Response object for getting device health tracking.", "properties" : { - "error" : { + "enabled" : { "type" : "boolean", + "description" : "Whether device health tracking is currently enabled for this device.", + "example" : true, "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "reEnableCondition" : { + "$ref" : "#/components/schemas/ReEnableDeviceHealthTrackingConditionEnum" } } }, - "Event_groups_GetClipGroupDetailsWSRequest" : { + "Device_label_AddDeviceLabelWSRequest" : { "type" : "object", - "description" : "Request object for retrieving detailed information about a clip group.", + "description" : "Request object for adding a label to a device.", "properties" : { - "uuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "label" : { + "type" : "string", + "description" : "Label to add to the device", + "example" : "Maintenance", + "nullable" : true } } }, - "Event_groups_GetClipGroupDetailsWSResponse" : { + "Device_label_AddDeviceLabelWSResponse" : { "type" : "object", - "description" : "Response object containing detailed information about a clip group.", + "description" : "Response object for adding a label to a device." + }, + "Device_label_FindDeviceLabelsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding device labels by organization." + }, + "Device_label_FindDeviceLabelsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing device labels by organization.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "group" : { - "$ref" : "#/components/schemas/ClipGroupWithDetailsType" - }, - "warningMsg" : { - "type" : "string", + "labelsByDevice" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device UUIDs to their associated labels", + "items" : { + "type" : "string", + "description" : "Map of device UUIDs to their associated labels", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : "Map of device UUIDs to their associated labels", "nullable" : true } } }, - "Event_groups_GetClipGroupsForOrgWSRequest" : { + "Device_label_RemoveDeviceLabelWSRequest" : { "type" : "object", - "description" : "Request object for retrieving clip groups for an organization with date filtering.", + "description" : "Request object for removing a label from a device.", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter for clip groups created after this timestamp", - "example" : 1640995200000, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter for clip groups created before this timestamp", - "example" : 1641081600000, + "label" : { + "type" : "string", + "description" : "Label to remove from the device.", + "example" : "Maintenance", "nullable" : true } } }, - "Event_groups_GetClipGroupsForOrgWSResponse" : { + "Device_label_RemoveDeviceLabelWSResponse" : { + "type" : "object", + "description" : "Response object for removing a label from a device." + }, + "DewarpedView" : { "type" : "object", - "description" : "Response object containing clip groups for an organization.", "properties" : { - "error" : { - "type" : "boolean", + "aspectRatio" : { + "$ref" : "#/components/schemas/AspectRatio" + }, + "pitchDegrees" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "rollDegrees" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "groups" : { - "type" : "array", - "description" : "List of clip groups for the organization", - "items" : { - "$ref" : "#/components/schemas/ClipGroupType" - }, + "verticalFieldOfViewDegrees" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "yawDegrees" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "Event_groups_UpdateClipGroupWSRequest" : { + "DiagnosticActivityEnum" : { + "type" : "string", + "enum" : [ "CAMERA_CONNECTED", "CAMERA_DISCONNECTED", "STARTUP", "GATEWAY_CONNECTED", "GATEWAY_DISCONNECTED", "UPDATE_STARTED", "UPDATE_FIRMWARE_DOWNLOADED", "UPDATE_FIRMWARE_APPLIED", "UPDATE_STARTING_REBOOT", "UPDATE_FAILED_MD5_MISMATCH", "UPDATE_FAILED_ACCESS_DENIED", "UPDATE_FAILED_MITM", "UPDATE_FAILED_CONNNECTION_REFUSED", "UPDATE_FAILED_CONNNECTION_TIMEOUT", "UPDATE_FAILED_CONNECTION_REFUSED", "UPDATE_FAILED_CONNECTION_TIMEOUT", "UPDATE_FAILED_DNS_FAILURE", "UPDATE_RUNNING", "UPDATE_HALTED_FOR_INVESTIGATION", "UPDATE_HALT_CLEARED", "UPDATE_HALT_STATE_ACTIVE", "UPDATE_REFUSED_HALTED", "BLE_CONNECTED", "BLE_CONNECTION_FAILED", "BLE_DISCONNECTED", "BLE_OP_SUCCESS", "BLE_OP_FAILURE", "UPLOAD_CLIP_SUCCESS", "UPLOAD_CLIP_FAILURE", "NOTIFICATION_FAILURE", "USB_FAILURE_REBOOT", "PERSISTENT_STORAGE_FAILURE", "PING", "FORCED_REBOOT", "AUTO_REBOOT", "AUDIO_HARDWARE_NOT_DETECTED", "ENCRYPTED_CONTAINER_FAILURE_CREATE", "ENCRYPTED_CONTAINER_FAILURE_OPEN", "ENCRYPTED_CONTAINER_FAILURE_MOUNT", "VIDEO_HARDWARE_FAILURE", "WIFI_NETWORK_CHANGED", "AI_ENGINE_DOWNLOADED", "AI_ENGINE_DOWNLOAD_FAILED_MD5_MISMATCH", "AI_ENGINE_CONFIGURED", "AI_ENGINE_CONFIGURATION_FAILED", "MITM_FAILURE", "SERVER_RECONNECT", "AP_CHANGED", "WATCHDOG_KILLED_AGENT", "WATCHDOG_DID_RESET", "CLIMATE_OFFLINE", "CLIMATE_ONLINE", "CLIMATE_LOW_BATTERY", "CLIMATE_PROBE_CONNECTED", "CLIMATE_PROBE_DISCONNECTED", "DOOR_OFFLINE", "DOOR_ONLINE", "DOOR_LOW_BATTERY", "OCCUPANCY_SENSOR_ONLINE", "OCCUPANCY_SENSOR_OFFLINE", "OCCUPANCY_SENSOR_LOW_BATTERY", "BUTTON_OFFLINE", "BUTTON_ONLINE", "BUTTON_LOW_BATTERY", "PROXIMITY_LOW_BATTERY", "ROBOT_LOW_BATTERY", "DOOR_CONTROLLER_CONNECTED", "DOOR_CONTROLLER_DISCONNECTED", "APERIO_LOW_BATTERY", "APERIO_FLAT_BATTERY", "APERIO_OK_BATTERY", "APERIO_GW_CONNECTED", "APERIO_GW_DISCONNECTED", "SCHLAGE_LOW_BATTERY", "SCHLAGE_CRITICAL_BATTERY", "SCHLAGE_OK_BATTERY", "SCHLAGE_GW_CONNECTED", "SCHLAGE_GW_DISCONNECTED", "SCHLAGE_APM_CONNECTED", "SCHLAGE_APM_DISCONNECTED", "BADGE_READER_CONNECTED", "BADGE_READER_DISCONNECTED", "REBOOT", "NETWORK_INTERRUPTION", "OPENPATH_WEBHOOK_FAILURE", "TOAST_WEBHOOK_FAILURE", "KISI_WEBHOOK_FAILURE", "BRIVO_WEBHOOK_FAILURE", "HALO_WEBHOOK_FAILURE", "SALTO_WEBHOOK_FAILURE", "SQUARE_WEBHOOK_FAILURE", "BUTTERFLYMX_WEBHOOK_FAILURE", "ENVOY_WEBHOOK_FAILURE", "GENEA_WEBHOOK_FAILURE", "PRODATAKEY_WEBHOOK_FAILURE", "AMT_WEBHOOK_FAILURE", "PLACEOS_WEBHOOK_FAILURE", "OMNIALERT_WEBHOOK_FAILURE", "FLIC_WEBHOOK_FAILURE", "SHELLY_WEBHOOK_FAILURE", "PIMLOC_WEBHOOK_FAILURE", "NINEONEONECELLULAR_WEBHOOK_FAILURE", "HONEYWELL_ELEMENTS_WEBHOOK_FAILURE", "HONEYWELL_ONGUARD_WEBHOOK_FAILURE", "TRITON_WEBHOOK_FAILURE", "EXTERNAL_WEBHOOK_FAILURE", "VOICE_CALL_INITIATED", "VOICE_CALL_ANSWERED", "VOICE_CALL_REJECTED_AS_MACHINE", "VOICE_CALL_COMPLETED", "VOICE_CALL_NO_ANSWER", "VOICE_CALL_FAILED", "VOICE_CALL_SKIPPED", "CV_FAILURE", "NFC_HW_FAILURE", "CONFIG_ERROR", "HW_FAILURE", "BLE_HW_RECOVERED", "BLE_HW_FAILURE", "KEYPAD_ONLINE", "KEYPAD_OFFLINE", "ALM_OVERAGE_APPROACHING", "ALM_OVERAGE_REACHED", "ALM_OVERAGE_EXCEEDED", "ALM_EXCESSIVE_VERIFICATIONS", "KIOSK_OFFLINE", "KIOSK_ONLINE", "TUNNELED_DEVICE_CONNECTED", "TUNNELED_DEVICE_DISCONNECTED", "SD_CARD_CHANGED", "SD_CARD_NOT_FOUND", "SUPERVISION_CUT_DETECTED", "SUPERVISION_SHORT_DETECTED", "SUPERVISION_INVALID_SETUP", "THIRD_PARTY_DEVICE_CONNECTED", "THIRD_PARTY_DEVICE_DISCONNECTED", "NVR_STREAMING_STATUS", "STORAGE_SM", "DEVICE_OFFLINE_EXTENDED", "DEVICE_OFFLINE_RECOVERED", "DEVICES_OFFLINE_THRESHOLD", "CLOUD_ARCHIVE_LAGGING", "CLOUD_ARCHIVE_RECOVERED", "LOCAL_RECORDING_INTERRUPTED", "LOCAL_RECORDING_RECOVERED", "UNKNOWN" ] + }, + "DiagnosticEventType" : { "type" : "object", - "description" : "Request object for updating a clip group.", + "description" : "List of diagnostic events", "properties" : { - "description" : { + "activity" : { + "$ref" : "#/components/schemas/DiagnosticActivityEnum" + }, + "apMac" : { "type" : "string", - "description" : "Description for the clip group", - "example" : "Updated description of the security incident", "nullable" : true }, - "title" : { + "asi" : { "type" : "string", - "description" : "Title for the clip group", - "example" : "Updated Security Incident", "nullable" : true }, - "uuid" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuids" : { - "type" : "array", - "description" : "List of UUIDs for clips to include in the group", - "items" : { - "$ref" : "#/components/schemas/Event_RuuidWrapper" - }, - "nullable" : true - } - } - }, - "Event_groups_UpdateClipGroupWSResponse" : { - "type" : "object", - "description" : "Response object for updating a clip group.", - "properties" : { - "error" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "connectionUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "defaultInterface" : { "type" : "string", "nullable" : true - } - } - }, - "Eventsearch_CombinedSeekPointType" : { - "type" : "object", - "description" : "Combined seekpoint type containing information from various event sources including timestamps, activities, and metadata.", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" }, - "cameraUuid" : { + "defaultInterfaceMac" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "customActivityColor" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" - }, - "customActivityDescription" : { + "deviceName" : { "type" : "string", - "description" : "Custom description for the activity", - "example" : "A person was detected in the camera view", "nullable" : true }, - "customActivityDisplayName" : { + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { "type" : "string", - "description" : "Custom display name for the activity", - "example" : "Person Detected", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dwelling" : { - "type" : "boolean", - "description" : "Whether the detected person is dwelling/loitering", + "firmwareVersion" : { + "type" : "string", "nullable" : true }, - "faceName" : { + "orgUuid" : { "type" : "string", - "description" : "Name of the face detected in this seekpoint", - "example" : "John Doe", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "licensePlate" : { + "reportingDeviceUuid" : { "type" : "string", - "description" : "License plate detected in this seekpoint", - "example" : "ABC123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "objectId" : { + "rssi" : { "type" : "integer", "format" : "int32", - "description" : "Object ID for tracking purposes", - "example" : 12345, "nullable" : true }, - "originalEvent" : { - "type" : "object", - "description" : "Original event object that generated this seekpoint", + "ssid" : { + "type" : "string", "nullable" : true }, - "seekpointEndTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for the seekpoint duration", - "example" : 1640995300000, + "timestamp" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "seekpointStartTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds for the seekpoint duration", - "example" : 1640995200000, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "stableTrackId" : { + "wifiSignalStrength" : { "type" : "integer", "format" : "int32", - "description" : "Stable track ID for re-identification across track segments", - "example" : 42, "nullable" : true - }, - "thumbnailUrl" : { - "type" : "string", - "description" : "URL to the thumbnail image for this seekpoint", - "example" : "https://example.com/thumbnail.jpg", + } + } + }, + "DiagnosticRuleTriggerType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "deviceLabels" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "deviceUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "diagnosticEvent" : { + "$ref" : "#/components/schemas/SimpleDiagnosticEventType" + }, + "locationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "DiceSettings" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "timestampMs" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp in milliseconds when the seekpoint occurred", - "example" : 1640995200000, "nullable" : true }, - "unidentifiedFaceId" : { + "enablingUser" : { "type" : "string", - "description" : "ID for unidentified faces", - "example" : "face_12345", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Eventsearch_GetCameraOrDoorbellCameraSeekpointsWSResponse" : { + "DiceType" : { "type" : "object", - "description" : "Response object containing seekpoints from camera or doorbell camera events.", + "allOf" : [ ], + "nullable" : true, "properties" : { - "combinedSeekpoints" : { - "type" : "array", - "description" : "List of combined seekpoints from camera or doorbell camera events", - "items" : { - "$ref" : "#/components/schemas/Eventsearch_CombinedSeekPointType" - }, + "enabled" : { + "type" : "boolean", "nullable" : true }, - "error" : { - "type" : "boolean", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Eventsearch_GetEventSeekpointsByStableTrackIdWSRequest" : { + "DisarmMonitoringRule" : { "type" : "object", - "description" : "Request object for retrieving event seekpoints filtered by stable track IDs.", + "description" : "Rule used to manually disarm scheduled alarm policies while the monitoring mode is set to scheduled.\n", "properties" : { - "deviceUuids" : { - "type" : "array", - "description" : "Set of device facet uuids to retrieve footage seekpoints for.", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "activeAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The UNIX timestamp (in milliseconds) when this rule will go into effect.", + "nullable" : true }, - "durationSec" : { + "disarmAllUntilMs" : { "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds since the start time to retrieve seekpoints for.", + "format" : "int64", + "description" : "The UNIX timestamp (in milliseconds) to pause all alarm policies until.", "nullable" : true }, - "stableTrackIds" : { - "type" : "array", - "description" : "Set of stable track IDs to filter seekpoints by.", - "items" : { + "disarmedAlarmPolicies" : { + "type" : "object", + "additionalProperties" : { "type" : "integer", - "format" : "int32", - "description" : "Set of stable track IDs to filter seekpoints by.", + "format" : "int64", + "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will resume (i.e., when the pause expires).\n", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX timestamp in seconds for when to start retrieving seekpoints.", + "description" : "A map of scheduled alarm policy UUIDs to the UNIX timestamp (in milliseconds) indicating\nwhen each corresponding alarm policy will resume (i.e., when the pause expires).\n", "nullable" : true } - }, - "required" : [ "deviceUuids", "durationSec", "stableTrackIds", "startTimeSec" ] + } }, - "Eventsearch_GetEventSeekpointsV2WSRequest" : { + "DiscoveredThirdPartyCameraType" : { "type" : "object", - "description" : "Request object for retrieving event seekpoints V2 with enhanced filtering and clustering options.", + "description" : "The imported (discovered) third-party camera. This field is populated only if the RTSP URL specified in the import resulted in creation of a new discovery or an addition of a RTSP URL to an existing discovery. It is null, if the RTSP URL already existed or if the import was not successful.", "properties" : { - "accessControlledDoorUuids" : { - "type" : "array", - "description" : "Set of access controlled door uuids to retrieve component seekpoints for.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "activityFilter" : { - "type" : "array", - "description" : "Optional filter to specify what activities are returned.", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true + "codec" : { + "type" : "string", + "nullable" : true }, - "clothingColorFilter" : { - "type" : "array", - "description" : "Optional filter to specify which human motion seekpoints are returned.", - "items" : { - "$ref" : "#/components/schemas/ColorEnum" - }, - "nullable" : true, - "uniqueItems" : true + "createdOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true }, - "clusterIntervalSec" : { - "type" : "integer", - "format" : "int32", - "description" : "An optional interval X (in seconds) that, when specified, causes this endpoint to return a smaller collection of seekpoints. These seekpoints represent clusters of activities that occur consecutively within X seconds of each other.", + "ipAddress" : { + "type" : "string", "nullable" : true }, - "deviceUuids" : { - "type" : "array", - "description" : "Set of device facet uuids to retrieve footage seekpoints for.", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "lastVisibleMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds since the start time to retrieve seekpoints for.", "nullable" : true }, - "includeAnyMotion" : { - "type" : "boolean", - "default" : false, - "description" : "Determines whether or not any motion seekpoints are returned.", + "macAddress" : { + "type" : "string", "nullable" : true }, - "includeIntegrationEvents" : { - "type" : "boolean", - "default" : false, - "description" : "Determines whether or not to include any seekpoints from enabled integrations.", + "manufacturer" : { + "type" : "string", "nullable" : true }, - "ownerDeviceUuid" : { + "model" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "searchCells" : { - "type" : "array", - "description" : "Optional filter used to limit the seekpoint search to the region provided.", - "items" : { - "$ref" : "#/components/schemas/Event_FrontendCell" - }, + "name" : { + "type" : "string", "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "UNIX timestamp in seconds for when to start retrieving seekpoints.", + "onvifPassword" : { + "type" : "string", "nullable" : true }, - "vehicleColorFilter" : { - "type" : "array", - "description" : "Optional filter to specify which vehicle motion seekpoints are returned.", - "items" : { - "$ref" : "#/components/schemas/ColorEnum" - }, - "nullable" : true, - "uniqueItems" : true - } - }, - "required" : [ "durationSec", "startTimeSec" ] - }, - "Eventsearch_GetEventSeekpointsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving event seekpoints with various search criteria and filtering options.", - "properties" : { - "activitySet" : { - "type" : "array", - "description" : "Set of activity types to filter seekpoints by", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "componentSeekPointsByAccessControlledDoorWSRequest" : { - "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" - }, - "componentSeekPointsByAccessControlledDoorsWSRequest" : { - "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" - }, - "componentSeekPointsByOwnerDeviceWSRequest" : { - "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByOwnerDeviceWSRequest" - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds for the search window", - "example" : 3600, + "onvifProfileToken" : { + "type" : "string", "nullable" : true }, - "searchColorAndVehicleByColorWSRequest" : { - "$ref" : "#/components/schemas/Eventsearch_SearchClothingAndVehicleByColorWSRequest" - }, - "searchMotionGridWithActivitiesWSRequest" : { - "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSRequest" + "onvifUsername" : { + "type" : "string", + "nullable" : true }, - "seekpointsWSRequest" : { - "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSRequest" + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds for the search window", - "example" : 1640995200, + "password" : { + "type" : "string", "nullable" : true }, - "videoFootageWSRequest" : { - "$ref" : "#/components/schemas/Eventsearch_VideoFootageWSRequest" - } - } - }, - "Eventsearch_GetEventSeekpointsWSResponse" : { - "type" : "object", - "description" : "Response object containing combined seekpoints from various event sources.", - "properties" : { - "combinedSeekpoints" : { + "rtspEndpoints" : { "type" : "array", - "description" : "List of combined seekpoints from various event sources", "items" : { - "$ref" : "#/components/schemas/Eventsearch_CombinedSeekPointType" + "$ref" : "#/components/schemas/RtspEndpoint" }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "errorMsg" : { + "updatedOn" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "warningMsg" : { + "username" : { "type" : "string", "nullable" : true } } }, - "Eventsearch_SearchClothingAndVehicleByColorWSRequest" : { + "DoorAjarActivityEventType" : { "type" : "object", - "description" : "Request object for searching clothing and vehicle events by color with time and device filtering.", + "allOf" : [ { + "type" : "object", + "properties" : { + "doorAjarThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "clothingColorFilter" : { - "type" : "array", - "description" : "Set of clothing colors to filter the search by", - "items" : { - "$ref" : "#/components/schemas/ColorEnum" + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "DoorAuthFirstInStateEvent" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "acuEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "deviceFilter" : { - "type" : "array", - "description" : "List of device UUIDs to filter the search by", - "items" : { + "componentCompositeUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for the search window", - "example" : 1641081600000, - "nullable" : true - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds for the search window", - "example" : 1640995200000, - "nullable" : true - }, - "vehicleColorFilter" : { - "type" : "array", - "description" : "Set of vehicle colors to filter the search by", - "items" : { - "$ref" : "#/components/schemas/ColorEnum" + "newState" : { + "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Eventsearch_VideoFootageWSRequest" : { - "type" : "object", - "description" : "Request object for video footage search with camera selection and multi-camera options.", - "properties" : { - "cameraUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "cameraUuids" : { - "type" : "array", - "description" : "List of camera UUIDs to search for video footage", - "items" : { + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "settingsUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "source" : { + "$ref" : "#/components/schemas/FirstInSourceEnum" + }, + "stateChangedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "duration" : { - "type" : "integer", - "format" : "int32", - "description" : "Duration in seconds", - "example" : 3600, - "nullable" : true - }, - "includeAnyMotion" : { - "type" : "boolean", - "description" : "Whether to include any motion events", - "example" : true, + "correlationId" : { + "type" : "string", "nullable" : true }, - "startTime" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time in seconds since epoch", - "example" : 1640995200, "nullable" : true }, - "useMultiCamera" : { - "type" : "boolean", - "description" : "Whether to use multi-camera search functionality", - "example" : true, - "nullable" : true - } - } - }, - "ExampleImage" : { - "type" : "object", - "properties" : { - "image" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "label" : { + "orgUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Export_ExportAuditEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting audit events to CSV format with filtering options.", - "properties" : { - "endInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "End time interval in milliseconds for filtering audit events", - "example" : 1641081600000, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "excludeActions" : { - "type" : "array", - "description" : "If not empty, events with actions specified in the list are filtered out. If both include and exclude actions are specified, exclude actions are ignored.", - "items" : { - "$ref" : "#/components/schemas/AuditActionEnum" - }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "includeActions" : { - "type" : "array", - "description" : "If not empty, only events with actions specified in the list are included. If both include and exclude actions are specified, exclude actions are ignored.", - "items" : { - "$ref" : "#/components/schemas/AuditActionEnum" - }, - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "startInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time interval in milliseconds for filtering audit events", - "example" : 1640995200000, - "nullable" : true - } - } - }, - "Export_ExportClimateEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting climate sensor events with time filtering.", - "properties" : { - "createdAfterMs" : { + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time in milliseconds for filtering climate events", - "example" : 1640995200000, "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for filtering climate events", - "example" : 1641081600000, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "sensorUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -82085,271 +83380,227 @@ } } }, - "Export_ExportCountReportsWSRequest" : { + "DoorEventType" : { "type" : "object", - "description" : "Request object for exporting count reports with configurable intervals, scopes, and time ranges.", + "description" : "List of door open/close events for the sensor", "properties" : { - "endDate" : { + "baseStationUuid" : { "type" : "string", - "deprecated" : true, - "description" : "Enter the ending date in in ISO 8601 format", - "example" : "2024-07-17T00:00:00Z", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endTimeMs" : { + "batteryPercentage" : { "type" : "integer", - "format" : "int64", - "description" : "End datetime as a UNIX timestamp in milliseconds", - "example" : 1721416242907, - "minimum" : 0, + "format" : "int32", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" - }, - "startDate" : { + "bleDeviceUuid" : { "type" : "string", - "deprecated" : true, - "description" : "Enter the starting date in ISO 8601 format", - "example" : "2024-07-17T00:00:00Z", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startTimeMs" : { + "bleRssi" : { "type" : "integer", - "format" : "int64", - "description" : "Start datetime as a UNIX timestamp in milliseconds", - "example" : 1719861042000, - "minimum" : 0, - "nullable" : true - }, - "timeZone" : { - "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", + "format" : "int32", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" - }, - "uuidList" : { + "closeBaseStations" : { "type" : "array", - "description" : "Enter the UUID of device(s) or location(s)", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - } - }, - "required" : [ "endTimeMs", "interval", "scope", "startTimeMs", "type" ] - }, - "Export_ExportDiagnosticEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting diagnostic events with time interval filtering.", - "properties" : { - "endInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "End time interval in milliseconds for filtering diagnostic events", - "example" : 1641081600000, + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startInterval" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/DoorStateEnum" + }, + "stateChanged" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time interval in milliseconds for filtering diagnostic events", - "example" : 1640995200000, "nullable" : true } } }, - "Export_ExportDoorEventsWSRequest" : { + "DoorFirstInStateChangeEventReference" : { "type" : "object", - "description" : "Request object for exporting door sensor events with time filtering.", + "nullable" : true, "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds for filtering door events", - "example" : 1640995200000, + "doorUuidToEventUuidMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for filtering door events", - "example" : 1641081600000, - "nullable" : true + "newState" : { + "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, - "sensorUuid" : { + "originatingDoorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Export_ExportEnvironmentalGatewayEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting environmental gateway events with time filtering.", - "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds for filtering environmental gateway events", - "example" : 1640995200000, - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for filtering environmental gateway events", - "example" : 1641081600000, - "nullable" : true }, - "deviceUuid" : { + "originatingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "source" : { + "$ref" : "#/components/schemas/FirstInSourceEnum" + }, + "stateChangedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Export_ExportInventoryWSRequest" : { + "DoorLocationLockdownStateEventType" : { "type" : "object", - "description" : "Request object for exporting device inventory information to CSV format.", - "properties" : { - "cameraUuids" : { - "type" : "array", - "deprecated" : true, - "description" : "List of camera UUIDs to export (deprecated, use deviceUuids instead)", - "items" : { + "allOf" : [ { + "type" : "object", + "properties" : { + "activatedLockdownPlan" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "activeLockdownPlan" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "acuEventUuid" : { "type" : "string", "format" : "RUUID", - "deprecated" : true, "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "deviceUuids" : { - "type" : "array", - "description" : "List of device UUIDs to export inventory for", - "items" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "deactivatedLockdownPlan" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "followingTestPlan" : { + "type" : "boolean", + "nullable" : true + }, + "locationLockdownStateChangedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateEnumType" + } } - } - }, - "Export_ExportMotionEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting motion events from motion sensors with time filtering.", + } ], + "nullable" : true, "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "After datetime provided as a UNIX timestamp in milliseconds", - "example" : 1640995200000, - "minimum" : 0, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdBeforeMs" : { + "correlationId" : { + "type" : "string", + "nullable" : true + }, + "createdAtMs" : { "type" : "integer", "format" : "int64", - "description" : "Before datetime provided as a UNIX timestamp in milliseconds", - "example" : 1641081600000, - "minimum" : 0, "nullable" : true }, - "deviceUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "deviceUuid" ] - }, - "Export_ExportPeopleCountEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting people count events with time interval filtering.", - "properties" : { - "endInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "End time interval in milliseconds for filtering people count events", - "example" : 1641081600000, - "nullable" : true }, - "startInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time interval in milliseconds for filtering people count events", - "example" : 1640995200000, - "nullable" : true - } - } - }, - "Export_ExportPeopleEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting people detection events with time interval filtering.", - "properties" : { - "endInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "End time interval in milliseconds for filtering people events", - "example" : 1641081600000, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time interval in milliseconds for filtering people events", - "example" : 1640995200000, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Export_ExportProximityEventsWSRequest" : { - "type" : "object", - "description" : "Request object for exporting proximity events with time filtering and tag selection.", - "properties" : { - "createBeforeMs" : { - "type" : "integer", - "format" : "int64", + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "writeOnly" : true + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "createdAfterMs" : { + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time in milliseconds for filtering proximity events", - "example" : 1640995200000, "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for filtering proximity events", - "example" : 1641081600000, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "tagUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -82358,31 +83609,31 @@ } } }, - "Export_ExportProximityLocomotionEventsWSRequest" : { + "DoorLockdownStateEnumType" : { + "type" : "string", + "enum" : [ "LOCKED_DOWN", "ACCESS_CONTROLLED", "UNLOCKED", "UNKNOWN" ] + }, + "DoorLockdownStateEventReference" : { "type" : "object", - "description" : "Request object for exporting proximity locomotion events with time filtering and tag selection.", + "nullable" : true, "properties" : { - "createBeforeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true, - "writeOnly" : true + "activatedLockdownPlan" : { + "$ref" : "#/components/schemas/LockdownPlanReference" }, - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds for filtering proximity locomotion events", - "example" : 1640995200000, - "nullable" : true + "activeLockdownPlan" : { + "$ref" : "#/components/schemas/LockdownPlanReference" }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds for filtering proximity locomotion events", - "example" : 1641081600000, + "deactivatedLockdownPlan" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "doorEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tagUuid" : { + "doorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -82391,137 +83642,113 @@ } } }, - "Export_ExportUptimeWSRequest" : { + "DoorPolicyType" : { "type" : "object", - "description" : "Request object for exporting device uptime reports with configurable time ranges and granularity.", + "description" : "List of door sensor policies using the schedule", "properties" : { - "cameraUuids" : { - "type" : "array", - "deprecated" : true, - "description" : "Use deviceUuids instead", - "items" : { - "type" : "string", - "format" : "RUUID", - "deprecated" : true, - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "defaultAjarThresholdSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "deviceUuids" : { + "defaultTriggers" : { "type" : "array", - "description" : "List of device UUIDs to export uptime reports for", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/ActivityEnum" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "endDateTime" : { + "description" : { "type" : "string", - "description" : "End date and time for the uptime report", - "example" : "2024-01-31T23:59:59Z", "nullable" : true }, - "granularity" : { - "$ref" : "#/components/schemas/JavaTimeUnitEnum" + "name" : { + "type" : "string", + "nullable" : true }, - "startDateTime" : { + "orgUuid" : { "type" : "string", - "description" : "Start date and time for the uptime report", - "example" : "2024-01-01T00:00:00Z", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Export_ExportUsersWSRequest" : { - "type" : "object", - "description" : "Request object for exporting user information to CSV format.", - "properties" : { - "userUuids" : { + }, + "scheduledTriggers" : { "type" : "array", - "description" : "List of user UUIDs to export information for", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/DoorScheduledTriggerType" }, "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Export_ExportVehicleEventsWSRequest" : { + "DoorPositionIndicatorEnumType" : { + "type" : "string", + "enum" : [ "integrated", "remote" ] + }, + "DoorPositionIndicatorPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] + }, + "DoorPositionIndicatorPortType" : { "type" : "object", - "description" : "Request object for exporting vehicle events with filtering by time, devices, labels, and plate numbers.", "properties" : { - "deviceUuids" : { - "type" : "array", - "description" : "List of device UUIDs to filter vehicle events by", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "boardNum" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "fuzzy" : { - "type" : "boolean", - "description" : "Whether to use fuzzy search on the provided plate numbers", - "example" : true, + "portNum" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/TimeInterval" - }, - "labels" : { - "type" : "array", - "description" : "List of vehicle labels to filter by", - "example" : [ "car", "truck", "motorcycle" ], - "items" : { - "type" : "string", - "description" : "List of vehicle labels to filter by", - "example" : "[\"car\",\"truck\",\"motorcycle\"]", - "nullable" : true - }, - "nullable" : true + "portType" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorPhysicalPortEnumType" }, - "plateNumbers" : { - "type" : "array", - "description" : "List of license plate numbers to filter by", - "example" : [ "ABC123", "XYZ789" ], - "items" : { - "type" : "string", - "description" : "List of license plate numbers to filter by", - "example" : "[\"ABC123\",\"XYZ789\"]", - "nullable" : true - }, - "nullable" : true + "supervisionConfiguration" : { + "$ref" : "#/components/schemas/PortSupervisionConfigurationType" } } }, - "FaceUploadMetadata" : { + "DoorPositionIndicatorShadowType" : { "type" : "object", - "description" : "List of face upload metadata for the transaction", + "allOf" : [ { + "type" : "object", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorStateEnumType" + }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "supervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "errorMsg" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "faceId" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, "orgUuid" : { @@ -82531,100 +83758,59 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "origS3Key" : { - "type" : "string", - "nullable" : true - }, - "personUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "success" : { - "type" : "boolean", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "transactionId" : { - "type" : "string", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Facerecognition_faceevent_DeleteFaceEventWSRequest" : { + "DoorPositionIndicatorStateChangeEventType" : { "type" : "object", - "description" : "Request object for deleting a face event.", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "newState" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorStateEnumType" + }, + "newSupervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "eventUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_DeleteFaceEventWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a face event." - }, - "Facerecognition_faceevent_ExportFaceEventsByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for exporting face events by organization with search filtering.", - "properties" : { - "searchFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSearchFilter" - } - } - }, - "Facerecognition_faceevent_ExternalFaceEvent" : { - "type" : "object", - "description" : "External face event object containing face recognition data with person matches, embeddings, and metadata.", - "properties" : { - "detectionConfidence" : { - "type" : "number", - "format" : "float", - "description" : "Confidence value indicating the likelihood that the detected image is a face", - "example" : 0.98, - "nullable" : true }, - "deviceUuid" : { + "correlationId" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "embeddingConfidence" : { - "type" : "number", - "format" : "float", - "description" : "Confidence value associated with the embedding generated for the face image", - "example" : 0.95, "nullable" : true }, - "eventTimestamp" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the face event occurred", - "example" : 1640995200000, - "nullable" : true - }, - "faceName" : { - "type" : "string", - "description" : "Name of the person that matched the face image. If selectedPersonMatch is not null, faceName will be equal to the name field of selectedPersonMatch.", - "nullable" : true - }, - "hasEmbedding" : { - "type" : "boolean", - "description" : "Whether the face event has an embedding", - "example" : true, - "nullable" : true - }, - "imageS3Key" : { - "type" : "string", - "description" : "S3 key for the face event image", - "example" : "face-events/images/event_123.jpg", "nullable" : true }, "locationUuid" : { @@ -82641,33 +83827,29 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "personUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "selectedPersonMatch" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" - }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "thumbnailS3Key" : { "type" : "string", - "description" : "S3 key for the face event thumbnail", - "example" : "face-events/thumbnails/event_123.jpg", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "topPersonMatches" : { - "type" : "array", - "description" : "Top person matches found for the face image.", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" - }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -82677,200 +83859,199 @@ } } }, - "Facerecognition_faceevent_ExternalFaceEventSearchFilter" : { + "DoorPositionIndicatorStateEnumType" : { + "type" : "string", + "enum" : [ "OPEN", "CLOSED", "AJAR", "FORCED_OPEN", "ERROR", "UNKNOWN" ] + }, + "DoorReaderEnumType" : { + "type" : "string", + "enum" : [ "wiegand", "osdp", "rhombus_osdp", "aperio_wireless", "aperio_rs485", "schlage_wireless", "schlage_rs485" ] + }, + "DoorReaderSettings" : { "type" : "object", - "description" : "Search filter for face events with embedding presence filtering.", "properties" : { - "deviceUuids" : { - "type" : "array", - "description" : "Optional filter by a set of devices.", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "dr_enable_audio_feedback" : { + "type" : "boolean", "nullable" : true }, - "faceNameContains" : { - "type" : "string", - "description" : "Optional filter by name substring. The face event is a match if its face name contains the specified value. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.", + "tof_max_distance" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "faceNames" : { - "type" : "array", - "description" : "Optional filter by people names.", - "items" : { - "type" : "string", - "description" : "Optional filter by people names.", - "nullable" : true - }, + "tof_min_distance" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "hasEmbedding" : { + "tof_min_signal_over_noise" : { + "type" : "number", + "format" : "float", + "nullable" : true + } + } + }, + "DoorReaderSettingsSelectiveUpdate" : { + "type" : "object", + "description" : "Update Door Reader settings", + "properties" : { + "dr_enable_audio_feedback" : { "type" : "boolean", - "description" : "Optional filter by the presence or absence of an embedding.", "nullable" : true }, - "hasName" : { - "type" : "boolean", - "description" : "Optional filter by the presence or absence of a person name.", + "tof_max_distance" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "labels" : { - "type" : "array", - "description" : "Optional filter by labels.", - "items" : { - "type" : "string", - "description" : "Optional filter by labels.", - "nullable" : true - }, + "tof_min_distance" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "locationUuids" : { - "type" : "array", - "description" : "Optional filter by a set of locations.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "tof_min_signal_over_noise" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "personUuids" : { - "type" : "array", - "description" : "Optional filter by a set of people.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", "nullable" : true }, "nullable" : true - }, - "timestampFilter" : { - "$ref" : "#/components/schemas/TimestampFilter" } } }, - "Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" : { + "DoorReaderShadowType" : { "type" : "object", - "description" : "Search filter for finding similar face events with similarity thresholds and confidence settings.", - "properties" : { - "deviceUuids" : { - "type" : "array", - "description" : "Optional filter by a set of devices.", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/DoorReaderStateEnumType" }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "embeddingConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Optional face embedding confidence threshold used to filter out face events with embeddingconfidence values less than the specified threshold. Valid range [0,1].", - "maximum" : 1, - "minimum" : 0, - "nullable" : true - }, - "faceMatchDistanceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Optional face match distance threshold used to compare face event images. Defaults to 0.7.Valid range [0,1].", - "maximum" : 1, - "minimum" : 0, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "faceNameContains" : { + "orgUuid" : { "type" : "string", - "description" : "Optional filter by name substring. The face event is a match if its face name contains the specified value. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "faceNames" : { - "type" : "array", - "description" : "Optional filter by people names.", - "items" : { - "type" : "string", - "description" : "Optional filter by people names.", - "nullable" : true - }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "hasName" : { - "type" : "boolean", - "description" : "Optional filter by the presence or absence of a person name.", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "labels" : { - "type" : "array", - "description" : "Optional filter by labels.", - "items" : { - "type" : "string", - "description" : "Optional filter by labels.", - "nullable" : true - }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true - }, - "locationUuids" : { - "type" : "array", - "description" : "Optional filter by a set of locations.", - "items" : { + } + } + }, + "DoorReaderStateChangeEventType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "newState" : { + "$ref" : "#/components/schemas/DoorReaderStateEnumType" + }, + "reason" : { + "$ref" : "#/components/schemas/DoorReaderStateChangeReasonEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "personUuids" : { - "type" : "array", - "description" : "Optional filter by a set of people.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "correlationId" : { + "type" : "string", "nullable" : true }, - "timestampFilter" : { - "$ref" : "#/components/schemas/TimestampFilter" - } - } - }, - "Facerecognition_faceevent_ExternalPersonMatch" : { - "type" : "object", - "description" : "Person match information for face recognition events with confidence scoring.", - "properties" : { - "confidence" : { - "type" : "number", - "format" : "float", - "description" : "Match confidence level expressed as a value in range[0,1]", - "example" : 0.95, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "faceId" : { + "locationUuid" : { "type" : "string", - "description" : "Face ID associated with the person match", - "example" : "face_12345", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "orgUuid" : { "type" : "string", - "description" : "Name of the person matched", - "example" : "John Doe", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -82880,358 +84061,379 @@ } } }, - "Facerecognition_faceevent_FindFaceEventsByDeviceForReportingWSRequest" : { + "DoorReaderStateChangeReasonEnumType" : { + "type" : "string", + "enum" : [ "FIRMWARE_UPGRADE", "FORCED_REBOOT", "UNKNOWN" ] + }, + "DoorReaderStateEnumType" : { + "type" : "string", + "enum" : [ "CONNECTED", "DISCONNECTED", "UNKNOWN" ] + }, + "DoorRelayEnumType" : { + "type" : "string", + "enum" : [ "integrated", "remote" ] + }, + "DoorRelayPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_OUTPUT" ] + }, + "DoorRelayPortType" : { "type" : "object", - "description" : "Request object for finding face events by device for reporting purposes with timestamp filtering and pagination.", "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "boardNum" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" + "portNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "timestampFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" + "portType" : { + "$ref" : "#/components/schemas/DoorRelayPhysicalPortEnumType" } } }, - "Facerecognition_faceevent_FindFaceEventsByDeviceForReportingWSResponse" : { + "DoorRelayShadowType" : { "type" : "object", - "description" : "Response object containing face events by device for reporting purposes with pagination information.", - "properties" : { - "faceEvents" : { - "type" : "array", - "description" : "List of face events by device for reporting purposes", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + "allOf" : [ { + "type" : "object", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/DoorRelayStateEnumType" }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastEvaluatedKey" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of face events by device for reporting", - "example" : "next_page_key_123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_FindFaceEventsByLocationForReportingWSRequest" : { - "type" : "object", - "description" : "Request object for finding face events by location for reporting purposes with timestamp filtering and pagination.", - "properties" : { - "locationUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "timestampFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Facerecognition_faceevent_FindFaceEventsByLocationForReportingWSResponse" : { + "DoorRelayStateChangeEventType" : { "type" : "object", - "description" : "Response object containing face events by location for reporting purposes with pagination information.", - "properties" : { - "faceEvents" : { - "type" : "array", - "description" : "List of face events by location for reporting purposes", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, + "newState" : { + "$ref" : "#/components/schemas/DoorRelayStateEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastEvaluatedKey" : { + "correlationId" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of face events by location for reporting", - "example" : "next_page_key_123", "nullable" : true - } - } - }, - "Facerecognition_faceevent_FindFaceEventsByOrgForReportingWSRequest" : { - "type" : "object", - "description" : "Request object for finding face events by organization for reporting purposes with timestamp filtering and pagination.", - "properties" : { - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" }, - "timestampFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" - } - } - }, - "Facerecognition_faceevent_FindFaceEventsByOrgForReportingWSResponse" : { - "type" : "object", - "description" : "Response object containing face events for reporting purposes with pagination information.", - "properties" : { - "faceEvents" : { - "type" : "array", - "description" : "List of face events for reporting purposes", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" - }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "lastEvaluatedKey" : { + "locationUuid" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of face events for reporting", - "example" : "next_page_key_123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_FindFaceEventsByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding face events by organization with search filtering and pagination.", - "properties" : { - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" }, - "searchFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSearchFilter" - } - } - }, - "Facerecognition_faceevent_FindFaceEventsByOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing face events for an organization with pagination information.", - "properties" : { - "faceEvents" : { - "type" : "array", - "description" : "List of face events matching the search criteria", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" - }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastEvaluatedKey" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of results", - "example" : "next_page_key_123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_FindSimilarFaceEventsByEmbeddingWSRequest" : { - "type" : "object", - "description" : "Request object for finding face events similar to a face embedding with search filtering and pagination.", - "properties" : { - "embedding" : { - "$ref" : "#/components/schemas/Embedding" }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "searchFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" - } - } - }, - "Facerecognition_faceevent_FindSimilarFaceEventsByEmbeddingWSResponse" : { - "type" : "object", - "description" : "Response object containing face events similar to a face embedding with pagination information.", - "properties" : { - "faceEvents" : { - "type" : "array", - "description" : "List of face events similar to the specified face embedding", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" - }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "lastEvaluatedKey" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of similar face events", - "example" : "next_page_key_123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Facerecognition_faceevent_FindSimilarFaceEventsByFaceMatchmakerWSRequest" : { + "DoorRelayStateEnumType" : { + "type" : "string", + "enum" : [ "UNLOCKED", "LOCKED", "UNKNOWN" ] + }, + "DoorScheduleExceptionType" : { "type" : "object", - "description" : "Request object for finding face events similar to a face ID using face matchmaker with search filtering and pagination.", + "description" : "The door schedule exception to update.", "properties" : { - "faceId" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX timestamp in milliseconds when exception was created.", + "nullable" : true, + "readOnly" : true + }, + "defaultState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "description" : { "type" : "string", - "description" : "Face ID to find similar face events for", - "example" : "face_12345", + "description" : "Exception description", "nullable" : true }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" + "doorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "searchFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" - } - } - }, - "Facerecognition_faceevent_FindSimilarFaceEventsByFaceMatchmakerWSResponse" : { - "type" : "object", - "description" : "Response object containing face events similar to a face ID using face matchmaker with pagination information.", - "properties" : { - "faceEvents" : { + "intervals" : { "type" : "array", - "description" : "List of face events similar to the specified face ID", + "description" : "List of intervals each specifying door state during date range. List must contain at least one element", "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + "$ref" : "#/components/schemas/LocalInterval" }, "nullable" : true }, - "lastEvaluatedKey" : { + "localEndDate" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of similar face events", - "example" : "next_page_key_123", + "description" : "Exception end date in 'yyyy-MM-dd' format. End date is inclusive.", "nullable" : true - } - } - }, - "Facerecognition_faceevent_FindSimilarFaceEventsWSRequest" : { - "type" : "object", - "description" : "Request object for finding face events similar to a specified face event with search filtering and pagination.", - "properties" : { - "faceEventUuid" : { + }, + "localStartDate" : { + "type" : "string", + "description" : "Exception start date in 'yyyy-MM-dd' format. Start date is inclusive.", + "nullable" : true + }, + "locationToDoorsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Mapping of location uuid to a list of door uuids, representing the doors assigned to each location. Map must contain at least one entry with at least one door.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : "Mapping of location uuid to a list of door uuids, representing the doors assigned to each location. Map must contain at least one entry with at least one door.", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - }, - "searchFilter" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" - } - } - }, - "Facerecognition_faceevent_FindSimilarFaceEventsWSResponse" : { - "type" : "object", - "description" : "Response object containing face events similar to a specified face event with pagination information.", - "properties" : { - "faceEvents" : { - "type" : "array", - "description" : "List of face events similar to the specified face event", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" - }, + "name" : { + "type" : "string", + "description" : "Exception name", "nullable" : true }, - "lastEvaluatedKey" : { + "orgUuid" : { "type" : "string", - "description" : "Pagination key for retrieving the next page of similar face events", - "example" : "next_page_key_123", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_GetFaceEventWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a specific face event by UUID.", - "properties" : { - "eventUuid" : { + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX timestamp in milliseconds when exception was modified.", + "nullable" : true, + "readOnly" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "intervals", "localEndDate", "localStartDate", "name" ] }, - "Facerecognition_faceevent_GetFaceEventWSResponse" : { + "DoorScheduleFirstInStateEvent" : { "type" : "object", - "description" : "Response object containing a specific face event.", - "properties" : { - "faceEvent" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + "allOf" : [ { + "type" : "object", + "properties" : { + "acuEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "newState" : { + "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "settingsUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "source" : { + "$ref" : "#/components/schemas/FirstInSourceEnum" + }, + "stateChangedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } } - } - }, - "Facerecognition_faceevent_ProcessFaceEventSearchImageWSResponse" : { - "type" : "object", - "description" : "Response object containing processed face search image with embedding and base64 image data.", + } ], + "nullable" : true, "properties" : { - "embedding" : { - "$ref" : "#/components/schemas/Embedding" - }, - "imageBase64" : { + "componentUuid" : { "type" : "string", - "description" : "Base64 encoded image used for embedding generation. The image in the request may have been modified(cropped) in order to generate embedding.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_ReportTimestampFilter" : { - "type" : "object", - "description" : "Filter object for reporting face events with timestamp range and interval configuration.", - "properties" : { - "rangeStart" : { + }, + "correlationId" : { "type" : "string", - "format" : "date-time", - "description" : "Start date for the reporting range", - "example" : "2024-01-01T00:00:00Z", "nullable" : true }, - "reportInterval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - } - } - }, - "Facerecognition_faceevent_UpdateFaceEventWSRequest" : { - "type" : "object", - "description" : "Request object for updating a face event with person association information.", - "properties" : { - "eventUuid" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "personName" : { - "type" : "string", - "description" : "Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches.", - "nullable" : true - }, - "personUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_faceevent_UpdateFaceEventWSResponse" : { - "type" : "object", - "description" : "Response object for updating a face event.", - "properties" : { - "faceEvent" : { - "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" - } - } - }, - "Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSRequest" : { - "type" : "object", - "description" : "Request object for creating a face matchmaker from a face event sighting.", - "properties" : { - "faceEventUuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "personUuid" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -83240,352 +84442,557 @@ } } }, - "Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSResponse" : { + "DoorScheduledTriggerType" : { "type" : "object", - "description" : "Response object for creating a face matchmaker from a face event sighting.", "properties" : { - "faceMatchmaker" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" + "ajarThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Facerecognition_matchmaker_CreatePersonAndFaceMatchmakersWSResponse" : { + "DoorSensorSettings" : { "type" : "object", - "description" : "Response object for creating a person and associated face matchmakers.", "properties" : { - "faceMatchmakers" : { - "type" : "array", - "description" : "List of created face matchmakers for the person", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" - }, + "ajar_threshold_enabled" : { + "type" : "boolean", + "description" : "Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).", "nullable" : true }, - "person" : { - "$ref" : "#/components/schemas/Person" - }, - "transactionId" : { - "type" : "string", - "description" : "Transaction ID for tracking the creation process", - "example" : "txn_12345", + "ajar_threshold_sec" : { + "type" : "integer", + "format" : "int32", + "description" : "Threshold value for Door Sensor Ajar state. Defaults to 30s.", "nullable" : true } } }, - "Facerecognition_matchmaker_DeleteFaceMatchmakerWSRequest" : { + "DoorSensorSettingsSelectiveUpdate" : { "type" : "object", - "description" : "Request object for deleting a face matchmaker.", "properties" : { - "faceId" : { - "type" : "string", - "description" : "Face ID of the matchmaker to delete", - "example" : "face_12345", + "ajar_threshold_enabled" : { + "type" : "boolean", + "description" : "Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).", + "nullable" : true + }, + "ajar_threshold_sec" : { + "type" : "integer", + "format" : "int32", + "description" : "Threshold value for Door Sensor Ajar state. Defaults to 30s.", + "nullable" : true + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true } } }, - "Facerecognition_matchmaker_DeleteFaceMatchmakerWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a face matchmaker." - }, - "Facerecognition_matchmaker_ExternalFaceMatchmaker" : { + "DoorStateChangeEvent" : { "type" : "object", - "description" : "External face matchmaker object containing face recognition matchmaker data and metadata.", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "newState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "source" : { + "$ref" : "#/components/schemas/AccessStateSourceEnum" + } + } + } ], + "nullable" : true, "properties" : { - "createdOn" : { + "componentUuid" : { "type" : "string", - "format" : "date-time", - "description" : "Date when the face matchmaker was created", - "example" : "2024-01-01T00:00:00Z", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "id" : { + "correlationId" : { "type" : "string", - "description" : "Unique identifier for the face matchmaker", - "example" : "face_12345", "nullable" : true }, - "orgUuid" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "personUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uploaded" : { - "type" : "boolean", - "description" : "Whether the face matchmaker has been uploaded", - "example" : true, - "nullable" : true - } - } - }, - "Facerecognition_matchmaker_FileUploadResult" : { - "type" : "object", - "description" : "Result of a file upload process for face matchmaker creation, including success status and error messages.", - "properties" : { - "fileName" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "The name of the uploaded file.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "message" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Error message that occurred during upload.", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "success" : { - "type" : "boolean", - "description" : "Indicates whether the file upload was successful. Note, that even if upload was successful, subsequent operations, such as adding the uploaded file as a matchmaker, may fail.", + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding face matchmakers by organization." + "DoorStateEnum" : { + "type" : "string", + "description" : "Filter events by door state", + "enum" : [ "OPEN", "CLOSED", "AJAR" ] }, - "Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSResponse" : { + "DoorStatusEnum" : { + "type" : "string", + "description" : "Door state for door sensor webhooks", + "enum" : [ "OPEN", "CLOSED", "AJAR" ] + }, + "DoorType" : { "type" : "object", - "description" : "Response object containing face matchmakers for an organization.", "properties" : { - "faceMatchmakers" : { - "type" : "array", - "description" : "List of face matchmakers for the organization", - "items" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" - }, + "id" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "name" : { + "type" : "string", "nullable" : true } } }, - "Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSRequest" : { + "Door_DoorHealthDetailsEnum" : { + "type" : "string", + "description" : "Enumeration of specific health details for door sensors.", + "enum" : [ "FIRMWARE_BEHIND", "NO_HEARTBEAT", "NONE" ] + }, + "Door_DoorHealthEnum" : { + "type" : "string", + "description" : "Enumeration of health status for door sensors.", + "enum" : [ "GREEN", "RED" ] + }, + "Door_GetDoorEventsForSensorWSRequest" : { "type" : "object", - "description" : "Request object for finding face matchmakers by person UUID.", + "description" : "Request object for retrieving door open/close events for a door sensor.", "properties" : { - "personUuid" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds to get events created after this time", + "example" : 1640995200000, + "nullable" : true + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds to get events created before this time", + "example" : 1640995200000, + "nullable" : true + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of events to return", + "example" : 100, + "nullable" : true + }, + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "stateChangedOnly" : { + "type" : "boolean", + "description" : "When true, only return events where the door state actually changed (open/close transitions), excluding the periodic heartbeat events that report an unchanged state", + "nullable" : true + }, + "stateFilter" : { + "$ref" : "#/components/schemas/DoorStateEnum" } } }, - "Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSResponse" : { + "Door_GetDoorEventsForSensorWSResponse" : { "type" : "object", - "description" : "Response object containing face matchmakers for a specific person.", + "description" : "Response object containing door open/close events for a door sensor.", "properties" : { - "faceMatchmakers" : { + "doorEvents" : { "type" : "array", - "description" : "List of face matchmakers for the specified person", + "description" : "List of door open/close events for the sensor", "items" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" + "$ref" : "#/components/schemas/DoorEventType" }, "nullable" : true - } - } - }, - "Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSRequest" : { - "type" : "object", - "description" : "Request object for finding face upload metadata by transaction ID.", - "properties" : { - "transactionId" : { + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "description" : "Transaction ID to find face upload metadata for", - "example" : "txn_12345", "nullable" : true } } }, - "Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSResponse" : { + "Door_GetMinimalDoorStatesWSRequest" : { "type" : "object", - "description" : "Response object containing face upload metadata for a transaction.", + "description" : "Request object for retrieving basic state information for all door sensors." + }, + "Door_GetMinimalDoorStatesWSResponse" : { + "type" : "object", + "description" : "Response object containing basic state information for all door sensors.", "properties" : { - "faceUploadMetadata" : { + "doorStates" : { "type" : "array", - "description" : "List of face upload metadata for the transaction", + "description" : "List of minimal door state information for all door sensors", "items" : { - "$ref" : "#/components/schemas/FaceUploadMetadata" + "$ref" : "#/components/schemas/Door_MinimalDoorStateType" }, "nullable" : true - } - } - }, - "Facerecognition_matchmaker_GetFaceMatchingConfigWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving face matching configuration." - }, - "Facerecognition_matchmaker_GetFaceMatchingConfigWSResponse" : { - "type" : "object", - "description" : "Response object containing face matching configuration settings.", - "properties" : { - "faceMatchConfidenceThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Face match confidence threshold value", - "example" : 0.7, + }, + "error" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Facerecognition_matchmaker_GetFaceMatchmakerWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a face matchmaker by face ID.", - "properties" : { - "faceId" : { + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "description" : "Face ID to retrieve the matchmaker for", - "example" : "face_12345", "nullable" : true } } }, - "Facerecognition_matchmaker_GetFaceMatchmakerWSResponse" : { + "Door_MinimalDoorStateType" : { "type" : "object", - "description" : "Response object containing a face matchmaker.", - "properties" : { - "faceMatchmaker" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" - } - } - }, - "Facerecognition_matchmaker_UpdateFaceMatchingConfigWSRequest" : { - "type" : "object", - "description" : "Request object for updating face matching configuration settings.", + "description" : "Minimal state information for a door sensor.", "properties" : { - "faceMatchConfidenceThreshold" : { + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device facet UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "batteryPercent" : { + "type" : "integer", + "format" : "int32", + "description" : "Battery percentage of the door sensor", + "example" : 75, + "nullable" : true + }, + "closestBaseStation" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds when the door sensor was created", + "example" : 1640995200000, + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "description" : "Firmware version of the door sensor", + "example" : "1.2.3", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the door sensor is located", + "example" : 1, + "nullable" : true + }, + "health" : { + "$ref" : "#/components/schemas/Door_DoorHealthEnum" + }, + "healthDetails" : { + "$ref" : "#/components/schemas/Door_DoorHealthDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lastSeenSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in seconds when the door sensor was last seen", + "example" : 1640995200, + "nullable" : true + }, + "latitude" : { "type" : "number", - "format" : "float", - "description" : "Minimum confidence level required for the system to automatically assign a match. If null, the system uses the built-in default.", - "maximum" : 1.0, - "minimum" : 0.0, + "format" : "double", + "description" : "Latitude coordinate of the door sensor", + "example" : 37.7749, "nullable" : true - } - } - }, - "Facerecognition_matchmaker_UpdateFaceMatchingConfigWSResponse" : { - "type" : "object", - "description" : "Response object for updating face matching configuration settings.", - "properties" : { - "faceMatchConfidenceThreshold" : { + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "longitude" : { "type" : "number", - "format" : "float", - "description" : "Updated face match confidence threshold value", - "example" : 0.7, + "format" : "double", + "description" : "Longitude coordinate of the door sensor", + "example" : -122.4194, "nullable" : true - } - } - }, - "Facerecognition_matchmaker_UploadFaceMatchmakerForPersonWSResponse" : { - "type" : "object", - "description" : "Response object for uploading a face matchmaker for a specific person.", - "properties" : { - "fileUploadResult" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_FileUploadResult" }, - "transactionId" : { + "name" : { "type" : "string", - "description" : "Transaction ID to track face matchmaker upload progress", - "example" : "txn_12345", + "description" : "Name of the door sensor", + "example" : "Main Entrance Door", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "sensorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the door sensor", + "example" : "DS123456789", + "nullable" : true + }, + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "Signal strength of the door sensor", + "example" : 85, "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/DoorStatusEnum" + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, - "Facerecognition_matchmaker_UploadFaceMatchmakersWSResponse" : { + "Door_UpdateDoorSensorDetailsWSRequest" : { "type" : "object", - "description" : "Response object for uploading face matchmakers with transaction tracking and upload results.", + "description" : "Request object for updating details for a door sensor.", "properties" : { - "fileUploadResults" : { + "associatedCameras" : { "type" : "array", - "description" : "List of file upload results for each uploaded face matchmaker", + "description" : "List of associated camera device facet UUIDs", "items" : { - "$ref" : "#/components/schemas/Facerecognition_matchmaker_FileUploadResult" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "transactionId" : { + "associatedCamerasUpdated" : { + "type" : "boolean", + "description" : "Whether the associated cameras have been updated", + "example" : true, + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "description" : "Whether the door sensor is deleted", + "example" : false, + "nullable" : true + }, + "deletedUpdated" : { + "type" : "boolean", + "description" : "Whether the deleted status has been updated", + "example" : false, + "nullable" : true + }, + "description" : { "type" : "string", - "description" : "Transaction ID to track face matchmakers upload progress", - "example" : "txn_12345", + "description" : "Description of the door sensor", + "example" : "Main entrance door sensor on the first floor", "nullable" : true - } - } - }, - "Facerecognition_matchmaker_ValidateFaceMatchmakerImageWSResponse" : { - "type" : "object", - "description" : "Response object for validating face matchmaker images with validation status and error information.", - "properties" : { - "errorMessage" : { + }, + "descriptionUpdated" : { + "type" : "boolean", + "description" : "Whether the description has been updated", + "example" : false, + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the door sensor is located", + "example" : 1, + "nullable" : true + }, + "floorNumberUpdated" : { + "type" : "boolean", + "description" : "Whether the floor number has been updated", + "example" : true, + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the door sensor", + "example" : 37.7749, + "nullable" : true + }, + "latitudeUpdated" : { + "type" : "boolean", + "description" : "Whether the latitude has been updated", + "example" : false, + "nullable" : true + }, + "locationUuid" : { "type" : "string", - "description" : "Error message if validation failed", - "example" : "Image quality too low", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "valid" : { + "locationUuidUpdated" : { "type" : "boolean", - "description" : "Whether the face matchmaker image is valid", + "description" : "Whether the location UUID has been updated", "example" : true, "nullable" : true - } - } - }, - "Facerecognition_person_AddPersonLabelWSRequest" : { - "type" : "object", - "description" : "Request object for adding a label to a person for face recognition purposes.", - "properties" : { - "label" : { + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the door sensor", + "example" : -122.4194, + "nullable" : true + }, + "longitudeUpdated" : { + "type" : "boolean", + "description" : "Whether the longitude has been updated", + "example" : false, + "nullable" : true + }, + "name" : { "type" : "string", - "description" : "Label to add to the person", - "example" : "VIP", + "description" : "Name of the door sensor", + "example" : "Main Entrance Door", "nullable" : true }, - "personUuid" : { + "nameUpdated" : { + "type" : "boolean", + "description" : "Whether the name has been updated", + "example" : true, + "nullable" : true + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_person_AddPersonLabelWSResponse" : { - "type" : "object", - "description" : "Response object for adding a label to a person for face recognition purposes." - }, - "Facerecognition_person_CreatePersonWSRequest" : { - "type" : "object", - "description" : "Request object for creating a person for face recognition purposes.", - "properties" : { - "name" : { + }, + "policyUuidUpdated" : { + "type" : "boolean", + "description" : "Whether the policy UUID has been updated", + "example" : false, + "nullable" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "Name of the person to create", - "example" : "John Doe", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, "nullable" : true - } - } - }, - "Facerecognition_person_CreatePersonWSResponse" : { - "type" : "object", - "description" : "Response object for creating a person for face recognition purposes.", - "properties" : { - "person" : { - "$ref" : "#/components/schemas/Person" - } - } - }, - "Facerecognition_person_DeletePersonWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a person for face recognition purposes.", - "properties" : { - "personUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -83594,87 +85001,97 @@ } } }, - "Facerecognition_person_DeletePersonWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a person for face recognition purposes." - }, - "Facerecognition_person_FindPeopleByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding people by organization for face recognition purposes." - }, - "Facerecognition_person_FindPeopleByOrgWSResponse" : { + "Door_UpdateDoorSensorDetailsWSResponse" : { "type" : "object", - "description" : "Response object containing people for an organization for face recognition purposes.", + "description" : "Response object for updating details for a door sensor.", "properties" : { - "people" : { - "type" : "array", - "description" : "List of people for the organization", - "items" : { - "$ref" : "#/components/schemas/Person" - }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Facerecognition_person_FindPersonLabelsByOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding person labels by organization for face recognition purposes." - }, - "Facerecognition_person_FindPersonLabelsByOrgWSResponse" : { + "DoorbellEventType" : { "type" : "object", - "description" : "Response object containing person labels by organization for face recognition purposes.", - "properties" : { - "labelsByPerson" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of person UUIDs to their associated labels", - "items" : { - "type" : "string", - "description" : "Map of person UUIDs to their associated labels", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "description" : "Map of person UUIDs to their associated labels", - "nullable" : true + "newSupervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } } - } - }, - "Facerecognition_person_GetPersonWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving a person by UUID.", + } ], + "nullable" : true, "properties" : { - "personUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Facerecognition_person_GetPersonWSResponse" : { - "type" : "object", - "description" : "Response object containing a person.", - "properties" : { - "person" : { - "$ref" : "#/components/schemas/Person" - } - } - }, - "Facerecognition_person_RemovePersonLabelWSRequest" : { - "type" : "object", - "description" : "Request object for removing a label from a person for face recognition purposes.", - "properties" : { - "label" : { + }, + "correlationId" : { "type" : "string", - "description" : "Label to remove from the person", - "example" : "VIP", "nullable" : true }, - "personUuid" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -83683,145 +85100,105 @@ } } }, - "Facerecognition_person_RemovePersonLabelWSResponse" : { - "type" : "object", - "description" : "Response object for removing a label from a person for face recognition purposes." - }, - "Facerecognition_person_UpdatePersonWSRequest" : { - "type" : "object", - "description" : "Request object for updating a person for face recognition purposes.", - "properties" : { - "personSelectiveUpdate" : { - "$ref" : "#/components/schemas/PersonSelectiveUpdate" - } - } - }, - "Facerecognition_person_UpdatePersonWSResponse" : { + "Doorbellcamera_CreateRuleForDoorbellCameraWSRequest" : { "type" : "object", - "description" : "Response object for updating a person for face recognition purposes.", + "description" : "Request object for creating a rule for a doorbell camera.", "properties" : { - "person" : { - "$ref" : "#/components/schemas/Person" + "rule" : { + "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" } } }, - "FeatureCompatabilityType" : { + "Doorbellcamera_CreateRuleForDoorbellCameraWSResponse" : { "type" : "object", - "description" : "List of feature compatibility information", + "description" : "Response object for creating a rule for a doorbell camera.", "properties" : { - "betaRolloutOrgFlag" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceFeatureEnablement" : { - "$ref" : "#/components/schemas/DeviceFeatureEnum" - }, - "featureName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "generatedActivities" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true - }, - "hardwareDefaultMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, - "nullable" : true - }, - "requiredLicenses" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LicenseEnum" - }, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "supportedHardware" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Feature_DeviceFeaturesType" : { + "Doorbellcamera_CreateSharedLiveVideoStreamWSRequest" : { "type" : "object", - "description" : "Device features configuration with feature enablement mapping.", + "description" : "Request object for creating a shared live video stream for a doorbell camera.", "properties" : { - "deviceUuid" : { + "audioGatewayUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "featureMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "description" : "Map of device features to their enabled/disabled status", - "nullable" : true - }, - "description" : "Map of device features to their enabled/disabled status", - "nullable" : true - } - } - }, - "Feature_GetDeviceEventTypesWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving possible event types for a device based on enabled features.", - "properties" : { - "deviceUuid" : { + "doorbellCameraUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - } - } - }, - "Feature_GetDeviceEventTypesWSResponse" : { - "type" : "object", - "description" : "Response object containing possible event types for a device based on enabled features.", - "properties" : { - "eventTypes" : { - "type" : "array", - "description" : "List of possible event types for the device", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, + }, + "expirationTimeSecs" : { + "type" : "integer", + "format" : "int32", + "description" : "Add a expiration date for accessing the stream in seconds", + "example" : 86400, "nullable" : true - } - } - }, - "Feature_GetDeviceFeaturesListWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving enabled features for multiple devices in an organization.", - "properties" : { - "deviceUuids" : { - "type" : "array", - "description" : "List of device UUIDs to retrieve features for", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + }, + "invertSchedule" : { + "type" : "boolean", + "description" : "If given a schedule uuid, will hide the stream during the schedule instead and show it otherwise", + "example" : false, + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "If not provided, will be named 'Unnamed'", + "example" : "Front Door Stream", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Add a password to allow access to your shared stream. If null or blank password is not set.", + "example" : "mypassword123", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "streamType" : { + "$ref" : "#/components/schemas/StreamTypeEnum" + }, + "vodEnabled" : { + "type" : "boolean", + "description" : "Enables recording of live footage to a VOD", + "example" : true, "nullable" : true } - } + }, + "required" : [ "doorbellCameraUuid", "streamType", "vodEnabled" ] }, - "Feature_GetDeviceFeaturesListWSResponse" : { + "Doorbellcamera_CreateSharedLiveVideoStreamWSResponse" : { "type" : "object", - "description" : "Response object containing enabled features for multiple devices in an organization.", + "description" : "Response object for creating a shared live video stream for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", @@ -83831,12 +85208,23 @@ "type" : "string", "nullable" : true }, - "featureList" : { - "type" : "array", - "description" : "List of device features for each requested device", - "items" : { - "$ref" : "#/components/schemas/Feature_DeviceFeaturesType" - }, + "sharedLiveM3U8StreamUrl" : { + "type" : "string", + "description" : "M3U8 URL for the shared live video stream", + "example" : "https://example.com/live/m3u8/stream", + "nullable" : true + }, + "sharedLiveVideoStreamUrl" : { + "type" : "string", + "description" : "URL for the shared live video stream", + "example" : "https://example.com/live/video/stream", + "nullable" : true + }, + "sharedLiveVideoStreamUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { @@ -83845,22 +85233,29 @@ } } }, - "Feature_GetDeviceFeaturesWSRequest" : { + "Doorbellcamera_DeleteDoorbellCameraWSRequest" : { "type" : "object", - "description" : "Request object for retrieving enabled features for a device.", + "description" : "Request object for removing a doorbell camera from the organization.", "properties" : { - "deviceUuid" : { + "doorbellCameraUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "mummify" : { + "type" : "boolean", + "description" : "Whether to mummify the doorbell camera", + "example" : false, "nullable" : true } - } + }, + "required" : [ "doorbellCameraUuid", "mummify" ] }, - "Feature_GetDeviceFeaturesWSResponse" : { + "Doorbellcamera_DeleteDoorbellCameraWSResponse" : { "type" : "object", - "description" : "Response object containing enabled features for a device.", + "description" : "Response object for removing a doorbell camera from the organization.", "properties" : { "error" : { "type" : "boolean", @@ -83870,8 +85265,8 @@ "type" : "string", "nullable" : true }, - "features" : { - "$ref" : "#/components/schemas/Feature_DeviceFeaturesType" + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" }, "warningMsg" : { "type" : "string", @@ -83879,13 +85274,29 @@ } } }, - "Feature_GetFeatureCompatabilityMatrixWSRequest" : { + "Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest" : { "type" : "object", - "description" : "Request object for retrieving the feature compatibility matrix." + "description" : "Request object for deleting a rule for a doorbell camera.", + "properties" : { + "doorbellCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } }, - "Feature_GetFeatureCompatabilityMatrixWSResponse" : { + "Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse" : { "type" : "object", - "description" : "Response object containing the feature compatibility matrix.", + "description" : "Response object for deleting a rule for a doorbell camera.", "properties" : { "error" : { "type" : "boolean", @@ -83895,1705 +85306,1925 @@ "type" : "string", "nullable" : true }, - "featureCompatabilityMatrix" : { - "type" : "array", - "description" : "List of feature compatibility information", - "items" : { - "$ref" : "#/components/schemas/FeatureCompatabilityType" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Feature_UpdateDeviceFeaturesWSRequest" : { + "Doorbellcamera_DoorbellCameraOfflineLanStreamingInfo" : { "type" : "object", - "description" : "Request object for updating enabled features for a device.", + "description" : "Information for offline LAN streaming of doorbell camera content.", "properties" : { - "deviceUuid" : { + "accessToken" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "description" : "Access token for offline LAN streaming", + "example" : "abc123def456", "nullable" : true }, - "featureMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "description" : "Map of device features to their new enabled/disabled status", + "lanAddresses" : { + "type" : "array", + "description" : "List of LAN addresses for offline streaming", + "items" : { + "type" : "string", + "description" : "List of LAN addresses for offline streaming", "nullable" : true }, - "description" : "Map of device features to their new enabled/disabled status", "nullable" : true } } }, - "Feature_UpdateDeviceFeaturesWSResponse" : { + "Doorbellcamera_DoorbellRingReadinessReasonEnum" : { + "type" : "string", + "description" : "Why the recipient cannot be rung, null when they can", + "enum" : [ "NOT_ORG_MEMBER", "NO_APP_SESSION", "NO_VOIP_DEVICE" ] + }, + "Doorbellcamera_DoorbellRingRecipientReadinessType" : { "type" : "object", - "description" : "Response object for updating enabled features for a device.", + "description" : "VoIP-ring reachability for one configured doorbell recipient.", "properties" : { - "error" : { + "canReceiveVoip" : { "type" : "boolean", + "description" : "Whether a VoIP-capable device can be rung for this recipient", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Display name of the recipient, null when the recipient is not an org member", "nullable" : true }, - "warningMsg" : { + "reason" : { + "$ref" : "#/components/schemas/Doorbellcamera_DoorbellRingReadinessReasonEnum" + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Fidoauth_DeleteCredentialForCurrentUserWSRequest" : { + "Doorbellcamera_ExternalDoorbellCameraComponentRuleType" : { "type" : "object", + "description" : "External representation of a doorbell camera component rule.", "properties" : { - "credentialId" : { + "action" : { + "$ref" : "#/components/schemas/RuleActionType" + }, + "doorbellCameraComponentUuid" : { "type" : "string", - "description" : "The id of the credential to be deleted", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "credentialId" ] - }, - "Fidoauth_DeleteCredentialForCurrentUserWSResponse" : { - "type" : "object", - "properties" : { - "credential" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, - "credentials" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" + "doorbellCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ruleFilters" : { + "$ref" : "#/components/schemas/RuleFilterType" + }, + "ruleName" : { + "type" : "string", + "description" : "Name of the rule", + "example" : "Motion Detection Rule", + "nullable" : true + }, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerActivity" : { + "$ref" : "#/components/schemas/ActivityEnum" } } }, - "Fidoauth_FindCredentialsForCurrentUserWSRequest" : { + "Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest" : { "type" : "object", + "description" : "Request object for retrieving component events for a doorbell camera.", "properties" : { - "lastEvaluatedKey" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Returns events created after (exclusive) the specified millisecond epoch timestamp", + "example" : 1640995200000, + "nullable" : true + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Returns events created before (exclusive) the specified millisecond epoch timestamp", + "example" : 1640995200000, + "nullable" : true + }, + "doorbellCameraUuid" : { "type" : "string", - "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { + "limit" : { "type" : "integer", "format" : "int32", - "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "description" : "Limits the number of returned events to the latest LIMIT events. Maximum value is 100.", + "example" : 50, + "nullable" : true + }, + "typeFilter" : { + "type" : "array", + "description" : "Limits results to only contain the specified type of events, if applicable", + "items" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, "nullable" : true } - } + }, + "required" : [ "doorbellCameraUuid", "limit" ] }, - "Fidoauth_FindCredentialsForCurrentUserWSResponse" : { + "Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse" : { "type" : "object", + "description" : "Response object containing component events for a doorbell camera.", "properties" : { - "credentials" : { + "componentEvents" : { "type" : "array", + "description" : "List of component events for the doorbell camera", "items" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" + "$ref" : "#/components/schemas/ComponentEventType" }, "nullable" : true }, - "lastEvaluatedKey" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true - } - } - }, - "Fidoauth_InitiateCredentialRegistrationForCurrentUserWSRequest" : { - "type" : "object", - "properties" : { - "reduceRequirementsForMultiFactorAuthOnlyCred" : { - "type" : "boolean", + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Fidoauth_InitiateCredentialRegistrationForCurrentUserWSResponse" : { + "Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest" : { "type" : "object", + "description" : "Request object for retrieving component seekpoints for a doorbell camera.", "properties" : { - "registrationRequest" : { - "$ref" : "#/components/schemas/JsonNode" + "doorbellCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds for the seekpoint query", + "example" : 3600, + "nullable" : true + }, + "startTimeSecEpochExclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds epoch (exclusive) for the seekpoint query", + "example" : 1640995200, + "nullable" : true } } }, - "Fidoauth_InitiateMultiFactorAuthCredentialUpgradeForCurrentUserWSRequest" : { + "Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse" : { "type" : "object", + "description" : "Response object containing component seekpoints for a doorbell camera.", "properties" : { - "credentialId" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "seekpoints" : { + "type" : "array", + "description" : "List of component seekpoints for the doorbell camera", + "items" : { + "$ref" : "#/components/schemas/ComponentSeekPointType" + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "description" : "The id of a mfa credential to attempt upgrading", "nullable" : true - } - }, - "required" : [ "credentialId" ] - }, - "Fidoauth_InitiateMultiFactorAuthCredentialUpgradeForCurrentUserWSResponse" : { - "type" : "object", - "properties" : { - "upgradeRequest" : { - "$ref" : "#/components/schemas/JsonNode" } } }, - "Fidoauth_RegisterCredentialForCurrentUserWSRequest" : { - "type" : "object", - "properties" : { - "registrationResponse" : { - "$ref" : "#/components/schemas/JsonNode" - } - }, - "required" : [ "registrationResponse" ] - }, - "Fidoauth_RegisterCredentialForCurrentUserWSResponse" : { + "Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest" : { "type" : "object", + "description" : "Request object for finding shared live video streams for a doorbell camera.", "properties" : { - "credential" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" + "doorbellCameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true } } }, - "Fidoauth_UpdateCredentialForCurrentUserWSRequest" : { + "Doorbellcamera_FindSharedLiveVideoStreamsWSResponse" : { "type" : "object", + "description" : "Response object containing shared live video streams for a doorbell camera.", "properties" : { - "credentialId" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "description" : "The id of the credential to be updated", "nullable" : true }, - "displayName" : { + "sharedLiveVideoStreams" : { + "type" : "array", + "description" : "List of shared live video streams for the doorbell camera", + "items" : { + "$ref" : "#/components/schemas/Camera_SharedLiveVideoStreamWS" + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "description" : "A new display name to apply to the credential", "nullable" : true } - }, - "required" : [ "credentialId" ] + } }, - "Fidoauth_UpdateCredentialForCurrentUserWSResponse" : { + "Doorbellcamera_GetDoorbellCameraConfigWSResponse" : { "type" : "object", + "description" : "Response object containing doorbell camera configuration.", "properties" : { - "credential" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableAudioVideoUserConfig" }, - "credentials" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Fidoauth_UpgradeMultiFactorAuthCredentialForCurrentUserWSRequest" : { - "type" : "object", - "properties" : { - "upgradeResponse" : { - "$ref" : "#/components/schemas/JsonNode" - } - }, - "required" : [ "upgradeResponse" ] - }, - "Fidoauth_UpgradeMultiFactorAuthCredentialForCurrentUserWSResponse" : { + "Doorbellcamera_GetDoorbellCameraFullStateWSResponse" : { "type" : "object", + "description" : "Response object containing detailed state information for a doorbell camera.", "properties" : { - "credential" : { - "$ref" : "#/components/schemas/RhombusUserFidoCredential" + "fullState" : { + "$ref" : "#/components/schemas/FullDeviceStateType" } } }, - "FirmwareUpdateIntervalType" : { + "Doorbellcamera_GetDoorbellCameraMediaUrisWSResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response object containing media URIs for doorbell camera footage and audio.", "properties" : { - "minuteOfWeekStart" : { - "type" : "integer", - "format" : "int32", + "lanCheckUrls" : { + "type" : "array", + "description" : "List of LAN check URLs to verify device availability on local network", + "items" : { + "type" : "string", + "description" : "List of LAN check URLs to verify device availability on local network", + "nullable" : true + }, "nullable" : true }, - "minuteOfWeekStop" : { - "type" : "integer", - "format" : "int32", + "lanLiveH264Uris" : { + "type" : "array", + "description" : "List of LAN URIs for live H.264 video streams", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for live H.264 video streams", + "nullable" : true + }, "nullable" : true - } - } - }, - "FirmwareUpdateModeEnum" : { - "type" : "string", - "enum" : [ "MANUAL", "SCHEDULED" ] - }, - "FirmwareUpdateSettingsOverrideType" : { - "type" : "object", - "description" : "Overrides default firmware update settings.", - "nullable" : true, - "properties" : { - "deviceTypes" : { + }, + "lanLiveMpdUris" : { "type" : "array", + "description" : "List of LAN URIs for live MPD streams", "items" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "type" : "string", + "description" : "List of LAN URIs for live MPD streams", + "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "firmwareUpdateSettings" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" + "lanLiveOpusUris" : { + "type" : "array", + "description" : "List of LAN URIs for live Opus audio streams", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for live Opus audio streams", + "nullable" : true + }, + "nullable" : true + }, + "lanVodM3u8UrisTemplates" : { + "type" : "array", + "description" : "List of LAN URI templates for VOD M3U8 streams", + "items" : { + "type" : "string", + "description" : "List of LAN URI templates for VOD M3U8 streams", + "nullable" : true + }, + "nullable" : true + }, + "lanVodMpdUrisTemplates" : { + "type" : "array", + "description" : "List of LAN URI templates for VOD MPD streams", + "items" : { + "type" : "string", + "description" : "List of LAN URI templates for VOD MPD streams", + "nullable" : true + }, + "nullable" : true + }, + "wanLiveH264Uri" : { + "type" : "string", + "description" : "WAN URI for live H.264 video stream", + "nullable" : true + }, + "wanLiveMpdUri" : { + "type" : "string", + "description" : "WAN URI for live MPD stream", + "nullable" : true + }, + "wanLiveOpusUri" : { + "type" : "string", + "description" : "WAN URI for live Opus audio stream", + "nullable" : true + }, + "wanVodM3u8UriTemplate" : { + "type" : "string", + "description" : "WAN URI template for VOD M3U8 streams", + "nullable" : true + }, + "wanVodMpdUriTemplate" : { + "type" : "string", + "description" : "WAN URI template for VOD MPD streams", + "nullable" : true } } }, - "FirmwareUpdateSettingsType" : { + "Doorbellcamera_GetDoorbellCameraMinimalStateListWSResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response object containing basic state information for all doorbell cameras.", "properties" : { - "intervalsV2" : { + "minimalStates" : { "type" : "array", + "description" : "List of minimal state information for doorbell cameras", "items" : { - "$ref" : "#/components/schemas/FirmwareUpdateIntervalType" + "$ref" : "#/components/schemas/MinimalObservableDeviceStateType" }, "nullable" : true - }, - "mode" : { - "$ref" : "#/components/schemas/FirmwareUpdateModeEnum" } } }, - "FirstInFirmwareStatusEnum" : { - "type" : "string", - "enum" : [ "DISABLED", "NOT_CONFIGURED", "REQUIRED", "SATISFIED", "UNKNOWN" ] - }, - "FirstInResetEnum" : { - "type" : "string", - "enum" : [ "DAILY" ] + "Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving offline LAN streaming information for doorbell cameras." }, - "FirstInShadow" : { + "Doorbellcamera_GetDoorbellCameraOfflineLanStreamingInfoWSResponse" : { "type" : "object", + "description" : "Response object containing offline LAN streaming information for doorbell cameras.", "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" + "error" : { + "type" : "boolean", + "nullable" : true }, - "source" : { - "$ref" : "#/components/schemas/FirstInSourceEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" + "info" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Doorbellcamera_DoorbellCameraOfflineLanStreamingInfo" + }, + "description" : "Map of doorbell camera UUIDs to their offline LAN streaming information", + "nullable" : true }, - "stateUpdateEventTimestampMs" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "FirstInSourceEnum" : { - "type" : "string", - "enum" : [ "CONFIG_MANUAL_OVERRIDE", "CONFIG_REQUIREMENT_CHANGE", "CONFIG_MEMBERSHIP", "SCHEDULED_RESET", "LOCAL_BADGE_EVENT", "LOCKDOWN", "UNKNOWN" ] + "Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving rules for all doorbell cameras in an organization." }, - "FirstInState" : { + "Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse" : { "type" : "object", + "description" : "Response object containing rules for all doorbell cameras in an organization.", "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" + "doorbellCameraUuidToRulesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of doorbell camera UUIDs to their component rules", + "items" : { + "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" + }, + "nullable" : true + }, + "description" : "Map of doorbell camera UUIDs to their component rules", + "nullable" : true }, - "requestedAtMillis" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "FirstInState_Minimal" : { + "Doorbellcamera_GetMobileRingReadinessForDoorbellCameraWSRequest" : { "type" : "object", + "description" : "Request object for retrieving mobile-ring readiness for a doorbell camera.", "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator_Minimal" - }, - "requestedAtMillis" : { - "type" : "integer", - "format" : "int64", + "doorbellCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "state" : { - "$ref" : "#/components/schemas/FirstInStatusEnum_Minimal" } } }, - "FirstInStatusEnum" : { - "type" : "string", - "enum" : [ "REQUIRED", "SATISFIED" ] - }, - "FirstInStatusEnum_Minimal" : { - "type" : "string", - "enum" : [ "REQUIRED", "SATISFIED" ] - }, - "FisheyeDisplayModeEnum" : { - "type" : "string", - "enum" : [ "RAW", "IMMERSIVE", "TILES", "RAW_PANO" ] - }, - "FlicDevice" : { + "Doorbellcamera_GetMobileRingReadinessForDoorbellCameraWSResponse" : { "type" : "object", + "description" : "Response object containing per-recipient mobile-ring readiness for a doorbell camera.", "properties" : { - "flicAction" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "flicBatteryLevel" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "flicHub" : { - "$ref" : "#/components/schemas/FlicHub" + "recipients" : { + "type" : "array", + "description" : "Readiness of every recipient configured on the doorbell camera's ring rules", + "items" : { + "$ref" : "#/components/schemas/Doorbellcamera_DoorbellRingRecipientReadinessType" + }, + "nullable" : true }, - "flicName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "flicSerialNumber" : { + } + } + }, + "Doorbellcamera_GetRulesForDoorbellCameraWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving all rules for a doorbell camera.", + "properties" : { + "doorbellCameraUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "flicTimestamp" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Doorbellcamera_GetRulesForDoorbellCameraWSResponse" : { + "type" : "object", + "description" : "Response object containing all rules for a doorbell camera.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "flicUuid" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "lastClickedTimestamp" : { - "type" : "string", + "rules" : { + "type" : "array", + "description" : "List of component rules for the doorbell camera", + "items" : { + "$ref" : "#/components/schemas/Doorbellcamera_ExternalDoorbellCameraComponentRuleType" + }, "nullable" : true }, - "moduleUuid" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "FlicHub" : { + "Doorbellcamera_RebootDoorbellCameraWSRequest" : { "type" : "object", + "description" : "Request object for rebooting a doorbell camera.", "properties" : { - "flicHubName" : { + "doorbellCameraUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "flicHubSerialNumber" : { + } + }, + "required" : [ "doorbellCameraUuid" ] + }, + "Doorbellcamera_ReportTalkSessionWSRequest" : { + "type" : "object", + "description" : "Request object for reporting an operator talk session on a video intercom.", + "properties" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "flicHubUuid" : { + "state" : { + "$ref" : "#/components/schemas/IntercomTalkStateEnumType" + }, + "talkSessionUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "deviceUuid", "state", "talkSessionUuid" ] }, - "FlicType" : { + "Doorbellcamera_ReportTalkSessionWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "apiKey" : { - "type" : "string", - "nullable" : true - }, - "apiSecret" : { - "type" : "string", - "nullable" : true - }, - "associatedLocations" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "moduleUploaded" : { - "type" : "boolean", - "nullable" : true - }, - "webhookId" : { - "type" : "string", - "nullable" : true - }, - "webhookToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Response object for reporting an operator talk session on a video intercom.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "FloorPlanType" : { + "Doorbellcamera_UpdateDoorbellCameraConfigWSRequest" : { "type" : "object", + "description" : "Request object for updating doorbell camera configuration.", "properties" : { - "eastEdge" : { - "type" : "number", - "format" : "double", + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" + } + } + }, + "Doorbellcamera_UpdateDoorbellCameraDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for updating hardware details of a doorbell camera.", + "properties" : { + "associatedCameras" : { + "type" : "array", + "description" : "Optional list of associated camera device facet UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "floorLabel" : { + "description" : { + "type" : "string", + "description" : "Optional description for the doorbell camera", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "directionRadians" : { + "type" : "number", + "format" : "float", + "description" : "Optional direction in radians for the doorbell camera", "nullable" : true }, "floorNumber" : { "type" : "integer", "format" : "int32", + "description" : "Optional floor number where the doorbell camera is located", "nullable" : true }, - "imageUrl" : { - "type" : "string", - "format" : "url", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional latitude coordinate of the doorbell camera", "nullable" : true }, - "mediaUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "northEdge" : { + "longitude" : { "type" : "number", "format" : "double", + "description" : "Optional longitude coordinate of the doorbell camera", "nullable" : true }, - "rotation" : { - "type" : "number", - "format" : "double", + "name" : { + "type" : "string", + "description" : "Optional name for the doorbell camera", "nullable" : true }, - "southEdge" : { - "type" : "number", - "format" : "double", + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "westEdge" : { - "type" : "number", - "format" : "double", + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, "nullable" : true } } }, - "FollowUpAction" : { + "Doorcontroller_CreateDoorControllerRuleWSRequest" : { "type" : "object", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/NotificationFollowUp" - } ], + "description" : "Request object for creating a rule owned by a door controller.", "properties" : { - "type" : { - "$ref" : "#/components/schemas/ChatFollowUpActionEnum" + "doorControllerUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rule" : { + "$ref" : "#/components/schemas/RuleType" } } }, - "FootageBoundingBoxType" : { + "Doorcontroller_CreateDoorControllerRuleWSResponse" : { "type" : "object", - "description" : "List of shared footage bounding boxes", + "description" : "Response object for creating a rule owned by a door controller.", "properties" : { - "a" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "al" : { + "error" : { "type" : "boolean", - "description" : "alerted on this?", "nullable" : true }, - "b" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - bottom permyriad", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "c" : { - "type" : "number", - "format" : "float", - "description" : "confidence", - "nullable" : true + "rule" : { + "$ref" : "#/components/schemas/RuleType" }, - "cd" : { + "warningMsg" : { "type" : "string", - "description" : "Custom activity display description, maximum 100 characters", "nullable" : true - }, - "cdn" : { + } + } + }, + "Doorcontroller_DeleteDoorControllerRuleWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a rule owned by a door controller.", + "properties" : { + "doorControllerUuid" : { "type" : "string", - "description" : "custom activity display name", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "croppedImageLocator" : { + "ruleUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "customActivityColor" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" - }, - "dw" : { - "type" : "boolean", - "description" : "bounding box is in a loiter state", - "nullable" : true - }, - "fn" : { + } + } + }, + "Doorcontroller_DeleteDoorControllerRuleWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a rule owned by a door controller." + }, + "Doorcontroller_DeleteDoorControllerWSRequest" : { + "type" : "object", + "description" : "Request object for removing a door controller from the organization.", + "properties" : { + "doorControllerUuid" : { "type" : "string", - "description" : "face names", - "nullable" : true - }, - "kp" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PointType" - }, - "description" : "pose keypoints", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "l" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - left permyriad", + "mummify" : { + "type" : "boolean", + "description" : "Whether to mummify the door controller", + "example" : false, "nullable" : true - }, - "loudness" : { - "type" : "integer", - "format" : "int32", + } + }, + "required" : [ "doorControllerUuid", "mummify" ] + }, + "Doorcontroller_DeleteDoorControllerWSResponse" : { + "type" : "object", + "description" : "Response object for removing a door controller from the organization.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "lp" : { + "errorMsg" : { "type" : "string", - "description" : "license plate", "nullable" : true }, - "m" : { - "type" : "boolean", - "description" : "object in motion?", - "nullable" : true + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" }, - "objectId" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "p" : { + } + } + }, + "Doorcontroller_DoorControllerDiscoveredAperioDoor" : { + "type" : "object", + "description" : "Discovered Aperio door device information.", + "properties" : { + "gatewayId" : { "type" : "string", - "description" : "pose", + "description" : "Identifier for the associated Aperio gateway", + "example" : "gateway_67890", "nullable" : true }, - "r" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - right permyriad", + "id" : { + "type" : "string", + "description" : "Unique identifier for the Aperio door", + "example" : "door_12345", "nullable" : true }, - "reid" : { + "lastSeenMs" : { "type" : "integer", - "format" : "int32", - "description" : "Stable track ID for re-identification across track segments", + "format" : "int64", + "description" : "Timestamp when the door was last seen", + "example" : 1640995200000, "nullable" : true - }, - "ro" : { - "type" : "array", - "description" : "recognized objects", - "items" : { - "type" : "string", - "description" : "recognized objects", - "nullable" : true - }, + } + } + }, + "Doorcontroller_DoorControllerDiscoveredAperioGateway" : { + "type" : "object", + "description" : "Discovered Aperio gateway device information.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique identifier for the Aperio gateway", + "example" : "gateway_12345", "nullable" : true }, - "sensorValType" : { - "$ref" : "#/components/schemas/SensorValType" - }, - "t" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - top permyriad", + "ipAddress" : { + "type" : "string", + "description" : "IP address of the Aperio gateway", + "example" : "192.168.1.100", "nullable" : true }, - "toastOrderIdInfo" : { - "$ref" : "#/components/schemas/ToastOrderIdType" - }, - "ts" : { + "lastSeenMs" : { "type" : "integer", "format" : "int64", - "description" : "timestamp in milliseconds since epoch", + "description" : "Timestamp when the gateway was last seen", + "example" : 1640995200000, "nullable" : true }, - "uf" : { + "model" : { "type" : "string", - "description" : "FaceId for an unidentified face", + "description" : "Model of the Aperio gateway", + "example" : "AH-GW-01", "nullable" : true }, - "vn" : { + "protocolVersion" : { "type" : "string", - "description" : "vehicle name", + "description" : "Protocol version of the Aperio gateway", + "example" : "2.1", "nullable" : true } - }, - "required" : [ "a", "b", "l", "r", "t", "ts" ] - }, - "FootageSeekPointColorEnum" : { - "type" : "string", - "enum" : [ "BLUE", "RED", "PURPLE", "TAN", "ORANGE", "TEAL", "GRAY", "BLACK" ] + } }, - "FootageSeekPointType" : { + "Doorcontroller_DoorControllerDiscoveredReaderType" : { "type" : "object", - "description" : "List of shared footage seekpoints", + "description" : "List of discovered readers", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredRhombusReaderType" + }, { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredThirdPartyReaderType" + } ], "properties" : { - "a" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "al" : { - "type" : "boolean", + "boardNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Board number for the reader connection", + "example" : 1, "nullable" : true }, - "b" : { - "type" : "number", - "format" : "float", + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the reader was last seen", + "example" : 1640995200000, "nullable" : true }, - "fn" : { - "type" : "string", + "online" : { + "type" : "boolean", + "description" : "Whether the reader is currently online", + "example" : true, "nullable" : true }, - "kp" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PointType" - }, + "portNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Port number for the reader connection", + "example" : 0, "nullable" : true }, - "l" : { - "type" : "number", - "format" : "float", + "type" : { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" + } + } + }, + "Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" : { + "type" : "string", + "description" : "Enumeration of discovered reader types.", + "enum" : [ "RHOMBUS", "THIRD_PARTY" ] + }, + "Doorcontroller_DoorControllerDiscoveredRhombusReaderType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the Rhombus reader", + "example" : "RR-12345678", + "nullable" : true + } + } + } ], + "description" : "Discovered Rhombus reader information.", + "nullable" : true, + "properties" : { + "boardNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Board number for the reader connection", + "example" : 1, "nullable" : true }, - "lp" : { - "type" : "string", + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the reader was last seen", + "example" : 1640995200000, "nullable" : true }, - "p" : { - "type" : "string", + "online" : { + "type" : "boolean", + "description" : "Whether the reader is currently online", + "example" : true, "nullable" : true }, - "r" : { - "type" : "number", - "format" : "float", + "portNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Port number for the reader connection", + "example" : 0, "nullable" : true }, - "ro" : { - "type" : "array", - "items" : { + "type" : { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" + } + } + }, + "Doorcontroller_DoorControllerDiscoveredThirdPartyReaderType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "model" : { "type" : "string", + "format" : "byte", + "description" : "Model identifier for the third-party reader", + "example" : "MQ==", "nullable" : true }, + "serialNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Serial number of the third-party reader", + "example" : 12345, + "nullable" : true + }, + "vendorCode" : { + "type" : "array", + "description" : "Vendor code for the third-party reader", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Vendor code for the third-party reader", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "description" : "Discovered third-party reader information.", + "nullable" : true, + "properties" : { + "boardNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Board number for the reader connection", + "example" : 1, "nullable" : true }, - "t" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "ts" : { + "lastSeenMs" : { "type" : "integer", "format" : "int64", + "description" : "Timestamp when the reader was last seen", + "example" : 1640995200000, "nullable" : true }, - "uf" : { - "type" : "string", + "online" : { + "type" : "boolean", + "description" : "Whether the reader is currently online", + "example" : true, "nullable" : true }, - "vn" : { - "type" : "string", + "portNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Port number for the reader connection", + "example" : 0, "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderTypeEnum" } } }, - "FootageSeekPointV2Type" : { + "Doorcontroller_DoorControllerStateType" : { "type" : "object", - "description" : "List of shared footage seekpoints (deprecated)", + "description" : "State information for a door controller including discovered devices and configuration.", "properties" : { - "a" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "al" : { - "type" : "boolean", - "description" : "alerted on this?", + "configUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when configuration was last updated", + "example" : 1640995200000, "nullable" : true }, - "cc" : { - "$ref" : "#/components/schemas/FootageSeekPointColorEnum" + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" }, - "cd" : { + "defaultInterface" : { "type" : "string", - "description" : "Custom activity display description, maximum 100 characters", + "description" : "Default network interface of the door controller", + "example" : "eth0", "nullable" : true }, - "cdn" : { + "defaultInterfaceMac" : { "type" : "string", - "description" : "Custom activity display name, maximum 32 characters", - "nullable" : true - }, - "dcao" : { - "type" : "boolean", + "description" : "MAC address of the default interface", + "example" : "00:11:22:33:44:55", "nullable" : true }, - "dwelling" : { + "deleted" : { "type" : "boolean", + "description" : "Whether the door controller is deleted", + "example" : false, "nullable" : true }, - "fn" : { + "description" : { "type" : "string", - "description" : "face names", - "nullable" : true - }, - "id" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "loudness" : { - "type" : "integer", - "format" : "int32", + "description" : "Description of the door controller", + "example" : "Controls access to the main entrance", "nullable" : true }, - "lp" : { - "type" : "string", - "description" : "license plate", + "directionRadians" : { + "type" : "number", + "format" : "float", + "description" : "Direction in radians for the door controller", + "example" : 1.5708, "nullable" : true }, - "m" : { - "type" : "boolean", - "description" : "object in motion?", + "discoveredAperioDoors" : { + "type" : "array", + "description" : "List of discovered Aperio doors", + "items" : { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredAperioDoor" + }, "nullable" : true }, - "p" : { - "type" : "string", - "description" : "pose", + "discoveredAperioGateways" : { + "type" : "array", + "description" : "List of discovered Aperio gateways", + "items" : { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredAperioGateway" + }, "nullable" : true }, - "ro" : { + "discoveredReaders" : { "type" : "array", - "description" : "recognized objects", + "description" : "List of discovered readers", "items" : { - "type" : "string", - "description" : "recognized objects", - "nullable" : true + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerDiscoveredReaderType" }, "nullable" : true }, - "sensorValType" : { - "$ref" : "#/components/schemas/SensorValType" + "firmwareVersion" : { + "type" : "string", + "description" : "Firmware version of the door controller", + "example" : "2.1.0", + "nullable" : true }, - "stableTrackId" : { + "floorNumber" : { "type" : "integer", "format" : "int32", + "description" : "Floor number where the door controller is located", + "example" : 1, "nullable" : true }, - "toi" : { - "$ref" : "#/components/schemas/ToastOrderIdType" - }, - "ts" : { + "grantsUpdatedAtMs" : { "type" : "integer", "format" : "int64", - "description" : "timestamp", + "description" : "Timestamp when grants were last updated", + "example" : 1640995200000, "nullable" : true }, - "tu" : { - "type" : "string", + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { + "type" : "array", + "description" : "List of LAN addresses for the door controller", + "items" : { + "type" : "string", + "description" : "List of LAN addresses for the door controller", + "nullable" : true + }, "nullable" : true }, - "uf" : { - "type" : "string", - "description" : "FaceId for an unidentified face", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the door controller", + "example" : 34.0522, "nullable" : true }, - "vn" : { + "locationUuid" : { "type" : "string", - "description" : "vehicle name", - "nullable" : true - } - }, - "required" : [ "a", "ts" ] - }, - "FormDataBodyPart" : { - "type" : "object", - "nullable" : true, - "properties" : { - "content" : { - "type" : "object", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the door controller", + "example" : -118.2437, + "nullable" : true }, - "entity" : { - "type" : "object", + "name" : { + "type" : "string", + "description" : "Name of the door controller", + "example" : "Main Entrance Controller", "nullable" : true }, - "fileName" : { + "policyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "formDataContentDisposition" : { - "$ref" : "#/components/schemas/FormDataContentDisposition" + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the door controller", + "example" : "DC-12345678", + "nullable" : true }, - "headers" : { + "state" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "type" : "object", + "description" : "State information for the door controller", "nullable" : true }, + "description" : "State information for the door controller", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "messageBodyWorkers" : { - "$ref" : "#/components/schemas/MessageBodyWorkers" + "wanAddress" : { + "type" : "string", + "description" : "WAN address of the door controller", + "example" : "203.0.113.1", + "nullable" : true + } + } + }, + "Doorcontroller_GetDoorControllerConfigWSResponse" : { + "type" : "object", + "description" : "Response object containing door controller configuration.", + "properties" : { + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalReadableDoorControllerUserConfig" }, - "name" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "parameterizedHeaders" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ParameterizedHeader" - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "parent" : { - "$ref" : "#/components/schemas/MultiPart" - }, - "providers" : { - "$ref" : "#/components/schemas/Providers" - }, - "simple" : { - "type" : "boolean", - "nullable" : true - }, - "value" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "FormDataContentDisposition" : { + "Doorcontroller_GetDoorControllerRuleWSRequest" : { "type" : "object", + "description" : "Request object for retrieving a specific rule owned by a door controller.", "properties" : { - "creationDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "fileName" : { + "doorControllerUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "modificationDate" : { + "ruleUuid" : { "type" : "string", - "format" : "date-time", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "name" : { + } + } + }, + "Doorcontroller_GetDoorControllerRuleWSResponse" : { + "type" : "object", + "description" : "Response object containing a specific rule owned by a door controller.", + "properties" : { + "rule" : { + "$ref" : "#/components/schemas/RuleType" + } + } + }, + "Doorcontroller_GetDoorControllerRulesWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving all rules owned by a door controller.", + "properties" : { + "doorControllerUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "parameters" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + } + } + }, + "Doorcontroller_GetDoorControllerRulesWSResponse" : { + "type" : "object", + "description" : "Response object containing all rules owned by a door controller.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "readDate" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "size" : { - "type" : "integer", - "format" : "int64", + "rules" : { + "type" : "array", + "description" : "List of rules owned by the door controller", + "items" : { + "$ref" : "#/components/schemas/RuleType" + }, "nullable" : true }, - "type" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "FormDataMultiPart" : { + "Doorcontroller_GetDoorControllerStateListWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request object for retrieving state information for all door controllers in an organization." + }, + "Doorcontroller_GetDoorControllerStateListWSResponse" : { + "type" : "object", + "description" : "Response object containing state information for all door controllers in an organization.", "properties" : { - "bodyParts" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BodyPart" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" - }, - "entity" : { - "type" : "object", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/FormDataBodyPart" - }, - "nullable" : true + "stateList" : { + "type" : "array", + "description" : "List of door controller state information", + "items" : { + "$ref" : "#/components/schemas/Doorcontroller_DoorControllerStateType" }, "nullable" : true }, - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "messageBodyWorkers" : { - "$ref" : "#/components/schemas/MessageBodyWorkers" - }, - "parameterizedHeaders" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ParameterizedHeader" - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "parent" : { - "$ref" : "#/components/schemas/MultiPart" - }, - "providers" : { - "$ref" : "#/components/schemas/Providers" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "FormaSensorType" : { + "Doorcontroller_RegisterDiscoveredRhombusReaderWSRequest" : { "type" : "object", + "description" : "Request object for registering a Rhombus reader discovered by a door controller.", "properties" : { - "ch2oPpb" : { - "type" : "number", - "format" : "float", + "boardNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Board number for the reader connection", + "example" : 1, "nullable" : true }, - "relHumid" : { - "type" : "number", - "format" : "float", + "doorControllerUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tempC" : { - "type" : "number", - "format" : "float", + "portNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Port number for the reader connection", + "example" : 0, "nullable" : true }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the discovered Rhombus reader", + "example" : "RR-12345678", "nullable" : true } } }, - "Freight" : { + "Doorcontroller_RegisterDiscoveredRhombusReaderWSResponse" : { "type" : "object", - "properties" : { - "warehouse" : { - "$ref" : "#/components/schemas/WarehouseEnum" - } - } - }, - "FrequencyUnitEnum" : { - "type" : "string", - "enum" : [ "HOURS", "DAYS", "WEEKS", "MONTHS", "UNKNOWN" ] + "description" : "Response object for registering a Rhombus reader discovered by a door controller." }, - "FrontendEqualizerSettings" : { + "Doorcontroller_UpdateDoorControllerConfigWSRequest" : { "type" : "object", + "description" : "Request object for updating door controller configuration.", "properties" : { - "frequency" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "gain" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "q" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableDoorControllerUserConfig" } } }, - "FullDeviceStateType" : { + "Doorcontroller_UpdateDoorControllerDetailsWSRequest" : { "type" : "object", - "description" : "Detailed state information for the specified NVR", + "description" : "Request object for updating details for a door controller.", "properties" : { - "afSupport" : { - "type" : "boolean", - "nullable" : true - }, - "audioSupported" : { - "type" : "boolean", - "nullable" : true - }, - "baseVideoOperationUri" : { + "description" : { "type" : "string", + "description" : "Description of the door controller", + "example" : "Controls access to the main entrance", "nullable" : true }, - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "connectionTimestampMs" : { - "type" : "integer", - "format" : "int64", + "directionRadians" : { + "type" : "number", + "format" : "float", + "description" : "Direction in radians for the door controller", + "example" : 1.5708, "nullable" : true }, - "createdAtMillis" : { + "floorNumber" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Floor number where the door controller is located", + "example" : 1, "nullable" : true }, - "defaultInterface" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the door controller", + "example" : 34.0522, "nullable" : true }, - "defaultInterfaceMac" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "directionRadians" : { + "longitude" : { "type" : "number", - "format" : "float", + "format" : "double", + "description" : "Longitude coordinate of the door controller", + "example" : -118.2437, "nullable" : true }, - "externalIPAddress" : { + "name" : { "type" : "string", + "description" : "Name of the door controller", + "example" : "Main Entrance Controller", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "firmwareUpdateInProgress" : { + "subLocationsHierarchyKeyUpdated" : { "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, "nullable" : true }, - "firmwareVersion" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + } + }, + "required" : [ "uuid" ] + }, + "Doorcontroller_UpdateDoorControllerDetailsWSResponse" : { + "type" : "object", + "description" : "Response object for updating details for a door controller.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "latestFirmwareVersion" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "liveStreamShared" : { - "type" : "boolean", - "nullable" : true - }, - "liveStreamsSharedCount" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "locationUuid" : { + } + } + }, + "Doorcontroller_UpdateDoorControllerRuleWSRequest" : { + "type" : "object", + "description" : "Request object for updating a rule owned by a door controller.", + "properties" : { + "doorControllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "rule" : { + "$ref" : "#/components/schemas/RuleType" + } + } + }, + "Doorcontroller_UpdateDoorControllerRuleWSResponse" : { + "type" : "object", + "description" : "Response object for updating a rule owned by a door controller.", + "properties" : { + "rule" : { + "$ref" : "#/components/schemas/RuleType" + } + } + }, + "Doorstation_AnswerDoorStationCallWSRequest" : { + "type" : "object", + "description" : "Request for the calling door station to answer (claim) a ringing doorbell call.", + "properties" : { + "callUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "maxZoomPercent" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Doorstation_AnswerDoorStationCallWSResponse" : { + "type" : "object", + "description" : "Outcome of a door station's attempt to answer a doorbell call.", + "properties" : { + "audioDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mediaRegion" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mediaStorageDeviceUuid" : { + "originatorUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mummified" : { + "result" : { + "$ref" : "#/components/schemas/RingClaimResultEnum" + } + } + }, + "Doorstation_GetCurrentDoorStationWSRequest" : { + "type" : "object", + "description" : "Request object for getting the calling door station's own registration information." + }, + "Doorstation_GetCurrentDoorStationWSResponse" : { + "type" : "object", + "description" : "Response object containing the calling door station's own registration information.", + "properties" : { + "away" : { "type" : "boolean", + "description" : "Whether this door station is in away mode, so it does not ring for doorbell presses. Absent if the door station's settings could not be loaded.", "nullable" : true }, - "name" : { + "displayName" : { "type" : "string", + "description" : "Current display name of this door station, as set in the console", + "example" : "Front Lobby Door Station", "nullable" : true }, - "onCameraState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "nullable" : true - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "onCloudState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "policyUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { + "tokenUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "secondaryLanAddresses" : { + "videoWallUuids" : { "type" : "array", + "description" : "Video walls assigned to this door station. Absent if the door station's settings could not be loaded.", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "serialNumber" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "ssid" : { + } + } + }, + "Doorstation_GetDoorStationWSRequest" : { + "type" : "object", + "description" : "Request object for getting a door station's settings.", + "properties" : { + "tokenUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "tokenUuid" ] + }, + "Doorstation_GetDoorStationWSResponse" : { + "type" : "object", + "description" : "A door station's settings.", + "properties" : { + "away" : { + "type" : "boolean", + "description" : "Whether the door station is in away mode, so it does not ring for doorbell presses. Only the door station itself can change this.", "nullable" : true }, - "stateUpdatedTimestampMs" : { - "type" : "integer", - "format" : "int64", + "displayName" : { + "type" : "string", + "description" : "Display name of the door station", + "example" : "Front Lobby Door Station", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "error" : { + "type" : "boolean", + "nullable" : true }, - "supportedFacets" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "uuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "versionsBehind" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "wifiApMac" : { + "tokenUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", + "videoWallUuids" : { + "type" : "array", + "description" : "Video walls assigned to this door station", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "FunctionalityEnum" : { - "type" : "string", - "enum" : [ "DEVICE_ADMINISTRATION", "ORG_ADMINISTRATION", "AUTH_ADMINISTRATION", "FIRMWARE_ADMINISTRATION", "DOOR_ACCESS_ADMINISTRATION", "CAMERA_ADMINISTRATION", "REGISTER_DEVICES", "DELETE_DEVICES", "LOCATION_ADMINISTRATION", "POLICY_ADMINISTRATION", "USER_ADMINISTRATION", "REPORT_ADMINISTRATION", "NOTIFICATION_ADMINISTRATION", "LICENSE_ADMINISTRATION", "RECEIVE_EMAILS", "MANAGE_FACES", "MANAGE_LICENSEPLATES", "API_ADMINISTRATION", "INTEGRATION_ADMINISTRATION", "DATA_EXFILTRATION", "ALERT_MONITORING_ADMINISTRATION", "ALERT_MONITORING_VIEWONLY", "GUEST_MANAGEMENT_ADMINISTRATION", "GUEST_MANAGEMENT_VIEWONLY", "CLIP_MANAGEMENT", "VIEW_SAVED_VIDEO", "VIEW_AND_MANAGE_SAVED_VIDEO", "CLLM_ADMINISTRATION", "UNKNOWN" ] + "Doorstation_UnregisterDoorStationWSRequest" : { + "type" : "object", + "description" : "Request object for the calling door station to remove itself from its organization." }, - "GeneaSettings" : { + "Doorstation_UnregisterDoorStationWSResponse" : { "type" : "object", + "description" : "Response object for a door station removing itself from its organization.", "properties" : { - "alertUnauthorizedFaces" : { + "error" : { "type" : "boolean", "nullable" : true }, - "apiToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "createSeekPoints" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Doorstation_UpdateCurrentDoorStationAwayWSRequest" : { + "type" : "object", + "description" : "Request object for the calling door station to turn its own away mode on or off.", + "properties" : { + "away" : { "type" : "boolean", + "description" : "True to go away, so this door station stops ringing for doorbell presses; false to return", "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + } + }, + "required" : [ "away" ] + }, + "Doorstation_UpdateCurrentDoorStationAwayWSResponse" : { + "type" : "object", + "description" : "Response object for a door station turning its own away mode on or off.", + "properties" : { + "away" : { + "type" : "boolean", + "description" : "Whether this door station is now away. Absent on error.", "nullable" : true }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "enablingUser" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "enablingUserUuid" : { + } + } + }, + "Doorstation_UpdateDoorStationLocationWSRequest" : { + "type" : "object", + "description" : "Request object for setting or clearing the location a door station is assigned to.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "migrated" : { - "type" : "boolean", - "nullable" : true - }, - "rhombusToken" : { + "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "saveClips" : { + } + }, + "required" : [ "tokenUuid" ] + }, + "Doorstation_UpdateDoorStationLocationWSResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "webhookSignatureSecret" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "webhookUuid" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "GeneaType" : { + "Doorstation_UpdateDoorStationVideoWallsWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { + "description" : "Request object for replacing the video walls assigned to a door station.", + "properties" : { + "tokenUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "videoWallUuids" : { + "type" : "array", + "description" : "The full set of video walls to assign. Replaces the current set; an empty list clears it. Each wall must be unowned, or shared with at least one device.", + "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "webhookSignatureSecret" : { - "type" : "string", - "nullable" : true - }, - "webhookUuid" : { - "type" : "string", - "nullable" : true - } + "nullable" : true } - } ], - "nullable" : true, + }, + "required" : [ "tokenUuid", "videoWallUuids" ] + }, + "Doorstation_UpdateDoorStationVideoWallsWSResponse" : { + "type" : "object", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "videoWallUuids" : { + "type" : "array", + "description" : "Video walls now assigned to this door station", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "GenericButtonShadowType" : { + "DropboxSettingsV2" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "state" : { - "$ref" : "#/components/schemas/GenericButtonStateEnumType" - }, - "stateUpdateEventTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "supervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } - } - } ], - "nullable" : true, + "description" : "Dropbox integration settings to update", "properties" : { - "componentUuid" : { + "accessToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "orgUuid" : { + "accountEmail" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "accountName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" + "enabled" : { + "type" : "boolean", + "nullable" : true }, - "updatedAtMillis" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true - } - } - }, - "GenericButtonStateEnumType" : { - "type" : "string", - "enum" : [ "BUTTON_DOWN", "BUTTON_UP", "UNKNOWN" ] - }, - "GenericDoorType" : { - "type" : "object", - "properties" : { - "id" : { + }, + "enablingUser" : { "type" : "string", "nullable" : true }, - "name" : { + "enablingUserUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "GenericInputShadowType" : { + "DtcInfo" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "state" : { - "$ref" : "#/components/schemas/GenericInputStateEnumType" - }, - "stateUpdateEventTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "supervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } - } - } ], "nullable" : true, "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "code" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "failing" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "hasFailed" : { + "type" : "boolean", "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "testCompleted" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" - }, - "updatedAtMillis" : { + "time" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, - "GenericInputStateChangeEventType" : { + "DwellEventType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { + "nullable" : true, + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "deviceLabels" : { + "type" : "array", + "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "newState" : { - "$ref" : "#/components/schemas/GenericInputStateEnumType" - }, - "newSupervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", + "durationSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "createdAtMs" : { + "dwellStartTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, + "locationLabels" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -85608,88 +87239,141 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "regionUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "thumbnailLocation" : { + "type" : "string", + "nullable" : true + }, + "thumbnailUri" : { + "type" : "string", + "nullable" : true + }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "trackId" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "GenericInputStateEnumType" : { + "DwellStrategyEnum" : { "type" : "string", - "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] + "default" : "DURATION", + "description" : "Strategy for how long the robot dwells at this waypoint", + "enum" : [ "NONE", "DURATION", "TIME_ABSOLUTE", "EVENT", "MANUAL", "UNKNOWN" ] }, - "GenericObjectEmbedding" : { + "DynamoPageRequest" : { "type" : "object", + "description" : "Pagination request for retrieving policy alerts. Page size must be between 1 and 1000.", "properties" : { - "b" : { + "lastEvaluatedKey" : { + "type" : "string", + "nullable" : true + }, + "maxPageSize" : { "type" : "integer", "format" : "int32", - "description" : "bounding box - bottom permyriad", "nullable" : true - }, - "deviceUuid" : { + } + } + }, + "DynamoPageResultALMEvent" : { + "type" : "object", + "description" : "Paginated list of ALM events matching the request.", + "properties" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "embedding" : { + "page" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ALMEvent" + }, + "nullable" : true + } + } + }, + "E50ClimateEventType" : { + "type" : "object", + "description" : "List of climate events for the environmental gateway", + "properties" : { + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true + }, + "alertTriggerThresholds" : { "type" : "array", "items" : { "type" : "number", - "format" : "float", + "format" : "double", "nullable" : true }, "nullable" : true }, - "embeddingId" : { - "type" : "string", + "alertTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, "nullable" : true }, - "l" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - left permyriad", - "nullable" : true + "carbonMonoSense" : { + "$ref" : "#/components/schemas/COSensorType" }, - "locationUuid" : { + "clipMetaData" : { + "$ref" : "#/components/schemas/ClipMetaDataType" + }, + "co2Sense" : { + "$ref" : "#/components/schemas/Co2SensorType" + }, + "derivedValues" : { + "$ref" : "#/components/schemas/E50DerivedValuesType" + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "model" : { - "$ref" : "#/components/schemas/ObjectSearchModelEnum" - }, - "objectId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "objectType" : { + "firmwareVersion" : { "type" : "string", "nullable" : true }, + "formaSense" : { + "$ref" : "#/components/schemas/FormaSensorType" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "leakProbe" : { + "$ref" : "#/components/schemas/LeakProbeType" + }, "orgUuid" : { "type" : "string", "format" : "RUUID", @@ -85697,47 +87381,28 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "r" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - right permyriad", - "nullable" : true + "pmSense" : { + "$ref" : "#/components/schemas/PmSensorType" }, - "stableTrackId" : { - "type" : "integer", - "format" : "int32", + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "t" : { - "type" : "integer", - "format" : "int32", - "description" : "bounding box - top permyriad", - "nullable" : true + "pressSense" : { + "$ref" : "#/components/schemas/PressureSensorType" }, - "thumbnailUri" : { - "type" : "string", - "nullable" : true + "tempProbe" : { + "$ref" : "#/components/schemas/TempProbeType" }, - "timestamp" : { + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true - } - } - }, - "GenericObjectEmbeddingMatch" : { - "type" : "object", - "description" : "List of similar object embedding matches", - "properties" : { - "distance" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "embedding" : { - "$ref" : "#/components/schemas/GenericObjectEmbedding" }, - "matchedEmbeddingId" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -85746,298 +87411,374 @@ } } }, - "GenericPosSettings" : { + "E50DerivedValuesType" : { "type" : "object", - "description" : "Collection of service area settings for this restaurant", - "nullable" : true, "properties" : { - "assignedCameraList" : { + "airQualityIndex" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "airQualityIndexPollutant" : { + "$ref" : "#/components/schemas/AirQualityIndexPollutantEnum" + }, + "calibrating" : { + "type" : "boolean", + "nullable" : true + }, + "deviceOrientation" : { + "$ref" : "#/components/schemas/DeviceOrientationEnum" + }, + "falsePositiveConfidencePercent" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "heatIndexDegF" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "heatIndexRangeWarning" : { + "$ref" : "#/components/schemas/HeatIndexRangeWarningEnum" + }, + "indoorAirQuality" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "malfunctioningModules" : { "type" : "array", - "description" : "A list of camera uuids from Rhombus that are assigned to the PoS device", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "posName" : { - "type" : "string", - "description" : "The name of the point of sale device", - "nullable" : true - } - } - }, - "GenericPosType" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", + "smokeConfidencePercent" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "name" : { - "type" : "string", + "smokeThcConfidencePercent" : { + "type" : "number", + "format" : "float", "nullable" : true - } - } - }, - "GenericRelayShadowType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "state" : { - "$ref" : "#/components/schemas/GenericRelayStateEnumType" - }, - "stateUpdateEventTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "smokeTobaccoConfidencePercent" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "createdAtMillis" : { + "timestampSec" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "tvoc" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "vapeConfidencePercent" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" + "vapeDetected" : { + "type" : "boolean", + "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "vapeThcConfidencePercent" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "GenericRelayStateChangeEventType" : { + "EarlyExpireModeEnum" : { + "type" : "string", + "enum" : [ "SCHEDULED_CHANGE", "STEADY_STATE_CHANGE", "OFF" ] + }, + "EditPeriodAccessUpdate" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" + "absoluteIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" + }, + "nullable" : true }, - "steadyState" : { - "$ref" : "#/components/schemas/GenericRelayStateEnumType" + "accessControlledDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "steadyStateChangedAtMs" : { - "type" : "integer", - "format" : "int64", + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "autoDailyInterval" : { + "type" : "boolean", "nullable" : true }, - "transientState" : { - "$ref" : "#/components/schemas/GenericRelayStateEnumType" + "dailyIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DailyMinuteIntervalType" + }, + "nullable" : true } } } ], "nullable" : true, "properties" : { - "componentUuid" : { + "action" : { + "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" + } + }, + "required" : [ "action" ] + }, + "ElevatorLandingReference" : { + "type" : "object", + "properties" : { + "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { - "type" : "string", - "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "locationUuid" : { + "relayComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "ElevatorLandingReference_Minimal" : { + "type" : "object", + "properties" : { + "elevatorLandingUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "relayComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentReferenceType_Minimal" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "EmailAuditLogExportActionType" : { + "type" : "object", + "properties" : { + "includeActions" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "includeApiInvocation" : { + "type" : "boolean", "nullable" : true }, - "timestampMs" : { + "lookbackCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "lookbackType" : { + "$ref" : "#/components/schemas/ReportLookbackTypeEnum" }, - "uuid" : { + "lookbackUnit" : { + "$ref" : "#/components/schemas/ReportLookbackUnitEnum" + }, + "recipientEmails" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "timezoneId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "GenericRelayStateEnumType" : { - "type" : "string", - "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] - }, - "GenericVideoEmbedding" : { + "EmailSettings" : { "type" : "object", "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "embedding" : { + "emailAddresses" : { "type" : "array", "items" : { - "type" : "number", - "format" : "float", + "type" : "string", "nullable" : true }, "nullable" : true }, - "embeddingId" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "endTimeMs" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "locationUuid" : { + "enablingUser" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "model" : { - "$ref" : "#/components/schemas/VideoSimilarityModelEnum" - }, - "orgUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "GenericVideoEmbeddingMatch" : { + "Embedding" : { "type" : "object", - "description" : "List of similar video embedding matches", + "description" : "Returns the generated embedding or null if the embedding could not be generated. If image contains multiple faces, only the first generated embedding is returned.", "properties" : { - "distance" : { + "embeddingComparisonType" : { + "type" : "string", + "nullable" : true + }, + "embeddingConfidence" : { "type" : "number", "format" : "float", "nullable" : true }, - "embedding" : { - "$ref" : "#/components/schemas/GenericVideoEmbedding" + "embeddingEncodingType" : { + "$ref" : "#/components/schemas/EmbeddingEncodingTypeEnum" }, - "matchedEmbeddingId" : { + "encodedEmbedding" : { "type" : "string", "nullable" : true } } }, - "GeoIpLocationType" : { + "EmbeddingEncodingTypeEnum" : { + "type" : "string", + "enum" : [ "Q_8_24", "IEEE_754" ] + }, + "EmergencyContact" : { "type" : "object", "properties" : { - "city_name" : { + "name" : { "type" : "string", + "description" : "The name of the emergency contact.", "nullable" : true }, - "country_code" : { + "phoneNumber" : { "type" : "string", + "description" : "The phone number for this emergency contact.", "nullable" : true - }, - "country_name" : { - "type" : "string", + } + }, + "required" : [ "name", "phoneNumber" ] + }, + "EmergencyContactPolicy" : { + "type" : "object", + "description" : "Emergency contacts that may be notified after threat detection occurs at this zone.\n", + "nullable" : true, + "properties" : { + "emergencyContacts" : { + "type" : "array", + "description" : "The emergency contacts eligible to be notified under this configuration.", + "items" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, "nullable" : true }, - "region_name" : { + "scheduleUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "emergencyContacts", "scheduleUuid" ] }, - "GeodeticCoordinates" : { + "EmergencyResponseContactsIntervalType" : { "type" : "object", "properties" : { - "error" : { - "$ref" : "#/components/schemas/GpsError" + "emergencyContactList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, + "nullable" : true }, - "floor" : { + "minuteOfWeekStart" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "lat" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "lon" : { - "type" : "number", - "format" : "double", + "minuteOfWeekStop" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "GetTemporaryOrgTokenResponse" : { + "EmergencyResponseContactsScheduleType" : { "type" : "object", "properties" : { - "tempOrgToken" : { + "deviceUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "emergencyContactList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, + "nullable" : true + }, + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -86046,535 +87787,581 @@ } } }, - "GoogleCaptchaSourceEnum" : { - "type" : "string", - "description" : "Source of the Google reCAPTCHA (legacy or V3)", - "enum" : [ "LEGACY", "RHOMBUS_CONSOLE_WEB", "RHOMBUS_CONSOLE_ANDROID_APP", "RHOMBUS_CONSOLE_IOS_APP", "RHOMBUS_KEY_ANDROID_APP", "RHOMBUS_KEY_IOS_APP" ] - }, - "GoogleSettings" : { + "EnableDisableAudioRecordActionRecordType" : { "type" : "object", - "description" : "Google integration settings to update", "properties" : { - "accountUser" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "enabled" : { + "enable" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "enablingUser" : { - "type" : "string", + "succeeded" : { + "type" : "boolean", "nullable" : true - }, - "enablingUserUuid" : { + } + } + }, + "EnableDisableAudioRecordActionType" : { + "type" : "object", + "properties" : { + "audioDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "folderId" : { + "enable" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "EntityEnum" : { + "type" : "string", + "description" : "Entity object for exposing to OpenAPI component schemas", + "enum" : [ "ALARM_MONITORING_LOCATION_SETTINGS", "ALARM_MONITORING_LICENSE", "DEVICE", "LOCATION", "POLICY", "POLICY_ALERT", "POLICY_ADDENDUM", "POLICY_PAUSE", "USER", "CAMERA_USER_CONFIG", "ORG", "USER_PERMISSION_GROUP", "PARTNER_PERMISSION_GROUP", "VIDEO_WALL", "SHARED_CLIPS", "SAVED_CLIPS", "SHARED_STREAMS", "SPLICED_CLIPS", "TIMELAPSE", "AUDIT_EVENTS", "DIAGNOSTIC_EVENTS", "CAMERA_STATE", "CLIMATE_STATE", "DOOR_STATE", "NVR_STATE", "OCCUPANCY_STATE", "PROXIMITY_STATE", "AUDIO_STATE", "CAMERA", "NVR", "DOOR_SENSOR", "CLIMATE_SENSOR", "PROXIMITY_SENSOR", "BOUNDING_BOX", "SEEK_POINT", "SENSOR_SEEK_POINT", "SCHEDULE", "FACE_EVENT", "DEVICE_SHADOW", "THREAT_CASE", "THREAT_CASE_REVIEWER", "KEYPAD", "COMPONENT_DOOR_READER_SHADOW", "COMPONENT_DOOR_RELAY_SHADOW", "COMPONENT_DOOR_POSITION_INDICATOR_SHADOW", "COMPONENT_APERIO_GATEWAY_SHADOW", "COMPONENT_APERIO_DOOR_EXT_SHADOW", "COMPONENT_SCHLAGE_GATEWAY_SHADOW", "COMPONENT_SCHLAGE_DOOR_EXT_SHADOW", "COMPONENT_REQUEST_TO_EXIT_SHADOW", "COMPONENT_GENERIC_RELAY_SHADOW", "COMPONENT_GENERIC_INPUT_SHADOW", "COMPONENT_GENERIC_BUTTON_SHADOW", "ACCESS_CONTROLLED_DOOR_SHADOW", "ACCESS_CONTROLLED_DOOR", "ACCESS_CONTROLLED_ELEVATOR_SHADOW", "ACCESS_CONTROLLED_ELEVATOR", "ACCESS_CONTROLLED_ELEVATOR_LANDING_SHADOW", "ACCESS_CONTROLLED_ELEVATOR_LANDING", "COMPONENT_SEEKPOINT", "ROBOT_SEEKPOINT", "VEHICLE_EVENT", "DEVICE_INTEGRATION", "SHELLY_INTEGRATION", "THIRD_PARTY_CAMERA_DISCOVERY", "THIRD_PARTY_CAMERA_ASSIGNMENT", "THIRD_PARTY_CAMERA_CREDENTIAL", "CHATBOT_QUERY", "KEYPAD_COMMAND", "PRIORITY_DETECTION", "LIVE_DETECTION", "LIVE_OCCUPANCY", "UNKNOWN" ] + }, + "EntityTag" : { + "type" : "object", + "nullable" : true, + "properties" : { + "value" : { "type" : "string", "nullable" : true }, - "teamDriveId" : { - "type" : "string", + "weak" : { + "type" : "boolean", "nullable" : true } } }, - "GoogleSettingsV2" : { + "EnvironmentalGatewaySettings" : { "type" : "object", "properties" : { - "defaultAlertFolderId" : { - "type" : "string", + "data_measurement_interval_sec" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "defaultAlertFolderName" : { - "type" : "string", + "data_upload_interval_sec" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "defaultFolderId" : { - "type" : "string", + "false_positive_confidence_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "defaultFolderName" : { - "type" : "string", + "leak_detection_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "enabled" : { + "leak_detector_present" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "moist_detection_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "smoke_confidence_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "enablingUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "smoke_thc_confidence_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "refreshToken" : { - "type" : "string", + "smoke_tobacco_confidence_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "saveAllAlerts" : { - "type" : "boolean", + "vape_alert_backoff_sec" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "vape_confidence_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vape_thc_confidence_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "GoogleType" : { + "EnvironmentalGatewaySettingsSelectiveUpdate" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "allowUserStorage" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "defaultAlertFolderId" : { - "type" : "string", - "nullable" : true - }, - "defaultAlertFolderName" : { - "type" : "string", - "nullable" : true - }, - "defaultFolderId" : { - "type" : "string", - "nullable" : true - }, - "defaultFolderName" : { - "type" : "string", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "saveAllAlerts" : { - "type" : "boolean", - "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "userSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/GoogleUserSettings" - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Update Environmental Sensor settings", "properties" : { - "enabled" : { + "data_measurement_interval_sec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "data_upload_interval_sec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "false_positive_confidence_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "leak_detection_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "leak_detector_present" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "moist_detection_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true }, - "integrationAuditMap" : { + "smoke_confidence_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "smoke_thc_confidence_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "smoke_tobacco_confidence_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "updatedSetMethodMap" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "type" : "boolean", + "nullable" : true }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "vape_alert_backoff_sec" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "vape_confidence_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vape_thc_confidence_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "GoogleUserSettings" : { + "EnvironmentalGatewayShadowType" : { "type" : "object", - "nullable" : true, + "description" : "List of environmental gateway shadows", "properties" : { - "defaultAlertFolderId" : { + "activeAlertTriggers" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true + }, + "apMac" : { "type" : "string", "nullable" : true }, - "defaultAlertFolderName" : { + "carbonMonoSense" : { + "$ref" : "#/components/schemas/COSensorType" + }, + "co2Sense" : { + "$ref" : "#/components/schemas/Co2SensorType" + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "connectionUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "defaultFolderId" : { + "defaultInterface" : { "type" : "string", "nullable" : true }, - "defaultFolderName" : { + "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, - "refreshToken" : { + "derivedValues" : { + "$ref" : "#/components/schemas/E50DerivedValuesType" + }, + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveAllAlerts" : { - "type" : "boolean", + "disconnectTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "externalIPAddress" : { + "type" : "string", "nullable" : true }, - "tokenValid" : { + "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true - } - } - }, - "GpsError" : { - "type" : "object", - "properties" : { - "majorAxis" : { - "type" : "number", - "format" : "double", + }, + "firmwareUpdateTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "minorAxis" : { - "type" : "number", - "format" : "double", + "firmwareVersion" : { + "type" : "string", "nullable" : true }, - "rotation" : { - "type" : "number", - "format" : "double", + "formaSense" : { + "$ref" : "#/components/schemas/FormaSensorType" + }, + "hardwareUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Group_AddUsersToOrgGroupWSRequest" : { - "type" : "object", - "description" : "Request to add users to an organization group.", - "properties" : { - "groupUuid" : { + }, + "internalWanAddress" : { + "type" : "string", + "nullable" : true + }, + "jumpHostUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuids" : { + "lanAddresses" : { "type" : "array", - "description" : "List of user UUIDs to add to the group", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - } - } - }, - "Group_AddUsersToOrgGroupWSResponse" : { - "type" : "object", - "description" : "Response for adding users to an organization group.", - "properties" : { - "groupMembers" : { - "type" : "array", - "description" : "Users added to the group successfully from the original request", - "items" : { - "$ref" : "#/components/schemas/OrgGroupMemberType" - }, - "nullable" : true - } - } - }, - "Group_CreateOrgGroupWSRequest" : { - "type" : "object", - "description" : "Request to create an organization group.", - "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the group", - "example" : "Software engineering team members", - "nullable" : true }, - "locationUuid" : { + "leakProbe" : { + "$ref" : "#/components/schemas/LeakProbeType" + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "pmSense" : { + "$ref" : "#/components/schemas/PmSensorType" + }, + "pressSense" : { + "$ref" : "#/components/schemas/PressureSensorType" + }, + "prevConnected" : { + "type" : "boolean", + "nullable" : true + }, + "prevConnectedUpdateTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "region" : { "type" : "string", - "description" : "Name of the group", - "example" : "Engineering Team", "nullable" : true }, - "userUuids" : { + "secondaryLanAddresses" : { "type" : "array", - "description" : "List of user UUIDs to add to the group", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - } - }, - "required" : [ "name" ] - }, - "Group_CreateOrgGroupWSResponse" : { - "type" : "object", - "description" : "Response for organization group creation.", - "properties" : { - "group" : { - "$ref" : "#/components/schemas/OrgGroupType" }, - "groupMembers" : { - "type" : "array", - "description" : "List of group members if optionally added when creating the group", - "items" : { - "$ref" : "#/components/schemas/OrgGroupMemberType" + "ssid" : { + "type" : "string", + "nullable" : true + }, + "state" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true }, "nullable" : true + }, + "stateUpdatedTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "tempProbe" : { + "$ref" : "#/components/schemas/TempProbeType" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "wanAddress" : { + "type" : "string", + "nullable" : true + }, + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "Group_DeleteOrgGroupWSRequest" : { + "EnvoyCustomField" : { "type" : "object", - "description" : "Request to delete an organization group.", "properties" : { - "groupUuid" : { + "field" : { + "type" : "string", + "nullable" : true + }, + "value" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Group_DeleteOrgGroupWSResponse" : { - "type" : "object", - "description" : "Response indicating successful deletion of an organization group." - }, - "Group_FindAllUsersForOrgGroupWSRequest" : { + "EnvoyDelivery" : { "type" : "object", - "description" : "Request to find all users for an organization group.", "properties" : { - "groupUuid" : { + "carrier" : { + "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + }, + "carrierInfo" : { + "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + }, + "deliveryArea" : { + "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + }, + "deliveryAreaInfo" : { + "$ref" : "#/components/schemas/EnvoyDeliveryInfo" + }, + "locationId" : { + "type" : "string", + "nullable" : true + }, + "pickedUpAt" : { + "type" : "string", + "nullable" : true + }, + "pickedUpBy" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, + "receivedTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "recipient" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, + "status" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Group_FindAllUsersForOrgGroupWSResponse" : { + "EnvoyDeliveryInfo" : { "type" : "object", - "description" : "Response containing all users for an organization group.", "properties" : { - "groupMembers" : { - "type" : "array", - "description" : "List of group members", - "items" : { - "$ref" : "#/components/schemas/OrgGroupMemberType" - }, + "name" : { + "type" : "string", "nullable" : true } } }, - "Group_FindOrgGroupMembershipsByUserWSRequest" : { + "EnvoyExpectedGuest" : { "type" : "object", - "description" : "Request to find organization group memberships by user.", "properties" : { - "userUuid" : { + "expectedArrivalAt" : { + "type" : "string", + "nullable" : true + }, + "expectedArrivalTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "host" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, + "invitee" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, + "locationId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Group_FindOrgGroupMembershipsByUserWSResponse" : { + "EnvoyGuest" : { "type" : "object", - "description" : "Response containing organization group memberships for a user.", "properties" : { - "userGroupMemberships" : { - "type" : "array", - "description" : "List of user group memberships", - "items" : { - "$ref" : "#/components/schemas/OrgGroupMemberType" - }, + "agreementsStatus" : { + "type" : "string", + "nullable" : true + }, + "email" : { + "type" : "string", + "nullable" : true + }, + "fullName" : { + "type" : "string", + "nullable" : true + }, + "host" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, + "locationId" : { + "type" : "string", + "nullable" : true + }, + "notes" : { + "type" : "string", + "nullable" : true + }, + "signedInAt" : { + "type" : "string", + "nullable" : true + }, + "signedInTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "signedOutAt" : { + "type" : "string", + "nullable" : true + }, + "signedOutTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Group_FindOrgGroupMembershipsForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request to find organization group memberships for current user." - }, - "Group_FindOrgGroupMembershipsForCurrentUserWSResponse" : { + "EnvoyInvite" : { "type" : "object", - "description" : "Response containing organization group memberships for current user.", "properties" : { - "userGroupMemberships" : { + "customFields" : { "type" : "array", - "description" : "List of current user group memberships", "items" : { - "$ref" : "#/components/schemas/OrgGroupMemberType" + "$ref" : "#/components/schemas/EnvoyCustomField" }, "nullable" : true - } - } - }, - "Group_FindOrgGroupsByExactNameWSRequest" : { - "type" : "object", - "description" : "Request to find organization groups by exact name.", - "properties" : { - "groupName" : { - "type" : "string", - "description" : "Case insensitive name of the group to find, if it exists", - "example" : "Engineering Team", + }, + "expectedArrivalAt" : { + "type" : "string", "nullable" : true - } - } - }, - "Group_FindOrgGroupsByExactNameWSResponse" : { - "type" : "object", - "description" : "Response containing organization group found by exact name.", - "properties" : { - "group" : { - "$ref" : "#/components/schemas/OrgGroupType" - } - } - }, - "Group_FindOrgGroupsByNamePrefixWSRequest" : { - "type" : "object", - "description" : "Request to find organization groups by name prefix.", - "properties" : { - "groupNamePrefix" : { + }, + "expectedDepartureAt" : { "type" : "string", - "description" : "Name prefix to search for groups", - "example" : "Eng", "nullable" : true - } - } - }, - "Group_FindOrgGroupsByNamePrefixWSResponse" : { - "type" : "object", - "description" : "Response containing organization groups found by name prefix.", - "properties" : { - "groups" : { - "type" : "array", - "description" : "List of organization groups found by name prefix", - "items" : { - "$ref" : "#/components/schemas/OrgGroupType" - }, + }, + "flowId" : { + "type" : "string", "nullable" : true - } - } - }, - "Group_FindOrgGroupsByOrgWSRequest" : { - "type" : "object", - "description" : "Request to find organization groups by organization." - }, - "Group_FindOrgGroupsByOrgWSResponse" : { - "type" : "object", - "description" : "Response containing organization groups found by organization.", - "properties" : { - "groups" : { - "type" : "array", - "description" : "List of organization groups found by organization", - "items" : { - "$ref" : "#/components/schemas/OrgGroupType" - }, + }, + "hostEmployeeId" : { + "type" : "string", "nullable" : true - } - } - }, - "Group_FindOrgGroupsByUserMembershipWSRequest" : { - "type" : "object", - "description" : "Request to find organization groups by user membership.", - "properties" : { - "userUuid" : { + }, + "inviteId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "invitee" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, + "locationId" : { + "type" : "string", + "nullable" : true + }, + "notes" : { + "type" : "string", + "nullable" : true + }, + "sendEmailToInvitee" : { + "type" : "boolean", "nullable" : true } } }, - "Group_FindOrgGroupsByUserMembershipWSResponse" : { + "EnvoyLocation" : { "type" : "object", - "description" : "Response containing organization groups found by user membership.", "properties" : { - "groups" : { - "type" : "array", - "description" : "List of organization groups found by user membership", - "items" : { - "$ref" : "#/components/schemas/OrgGroupType" - }, + "id" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "name" : { + "type" : "string", "nullable" : true } } }, - "Group_RemoveUsersFromOrgGroupWSRequest" : { + "EnvoyLocationInfoType" : { "type" : "object", - "description" : "Request to remove users from an organization group.", + "nullable" : true, "properties" : { - "groupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "userUuids" : { + "assignedCameraList" : { "type" : "array", - "description" : "List of user UUIDs to remove from the group", "items" : { "type" : "string", "format" : "RUUID", @@ -86583,372 +88370,470 @@ "nullable" : true }, "nullable" : true - } - } - }, - "Group_RemoveUsersFromOrgGroupWSResponse" : { - "type" : "object", - "description" : "Response indicating successful removal of users from an organization group." - }, - "Group_UpdateOrgGroupWSRequest" : { - "type" : "object", - "description" : "Request to update an organization group.", - "properties" : { - "description" : { - "type" : "string", - "description" : "New description for the group", - "example" : "Updated software engineering team members", - "nullable" : true }, - "groupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "name" : { + "locationName" : { "type" : "string", - "description" : "New name for the group", - "example" : "Updated Engineering Team", "nullable" : true } } }, - "Group_UpdateOrgGroupWSResponse" : { - "type" : "object", - "description" : "Response containing the updated organization group.", - "properties" : { - "group" : { - "$ref" : "#/components/schemas/OrgGroupType" - } - } - }, - "Guest" : { + "EnvoyPersonInfo" : { "type" : "object", - "description" : "Guest information to update", "properties" : { - "accessEndTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "accessStartTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "address1" : { - "type" : "string", - "nullable" : true - }, - "address2" : { - "type" : "string", - "nullable" : true - }, - "backgroundCheckStatus" : { - "$ref" : "#/components/schemas/BackgroundCheckEnum" - }, - "checkedInEnum" : { - "$ref" : "#/components/schemas/GuestActivityEnum" - }, - "city" : { - "type" : "string", - "nullable" : true - }, - "companyName" : { - "type" : "string", - "nullable" : true - }, - "countryCode" : { + "email" : { "type" : "string", "nullable" : true }, - "crime" : { + "id" : { "type" : "string", "nullable" : true }, - "email" : { - "type" : "string", + "locationIds" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "emailCaseSensitive" : { - "type" : "string", + "locations" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "faceImage" : { + "name" : { "type" : "string", "nullable" : true }, - "firstName" : { + "type" : { "type" : "string", "nullable" : true - }, - "guestType" : { - "$ref" : "#/components/schemas/GuestTypeEnum" - }, - "hostUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + } + } + }, + "EnvoySettings" : { + "type" : "object", + "description" : "Envoy visitor management integration settings to update", + "properties" : { + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "lastCheckedInMs" : { - "type" : "integer", - "format" : "int64", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "lastCheckedOutMs" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "lastName" : { + "enablingUser" : { "type" : "string", "nullable" : true }, - "locationUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "meetingParticipants" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "envoyIntegrationInstalled" : { + "type" : "boolean", "nullable" : true }, - "phoneNumber" : { - "type" : "string", + "indexFaces" : { + "type" : "boolean", "nullable" : true }, - "postalCode" : { - "type" : "string", + "locationInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/EnvoyLocationInfoType" + }, "nullable" : true }, - "profileImageUrl" : { - "type" : "string", + "migrated" : { + "type" : "boolean", "nullable" : true }, - "state" : { + "refreshToken" : { "type" : "string", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/GuestStatusEnum" + "saveClips" : { + "type" : "boolean", + "nullable" : true } } }, - "GuestActivityEnum" : { - "type" : "string", - "enum" : [ "CHECKED_IN", "CHECKED_OUT", "AUTO_CHECKED_OUT", "UPDATED_INFO", "INVITED" ] - }, - "GuestActivityLog" : { + "EnvoyType" : { "type" : "object", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/GuestActivityEnum" - }, - "agent" : { - "type" : "string", - "nullable" : true - }, - "associatedCameras" : { - "type" : "array", - "items" : { + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "email" : { - "type" : "string", + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "envoyIntegrationInstalled" : { + "type" : "boolean", + "nullable" : true + }, + "envoyUserSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/EnvoyUserSettings" + }, + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "locationInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/EnvoyLocationInfoType" + }, + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "guestType" : { - "$ref" : "#/components/schemas/GuestTypeEnum" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "hostUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "GuestInvite" : { + "EnvoyUserSettings" : { "type" : "object", - "description" : "List of guest invites", + "nullable" : true, "properties" : { - "accessEndTimeMs" : { - "type" : "integer", - "format" : "int64", + "guestsEnabled" : { + "type" : "boolean", "nullable" : true }, - "accessStartTimeMs" : { - "type" : "integer", - "format" : "int64", + "packagesEnabled" : { + "type" : "boolean", "nullable" : true - }, - "address1" : { + } + } + }, + "EpochSecondsProvisioner" : { + "type" : "object", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StaticEpochSecondsProvisioner" + } ], + "properties" : { + "type" : { + "type" : "string" + } + }, + "required" : [ "type" ] + }, + "ErrorCodeOrMessageEnum" : { + "type" : "string", + "enum" : [ "BADGE_READER_UNKNOWN", "DEAD_OR_MISSING_BATTERY", "DOORBELL_BUTTON_ISSUE", "ERROR_2", "ERROR_4", "ERROR_5", "ERROR_24", "ERROR_28", "ERROR_30", "ERROR_39", "ERROR_74", "ERROR_84", "FOREIGN_HARDWARE", "BAD_SD_BLOCKS", "NEVER_LEFT_BUSY_STATE", "HARDWARE_DAMAGE", "HEAVY_HARDWARE_DAMAGE", "WATER_DAMAGE", "VIDEO_HARDWARE_FAILURE", "ENCRYPTED_CONTAINER_FAILURE_CREATE", "ENCRYPTED_CONTAINER_FAILURE_OPEN", "ENCRYPTED_CONTAINER_FAILURE_MOUNT", "LIGHT_SENSOR", "SD_CARD_UNKOWN", "SD_CARD_READER_BROKEN", "POWER_ISSUES", "RS485_ISSUE", "CUT_FILTER", "QUALITY_OR_PERFORMANCE", "NETWORK_ISSUES", "UNKNOWN", "ILLEGIBLE_SERIAL_COMM", "NO_SERIAL_COMM", "COSMETIC_DAMAGE", "IR_RING_OVERHEATED", "REGISTERED_SENSOR", "UNDISCOVERED_ISSUE", "FOCUS_ISSUES", "FIRMWARE_REFLASH_REQUIRED", "POTENTIAL_MANUFACTURING_DEFECT", "NO_FAULT_FOUND", "FDT_COMMAND_LINE_ERROR", "KERNEL_PANIC", "GET_DTB_FAILED", "POTENTIAL_FIRMWARE_ISSUE", "BOOTS_TO_AMBOOT" ] + }, + "Ethernettester_GetEthernetTesterConfigWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving Ethernet tester configuration.", + "properties" : { + "version" : { "type" : "string", + "description" : "Version of the Ethernet tester configuration", + "example" : "1.0", "nullable" : true - }, - "address2" : { + } + } + }, + "Ethernettester_GetEthernetTesterConfigWSResponse" : { + "type" : "object", + "description" : "Response object containing Ethernet tester configuration.", + "properties" : { + "configJson" : { "type" : "string", + "description" : "JSON configuration for the Ethernet tester", + "example" : "{\"testMode\":\"ping\",\"targetHost\":\"192.168.1.1\"}", "nullable" : true }, - "backgroundCheckStatus" : { - "$ref" : "#/components/schemas/BackgroundCheckEnum" - }, - "checkedInEnum" : { - "$ref" : "#/components/schemas/GuestActivityEnum" - }, - "city" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "companyName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "countryCode" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "EventCount" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "number", "nullable" : true }, - "crime" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "EventListenerType" : { + "type" : "object", + "description" : "List of event listeners for the specified device", + "properties" : { + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "email" : { - "type" : "string", + "clientCertificate" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, "nullable" : true }, - "emailCaseSensitive" : { - "type" : "string", + "clientKey" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, "nullable" : true }, - "faceImage" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firstName" : { + "hostname" : { "type" : "string", "nullable" : true }, - "guestType" : { - "$ref" : "#/components/schemas/GuestTypeEnum" - }, - "hostUserUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastCheckedInMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastCheckedOutMs" : { - "type" : "integer", - "format" : "int64", + "trustedCertificate" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, "nullable" : true }, - "lastName" : { + "uri" : { "type" : "string", "nullable" : true }, - "locationUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "meetingParticipants" : { - "type" : "array", - "items" : { + } + } + }, + "EventOriginatorEnum" : { + "type" : "string", + "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "COMPONENT_COMPOSITE_EVENT", "GUEST_PASS", "DEVICE_SERVICE", "UNKNOWN" ] + }, + "EventOriginatorEnum_Minimal" : { + "type" : "string", + "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "COMPONENT_COMPOSITE_EVENT", "GUEST_PASS", "DEVICE_SERVICE", "UNKNOWN" ] + }, + "EventTimelineEntry" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "customActivityDescription" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Custom description for the activity.", + "example" : "A person was detected in the camera view", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "customActivityDisplayName" : { + "type" : "string", + "description" : "Custom display name for the activity.", + "example" : "Person Detected", + "nullable" : true + }, + "device" : { + "$ref" : "#/components/schemas/TimelineEntryDevice" + }, + "subjectEntityName" : { + "type" : "string", + "description" : "Name or identifier associated with the event, such as a person's name or a vehicle license plate. Null when the entry is redacted.", + "nullable" : true + } + } + } ], + "description" : "A timeline entry recording an event a device observed, such as a face or a vehicle.", + "nullable" : true, + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", + "nullable" : true }, - "orgUuid" : { + "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "phoneNumber" : { + "imageKey" : { "type" : "string", + "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", "nullable" : true }, - "postalCode" : { + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "profileImageUrl" : { + "reportUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "type" : "string", + "systemGenerated" : { + "type" : "boolean", + "description" : "Whether the entry was generated by the system rather than created by a user.", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/GuestStatusEnum" + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/TimelineEntryTypeEnum" }, "uuid" : { "type" : "string", @@ -86959,167 +88844,239 @@ } } }, - "GuestInviteSelectiveUpdateByInvocation" : { + "EventTimestampFilter" : { "type" : "object", - "description" : "Guest invite to update", + "description" : "A time range, in milliseconds since the epoch. Which bounds are required depends on the request that carries this filter.", "properties" : { - "accessEndTimeMs" : { + "endTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Inclusive upper bound of the time range.", "nullable" : true }, - "accessStartTimeMs" : { + "startTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Inclusive lower bound of the time range.", "nullable" : true + } + } + }, + "Event_CalculateAlertMonitoringThreatCaseStatsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for calculating alert monitoring threat case stats by organization.", + "properties" : { + "reportInterval" : { + "$ref" : "#/components/schemas/ThreatCaseReportIntervalEnum" }, - "address1" : { - "type" : "string", - "nullable" : true + "threatCaseCreatedAtFilter" : { + "$ref" : "#/components/schemas/EventTimestampFilter" }, - "address2" : { - "type" : "string", + "timeZone" : { + "type" : "object", + "description" : "Time zone the interval buckets are aligned to, defaults to UTC", + "nullable" : true, + "properties" : { + "displayName" : { + "type" : "string", + "nullable" : true + }, + "dstsavings" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "rawOffset" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } + } + }, + "Event_CalculateAlertMonitoringThreatCaseStatsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing aggregate alert monitoring threat case stats for an organization.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of alerts across the matching threat cases", "nullable" : true }, - "backgroundCheckStatus" : { - "$ref" : "#/components/schemas/BackgroundCheckEnum" - }, - "checkedInEnum" : { - "$ref" : "#/components/schemas/GuestActivityEnum" - }, - "city" : { - "type" : "string", + "averageAlarmCloseSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Average time in seconds from threat case creation to alarm close", "nullable" : true }, - "companyName" : { - "type" : "string", + "averageResponseSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Average time in seconds from threat case creation to dismissal or escalation by a reviewer. Cases resolved without one, such as a panic button escalating on its own, are excluded.", "nullable" : true }, - "countryCode" : { - "type" : "string", + "closedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of closed threat cases", "nullable" : true }, - "createdAtMs" : { + "dismissedCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Number of dismissed threat cases", "nullable" : true }, - "crime" : { - "type" : "string", + "escalatedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of escalated threat cases", "nullable" : true }, - "email" : { - "type" : "string", - "nullable" : true + "externalReviewerStats" : { + "$ref" : "#/components/schemas/ThreatCaseReviewerStats" }, - "emailCaseSensitive" : { - "type" : "string", + "internalReviewerStats" : { + "type" : "array", + "description" : "Stats for each internal reviewer.", + "items" : { + "$ref" : "#/components/schemas/ThreatCaseReviewerStats" + }, "nullable" : true }, - "faceImage" : { - "type" : "string", + "openCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of open threat cases", "nullable" : true }, - "firstName" : { - "type" : "string", + "statsByIntervalStartMs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ThreatCaseIntervalStats" + }, + "description" : "Stats keyed by the start of each interval", "nullable" : true }, - "guestType" : { - "$ref" : "#/components/schemas/GuestTypeEnum" - }, - "hostUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "timedOutCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of timed out threat cases", "nullable" : true }, - "lastCheckedInMs" : { + "totalCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Total number of threat cases matching the filter", "nullable" : true - }, - "lastCheckedOutMs" : { + } + } + }, + "Event_CreateSharedClipGroupWSRequest" : { + "type" : "object", + "description" : "Request object for creating a shared clip group.", + "properties" : { + "expirationTimeSecs" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Expiration time in seconds for the shared clip group", + "example" : 86400, "nullable" : true }, - "lastName" : { + "plaintextPassword" : { "type" : "string", + "description" : "Optional password for accessing the shared clip group", + "example" : "mypassword123", "nullable" : true }, - "locationUuid" : { + "title" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Title for the shared clip group", + "example" : "Security Incident - Main Entrance", "nullable" : true }, - "meetingParticipants" : { + "uuids" : { "type" : "array", + "description" : "List of UUIDs for clips to include in the shared group", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/Event_RuuidWrapper" }, - "nullable" : true, - "uniqueItems" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Event_CreateSharedClipGroupWSResponse" : { + "type" : "object", + "description" : "Response object for creating a shared clip group.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "phoneNumber" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "postalCode" : { + "shareUrl" : { "type" : "string", + "description" : "URL for accessing the shared clip group", + "example" : "https://share.rhombus.com/clips/abc123", "nullable" : true }, - "profileImageUrl" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, + } + } + }, + "Event_DeleteAlertMonitoringThreatCaseByStatusWSRequest" : { + "type" : "object", + "description" : "Request object for deleting alert monitoring threat cases by status.", + "properties" : { "status" : { - "$ref" : "#/components/schemas/GuestStatusEnum" + "$ref" : "#/components/schemas/ThreatCaseStatusEnum" + } + } + }, + "Event_DeleteAlertMonitoringThreatCaseByStatusWSResponse" : { + "type" : "object", + "description" : "Response object for deleting alert monitoring threat cases by status.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "GuestManagementOrgSettings" : { + "Event_DeleteAlertMonitoringThreatCaseWSRequest" : { "type" : "object", + "description" : "Request object for deleting alert monitoring threat cases.", "properties" : { - "hexIdentityColor" : { - "type" : "string", - "nullable" : true - }, - "locationReceptionHostUserUuidMap" : { - "type" : "object", - "additionalProperties" : { + "threatCaseUuids" : { + "type" : "array", + "description" : "List of threat case UUIDs to delete", + "items" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -87127,222 +89084,319 @@ "nullable" : true }, "nullable" : true + } + } + }, + "Event_DeleteAlertMonitoringThreatCaseWSResponse" : { + "type" : "object", + "description" : "Response object for deleting alert monitoring threat cases.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "logoImageString" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_DeleteSavedClipWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a saved clip.", + "properties" : { + "savedClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "userHostNotificationSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "nullable" : true } } }, - "GuestManagementSettingsSelectiveUpdate" : { + "Event_DeleteSavedClipWSResponse" : { "type" : "object", + "description" : "Response object for deleting a saved clip.", "properties" : { - "hexIdentityColor" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "locationReceptionHostUserUuidMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "logoImageString" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Event_DeleteSharedClipGroupWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a shared clip group.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Event_DeleteSharedClipGroupWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a shared clip group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userHostNotificationSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "GuestManagementType" : { + "Event_DismissAllPolicyAlertsForDeviceWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "locationSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/LocationSettings" - }, + "description" : "Request object for dismissing all policy alerts for specific devices.", + "properties" : { + "deviceUuids" : { + "type" : "array", + "description" : "List of device UUIDs to dismiss alerts for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } + }, + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Event_DismissAllPolicyAlertsForDeviceWSResponse" : { + "type" : "object", + "description" : "Response object for dismissing all policy alerts for specific devices.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "GuestSelectiveUpdateByInvocation" : { + "Event_DismissAllPolicyAlertsWSRequest" : { + "type" : "object", + "description" : "Request object for dismissing all policy alerts." + }, + "Event_DismissAllPolicyAlertsWSResponse" : { "type" : "object", - "description" : "Guest update information", + "description" : "Response object for dismissing all policy alerts.", "properties" : { - "accessEndTimeMs" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "accessStartTimeMs" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "address1" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "address2" : { + } + } + }, + "Event_DismissPolicyAlertWSRequest" : { + "type" : "object", + "description" : "Request object for dismissing a policy alert.", + "properties" : { + "alertUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "backgroundCheckStatus" : { - "$ref" : "#/components/schemas/BackgroundCheckEnum" - }, - "checkedInEnum" : { - "$ref" : "#/components/schemas/GuestActivityEnum" - }, - "city" : { - "type" : "string", + } + } + }, + "Event_DismissPolicyAlertWSResponse" : { + "type" : "object", + "description" : "Response object for dismissing a policy alert.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "companyName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "countryCode" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "crime" : { - "type" : "string", + } + } + }, + "Event_DismissPolicyAlertsWSRequest" : { + "type" : "object", + "description" : "Request object for dismissing multiple policy alerts.", + "properties" : { + "alertUuids" : { + "type" : "array", + "description" : "List of policy alert UUIDs to dismiss", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Event_DismissPolicyAlertsWSResponse" : { + "type" : "object", + "description" : "Response object for dismissing multiple policy alerts.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "email" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "emailCaseSensitive" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Event_FrontendCell" : { + "type" : "object", + "description" : "Represents a cell in the motion grid with column and row coordinates.", + "properties" : { + "col" : { + "type" : "integer", + "format" : "int32", + "description" : "Column coordinate of the cell", + "example" : 5, + "nullable" : true }, - "faceImage" : { + "row" : { + "type" : "integer", + "format" : "int32", + "description" : "Row coordinate of the cell", + "example" : 3, + "nullable" : true + } + } + }, + "Event_GetAlertMonitoringThreatCaseWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving a specific alert monitoring threat case.", + "properties" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Event_GetAlertMonitoringThreatCaseWSResponse" : { + "type" : "object", + "description" : "Response object containing a specific alert monitoring threat case.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "firstName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "guestType" : { - "$ref" : "#/components/schemas/GuestTypeEnum" + "threatCase" : { + "$ref" : "#/components/schemas/AlertMonitoringThreatCaseType" }, - "hostUserUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "lastCheckedInMs" : { + } + } + }, + "Event_GetAlertMonitoringThreatCasesWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving alert monitoring threat cases with filtering and pagination options.", + "properties" : { + "afterTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Filter for threat cases after this timestamp", + "example" : 1640995200000, "nullable" : true }, - "lastCheckedOutMs" : { + "beforeTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Filter for threat cases before this timestamp", + "example" : 1641081600000, "nullable" : true }, - "lastName" : { + "deviceFilter" : { + "type" : "array", + "description" : "List of device UUIDs to filter by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, - "locationUuid" : { + "lastTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Last timestamp for pagination", + "example" : 1640995200000, + "nullable" : true + }, + "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "meetingParticipants" : { + "locationFilter" : { "type" : "array", + "description" : "List of location UUIDs to filter by", "items" : { "type" : "string", "format" : "RUUID", @@ -87350,67 +89404,39 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "phoneNumber" : { - "type" : "string", "nullable" : true }, - "postalCode" : { - "type" : "string", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "profileImageUrl" : { - "type" : "string", + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to return", + "example" : 100, "nullable" : true }, - "state" : { - "type" : "string", + "mostRecent" : { + "type" : "boolean", + "description" : "Whether to return only the most recent threat cases", + "example" : true, "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/GuestStatusEnum" - }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true + "statusFilter" : { + "type" : "array", + "description" : "List of threat case statuses to filter by", + "items" : { + "$ref" : "#/components/schemas/ThreatCaseStatusEnum" }, "nullable" : true } } }, - "GuestStatusEnum" : { - "type" : "string", - "enum" : [ "INVITED", "PENDING", "APPROVED", "DENIED" ] - }, - "GuestTypeEnum" : { - "type" : "string", - "enum" : [ "CONTRACTOR", "INTERVIEWER", "GENERAL_VISITOR", "UNPLANNED_VISITOR", "PARTNER", "MEETINGS" ] - }, - "Guestmanagement_ActivateKioskWSRequest" : { - "type" : "object", - "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Guestmanagement_ActivateKioskWSResponse" : { + "Event_GetAlertMonitoringThreatCasesWSResponse" : { "type" : "object", + "description" : "Response object containing alert monitoring threat cases with pagination information.", "properties" : { "error" : { "type" : "boolean", @@ -87420,41 +89446,45 @@ "type" : "string", "nullable" : true }, - "redirectUrl" : { + "lastEvaluatedKey" : { "type" : "string", "nullable" : true }, + "threatCases" : { + "type" : "array", + "description" : "List of threat cases matching the request criteria", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringThreatCaseType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Guestmanagement_BaseGuestManagementWSRequest" : { - "type" : "object", - "description" : "Base request object for guest management operations." - }, - "Guestmanagement_CreateGuestInviteWSRequest" : { + "Event_GetClipWithProgressWSRequest" : { "type" : "object", - "description" : "Request object for creating a guest invite.", + "description" : "Request object for retrieving a specific clip with progress information.", "properties" : { - "guestInvite" : { - "$ref" : "#/components/schemas/GuestInvite" + "clipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } }, - "required" : [ "guestInvite" ] - }, - "Guestmanagement_CreateGuestManagementSettingsWSRequest" : { - "type" : "object", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/GuestManagementOrgSettings" - } - } + "required" : [ "clipUuid" ] }, - "Guestmanagement_CreateGuestManagementSettingsWSResponse" : { + "Event_GetClipWithProgressWSResponse" : { "type" : "object", + "description" : "Response object containing a specific clip with progress information.", "properties" : { + "clip" : { + "$ref" : "#/components/schemas/Event_SavedClipWithProgressType" + }, "error" : { "type" : "boolean", "nullable" : true @@ -87469,48 +89499,37 @@ } } }, - "Guestmanagement_CreateGuestWSRequest" : { - "type" : "object", - "description" : "Request object for creating a guest with optional file attachment.", - "properties" : { - "fileName" : { - "type" : "string", - "description" : "Optional file name for guest attachment", - "example" : "guest_photo.jpg", - "nullable" : true - }, - "guest" : { - "$ref" : "#/components/schemas/Guest" - } - } - }, - "Guestmanagement_ExportGuestActivitiesWSRequest" : { + "Event_GetClipsWithProgressWSRequest" : { "type" : "object", + "description" : "Request object for retrieving clips with progress information and filtering options.", "properties" : { - "beginTimeMs" : { - "type" : "integer", - "format" : "int64", + "deviceUuidFilters" : { + "type" : "array", + "description" : "Device uuids to filter clips by.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "email" : { - "type" : "string", + "excludeAlertMonitoringClips" : { + "type" : "boolean", + "default" : false, + "description" : "Filter to exclude clips created for alarm monitoring verification.", "nullable" : true }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", + "filterByPrivate" : { + "type" : "boolean", + "default" : false, + "description" : "Filter to only include private clips in the result.", "nullable" : true }, - "includeGuestTypes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GuestTypeEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "includeLocations" : { + "locationUuidFilters" : { "type" : "array", + "description" : "Location uuids to filter clips by.", "items" : { "type" : "string", "format" : "RUUID", @@ -87518,83 +89537,119 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Guestmanagement_ExportGuestsWSRequest" : { - "type" : "object", - "properties" : { - "beginTimeMs" : { + "nullable" : true + }, + "pageSize" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Page size", + "maximum" : 200, + "minimum" : 1, + "nullable" : true + }, + "pageToken" : { + "type" : "string", + "description" : "Page token received from the previous search request.", + "example" : "next_page_token_123", + "nullable" : true + }, + "searchFilter" : { + "type" : "string", + "description" : "Search filter for clips", + "example" : "motion detected", + "nullable" : true + }, + "sortField" : { + "type" : "string", + "description" : "Field to sort clips by", + "example" : "timestamp", + "nullable" : true + }, + "sortOrder" : { + "type" : "string", + "description" : "Sort order (asc or desc)", + "example" : "desc", + "nullable" : true + }, + "timestampFilterField" : { + "type" : "string", + "description" : "Timestamp to filter clips by (either clip creation date or clip footage date).", + "nullable" : true + }, + "timestampMsAfter" : { "type" : "integer", "format" : "int64", + "description" : "Timestamp to find clips after this time.", + "example" : 1640995200000, "nullable" : true }, - "endTimeMs" : { + "timestampMsBefore" : { "type" : "integer", "format" : "int64", + "description" : "Timestamp to find clips before this time", + "example" : 1641081600000, + "nullable" : true + } + }, + "required" : [ "pageSize" ] + }, + "Event_GetClipsWithProgressWSResponse" : { + "type" : "object", + "description" : "Response object containing clips with progress information.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "includeGuestTypes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GuestTypeEnum" - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "includeLocations" : { + "pageToken" : { + "type" : "string", + "description" : "Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.", + "nullable" : true + }, + "savedClips" : { "type" : "array", + "description" : "List of saved clips with progress information", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/Event_SavedClipWithProgressType" }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Guestmanagement_GetActivityLogsForGuestWSRequest" : { - "type" : "object", - "properties" : { - "email" : { + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Guestmanagement_GetActivityLogsForLocationWSRequest" : { + "Event_GetExpiringPolicyAlertsWSRequest" : { "type" : "object", + "description" : "Request object for retrieving expiring policy alerts.", "properties" : { - "createdAfterMs" : { + "expiresBeforeMs" : { "type" : "integer", "format" : "int64", + "description" : "Epoch timestamp in milliseconds. Used to find policy alerts that expire before this timestamp.\n", "nullable" : true }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", + "lastEvaluatedKey" : { + "type" : "string", "nullable" : true }, - "dynamoPageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "maxPageSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true } - } + }, + "required" : [ "expiresBeforeMs" ] }, - "Guestmanagement_GetAllGuestInvitesWSResponse" : { + "Event_GetExpiringPolicyAlertsWSResponse" : { "type" : "object", - "description" : "Response object containing all guest invites.", + "description" : "Response object containing a list of expiring policy alerts.", "properties" : { "error" : { "type" : "boolean", @@ -87604,11 +89659,16 @@ "type" : "string", "nullable" : true }, - "guestInvites" : { + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Key used to resume pagination, if applicable", + "nullable" : true + }, + "policyAlerts" : { "type" : "array", - "description" : "List of all guest invites", + "description" : "List of expiring policy alerts", "items" : { - "$ref" : "#/components/schemas/GuestInvite" + "$ref" : "#/components/schemas/BasePolicyAlertType" }, "nullable" : true }, @@ -87618,15 +89678,23 @@ } } }, - "Guestmanagement_GetAllGuestsWSResponse" : { + "Event_GetMotionGridCountsWSResponse" : { "type" : "object", - "description" : "Response object containing all guests.", + "description" : "Response object containing motion grid counts for a device.", "properties" : { - "allGuests" : { + "countGrid" : { "type" : "array", - "description" : "List of all guests", + "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", "items" : { - "$ref" : "#/components/schemas/Guest" + "type" : "array", + "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Matrix where each cell is a fraction of the camera's resolution and stores the total number of motion events that occurred in the given timeframe", + "nullable" : true + }, + "nullable" : true }, "nullable" : true }, @@ -87644,26 +89712,37 @@ } } }, - "Guestmanagement_GetGuestActivityLogsWSRequest" : { + "Event_GetMotionGridWSRequest" : { "type" : "object", + "description" : "Request object for retrieving motion grid data for a device.", "properties" : { - "createdAfterMs" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "endTimeUtcSecs" : { "type" : "integer", "format" : "int64", + "description" : "End time as a UNIX timestamp in seconds", + "example" : 1641081600, "nullable" : true }, - "createdBeforeMs" : { + "startTimeUtcSecs" : { "type" : "integer", "format" : "int64", + "description" : "Start time as a UNIX timestamp in seconds", + "example" : 1640995200, "nullable" : true - }, - "dynamoPageRequest" : { - "$ref" : "#/components/schemas/DynamoPageRequest" } - } + }, + "required" : [ "deviceUuid", "endTimeUtcSecs", "startTimeUtcSecs" ] }, - "Guestmanagement_GetGuestActivityLogsWSResponse" : { + "Event_GetMotionGridWSResponse" : { "type" : "object", + "description" : "Response object containing motion grid data for a device.", "properties" : { "error" : { "type" : "boolean", @@ -87673,11 +89752,17 @@ "type" : "string", "nullable" : true }, - "guestActivities" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GuestActivityLog" + "motionCells" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of timestamps to motion grid cells", + "items" : { + "$ref" : "#/components/schemas/Event_FrontendCell" + }, + "nullable" : true }, + "description" : "Map of timestamps to motion grid cells", "nullable" : true }, "warningMsg" : { @@ -87686,10 +89771,30 @@ } } }, - "Guestmanagement_GetGuestInviteWSResponse" : { + "Event_GetPolicyAlertCountWSRequest" : { "type" : "object", - "description" : "Response object containing guest invite information.", + "description" : "Request object for retrieving the count of policy alerts.", + "properties" : { + "maxResultsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to count", + "example" : 1000, + "nullable" : true + } + } + }, + "Event_GetPolicyAlertCountWSResponse" : { + "type" : "object", + "description" : "Response object containing the count of policy alerts.", "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Count of policy alerts", + "example" : 42, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -87698,18 +89803,28 @@ "type" : "string", "nullable" : true }, - "guestInvite" : { - "$ref" : "#/components/schemas/GuestInvite" - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Guestmanagement_GetGuestInvitesWSResponse" : { + "Event_GetPolicyAlertDetailsWSRequest" : { "type" : "object", - "description" : "Response object containing guest invites.", + "description" : "Request object for retrieving detailed information about a policy alert.", + "properties" : { + "policyAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Event_GetPolicyAlertDetailsWSResponse" : { + "type" : "object", + "description" : "Response object containing detailed information about a policy alert.", "properties" : { "error" : { "type" : "boolean", @@ -87719,13 +89834,8 @@ "type" : "string", "nullable" : true }, - "guestInvites" : { - "type" : "array", - "description" : "List of guest invites", - "items" : { - "$ref" : "#/components/schemas/GuestInvite" - }, - "nullable" : true + "policyAlert" : { + "$ref" : "#/components/schemas/PolicyAlertWithDetailsType" }, "warningMsg" : { "type" : "string", @@ -87733,29 +89843,43 @@ } } }, - "Guestmanagement_GetGuestManagementSettingsWSResponse" : { + "Event_GetPolicyAlertGroupsForDeviceWSRequest" : { "type" : "object", + "description" : "Request object for retrieving policy alert groups for a specific device.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "settings" : { - "$ref" : "#/components/schemas/GuestManagementOrgSettings" + "lastTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Last timestamp for pagination (required with LastUuid)", + "example" : 1640995200000, + "nullable" : true }, - "warningMsg" : { + "lastUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to return", + "example" : 100, "nullable" : true } } }, - "Guestmanagement_GetGuestWSResponse" : { + "Event_GetPolicyAlertGroupsForDeviceWSResponse" : { "type" : "object", - "description" : "Response object containing guest information.", + "description" : "Response object containing policy alert groups for a specific device.", "properties" : { "error" : { "type" : "boolean", @@ -87765,8 +89889,13 @@ "type" : "string", "nullable" : true }, - "guest" : { - "$ref" : "#/components/schemas/Guest" + "policyAlertGroups" : { + "type" : "array", + "description" : "List of policy alert groups for the device", + "items" : { + "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" + }, + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -87774,46 +89903,43 @@ } } }, - "Guestmanagement_GetInvitesForOrgWSRequest" : { + "Event_GetPolicyAlertGroupsForLocationWSRequest" : { "type" : "object", + "description" : "Request object for retrieving policy alert groups for a specific location.", "properties" : { - "invitedAfterMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "invitedBeforeMs" : { + "lastTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Last timestamp for pagination", + "example" : 1640995200000, "nullable" : true }, - "paginateRequest" : { - "$ref" : "#/components/schemas/PaginateRequest" - } - } - }, - "Guestmanagement_GetKioskInfoWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", + "lastUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "kiosk" : { - "$ref" : "#/components/schemas/Kiosk" - }, - "warningMsg" : { - "type" : "string", + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to return", + "example" : 100, "nullable" : true } } }, - "Guestmanagement_GetKiosksForOrgWSResponse" : { + "Event_GetPolicyAlertGroupsForLocationWSResponse" : { "type" : "object", + "description" : "Response object containing policy alert groups for a specific location.", "properties" : { "error" : { "type" : "boolean", @@ -87823,10 +89949,11 @@ "type" : "string", "nullable" : true }, - "kiosks" : { + "policyAlertGroups" : { "type" : "array", + "description" : "List of policy alert groups for the location", "items" : { - "$ref" : "#/components/schemas/Kiosk" + "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" }, "nullable" : true }, @@ -87836,25 +89963,37 @@ } } }, - "Guestmanagement_GetNametagTemplateForGuestWSRequest" : { + "Event_GetPolicyAlertGroupsV2WSRequest" : { "type" : "object", + "description" : "Request object for retrieving policy alert groups V2 with pagination options.", "properties" : { - "email" : { + "lastTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Last timestamp for pagination", + "example" : 1640995200000, + "nullable" : true + }, + "lastUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to return", + "example" : 100, "nullable" : true } } }, - "Guestmanagement_GetNametagTemplateForGuestWSResponse" : { + "Event_GetPolicyAlertGroupsV2WSResponse" : { "type" : "object", + "description" : "Response object containing policy alert groups V2.", "properties" : { - "badgeTemplate" : { - "$ref" : "#/components/schemas/BadgeTemplate" - }, - "companyLogoUrl" : { - "type" : "string", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -87863,100 +90002,70 @@ "type" : "string", "nullable" : true }, + "policyAlertGroups" : { + "type" : "array", + "description" : "List of policy alert groups V2", + "items" : { + "$ref" : "#/components/schemas/Event_PolicyAlertGroupV2" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Guestmanagement_GuestByEmailWSRequest" : { + "Event_GetPolicyAlertV2WSRequest" : { "type" : "object", - "description" : "Request object for finding a guest by email address.", + "description" : "Request object for retrieving a specific policy alert V2.", "properties" : { - "email" : { + "policyAlertUuid" : { "type" : "string", - "description" : "Email address of the guest to find", - "example" : "guest@example.com", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Guestmanagement_GuestCheckinWSRequest" : { + "Event_GetPolicyAlertV2WSResponse" : { "type" : "object", - "description" : "Request object for guest check-in operations.", + "description" : "Response object containing a specific policy alert V2.", "properties" : { - "email" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "description" : "Email address of the guest checking in", - "example" : "guest@example.com", "nullable" : true }, - "locationUuid" : { + "policyAlert" : { + "$ref" : "#/components/schemas/PolicyAlertV2Type" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "email", "locationUuid" ] + } }, - "Guestmanagement_GuestInviteWSRequest" : { + "Event_GetPolicyAlertWSRequest" : { "type" : "object", - "description" : "Request object for guest invite operations.", + "description" : "Request object for retrieving a specific policy alert.", "properties" : { - "uuid" : { + "policyAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "uuid" ] - }, - "Guestmanagement_GuestInvitesByEmailWSRequest" : { - "type" : "object", - "description" : "Request object for finding guest invites by email address.", - "properties" : { - "email" : { - "type" : "string", - "description" : "Email of the guest to invite", - "example" : "guest@example.com", - "nullable" : true - } - }, - "required" : [ "email" ] - }, - "Guestmanagement_GuestWSRequest" : { - "type" : "object", - "description" : "Request object containing guest information.", - "properties" : { - "guest" : { - "$ref" : "#/components/schemas/Guest" - } - } - }, - "Guestmanagement_UpdateGuestInviteWSRequest" : { - "type" : "object", - "description" : "Request object for updating guest invite information.", - "properties" : { - "inviteUpdate" : { - "$ref" : "#/components/schemas/GuestInviteSelectiveUpdateByInvocation" - } - }, - "required" : [ "inviteUpdate" ] - }, - "Guestmanagement_UpdateGuestManagementSettingsWSRequest" : { - "type" : "object", - "properties" : { - "settingsUpdate" : { - "$ref" : "#/components/schemas/GuestManagementSettingsSelectiveUpdate" - } } }, - "Guestmanagement_UpdateGuestManagementSettingsWSResponse" : { + "Event_GetPolicyAlertWSResponse" : { "type" : "object", + "description" : "Response object containing a specific policy alert.", "properties" : { "error" : { "type" : "boolean", @@ -87966,306 +90075,459 @@ "type" : "string", "nullable" : true }, + "policyAlert" : { + "$ref" : "#/components/schemas/BasePolicyAlertType" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Guestmanagement_UpdateGuestWSRequest" : { + "Event_GetPolicyAlertsV2WSRequest" : { "type" : "object", - "description" : "Request object for updating guest information.", + "description" : "Request object for retrieving policy alerts V2 with filtering and pagination options.", "properties" : { - "fileName" : { - "type" : "string", - "description" : "File name for guest-related data", - "example" : "guest_data.csv", + "afterTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter for alerts after this timestamp", + "example" : 1640995200000, "nullable" : true }, - "guest" : { - "$ref" : "#/components/schemas/Guest" - }, - "guestUpdate" : { - "$ref" : "#/components/schemas/GuestSelectiveUpdateByInvocation" - } - } - }, - "HaloSettings" : { - "type" : "object", - "properties" : { - "alertAgression" : { - "type" : "boolean", + "beforeTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter for alerts before this timestamp", + "example" : 1641081600000, "nullable" : true }, - "alertCO" : { - "type" : "boolean", + "deviceFilter" : { + "type" : "array", + "description" : "List of device UUIDs to filter by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "alertCO2" : { - "type" : "boolean", + "lastTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Last timestamp for pagination", + "example" : 1640995200000, "nullable" : true }, - "alertGunshot" : { - "type" : "boolean", + "lastUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "alertHelp" : { - "type" : "boolean", + "locationFilter" : { + "type" : "array", + "description" : "List of location UUIDs to filter by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "alertMasking" : { - "type" : "boolean", + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of results to return", + "example" : 100, "nullable" : true - }, - "alertTHC" : { + } + } + }, + "Event_GetPolicyAlertsV2WSResponse" : { + "type" : "object", + "description" : "Response object containing policy alerts V2 with filtering and pagination options.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "alertTamper" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "alertTemp" : { - "type" : "boolean", - "nullable" : true + "oldestPolicyAlert" : { + "$ref" : "#/components/schemas/PolicyAlertV2Type" }, - "alertVOC" : { - "type" : "boolean", + "policyAlerts" : { + "type" : "array", + "description" : "List of policy alerts V2 matching the request criteria", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertV2Type" + }, "nullable" : true }, - "alertVape" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_GetPolicyAlertsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving policy alerts with filtering and pagination options.", + "properties" : { + "accessControlledDoorFilter" : { + "type" : "array", + "description" : "Filter including chosen Access Controlled Doors", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "enabled" : { - "type" : "boolean", + "afterTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Enter starting timestamp interval in UNIX ms", + "example" : 1640995200000, "nullable" : true }, - "enabledTimestampMs" : { + "beforeTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Enter ending timestamp interval in UNIX ms", + "example" : 1641081600000, "nullable" : true }, - "enablingUser" : { - "type" : "string", + "deviceFilter" : { + "type" : "array", + "description" : "Filter including chosen Devices", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "enablingUserUuid" : { + "lastTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Search with last known TimestampMs (Required for Pagination)", + "example" : 1640995200000, + "nullable" : true + }, + "lastUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "locationFilter" : { + "type" : "array", + "description" : "Filter any locations you would like to include", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "savedClipDurationMs" : { + "maxResults" : { "type" : "integer", "format" : "int32", + "description" : "Set a max result limit", + "example" : 100, + "nullable" : true + } + } + }, + "Event_GetPolicyAlertsWSResponse" : { + "type" : "object", + "description" : "Response object containing a list of policy alerts.", + "nullable" : true, + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "sensorName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "sensorToCamerasMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "policyAlerts" : { + "type" : "array", + "description" : "List of policy alerts matching the request criteria", + "items" : { + "$ref" : "#/components/schemas/BasePolicyAlertType" }, "nullable" : true }, - "triggerNotification" : { - "type" : "boolean", - "nullable" : true - }, - "url" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "HardwareInvoiceSubItem" : { + "Event_GetSavedClipCountWSRequest" : { "type" : "object", + "description" : "Request object for retrieving the count of saved clips with filtering options.", "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", + "deviceFilter" : { + "type" : "array", + "description" : "List of device UUIDs to filter clips by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "description" : { - "type" : "string", + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for filtering clips", + "example" : 1641081600000, "nullable" : true }, - "price" : { - "type" : "number", - "format" : "float", - "nullable" : true + "locationFilter" : { + "type" : "array", + "description" : "List of location UUIDs to filter clips by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for filtering clips", + "example" : 1640995200000, + "nullable" : true } } }, - "HardwareType" : { + "Event_GetSavedClipCountWSResponse" : { "type" : "object", + "description" : "Response object containing the count of saved clips.", "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "enforcedMinFirmwareVersion" : { - "type" : "string", - "nullable" : true - }, - "firmwareUpdateTimeMs" : { + "count" : { "type" : "integer", "format" : "int64", + "description" : "Count of org-wide saved clips matching the filter criteria", + "example" : 42, "nullable" : true }, - "firmwareVersion" : { - "type" : "string", - "nullable" : true - }, - "hwSupportDomain" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "mac" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "manufacturedAtMillis" : { + "privateCount" : { "type" : "integer", "format" : "int64", + "description" : "Count of private saved clips matching the filter criteria", + "example" : 10, "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pendingRegistrationDeviceUuid" : { + } + } + }, + "Event_GetSavedClipDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving detailed information about a saved clip.", + "properties" : { + "clipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Event_GetSavedClipDetailsWSResponse" : { + "type" : "object", + "description" : "Response object containing detailed information about a saved clip.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "pendingRegistrationOrgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pendingRegistrationToken" : { + "savedClip" : { + "$ref" : "#/components/schemas/SavedClipWithDetailsType" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "sdSize" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Event_GetSavedClipsByExternalTransactionIdWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving saved clips by external transaction ID.", + "properties" : { + "externalTransactionId" : { + "type" : "string", + "description" : "External transaction ID to search for saved clips", + "example" : "txn_123456789", + "nullable" : true + } + } + }, + "Event_GetSavedClipsByExternalTransactionIdWSResponse" : { + "type" : "object", + "description" : "Response object containing saved clips by external transaction ID.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "serialNumber" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "savedClips" : { + "type" : "array", + "description" : "List of saved clips matching the external transaction ID", + "items" : { + "$ref" : "#/components/schemas/SavedClipV2Type" + }, + "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "HardwareVariationEnum" : { - "type" : "string", - "enum" : [ "RASPBERRY_PI_3", "CAMERA_R1", "CAMERA_R2", "CAMERA_R2_LONG_RANGE", "CAMERA_R2_180", "CAMERA_R3", "CAMERA_R4", "CAMERA_R100", "CAMERA_R120", "CAMERA_R170", "CAMERA_R200", "CAMERA_R500", "CAMERA_R510", "CAMERA_R520", "CAMERA_R600", "SENSOR_ASSET_TAG_T1", "SENSOR_DOOR_D1", "SENSOR_DOOR_D20", "SENSOR_ENVIRONMENTAL_E1", "SENSOR_ENVIRONMENTAL_E15", "SENSOR_ENVIRONMENTAL_E2", "SENSOR_MOTION_M1", "SENSOR_MOTION_M15", "GATEWAY_A1", "GATEWAY_A100", "GATEWAY_ENVIRONMENTAL_E50", "CAMERA_R220", "CAMERA_R230", "CAMERA_R36S", "CAMERA_R410", "CAMERA_R540", "CAMERA_R545", "BADGE_READER_DR1", "BADGE_READER_DR40", "BADGE_READER_DR20", "DOOR_CONTROLLER_DC1", "DOOR_CONTROLLER_DC20", "DOOR_CONTROLLER_DC10", "ETHERNET_TESTER_ET1", "IO_BOARD_TB1", "BLE_BUTTON_B10", "BLE_BUTTON_B15", "CAMERA_THIRD_PARTY_RELAY", "CAMERA_THIRD_PARTY_NVR", "NVR_N100", "CAMERA_R130", "NVR_N500", "CAMERA_R150", "ROBOT_RC1", "CAMERA_R210", "CAMERA_R650", "UNSPECIFIED" ] - }, - "HeatIndexRangeWarningEnum" : { - "type" : "string", - "description" : "Heat index range warning status", - "enum" : [ "HEAT_INDEX_OK", "HEAT_INDEX_WARNING", "HEAT_INDEX_UNSUPPORTED" ] + "Event_GetSavedClipsV2WSRequest" : { + "type" : "object", + "description" : "Request object for retrieving saved clips with pagination.", + "properties" : { + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Set max results returned. Note: in future this will be defaulted to 100", + "example" : 100, + "nullable" : true + }, + "pageTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp start to specify page of up to 100 saved clips", + "example" : 1640995200000, + "nullable" : true + } + } }, - "Help_CreateTicketWSRequest" : { + "Event_GetSavedClipsV2WSResponse" : { "type" : "object", - "description" : "Request object for creating a support ticket.", + "description" : "Response object containing saved clips with pagination.", "properties" : { - "body" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "description" : "Body content of the support ticket", - "example" : "My camera is not connecting to the network properly.", "nullable" : true }, - "collaborators" : { + "lastEvaluatedTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the last evaluated clip for pagination", + "nullable" : true + }, + "savedClips" : { "type" : "array", - "description" : "List of collaborator email addresses", + "description" : "List of saved clips", "items" : { - "type" : "string", - "description" : "List of collaborator email addresses", - "nullable" : true + "$ref" : "#/components/schemas/SavedClipV2Type" }, "nullable" : true }, - "consoleAccessGranted" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_GetSavedClipsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving saved clips (deprecated)." + }, + "Event_GetSavedClipsWSResponse" : { + "type" : "object", + "description" : "Response object containing saved clips (deprecated).", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether console access has been granted for troubleshooting", - "example" : true, "nullable" : true }, - "productType" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "serialNumbers" : { + "savedClips" : { "type" : "array", - "description" : "List of device serial numbers related to the issue", + "description" : "List of saved clips", "items" : { - "type" : "string", - "description" : "List of device serial numbers related to the issue", - "nullable" : true + "$ref" : "#/components/schemas/SavedClipV2Type" }, "nullable" : true }, - "serviceType" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "subject" : { + } + } + }, + "Event_GetSharedClipGroupDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving detailed information about a shared clip group.", + "properties" : { + "uuid" : { "type" : "string", - "description" : "Subject of the support ticket", - "example" : "Camera connectivity issue", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Help_CreateTicketWSResponse" : { + "Event_GetSharedClipGroupDetailsWSResponse" : { "type" : "object", - "description" : "Response object for creating a support ticket.", + "description" : "Response object containing detailed information about a shared clip group.", "properties" : { "error" : { "type" : "boolean", @@ -88275,24 +90537,8 @@ "type" : "string", "nullable" : true }, - "failureReason" : { - "type" : "string", - "description" : "Reason for failure if ticket creation was unsuccessful", - "example" : "Invalid email address", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Whether the ticket creation was successful", - "example" : true, - "nullable" : true - }, - "ticketId" : { - "type" : "integer", - "format" : "int32", - "description" : "ID of the created support ticket", - "example" : 12345, - "nullable" : true + "sharedClipGroup" : { + "$ref" : "#/components/schemas/SharedClipGroupWithDetailsType" }, "warningMsg" : { "type" : "string", @@ -88300,29 +90546,29 @@ } } }, - "Help_GetOpenTicketsV2WSRequest" : { + "Event_GetSharedClipGroupsV2WSRequest" : { "type" : "object", - "description" : "Request object for retrieving open support tickets V2 with time range filtering.", + "description" : "Request object for retrieving shared clip groups with date filtering.", "properties" : { - "endTimeMs" : { + "createdAfterMs" : { "type" : "integer", "format" : "int64", - "description" : "End time in milliseconds for filtering tickets", - "example" : 1642319999999, + "description" : "Filter for clip groups created after this timestamp", + "example" : 1640995200000, "nullable" : true }, - "startTimeMs" : { + "createdBeforeMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time in milliseconds for filtering tickets", - "example" : 1642233600000, + "description" : "Filter for clip groups created before this timestamp", + "example" : 1641081600000, "nullable" : true } } }, - "Help_GetOpenTicketsV2WSResponse" : { + "Event_GetSharedClipGroupsV2WSResponse" : { "type" : "object", - "description" : "Response object containing open support tickets V2 with organization and user tickets.", + "description" : "Response object containing shared clip groups with date filtering.", "properties" : { "error" : { "type" : "boolean", @@ -88332,19 +90578,11 @@ "type" : "string", "nullable" : true }, - "tickets" : { - "type" : "array", - "description" : "List of organization support tickets", - "items" : { - "$ref" : "#/components/schemas/Help_TicketInformation" - }, - "nullable" : true - }, - "userTickets" : { + "sharedClipGroups" : { "type" : "array", - "description" : "List of user-specific support tickets", + "description" : "List of shared clip groups", "items" : { - "$ref" : "#/components/schemas/Help_TicketInformation" + "$ref" : "#/components/schemas/SharedClipGroupWrapperV2Type" }, "nullable" : true }, @@ -88354,29 +90592,14 @@ } } }, - "Help_GetOpenTicketsWSRequest" : { + "Event_GetSharedClipGroupsWSRequest" : { "type" : "object", - "description" : "Request object for retrieving open support tickets with pagination.", - "properties" : { - "pageNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Page number used for paginated response. If empty, the search will return the first page.", - "nullable" : true - } - } + "description" : "Request object for retrieving shared clip groups (deprecated)." }, - "Help_GetOpenTicketsWSResponse" : { + "Event_GetSharedClipGroupsWSResponse" : { "type" : "object", - "description" : "Response object containing open support tickets with pagination information.", + "description" : "Response object containing shared clip groups (deprecated).", "properties" : { - "currentPage" : { - "type" : "integer", - "format" : "int32", - "description" : "Current page number in the paginated response", - "example" : 1, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -88385,73 +90608,57 @@ "type" : "string", "nullable" : true }, - "hasNexPage" : { - "type" : "boolean", - "description" : "True if there is a next page, false otherwise", - "nullable" : true - }, - "tickets" : { + "sharedClipGroups" : { "type" : "array", - "description" : "List of open support tickets", + "description" : "List of shared clip groups", "items" : { - "$ref" : "#/components/schemas/Help_TicketInformation" + "$ref" : "#/components/schemas/SharedClipGroupWrapperType" }, "nullable" : true }, - "totalTickets" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of tickets, not limited to the current page", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Help_ProcessRMAWSRequest" : { + "Event_GetSplicedClipsInProgressWSRequest" : { "type" : "object", - "description" : "Request object for processing a Return Merchandise Authorization (RMA).", + "description" : "Request object for retrieving spliced clips in progress (deprecated)." + }, + "Event_GetSplicedClipsInProgressWSResponse" : { + "type" : "object", + "description" : "Response object containing spliced clips in progress (deprecated).", "properties" : { - "contactName" : { - "type" : "string", - "description" : "Contact name for the RMA", - "example" : "John Doe", - "nullable" : true - }, - "contactPhoneNumber" : { - "type" : "string", - "description" : "Contact phone number for the RMA", - "example" : "+1-555-123-4567", + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceName" : { + "errorMsg" : { "type" : "string", - "description" : "Name of the device for RMA", - "example" : "Rhombus Camera Pro", "nullable" : true }, - "problem" : { - "type" : "string", - "description" : "Description of the problem with the device", - "example" : "Camera not recording properly", + "splicedClips" : { + "type" : "array", + "description" : "List of spliced clips currently in progress", + "items" : { + "$ref" : "#/components/schemas/SplicedClipType" + }, "nullable" : true }, - "returnShippingAddress" : { - "$ref" : "#/components/schemas/Help_ShippingAddress" - }, - "serialNumber" : { + "warningMsg" : { "type" : "string", - "description" : "Serial number of the device", - "example" : "RHCAM123456789", "nullable" : true } } }, - "Help_ProcessRMAWSResponse" : { + "Event_GetUnhealthyDeviceAlertsWSRequest" : { "type" : "object", - "description" : "Response object for processing a Return Merchandise Authorization (RMA).", + "description" : "Request object for retrieving unhealthy device alerts." + }, + "Event_GetUnhealthyDeviceAlertsWSResponse" : { + "type" : "object", + "description" : "Response object containing unhealthy device alerts.", "properties" : { "error" : { "type" : "boolean", @@ -88461,23 +90668,12 @@ "type" : "string", "nullable" : true }, - "failureReason" : { - "type" : "string", - "description" : "Reason for failure if RMA processing was unsuccessful", - "example" : "Invalid serial number", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Whether the RMA processing was successful", - "example" : true, - "nullable" : true - }, - "ticketId" : { - "type" : "integer", - "format" : "int32", - "description" : "ID of the RMA ticket created", - "example" : 12345, + "unhealthyDeviceAlerts" : { + "type" : "array", + "description" : "List of unhealthy device alerts", + "items" : { + "$ref" : "#/components/schemas/UnHealthyDeviceAlertType" + }, "nullable" : true }, "warningMsg" : { @@ -88486,21 +90682,29 @@ } } }, - "Help_SendFeedbackWSRequest" : { + "Event_MuteNotificationsForDevicetWSRequest" : { "type" : "object", - "description" : "Request object for sending system feedback.", + "description" : "Request object for muting notifications for a specific device.", "properties" : { - "feedback" : { + "deviceUuid" : { "type" : "string", - "description" : "Feedback message about the system", - "example" : "The new interface is much more user-friendly!", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration to mute notifications in seconds", + "example" : 3600, "nullable" : true } } }, - "Help_SendFeedbackWSResponse" : { + "Event_MuteNotificationsForDevicetWSResponse" : { "type" : "object", - "description" : "Response object for sending system feedback.", + "description" : "Response object for muting notifications for a specific device.", "properties" : { "error" : { "type" : "boolean", @@ -88510,115 +90714,128 @@ "type" : "string", "nullable" : true }, - "failureReason" : { - "type" : "string", - "description" : "Reason for failure if feedback sending was unsuccessful", - "example" : "Invalid feedback content", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Whether the feedback was sent successfully", - "example" : true, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Help_ShippingAddress" : { + "Event_PolicyAlertGroupV2" : { "type" : "object", - "description" : "Shipping address information for RMA returns.", + "description" : "Group of policy alerts V2 with time range information.", "properties" : { - "returnAddressCity" : { - "type" : "string", - "description" : "City for return shipping", - "example" : "San Francisco", + "endTime" : { + "type" : "integer", + "format" : "int64", + "description" : "End time of the alert group (descending chronological order)", + "example" : 1641081600000, "nullable" : true }, - "returnAddressCountry" : { - "type" : "string", - "description" : "Country for return shipping", - "example" : "United States", + "policyAlerts" : { + "type" : "array", + "description" : "List of policy alerts V2 in the group", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertV2Type" + }, "nullable" : true }, - "returnAddressPostalCode" : { - "type" : "string", - "description" : "Postal code for return shipping", - "example" : "94105", + "startTime" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time of the alert group (descending chronological order)", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Event_ReportBadPolicyAlertWSRequest" : { + "type" : "object", + "description" : "Request object for reporting a bad policy alert.", + "properties" : { + "policyAlert" : { + "$ref" : "#/components/schemas/PolicyAlertV2Type" + } + } + }, + "Event_ReportBadPolicyAlertWSResponse" : { + "type" : "object", + "description" : "Response object for reporting a bad policy alert.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "returnAddressState" : { + "errorMsg" : { "type" : "string", - "description" : "State/province for return shipping", - "example" : "CA", "nullable" : true }, - "returnAddressStreet" : { + "warningMsg" : { "type" : "string", - "description" : "Street address for return shipping", - "example" : "123 Main Street", "nullable" : true } } }, - "Help_TicketInformation" : { + "Event_RuuidWrapper" : { "type" : "object", - "description" : "Information about a support ticket.", + "description" : "Wrapper object containing UUIDs for alerts and events.", "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date when the ticket was created", - "example" : "2024-01-15T10:30:00Z", - "nullable" : true - }, - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "Unique identifier for the support ticket", - "example" : 12345, - "nullable" : true - }, - "status" : { + "alertUuid" : { "type" : "string", - "description" : "Current status of the support ticket", - "example" : "Open", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subject" : { + "eventUuid" : { "type" : "string", - "description" : "Subject of the support ticket", - "example" : "Camera connectivity issue", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Help_TriageDeviceWSRequest" : { + "Event_SavePolicyAlertWSRequest" : { "type" : "object", - "description" : "Request object for triaging device connection/recording issues.", + "description" : "Request object for saving a policy alert as a clip.", "properties" : { - "deviceUuid" : { + "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Start date in seconds for triage analysis", - "example" : 1642233600, + "fisheyePresentationMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device UUIDs to dewarped view configurations for fisheye cameras", + "items" : { + "$ref" : "#/components/schemas/DewarpedView" + }, + "nullable" : true + }, + "description" : "Map of device UUIDs to dewarped view configurations for fisheye cameras", + "nullable" : true + }, + "savedClipDescription" : { + "type" : "string", + "description" : "Description for the saved clip", + "example" : "Motion detected at main entrance", + "nullable" : true + }, + "savedClipTitle" : { + "type" : "string", + "description" : "Title for the saved clip", + "example" : "Security Incident - Motion Detected", "nullable" : true } } }, - "Help_TriageDeviceWSResponse" : { + "Event_SavePolicyAlertWSResponse" : { "type" : "object", - "description" : "Response object containing device triage diagnostic information.", + "description" : "Response object for saving a policy alert as a clip.", "properties" : { "error" : { "type" : "boolean", @@ -88628,608 +90845,415 @@ "type" : "string", "nullable" : true }, - "firmwareUpdates" : { - "type" : "array", - "description" : "List of firmware update diagnostic events", - "items" : { - "$ref" : "#/components/schemas/DiagnosticEventType" - }, + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Event_SavedClipWithProgressType" : { + "type" : "object", + "description" : "Saved clip with progress information for processing operations.", + "properties" : { + "accessSettings" : { + "$ref" : "#/components/schemas/ClipAccessSettings" }, - "hardwareFailureEvents" : { - "type" : "array", - "description" : "List of hardware failure diagnostic events", - "items" : { - "$ref" : "#/components/schemas/DiagnosticEventType" + "alterMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlteredView" + }, + "nullable" : true }, "nullable" : true }, - "message" : { - "type" : "string", - "description" : "Triage analysis message", - "example" : "Device appears to be functioning normally", + "analyzed" : { + "type" : "boolean", "nullable" : true }, - "presenceWindows" : { - "type" : "array", - "description" : "List of device presence time windows", - "items" : { - "$ref" : "#/components/schemas/TimeWindowSeconds" - }, + "byteCount" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "suggestedArticles" : { - "type" : "array", - "description" : "List of suggested help articles for the device issue", - "items" : { - "type" : "string", - "description" : "List of suggested help articles for the device issue", - "nullable" : true - }, + "clipLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "clipLocationV2" : { + "type" : "string", "nullable" : true }, - "uptimeWindows" : { - "type" : "array", - "description" : "List of device uptime time windows", - "items" : { - "$ref" : "#/components/schemas/TimeWindowSeconds" - }, + "consoleDelete" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "currentOperation" : { "type" : "string", + "description" : "Current operation being performed on the clip", + "example" : "Processing video", "nullable" : true - } - } - }, - "HttpHeaders" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { + }, + "description" : { "type" : "string", "nullable" : true }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "accept" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/MediaType" + "deviceIntervalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true }, "nullable" : true }, - "acceptCharset" : { + "devicePresentationOrder" : { "type" : "array", "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "registered" : { - "type" : "boolean", - "nullable" : true - } - } + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "acceptLanguage" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "range" : { - "type" : "string", - "nullable" : true - }, - "weight" : { - "type" : "number", - "format" : "double", - "nullable" : true - } - } - }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "acceptLanguageAsLocales" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } + "deviceUuidMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MetaDataLocationType" }, "nullable" : true }, - "acceptPatch" : { + "deviceUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/MediaType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "accessControlAllowCredentials" : { - "type" : "boolean", + "durationSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "accessControlAllowHeaders" : { - "type" : "array", - "items" : { - "type" : "string", + "externalTransactionId" : { + "type" : "string", + "nullable" : true + }, + "fisheyeHardware" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "fisheyeMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DewarpedView" + }, "nullable" : true }, "nullable" : true }, - "accessControlAllowMethods" : { + "integrationUploadList" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/HttpMethod" + "$ref" : "#/components/schemas/IntegrationEnum" }, "nullable" : true }, - "accessControlAllowOrigin" : { - "type" : "string", + "isMonitoringClip" : { + "type" : "boolean", "nullable" : true }, - "accessControlExposeHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "isVendorClip" : { + "type" : "boolean", "nullable" : true }, - "accessControlMaxAge" : { + "lastUpdatedSec" : { "type" : "integer", "format" : "int64", + "description" : "Last update timestamp in seconds", + "example" : 1640995200, "nullable" : true }, - "accessControlRequestHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true + "mountingDirection" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, - "accessControlRequestMethod" : { - "$ref" : "#/components/schemas/HttpMethod" + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "all" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "writeOnly" : true + "percentComplete" : { + "type" : "integer", + "format" : "int32", + "description" : "Percentage of completion for the current operation", + "example" : 75, + "nullable" : true }, - "allow" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "nullable" : true, - "uniqueItems" : true + "placeholder" : { + "type" : "boolean", + "nullable" : true }, - "basicAuth" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true + "sendToSharedStorage" : { + "type" : "boolean", + "nullable" : true }, - "bearerAuth" : { + "sha256Hex" : { "type" : "string", - "nullable" : true, - "writeOnly" : true + "nullable" : true }, - "cacheControl" : { + "sourceAlertUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "connection" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true + "status" : { + "$ref" : "#/components/schemas/ClipStatusEnum" }, - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" }, - "contentLanguage" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true }, - "contentLength" : { + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "contentType" : { - "$ref" : "#/components/schemas/MediaType" + "title" : { + "type" : "string", + "nullable" : true }, - "date" : { - "type" : "integer", - "format" : "int64", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "empty" : { - "type" : "boolean", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "etag" : { + "videoResolution" : { + "$ref" : "#/components/schemas/Resolution" + } + } + }, + "Event_SearchMotionGridWSRequest" : { + "type" : "object", + "description" : "Request object for searching motion grid data.", + "properties" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "expires" : { + "endTimeUtcSecs" : { "type" : "integer", "format" : "int64", + "description" : "End time as a UNIX timestamp in seconds", + "example" : 1641081600, "nullable" : true }, - "host" : { - "type" : "object", - "nullable" : true, - "properties" : { - "address" : { - "type" : "object", - "nullable" : true, - "properties" : { - "address" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "anyLocalAddress" : { - "type" : "boolean", - "nullable" : true - }, - "canonicalHostName" : { - "type" : "string", - "nullable" : true - }, - "hostAddress" : { - "type" : "string", - "nullable" : true - }, - "hostName" : { - "type" : "string", - "nullable" : true - }, - "linkLocalAddress" : { - "type" : "boolean", - "nullable" : true - }, - "loopbackAddress" : { - "type" : "boolean", - "nullable" : true - }, - "mcglobal" : { - "type" : "boolean", - "nullable" : true - }, - "mclinkLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcnodeLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcorgLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcsiteLocal" : { - "type" : "boolean", - "nullable" : true - }, - "multicastAddress" : { - "type" : "boolean", - "nullable" : true - }, - "siteLocalAddress" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "hostName" : { - "type" : "string", - "nullable" : true - }, - "hostString" : { - "type" : "string", - "nullable" : true - }, - "port" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "unresolved" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "ifMatch" : { + "searchCells" : { "type" : "array", + "description" : "List of motion grid cells to include in the search", "items" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, - "ifModifiedSince" : { + "startTimeUtcSecs" : { "type" : "integer", "format" : "int64", + "description" : "Start time as a UNIX timestamp in seconds", + "example" : 1640995200, + "nullable" : true + } + }, + "required" : [ "deviceUuid", "endTimeUtcSecs", "searchCells", "startTimeUtcSecs" ] + }, + "Event_SearchMotionGridWSResponse" : { + "type" : "object", + "description" : "Response object containing motion grid search results.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "ifNoneMatch" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "timeUtcSecsList" : { "type" : "array", + "description" : "List of timestamps where motion was detected in the specified cells", "items" : { - "type" : "string", + "type" : "integer", + "format" : "int64", + "description" : "List of timestamps where motion was detected in the specified cells", "nullable" : true }, "nullable" : true }, - "ifUnmodifiedSince" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastModified" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "location" : { + "warningMsg" : { "type" : "string", - "format" : "uri", "nullable" : true - }, - "origin" : { + } + } + }, + "Event_SearchMotionGridWithActivitiesWSRequest" : { + "type" : "object", + "description" : "Request object for searching motion grid data with activity information.", + "properties" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "pragma" : { - "type" : "string", + "endTimeUtcSecs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time as a UNIX timestamp in seconds", + "example" : 1641081600, "nullable" : true }, - "range" : { + "searchCells" : { "type" : "array", + "description" : "List of motion grid cells to include in the search", "items" : { - "$ref" : "#/components/schemas/HttpRange" + "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, - "upgrade" : { - "type" : "string", - "nullable" : true - }, - "vary" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "startTimeUtcSecs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time as a UNIX timestamp in seconds", + "example" : 1640995200, "nullable" : true } - } - }, - "HttpMethod" : { - "type" : "object" - }, - "HttpRange" : { - "type" : "object" + }, + "required" : [ "deviceUuid", "endTimeUtcSecs", "searchCells", "startTimeUtcSecs" ] }, - "HttpStatusCode" : { + "Event_SearchMotionGridWithActivitiesWSResponse" : { "type" : "object", + "description" : "Response object containing motion grid search results with activity information.", "properties" : { "error" : { "type" : "boolean", "nullable" : true }, - "is1xxInformational" : { - "type" : "boolean", - "nullable" : true - }, - "is2xxSuccessful" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "is3xxRedirection" : { - "type" : "boolean", + "timeUtcSecsToActivityMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity" + }, + "description" : "Map of timestamps to motion grid activities", "nullable" : true }, - "is4xxClientError" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId" : { + "type" : "object", + "description" : "Activity information with object ID.", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "is5xxServerError" : { - "type" : "boolean", + "objectId" : { + "type" : "integer", + "format" : "int32", + "description" : "Object ID associated with the activity", + "example" : 123, "nullable" : true } } }, - "IAperioType" : { + "Event_SearchMotionGridWithActivitiesWSResponse_MotionGridActivity" : { "type" : "object", - "description" : "The updated Aperio integration configuration.", + "description" : "Motion grid activity information for a specific timestamp.", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "activitiesWithId" : { + "type" : "array", + "description" : "List of activities with object IDs", + "items" : { + "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSResponse_ActivityWithId" }, "nullable" : true }, - "orgUuid" : { + "bestTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Best timestamp in milliseconds for the activity", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Event_UnSavePolicyAlertWSRequest" : { + "type" : "object", + "description" : "Request object for unsaving a policy alert (deprecated).", + "properties" : { + "alertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "savedClipUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -89238,1051 +91262,1159 @@ } } }, - "IAudioUserConfig" : { + "Event_UnSavePolicyAlertWSResponse" : { "type" : "object", - "description" : "Audio gateway configuration settings", + "description" : "Response object for unsaving a policy alert (deprecated).", "properties" : { - "ai_license_invalid" : { + "error" : { "type" : "boolean", "nullable" : true }, - "audio_aec_via_software" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audio_ai_disabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_UpdatePolicyAlertTextDescriptionWSRequest" : { + "type" : "object", + "description" : "Request object for updating the text description of a policy alert.", + "properties" : { + "alertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_analysis_enabled" : { + "textDescription" : { + "type" : "string", + "description" : "Text description for the policy alert", + "example" : "Motion detected at main entrance", + "nullable" : true + } + } + }, + "Event_UpdatePolicyAlertTextDescriptionWSResponse" : { + "type" : "object", + "description" : "Response object for updating the text description of a policy alert.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "audio_analysis_params" : { - "$ref" : "#/components/schemas/AudioParamConfig" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "audio_external_mic_boost" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Event_UpdateSavedClipWSRequest" : { + "type" : "object", + "description" : "Request object for updating a saved clip.", + "properties" : { + "accessSettings" : { + "$ref" : "#/components/schemas/ClipAccessSettings" }, - "audio_external_mic_volume" : { - "type" : "integer", - "format" : "int32", + "description" : { + "type" : "string", + "description" : "Updated description for the saved clip", + "example" : "Updated description of the security incident", "nullable" : true }, - "audio_external_speaker_volume" : { - "type" : "integer", - "format" : "int32", + "savedClipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_internal_mic_aec_enabled" : { + "title" : { + "type" : "string", + "description" : "Updated title for the saved clip", + "example" : "Updated Security Incident", + "nullable" : true + } + }, + "required" : [ "savedClipUuid" ] + }, + "Event_UpdateSavedClipWSResponse" : { + "type" : "object", + "description" : "Response object for updating a saved clip.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "audio_internal_mic_boost" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audio_internal_mic_volume" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "audio_internal_speaker_volume" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Event_UpdateSharedClipGroupWSRequest" : { + "type" : "object", + "description" : "Request object for updating a shared clip group.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description for the shared clip group", + "example" : "Updated description of the security incident", "nullable" : true }, - "audio_min_echo_amplitude" : { + "expirationTimeSecs" : { "type" : "integer", "format" : "int32", - "nullable" : true + "nullable" : true, + "writeOnly" : true }, - "audio_playback_gain_percent" : { - "type" : "integer", - "format" : "int32", + "plaintextPassword" : { + "type" : "string", + "description" : "Password for accessing the shared clip group", + "example" : "newpassword123", "nullable" : true }, - "audio_record" : { - "type" : "boolean", + "sharedClipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audio_supported" : { - "type" : "boolean", + "title" : { + "type" : "string", + "description" : "Title for the shared clip group", + "example" : "Updated Security Incident", "nullable" : true - }, - "audio_use_external_mic" : { + } + } + }, + "Event_UpdateSharedClipGroupWSResponse" : { + "type" : "object", + "description" : "Response object for updating a shared clip group.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "audio_use_external_speaker" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "audio_use_internal_speaker" : { - "type" : "boolean", + "shareUrl" : { + "type" : "string", + "description" : "URL for accessing the updated shared clip group", + "example" : "https://share.rhombus.com/clips/abc123", "nullable" : true }, - "bandwidth_reports_disabled" : { - "type" : "boolean", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "cloud_archive_days" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_groups_CreateClipGroupWSRequest" : { + "type" : "object", + "description" : "Request object for creating a clip group.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description for the clip group", + "example" : "Motion detected at main entrance", "nullable" : true }, - "cloud_archive_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" + "title" : { + "type" : "string", + "description" : "Title for the clip group", + "example" : "Security Incident - Main Entrance", + "nullable" : true }, - "cloud_archive_upload_schedule" : { + "uuids" : { "type" : "array", + "description" : "List of UUIDs for clips to include in the group", "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" + "$ref" : "#/components/schemas/Event_RuuidWrapper" }, "nullable" : true - }, - "cloud_archive_upload_schedule_inverted" : { + } + } + }, + "Event_groups_CreateClipGroupWSResponse" : { + "type" : "object", + "description" : "Response object for creating a clip group.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "cloud_archive_upload_schedule_uuid" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_groups_DeleteClipGroupWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a clip group.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "device_mic_enabled" : { + } + } + }, + "Event_groups_DeleteClipGroupWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a clip group.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "device_near_audio_silenced" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "device_speaker_enabled" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_groups_GetClipGroupDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving detailed information about a clip group.", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Event_groups_GetClipGroupDetailsWSResponse" : { + "type" : "object", + "description" : "Response object containing detailed information about a clip group.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "event_clip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "firmware_dev_settings" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "frontendEqualizerHighShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerLowShelf" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking1" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking2" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" - }, - "frontendEqualizerPeaking3" : { - "$ref" : "#/components/schemas/FrontendEqualizerSettings" + "group" : { + "$ref" : "#/components/schemas/ClipGroupWithDetailsType" }, - "frontendNoiseSuppression" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "lastModified" : { + } + } + }, + "Event_groups_GetClipGroupsForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving clip groups for an organization with date filtering.", + "properties" : { + "createdAfterMs" : { "type" : "integer", "format" : "int64", + "description" : "Filter for clip groups created after this timestamp", + "example" : 1640995200000, "nullable" : true }, - "led_mode_blink_period_ms" : { + "createdBeforeMs" : { "type" : "integer", "format" : "int64", + "description" : "Filter for clip groups created before this timestamp", + "example" : 1641081600000, "nullable" : true - }, - "led_mode_when_active" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_mode_when_inactive" : { - "$ref" : "#/components/schemas/LEDModeEnum" - }, - "led_stealth_mode" : { + } + } + }, + "Event_groups_GetClipGroupsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing clip groups for an organization.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "lightweight_detection_disabled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "live_license_invalid" : { - "type" : "boolean", + "groups" : { + "type" : "array", + "description" : "List of clip groups for the organization", + "items" : { + "$ref" : "#/components/schemas/ClipGroupType" + }, "nullable" : true }, - "max_event_duration_ms" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "media_ttl_minutes" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Event_groups_UpdateClipGroupWSRequest" : { + "type" : "object", + "description" : "Request object for updating a clip group.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description for the clip group", + "example" : "Updated description of the security incident", "nullable" : true }, - "on_demand_license_invalid" : { - "type" : "boolean", + "title" : { + "type" : "string", + "description" : "Title for the clip group", + "example" : "Updated Security Incident", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "snapshot_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "splice_clip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" - }, - "storage_target_free_megabytes" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "storage_target_free_space_permyriad" : { - "type" : "integer", - "format" : "int32", + "uuids" : { + "type" : "array", + "description" : "List of UUIDs for clips to include in the group", + "items" : { + "$ref" : "#/components/schemas/Event_RuuidWrapper" + }, "nullable" : true - }, - "thumbstrip_upload_target" : { - "$ref" : "#/components/schemas/UploadTargetEnum" } } }, - "IAvigilonAltaType" : { + "Event_groups_UpdateClipGroupWSResponse" : { "type" : "object", - "description" : "Avigilon Alta V2 integration settings to update", + "description" : "Response object for updating a clip group.", "properties" : { - "alertUnauthorizedFaces" : { + "error" : { "type" : "boolean", "nullable" : true }, - "apiToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + } + } + }, + "Event_incident_AddThreatCaseActionTimelineEntriesWSRequest" : { + "type" : "object", + "description" : "Request object for adding threat case action entries to a report's timeline.", + "properties" : { + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "doorToCameraMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, + } + }, + "required" : [ "reportUuid" ] + }, + "Event_incident_AddThreatCaseActionTimelineEntriesWSResponse" : { + "type" : "object", + "description" : "Response object for adding threat case action entries to a report's timeline.", + "properties" : { + "addedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "How many entries were added. Entries already on the timeline are not added again.", "nullable" : true }, - "doorsValidated" : { + "error" : { "type" : "boolean", "nullable" : true }, - "email" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "eventToWebhookIdMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "eventToWebhookMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/WebhookMapEntry" - }, + } + } + }, + "Event_incident_CreateClipTimelineEntryWSRequest" : { + "type" : "object", + "description" : "Request object for creating an incident report timeline entry from a saved clip.", + "properties" : { + "clipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "indexFaces" : { + } + }, + "required" : [ "clipUuid", "reportUuid" ] + }, + "Event_incident_CreateClipTimelineEntryWSResponse" : { + "type" : "object", + "description" : "Response object for creating an incident report timeline entry from a saved clip.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "password" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Event_incident_CreateEventTimelineEntryWSRequest" : { + "type" : "object", + "description" : "Request object for creating an incident report timeline entry from an event.", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "refreshToken" : { + "customActivityDescription" : { "type" : "string", + "description" : "Custom description for the activity.", + "example" : "A person was detected in the camera view", "nullable" : true }, - "rhombusToken" : { + "customActivityDisplayName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "saveClips" : { - "type" : "boolean", + "description" : "Custom display name for the activity.", + "example" : "Person Detected", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "userUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "webhookId" : { + "subjectEntityName" : { + "type" : "string", + "description" : "Name of the person or entity the event is about, for example an identified individual.", + "nullable" : true + }, + "timestampMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "Timestamp when the event occurred, in milliseconds since the epoch.", "nullable" : true } - } + }, + "required" : [ "deviceUuid", "reportUuid", "timestampMs" ] }, - "IBaseIntegrationType" : { + "Event_incident_CreateEventTimelineEntryWSResponse" : { "type" : "object", - "discriminator" : { - "propertyName" : "integration" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/AperioType" - }, { - "$ref" : "#/components/schemas/AvigilonAltaType" - }, { - "$ref" : "#/components/schemas/BoulevardType" - }, { - "$ref" : "#/components/schemas/BrivoType" - }, { - "$ref" : "#/components/schemas/ButterflyMXType" - }, { - "$ref" : "#/components/schemas/DeviceIntegrationType" - }, { - "$ref" : "#/components/schemas/DiceType" - }, { - "$ref" : "#/components/schemas/EnvoyType" - }, { - "$ref" : "#/components/schemas/FlicType" - }, { - "$ref" : "#/components/schemas/GeneaType" - }, { - "$ref" : "#/components/schemas/GoogleType" - }, { - "$ref" : "#/components/schemas/GuestManagementType" - }, { - "$ref" : "#/components/schemas/InformacastType" - }, { - "$ref" : "#/components/schemas/InnerRangeType" - }, { - "$ref" : "#/components/schemas/KisiType" - }, { - "$ref" : "#/components/schemas/LumeoType" - }, { - "$ref" : "#/components/schemas/MicrosoftTeamsType" - }, { - "$ref" : "#/components/schemas/NineOneOneCellularType" - }, { - "$ref" : "#/components/schemas/OmnialertType" - }, { - "$ref" : "#/components/schemas/OpenAIType" - }, { - "$ref" : "#/components/schemas/OpentechAllianceType" - }, { - "$ref" : "#/components/schemas/PimlocType" - }, { - "$ref" : "#/components/schemas/PlaceOsType" - }, { - "$ref" : "#/components/schemas/ProDataKeyType" - }, { - "$ref" : "#/components/schemas/RaptorType" - }, { - "$ref" : "#/components/schemas/ShellyType" - }, { - "$ref" : "#/components/schemas/ToastType" - }, { - "$ref" : "#/components/schemas/WebhooksType" - }, { - "$ref" : "#/components/schemas/ZapierType" - }, { - "$ref" : "#/components/schemas/ParPOSType" - } ], + "description" : "Response object for creating an incident report timeline entry from an event.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "IBoulevardType" : { + "Event_incident_CreateIncidentReportAnnotationWSRequest" : { "type" : "object", - "description" : "Boulevard integration settings", + "description" : "Request object for creating an annotation on an incident report timeline entry.", "properties" : { - "accessWindowAfterMinutes" : { - "type" : "integer", - "format" : "int32", + "entryUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "accessWindowBeforeMinutes" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "position" : { + "$ref" : "#/components/schemas/AnnotationPosition" }, - "apiToken" : { + "reportUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "boulevardBusinessId" : { + "text" : { "type" : "string", + "description" : "Text content of the annotation.", + "maxLength" : 5000, "nullable" : true - }, - "boulevardLocationToRhombusLocationMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + } + }, + "required" : [ "entryUuid", "reportUuid", "text" ] + }, + "Event_incident_CreateIncidentReportAnnotationWSResponse" : { + "type" : "object", + "description" : "Response object for creating an annotation on an incident report timeline entry.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "incidentReportAnnotation" : { + "$ref" : "#/components/schemas/IncidentReportAnnotation" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Event_incident_CreateIncidentReportNoteWSRequest" : { + "type" : "object", + "description" : "Request object for creating a note on an incident report.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "refreshToken" : { + "text" : { "type" : "string", + "description" : "Text content of the note.", + "maxLength" : 5000, + "nullable" : true + } + }, + "required" : [ "reportUuid", "text" ] + }, + "Event_incident_CreateIncidentReportNoteWSResponse" : { + "type" : "object", + "description" : "Response object for creating a note on an incident report.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "rhombusToken" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true + "incidentReportNote" : { + "$ref" : "#/components/schemas/IncidentReportNote" }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "IBrivoType" : { + "Event_incident_CreateIncidentReportWSRequest" : { "type" : "object", + "description" : "Request object for creating an incident report.", "properties" : { - "accessToken" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true + "status" : { + "$ref" : "#/components/schemas/IncidentReportStatusEnum" }, - "apiKey" : { + "threatCaseUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "apiToken" : { + "title" : { "type" : "string", + "description" : "Title of the incident report.", + "maxLength" : 200, "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { + } + }, + "required" : [ "title" ] + }, + "Event_incident_CreateIncidentReportWSResponse" : { + "type" : "object", + "description" : "Response object for creating an incident report.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "clientId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "clientSecret" : { + "incidentReport" : { + "$ref" : "#/components/schemas/IncidentReport" + }, + "warningMsg" : { "type" : "string", "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", + } + } + }, + "Event_incident_CreatePolicyAlertTimelineEntryWSRequest" : { + "type" : "object", + "description" : "Request object for creating an incident report timeline entry from an alert.", + "properties" : { + "alertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "orgUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "password" : { - "type" : "string", + } + }, + "required" : [ "alertUuid", "reportUuid" ] + }, + "Event_incident_CreatePolicyAlertTimelineEntryWSResponse" : { + "type" : "object", + "description" : "Response object for creating an incident report timeline entry from an alert.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "refreshToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "rhombusToken" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_incident_CreateSnapshotTimelineEntryWSResponse" : { + "type" : "object", + "description" : "Response object for creating an incident report timeline entry from an uploaded snapshot.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "username" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "version" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } } }, - "IButterflyMXType" : { + "Event_incident_DeleteIncidentReportAnnotationWSRequest" : { "type" : "object", - "description" : "ButterflyMX V2 integration settings to update", + "description" : "Request object for deleting an annotation from an incident report timeline entry.", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { + "entryUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "buildingWebhookIdMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "indexFaces" : { + } + }, + "required" : [ "entryUuid", "reportUuid", "uuid" ] + }, + "Event_incident_DeleteIncidentReportAnnotationWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an annotation from an incident report timeline entry.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Event_incident_DeleteIncidentReportNoteWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an incident report note.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "panelInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ButterflymxPanelInfoType" - }, - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "saveClips" : { + } + }, + "required" : [ "reportUuid", "uuid" ] + }, + "Event_incident_DeleteIncidentReportNoteWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an incident report note.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_incident_DeleteIncidentReportWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an incident report.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "uuid" ] }, - "IClimateUserConfig" : { + "Event_incident_DeleteIncidentReportWSResponse" : { "type" : "object", - "description" : "Climate sensor configuration", + "description" : "Response object for deleting an incident report.", "properties" : { - "accelerometer_change_tamper_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "accelerometer_disabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "alert_window_minutes" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "deviceUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_incident_DeleteTimelineEntryWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an incident report timeline entry.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastModified" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pressure_switch_tamper_disabled" : { + } + }, + "required" : [ "reportUuid", "uuid" ] + }, + "Event_incident_DeleteTimelineEntryWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an incident report timeline entry.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "smoke_ai_threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "thc_ai_threshold" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "vape_ai_threshold" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "IDeviceIntegrationType" : { + "Event_incident_FindIncidentReportAnnotationsByEntryWSRequest" : { "type" : "object", - "description" : "Device integration settings to update", + "description" : "Request object for retrieving all annotations for a timeline entry.", "properties" : { - "deviceSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DeviceIntegrationSettings" - }, - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { + "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "entryUuid", "reportUuid" ] }, - "IDiceType" : { + "Event_incident_FindIncidentReportAnnotationsByEntryWSResponse" : { "type" : "object", - "description" : "Dice access control integration settings to update", + "description" : "Response object for retrieving all annotations for a timeline entry.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "incidentReportAnnotations" : { + "type" : "array", + "description" : "All annotations for the timeline entry.", + "items" : { + "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "userUuid" : { + } + } + }, + "Event_incident_FindIncidentReportAnnotationsByReportWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving all annotations for an incident report.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "reportUuid" ] }, - "IEnvoyType" : { + "Event_incident_FindIncidentReportAnnotationsByReportWSResponse" : { "type" : "object", - "description" : "Envoy V2 integration settings to update", + "description" : "Response object for retrieving all annotations for an incident report.", "properties" : { - "alertUnauthorizedFaces" : { + "error" : { "type" : "boolean", "nullable" : true }, - "apiToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + "incidentReportAnnotations" : { + "type" : "array", + "description" : "All annotations for the incident report.", + "items" : { + "$ref" : "#/components/schemas/IncidentReportAnnotation" }, "nullable" : true }, - "doorsValidated" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "enabled" : { + } + } + }, + "Event_incident_FindIncidentReportNotesByReportWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving all notes for an incident report.", + "properties" : { + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "reportUuid" ] + }, + "Event_incident_FindIncidentReportNotesByReportWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving all notes for an incident report.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "envoyIntegrationInstalled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "envoyUserSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/EnvoyUserSettings" + "incidentReportNotes" : { + "type" : "array", + "description" : "All notes for the incident report.", + "items" : { + "$ref" : "#/components/schemas/IncidentReportNote" }, "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Event_incident_FindIncidentReportsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving all incident reports for an organization.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/IncidentReportFilter" }, - "indexFaces" : { + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + } + }, + "Event_incident_FindIncidentReportsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving all incident reports for an organization.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "incidentReports" : { + "type" : "array", + "description" : "All incident reports for the organization.", + "items" : { + "$ref" : "#/components/schemas/IncidentReport" }, "nullable" : true }, - "locationInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/EnvoyLocationInfoType" - }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Pagination key for retrieving the next page of results. Absent when there are no further pages.", "nullable" : true }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_incident_FindIncidentReportsByThreatCaseWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving incident reports linked to a threat case.", + "properties" : { + "systemGenerated" : { + "type" : "boolean", + "description" : "If set, restricts the results to only system-generated (true) or only user-generated (false) reports linked to the threat case.", "nullable" : true }, - "orgUuid" : { + "threatCaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "threatCaseUuid" ] + }, + "Event_incident_FindIncidentReportsByThreatCaseWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving incident reports linked to a threat case.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "refreshToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "incidentReports" : { + "type" : "array", + "description" : "Incident reports linked to the threat case.", + "items" : { + "$ref" : "#/components/schemas/IncidentReport" + }, "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "userUuid" : { + } + } + }, + "Event_incident_FindTimelineEntriesByReportWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving all timeline entries for an incident report.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "reportUuid" ] }, - "IFlicType" : { + "Event_incident_FindTimelineEntriesByReportWSResponse" : { "type" : "object", - "description" : "Flic smart button integration settings to update", + "description" : "Response object for retrieving all timeline entries for an incident report.", "properties" : { - "apiKey" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "apiSecret" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "associatedLocations" : { + "redactedEntryUuids" : { "type" : "array", + "description" : "UUIDs of entries that were redacted because the caller does not have access to them.", "items" : { "type" : "string", "format" : "RUUID", @@ -90293,1091 +92425,1152 @@ "nullable" : true, "uniqueItems" : true }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "timelineEntries" : { + "type" : "array", + "description" : "The report's timeline entries.", + "items" : { + "$ref" : "#/components/schemas/BaseTimelineEntry" }, "nullable" : true }, - "moduleUploaded" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Event_incident_GetIncidentReportAnnotationWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving an incident report annotation.", + "properties" : { + "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "webhookId" : { - "type" : "string", - "nullable" : true - }, - "webhookToken" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "entryUuid", "reportUuid", "uuid" ] }, - "IGeneaType" : { + "Event_incident_GetIncidentReportAnnotationWSResponse" : { "type" : "object", - "description" : "Genea V2 integration settings to update", + "description" : "Response object for retrieving an incident report annotation.", "properties" : { - "alertUnauthorizedFaces" : { + "error" : { "type" : "boolean", "nullable" : true }, - "apiToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "incidentReportAnnotation" : { + "$ref" : "#/components/schemas/IncidentReportAnnotation" }, - "refreshToken" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "rhombusToken" : { + } + } + }, + "Event_incident_GetIncidentReportNoteWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving an incident report note.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "userUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "webhookSignatureSecret" : { - "type" : "string", - "nullable" : true - }, - "webhookUuid" : { - "type" : "string", - "nullable" : true } - } + }, + "required" : [ "reportUuid", "uuid" ] }, - "IGoogleType" : { + "Event_incident_GetIncidentReportNoteWSResponse" : { "type" : "object", - "description" : "Google V2 integration settings to update", + "description" : "Response object for retrieving an incident report note.", "properties" : { - "allowUserStorage" : { + "error" : { "type" : "boolean", "nullable" : true }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "defaultAlertFolderId" : { - "type" : "string", - "nullable" : true - }, - "defaultAlertFolderName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "defaultFolderId" : { - "type" : "string", - "nullable" : true + "incidentReportNote" : { + "$ref" : "#/components/schemas/IncidentReportNote" }, - "defaultFolderName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Event_incident_GetIncidentReportWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving an incident report.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "saveAllAlerts" : { - "type" : "boolean", - "nullable" : true - }, - "saveClips" : { + } + }, + "required" : [ "uuid" ] + }, + "Event_incident_GetIncidentReportWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving an incident report.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/GoogleUserSettings" - }, - "nullable" : true + "incidentReport" : { + "$ref" : "#/components/schemas/IncidentReport" }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "IGuestManagementType" : { + "Event_incident_GetTimelineEntryWSRequest" : { "type" : "object", - "description" : "Guest management integration settings to update", + "description" : "Request object for retrieving an incident report timeline entry.", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "locationSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/LocationSettings" - }, - "nullable" : true - }, - "orgUuid" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "reportUuid", "uuid" ] }, - "IInformacastType" : { + "Event_incident_GetTimelineEntryWSResponse" : { "type" : "object", + "description" : "Response object for retrieving an incident report timeline entry.", "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "redactedEntryUuids" : { + "type" : "array", + "description" : "UUIDs of entries that were redacted because the caller does not have access to them.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "timelineEntry" : { + "$ref" : "#/components/schemas/BaseTimelineEntry" }, - "refreshToken" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "userUuid" : { + } + } + }, + "Event_incident_RemoveThreatCaseActionTimelineEntriesWSRequest" : { + "type" : "object", + "description" : "Request object for removing the threat case action entries from a report's timeline.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "reportUuid" ] }, - "IInnerRangeType" : { + "Event_incident_RemoveThreatCaseActionTimelineEntriesWSResponse" : { "type" : "object", - "description" : "InnerRange access control integration settings to update", + "description" : "Response object for removing the threat case action entries from a report's timeline.", "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "consoleToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/InnerRangeConsoleSettings" - }, - "nullable" : true - }, - "createSeekPoints" : { + "error" : { "type" : "boolean", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/InnerRangeDoorInfoType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "removedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "How many entries were removed.", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Event_incident_ShareIncidentReportWSRequest" : { + "type" : "object", + "description" : "Request object for emailing a link to an incident report.", + "properties" : { + "userUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, + "maxItems" : 50, "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "refreshToken" : { - "type" : "string", + } + }, + "required" : [ "userUuids", "uuid" ] + }, + "Event_incident_ShareIncidentReportWSResponse" : { + "type" : "object", + "description" : "Response object for emailing a link to an incident report.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "skyTunnelSN" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "failedUserUuids" : { + "type" : "array", + "description" : "UUIDs of the users the report could not be emailed to. Empty when every send succeeded.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "IKisiType" : { + "Event_incident_UpdateIncidentReportAnnotationWSRequest" : { "type" : "object", - "description" : "Kisi V2 integration settings to update", + "description" : "Request object for updating an annotation on an incident report timeline entry.", "properties" : { - "apiSecretKey" : { - "type" : "string", - "nullable" : true - }, - "defaultOptions" : { - "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" - }, - "doorsValidated" : { + "selectiveUpdate" : { + "$ref" : "#/components/schemas/IncidentReportAnnotationSelectiveUpdate" + } + }, + "required" : [ "selectiveUpdate" ] + }, + "Event_incident_UpdateIncidentReportAnnotationWSResponse" : { + "type" : "object", + "description" : "Response object for updating an annotation on an incident report timeline entry.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "incidentReportAnnotation" : { + "$ref" : "#/components/schemas/IncidentReportAnnotation" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Event_incident_UpdateIncidentReportNoteWSRequest" : { + "type" : "object", + "description" : "Request object for updating an incident report note.", + "properties" : { + "reportUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "placeToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationSettings" - }, + "text" : { + "type" : "string", + "description" : "Text content of the note.", + "maxLength" : 5000, "nullable" : true }, - "userUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "reportUuid", "text", "uuid" ] }, - "ILumeoType" : { + "Event_incident_UpdateIncidentReportNoteWSResponse" : { "type" : "object", + "description" : "Response object for updating an incident report note.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "incidentReportNote" : { + "$ref" : "#/components/schemas/IncidentReportNote" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "IMicrosoftTeamsType" : { + "Event_incident_UpdateIncidentReportWSRequest" : { "type" : "object", + "description" : "Request object for updating an incident report. Only non-null fields are applied.", "properties" : { - "adminConsent" : { - "type" : "boolean", - "nullable" : true - }, - "allowUserNotifications" : { - "type" : "boolean", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "microsoftTeamSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MicrosoftTeamsChannelSettings" - }, - "nullable" : true + "status" : { + "$ref" : "#/components/schemas/IncidentReportStatusEnum" }, - "microsoftTeamsUserSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MicrosoftTeamsUserSettings" - }, + "title" : { + "type" : "string", + "description" : "Title for the incident report.", + "maxLength" : 200, "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "uuid" ] + }, + "Event_incident_UpdateIncidentReportWSResponse" : { + "type" : "object", + "description" : "Response object for updating an incident report.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "tenantId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "userUuid" : { + "incidentReport" : { + "$ref" : "#/components/schemas/IncidentReport" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "INineOneOneCellularType" : { + "Eventsearch_CombinedSeekPointType" : { "type" : "object", - "description" : "911 Cellular emergency notification integration settings to update", + "description" : "Combined seekpoint type containing information from various event sources including timestamps, activities, and metadata.", "properties" : { - "bearerToken" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "cardholderName" : { + "type" : "string", + "description" : "Cardholder (badge holder) name for OnGuard integration seekpoints", + "example" : "Jane Doe", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "customActivityColor" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "customActivityDescription" : { + "type" : "string", + "description" : "Custom description for the activity", + "example" : "A person was detected in the camera view", "nullable" : true }, - "orgUuid" : { + "customActivityDisplayName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Custom display name for the activity", + "example" : "Person Detected", "nullable" : true }, - "saveClips" : { + "dwelling" : { "type" : "boolean", + "description" : "Whether the detected person is dwelling/loitering", "nullable" : true }, - "securityZoneMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SecurityZoneInfoType" - }, + "faceName" : { + "type" : "string", + "description" : "Name of the face detected in this seekpoint", + "example" : "John Doe", "nullable" : true }, - "triggerNotification" : { - "type" : "boolean", + "licensePlate" : { + "type" : "string", + "description" : "License plate detected in this seekpoint", + "example" : "ABC123", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "objectId" : { + "type" : "integer", + "format" : "int32", + "description" : "Object ID for tracking purposes", + "example" : 12345, "nullable" : true }, - "webhookToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "originalEvent" : { + "type" : "object", + "description" : "Original event object that generated this seekpoint", "nullable" : true }, - "zonesValidated" : { - "type" : "boolean", + "regionMatchTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds of the earliest motion evidence inside the searched region for this seekpoint. Only populated when the request includes searchCells and this seekpoint matched the region. May trail timestampMs, which reflects the start of the underlying motion event rather than when the region was entered.", + "example" : 1640995215000, "nullable" : true - } - } - }, - "IOmnialertType" : { - "type" : "object", - "description" : "Omnialert emergency notification integration settings to update", - "properties" : { - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true }, - "enabled" : { - "type" : "boolean", + "seekpointEndTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for the seekpoint duration", + "example" : 1640995300000, "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "seekpointStartTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for the seekpoint duration", + "example" : 1640995200000, + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "stableTrackId" : { + "type" : "integer", + "format" : "int32", + "description" : "Stable track ID for re-identification across track segments", + "example" : 42, "nullable" : true }, - "orgUuid" : { + "thumbnailUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "URL to the thumbnail image for this seekpoint", + "example" : "https://example.com/thumbnail.jpg", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds when the seekpoint occurred", + "example" : 1640995200000, "nullable" : true }, - "triggerNotification" : { + "unidentifiedFaceId" : { + "type" : "string", + "description" : "ID for unidentified faces", + "example" : "face_12345", + "nullable" : true + } + } + }, + "Eventsearch_GetCameraOrDoorbellCameraSeekpointsWSResponse" : { + "type" : "object", + "description" : "Response object containing seekpoints from camera or doorbell camera events.", + "properties" : { + "combinedSeekpoints" : { + "type" : "array", + "description" : "List of combined seekpoints from camera or doorbell camera events", + "items" : { + "$ref" : "#/components/schemas/Eventsearch_CombinedSeekPointType" + }, + "nullable" : true + }, + "error" : { "type" : "boolean", "nullable" : true }, - "userUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "webhookToken" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "IOpenAIType" : { + "Eventsearch_GetEventSeekpointsByStableTrackIdWSRequest" : { "type" : "object", + "description" : "Request object for retrieving event seekpoints filtered by stable track IDs.", "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true + "deviceUuids" : { + "type" : "array", + "description" : "Set of device facet uuids to retrieve footage seekpoints for.", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "baseUrl" : { - "type" : "string", - "description" : "The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.", + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds since the start time to retrieve seekpoints for.", "nullable" : true }, - "defaultModel" : { - "type" : "string", - "description" : "The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.", - "nullable" : true + "stableTrackIds" : { + "type" : "array", + "description" : "Set of stable track IDs to filter seekpoints by.", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Set of stable track IDs to filter seekpoints by.", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "enabled" : { - "type" : "boolean", + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX timestamp in seconds for when to start retrieving seekpoints.", "nullable" : true + } + }, + "required" : [ "deviceUuids", "durationSec", "stableTrackIds", "startTimeSec" ] + }, + "Eventsearch_GetEventSeekpointsV2WSRequest" : { + "type" : "object", + "description" : "Request object for retrieving event seekpoints V2 with enhanced filtering and clustering options.", + "properties" : { + "accessControlledDoorUuids" : { + "type" : "array", + "description" : "Set of access controlled door uuids to retrieve component seekpoints for.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "activityFilter" : { + "type" : "array", + "description" : "Optional filter to specify what activities are returned.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "clothingColorFilter" : { + "type" : "array", + "description" : "Optional filter to specify which human motion seekpoints are returned.", + "items" : { + "$ref" : "#/components/schemas/ColorEnum" }, + "nullable" : true, + "uniqueItems" : true + }, + "clusterIntervalSec" : { + "type" : "integer", + "format" : "int32", + "description" : "An optional interval X (in seconds) that, when specified, causes this endpoint to return a smaller collection of seekpoints. These seekpoints represent clusters of activities that occur consecutively within X seconds of each other.", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "deviceUuids" : { + "type" : "array", + "description" : "Set of device facet uuids to retrieve footage seekpoints for.", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds since the start time to retrieve seekpoints for.", "nullable" : true }, - "refreshToken" : { - "type" : "string", + "includeAnyMotion" : { + "type" : "boolean", + "default" : false, + "description" : "Determines whether or not any motion seekpoints are returned.", "nullable" : true }, - "tokenValid" : { + "includeIntegrationEvents" : { "type" : "boolean", + "default" : false, + "description" : "Determines whether or not to include any seekpoints from enabled integrations.", "nullable" : true }, - "userUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "IOpentechAllianceType" : { - "type" : "object", - "description" : "OpenTech Alliance V2 integration settings to update", - "properties" : { - "apiKey" : { - "type" : "string", - "nullable" : true }, - "apiSecret" : { - "type" : "string", - "nullable" : true - }, - "enabled" : { + "rawInactivitySeekpoints" : { "type" : "boolean", + "description" : "When true, INACTIVITY_* seekpoints are returned as the raw start, fire and resolve instants of each window (sharing the window's objectId) instead of one clustered row per window. Defaults to false.", "nullable" : true }, - "facilityToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" - }, - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "searchCells" : { + "type" : "array", + "description" : "Optional filter used to limit the seekpoint search to the region provided.", + "items" : { + "$ref" : "#/components/schemas/Event_FrontendCell" }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "UNIX timestamp in seconds for when to start retrieving seekpoints.", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "vehicleColorFilter" : { + "type" : "array", + "description" : "Optional filter to specify which vehicle motion seekpoints are returned.", + "items" : { + "$ref" : "#/components/schemas/ColorEnum" + }, + "nullable" : true, + "uniqueItems" : true } - } + }, + "required" : [ "durationSec", "startTimeSec" ] }, - "IPimlocType" : { + "Eventsearch_GetEventSeekpointsWSRequest" : { "type" : "object", + "description" : "Request object for retrieving event seekpoints with various search criteria and filtering options.", "properties" : { - "baseAPIUrl" : { - "$ref" : "#/components/schemas/PimlocBaseAPIUrlEnum" - }, - "clientId" : { - "type" : "string", - "nullable" : true + "activitySet" : { + "type" : "array", + "description" : "Set of activity types to filter seekpoints by", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "clientSecret" : { - "type" : "string", - "nullable" : true + "componentSeekPointsByAccessControlledDoorWSRequest" : { + "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorWSRequest" }, - "enabled" : { - "type" : "boolean", - "nullable" : true + "componentSeekPointsByAccessControlledDoorsWSRequest" : { + "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByAccessControlledDoorsWSRequest" }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "componentSeekPointsByOwnerDeviceWSRequest" : { + "$ref" : "#/components/schemas/Component_FindComponentSeekPointsByOwnerDeviceWSRequest" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds for the search window", + "example" : 3600, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "searchColorAndVehicleByColorWSRequest" : { + "$ref" : "#/components/schemas/Eventsearch_SearchClothingAndVehicleByColorWSRequest" }, - "rhombusToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "searchMotionGridWithActivitiesWSRequest" : { + "$ref" : "#/components/schemas/Event_SearchMotionGridWithActivitiesWSRequest" }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "seekpointsWSRequest" : { + "$ref" : "#/components/schemas/Common_devices_GetSeekpointsWSRequest" }, - "validCredentials" : { - "type" : "boolean", + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds for the search window", + "example" : 1640995200, "nullable" : true + }, + "videoFootageWSRequest" : { + "$ref" : "#/components/schemas/Eventsearch_VideoFootageWSRequest" } } }, - "IPlaceOsType" : { + "Eventsearch_GetEventSeekpointsWSResponse" : { "type" : "object", - "description" : "PlaceOS V2 smart building management integration settings to update", + "description" : "Response object containing combined seekpoints from various event sources.", "properties" : { - "alertUnauthorizedFaces" : { + "combinedSeekpoints" : { + "type" : "array", + "description" : "List of combined seekpoints from various event sources", + "items" : { + "$ref" : "#/components/schemas/Eventsearch_CombinedSeekPointType" + }, + "nullable" : true + }, + "error" : { "type" : "boolean", "nullable" : true }, - "apiToken" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "apiUrl" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Eventsearch_SearchClothingAndVehicleByColorWSRequest" : { + "type" : "object", + "description" : "Request object for searching clothing and vehicle events by color with time and device filtering.", + "properties" : { + "clothingColorFilter" : { + "type" : "array", + "description" : "Set of clothing colors to filter the search by", + "items" : { + "$ref" : "#/components/schemas/ColorEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", + "deviceFilter" : { + "type" : "array", + "description" : "List of device UUIDs to filter the search by", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for the search window", + "example" : 1641081600000, "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for the search window", + "example" : 1640995200000, + "nullable" : true + }, + "vehicleColorFilter" : { + "type" : "array", + "description" : "Set of vehicle colors to filter the search by", + "items" : { + "$ref" : "#/components/schemas/ColorEnum" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Eventsearch_SearchIntegrationAccessEventsWSRequest" : { + "type" : "object", + "description" : "Filters for searching access events from third-party access-control integrations (e.g. Honeywell OnGuard or Honeywell Elements) — distinct from native Rhombus access control. All filters are optional; results are scoped to the caller's org and to the dedicated integration access-event types. Use activityTypes to scope to a specific integration's events (e.g. the ELEMENTS_* set or the ONGUARD_* set); leave it empty to search all integration access events.", + "properties" : { + "activityTypes" : { + "type" : "array", + "description" : "Dedicated access-control activity types to scope results to (e.g. the ELEMENTS_* set or the ONGUARD_* set). If null or empty, results are scoped to all dedicated access-control activity types.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" }, + "nullable" : true, + "uniqueItems" : true + }, + "afterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Only events at or after this time (epoch ms)", + "example" : 1640995200000, "nullable" : true }, - "doorsValidated" : { + "anomalyOnly" : { "type" : "boolean", + "description" : "Only return anomaly (alerting) events — inactive badge / no entry made", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "area" : { + "type" : "string", + "description" : "Filter by the area being entered", + "example" : "Lobby", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "badgeStatus" : { + "type" : "string", + "description" : "Filter by badge status", + "example" : "Active", "nullable" : true }, - "indexFaces" : { - "type" : "boolean", + "badgeType" : { + "type" : "string", + "description" : "Filter by badge type", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "beforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Only events at or before this time (epoch ms)", + "example" : 1640998800000, + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "cardholderQuery" : { + "type" : "string", + "description" : "Full-text match on the cardholder name (stored in the seekpoint description)", + "example" : "Lisa Lake", "nullable" : true }, - "misconfiguredDoors" : { + "deviceUuids" : { "type" : "array", + "description" : "Limit results to these camera/device UUIDs", "items" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", + "entryMade" : { + "type" : "boolean", + "description" : "Filter by whether access was granted AND entry was made (false = possible tailgating)", "nullable" : true }, - "rhombusToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Max results to return (server caps at 1000)", + "example" : 100, "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "locationUuids" : { + "type" : "array", + "description" : "Limit results to these location UUIDs", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true - }, - "tokenValid" : { + } + } + }, + "Eventsearch_SearchIntegrationAccessEventsWSResponse" : { + "type" : "object", + "description" : "Matching third-party integration access events (footage seekpoints), newest first.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "triggerNotification" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "events" : { + "type" : "array", + "description" : "Matching integration access events. Each carries timestamp, device/location, the event label (customDisplayName), the cardholder name, badge status/type, entering/exiting area, entryMade, and alert (anomaly) flag.", + "items" : { + "$ref" : "#/components/schemas/SeekpointIndexType" + }, "nullable" : true }, - "webhookSignatureSecret" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "IProDataKeyType" : { + "Eventsearch_VideoFootageWSRequest" : { "type" : "object", - "description" : "Pro Data Key (PDK) V2 integration settings to update", + "description" : "Request object for video footage search with camera selection and multi-camera options.", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { + "cameraUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + "cameraUuids" : { + "type" : "array", + "description" : "List of camera UUIDs to search for video footage", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "doorsValidated" : { - "type" : "boolean", + "duration" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds", + "example" : 3600, "nullable" : true }, - "enabled" : { + "includeAnyMotion" : { "type" : "boolean", + "description" : "Whether to include any motion events", + "example" : true, "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "startTime" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in seconds since epoch", + "example" : 1640995200, "nullable" : true }, - "indexFaces" : { + "useMultiCamera" : { "type" : "boolean", + "description" : "Whether to use multi-camera search functionality", + "example" : true, "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + } + } + }, + "ExampleImage" : { + "type" : "object", + "properties" : { + "image" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "imageUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "organizationId" : { + "label" : { "type" : "string", "nullable" : true - }, - "refreshToken" : { + } + } + }, + "ExistingGuestPassCredentialAssignment" : { + "type" : "object", + "description" : "Hex value of an existing credential to assign to the new guest pass.", + "properties" : { + "credentialHexValue" : { "type" : "string", + "description" : "Hex value of the credential to assign. Must resolve to an existing, currently-unassigned credential in the same org.", "nullable" : true + } + }, + "required" : [ "credentialHexValue" ] + }, + "Export_ExportAlertMonitoringEventsWSRequest" : { + "type" : "object", + "description" : "Request object for exporting an alarm monitoring events log.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/ALMEventFilter" }, - "rhombusToken" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { + "minimal" : { "type" : "boolean", + "default" : false, + "description" : "If true, events are returned without snapshot config/state data.", "nullable" : true }, - "systemId" : { + "principalName" : { "type" : "string", + "description" : "Case-insensitive principal name, used when scope is PRINCIPAL and no principalUuid is set.", "nullable" : true }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "userUuid" : { + "principalUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "webhookId" : { - "type" : "string", + "scope" : { + "$ref" : "#/components/schemas/Export_ExportAlertMonitoringEventsWSRequest_Scope" + }, + "sortAscending" : { + "type" : "boolean", + "default" : false, + "description" : "If true, return events in ascending timestamp order.", "nullable" : true }, - "webhookSignatureSecret" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } - } + }, + "required" : [ "scope" ] }, - "IRModesEnum" : { + "Export_ExportAlertMonitoringEventsWSRequest_Scope" : { "type" : "string", - "enum" : [ "ON", "OFF", "AUTO" ] + "default" : "ORG", + "description" : "Scope to export events for.", + "enum" : [ "ORG", "LOCATION", "SUB_LOCATION", "PRINCIPAL" ] }, - "IRaptorType" : { + "Export_ExportAuditEventsWSRequest" : { "type" : "object", + "description" : "Request object for exporting audit events to CSV format with filtering options.", "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "clientId" : { - "type" : "string", - "nullable" : true - }, - "clientSecret" : { - "type" : "string", - "nullable" : true - }, - "clientUid" : { - "type" : "string", + "endInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "End time interval in milliseconds for filtering audit events", + "example" : 1641081600000, "nullable" : true }, - "enabled" : { - "type" : "boolean", + "excludeActions" : { + "type" : "array", + "description" : "If not empty, events with actions specified in the list are filtered out. If both include and exclude actions are specified, exclude actions are ignored.", + "items" : { + "$ref" : "#/components/schemas/AuditActionEnum" + }, "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" + "includeActions" : { + "type" : "array", + "description" : "If not empty, only events with actions specified in the list are included. If both include and exclude actions are specified, exclude actions are ignored.", + "items" : { + "$ref" : "#/components/schemas/AuditActionEnum" }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "startInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time interval in milliseconds for filtering audit events", + "example" : 1640995200000, "nullable" : true - }, - "refreshToken" : { - "type" : "string", + } + } + }, + "Export_ExportClimateEventsWSRequest" : { + "type" : "object", + "description" : "Request object for exporting climate sensor events with time filtering.", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for filtering climate events", + "example" : 1640995200000, "nullable" : true }, - "tokenValid" : { - "type" : "boolean", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for filtering climate events", + "example" : 1641081600000, "nullable" : true }, - "userUuid" : { + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -91386,110 +93579,136 @@ } } }, - "IShellyType" : { + "Export_ExportCountReportsWSRequest" : { "type" : "object", - "description" : "Shelly smart device integration settings to update", + "description" : "Request object for exporting count reports with configurable intervals, scopes, and time ranges.", "properties" : { - "canSendDiagnosticNotifications" : { - "type" : "boolean", + "endDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Enter the ending date in in ISO 8601 format", + "example" : "2024-07-17T00:00:00Z", "nullable" : true }, - "diagnosticQuietPeriodSecs" : { + "endTimeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "End datetime as a UNIX timestamp in milliseconds", + "example" : 1721416242907, + "minimum" : 0, "nullable" : true }, - "enabled" : { - "type" : "boolean", - "nullable" : true + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "startDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Enter the starting date in ISO 8601 format", + "example" : "2024-07-17T00:00:00Z", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start datetime as a UNIX timestamp in milliseconds", + "example" : 1719861042000, + "minimum" : 0, "nullable" : true }, - "shellyDeviceMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ShellyDevice" - }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", "nullable" : true }, - "thirdPartyDeviceToLocationMap" : { - "type" : "object", - "additionalProperties" : { + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + }, + "uuidList" : { + "type" : "array", + "description" : "Enter the UUID of device(s) or location(s)", + "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + } + }, + "required" : [ "endTimeMs", "interval", "scope", "startTimeMs", "type" ] + }, + "Export_ExportDiagnosticEventsWSRequest" : { + "type" : "object", + "description" : "Request object for exporting diagnostic events with time interval filtering.", + "properties" : { + "endInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "End time interval in milliseconds for filtering diagnostic events", + "example" : 1641081600000, "nullable" : true }, - "webhookToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "startInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time interval in milliseconds for filtering diagnostic events", + "example" : 1640995200000, "nullable" : true } } }, - "IToastType" : { + "Export_ExportDoorEventsWSRequest" : { "type" : "object", + "description" : "Request object for exporting door sensor events with time filtering.", "properties" : { - "currentToastRestaurantGuid" : { - "type" : "string", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for filtering door events", + "example" : 1640995200000, "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for filtering door events", + "example" : 1641081600000, "nullable" : true }, - "orgUuid" : { + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Export_ExportEnvironmentalGatewayEventsWSRequest" : { + "type" : "object", + "description" : "Request object for exporting environmental gateway events with time filtering.", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for filtering environmental gateway events", + "example" : 1640995200000, + "nullable" : true }, - "restaurantSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ToastRestaurantSettings" - }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for filtering environmental gateway events", + "example" : 1641081600000, "nullable" : true }, - "userUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -91498,378 +93717,286 @@ } } }, - "IWebhooksType" : { + "Export_ExportInventoryWSRequest" : { "type" : "object", - "description" : "Updated webhook V2 integration settings", + "description" : "Request object for exporting device inventory information to CSV format.", "properties" : { - "activityWebhooks" : { - "type" : "object", - "additionalProperties" : { + "cameraUuids" : { + "type" : "array", + "deprecated" : true, + "description" : "List of camera UUIDs to export (deprecated, use deviceUuids instead)", + "items" : { "type" : "string", + "format" : "RUUID", + "deprecated" : true, + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "activityWebhooksV2" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/WebhookInfo" - }, - "nullable" : true - }, - "diagnosticWebhooks" : { - "type" : "object", - "additionalProperties" : { + "deviceUuids" : { + "type" : "array", + "description" : "List of device UUIDs to export inventory for", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - }, - "diagnosticWebhooksV2" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/WebhookInfo" - }, - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + } + } + }, + "Export_ExportMotionEventsWSRequest" : { + "type" : "object", + "description" : "Request object for exporting motion events from motion sensors with time filtering.", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "After datetime provided as a UNIX timestamp in milliseconds", + "example" : 1640995200000, + "minimum" : 0, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Before datetime provided as a UNIX timestamp in milliseconds", + "example" : 1641081600000, + "minimum" : 0, "nullable" : true }, - "userUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "deviceUuid" ] }, - "ImmixSettings" : { + "Export_ExportPeopleCountEventsWSRequest" : { "type" : "object", + "description" : "Request object for exporting people count events with time interval filtering.", "properties" : { - "deviceList" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "enabled" : { - "type" : "boolean", + "endInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "End time interval in milliseconds for filtering people count events", + "example" : 1641081600000, "nullable" : true }, - "serverUrl" : { - "type" : "string", + "startInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time interval in milliseconds for filtering people count events", + "example" : 1640995200000, "nullable" : true } } }, - "Inference_GetPersonReidentificationEmbeddingFromImageWSResponse" : { + "Export_ExportProximityEventsWSRequest" : { "type" : "object", - "description" : "Response for Person Reidentification embedding from image.", + "description" : "Request object for exporting proximity events with time filtering and tag selection.", "properties" : { - "embedding" : { - "type" : "array", - "description" : "Reidentification embedding for the uploaded image", - "items" : { - "type" : "number", - "format" : "double", - "description" : "Reidentification embedding for the uploaded image", - "nullable" : true - }, - "nullable" : true + "createBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true, + "writeOnly" : true }, - "error" : { - "type" : "boolean", + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for filtering proximity events", + "example" : 1640995200000, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds for filtering proximity events", + "example" : 1641081600000, "nullable" : true }, - "warningMsg" : { + "tagUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Inference_SegmentWithBoxesWSResponse" : { + "Export_ExportProximityLocomotionEventsWSRequest" : { "type" : "object", - "description" : "Response for segmentation using box prompts.", + "description" : "Request object for exporting proximity locomotion events with time filtering and tag selection.", "properties" : { - "boxesXyxy" : { - "type" : "array", - "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", - "items" : { - "type" : "array", - "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", - "items" : { - "type" : "number", - "format" : "float", - "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "createBeforeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true, + "writeOnly" : true }, - "imageHeight" : { + "createdAfterMs" : { "type" : "integer", - "format" : "int32", - "description" : "Height of the input image in pixels.", + "format" : "int64", + "description" : "Start time in milliseconds for filtering proximity locomotion events", + "example" : 1640995200000, "nullable" : true }, - "imageWidth" : { + "createdBeforeMs" : { "type" : "integer", - "format" : "int32", - "description" : "Width of the input image in pixels.", + "format" : "int64", + "description" : "End time in milliseconds for filtering proximity locomotion events", + "example" : 1641081600000, "nullable" : true }, - "maskFormat" : { + "tagUuid" : { "type" : "string", - "description" : "Format of the returned masks (ex: png_base64).", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "masks" : { + } + } + }, + "Export_ExportUptimeWSRequest" : { + "type" : "object", + "description" : "Request object for exporting device uptime reports with configurable time ranges and granularity.", + "properties" : { + "cameraUuids" : { "type" : "array", - "description" : "Base64-encoded mask images.", + "deprecated" : true, + "description" : "Use deviceUuids instead", "items" : { "type" : "string", - "description" : "Base64-encoded mask images.", + "format" : "RUUID", + "deprecated" : true, + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "scores" : { + "deviceUuids" : { "type" : "array", - "description" : "Confidence score for each returned mask.", + "description" : "List of device UUIDs to export uptime reports for", "items" : { - "type" : "number", - "format" : "float", - "description" : "Confidence score for each returned mask.", + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "warningMsg" : { + "endDateTime" : { + "type" : "string", + "description" : "End date and time for the uptime report", + "example" : "2024-01-31T23:59:59Z", + "nullable" : true + }, + "granularity" : { + "$ref" : "#/components/schemas/JavaTimeUnitEnum" + }, + "startDateTime" : { "type" : "string", + "description" : "Start date and time for the uptime report", + "example" : "2024-01-01T00:00:00Z", "nullable" : true } } }, - "Inference_SegmentWithPointsWSResponse" : { + "Export_ExportUsersWSRequest" : { "type" : "object", - "description" : "Response for segmentation using point prompts.", + "description" : "Request object for exporting user information to CSV format.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "imageHeight" : { - "type" : "integer", - "format" : "int32", - "description" : "Height of the input image in pixels.", - "nullable" : true - }, - "imageWidth" : { - "type" : "integer", - "format" : "int32", - "description" : "Width of the input image in pixels.", - "nullable" : true - }, - "labels" : { - "type" : "string", - "description" : "Point labels payload that was provided.", - "nullable" : true - }, - "maskFormat" : { - "type" : "string", - "description" : "Format of the returned masks (ex: png_base64).", - "nullable" : true - }, - "masks" : { + "userUuids" : { "type" : "array", - "description" : "Base64-encoded mask images.", + "description" : "List of user UUIDs to export information for", "items" : { "type" : "string", - "description" : "Base64-encoded mask images.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - }, - "points" : { - "type" : "string", - "description" : "Point coordinates payload that was provided.", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Inference_SegmentWithTextWSResponse" : { + "Export_ExportVehicleEventsWSRequest" : { "type" : "object", - "description" : "Response for segmentation using a text prompt.", + "description" : "Request object for exporting vehicle events with filtering by time, devices, labels, and plate numbers.", "properties" : { - "boxesXyxy" : { + "deviceUuids" : { "type" : "array", - "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", + "description" : "List of device UUIDs to filter vehicle events by", "items" : { - "type" : "array", - "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", - "items" : { - "type" : "number", - "format" : "float", - "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", - "nullable" : true - }, + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true }, - "error" : { + "fuzzy" : { "type" : "boolean", + "description" : "Whether to use fuzzy search on the provided plate numbers", + "example" : true, "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "imageHeight" : { - "type" : "integer", - "format" : "int32", - "description" : "Height of the input image in pixels.", - "nullable" : true - }, - "imageWidth" : { - "type" : "integer", - "format" : "int32", - "description" : "Width of the input image in pixels.", - "nullable" : true - }, - "maskFormat" : { - "type" : "string", - "description" : "Format of the returned masks (ex: png_base64).", - "nullable" : true + "interval" : { + "$ref" : "#/components/schemas/TimeInterval" }, - "masks" : { + "labels" : { "type" : "array", - "description" : "Base64-encoded mask images.", + "description" : "List of vehicle labels to filter by", + "example" : [ "car", "truck", "motorcycle" ], "items" : { "type" : "string", - "description" : "Base64-encoded mask images.", + "description" : "List of vehicle labels to filter by", + "example" : "[\"car\",\"truck\",\"motorcycle\"]", "nullable" : true }, "nullable" : true }, - "scores" : { + "plateNumbers" : { "type" : "array", - "description" : "Confidence score for each returned mask.", + "description" : "List of license plate numbers to filter by", + "example" : [ "ABC123", "XYZ789" ], "items" : { - "type" : "number", - "format" : "float", - "description" : "Confidence score for each returned mask.", + "type" : "string", + "description" : "List of license plate numbers to filter by", + "example" : "[\"ABC123\",\"XYZ789\"]", "nullable" : true }, "nullable" : true - }, - "text" : { - "type" : "string", - "description" : "The text prompt used for segmentation.", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "InformacastScenario" : { + "FaceUploadMetadata" : { "type" : "object", + "description" : "List of face upload metadata for the transaction", "properties" : { - "id" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "scenarioId" : { + "faceId" : { "type" : "string", "nullable" : true - } - } - }, - "InformacastType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true }, "orgUuid" : { "type" : "string", @@ -91878,199 +94005,81 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "origS3Key" : { + "type" : "string", + "nullable" : true + }, + "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "InnerRangeConsoleSettings" : { - "type" : "object", - "nullable" : true, - "properties" : { - "apiKey" : { - "type" : "string", - "nullable" : true }, - "createSeekPoints" : { + "success" : { "type" : "boolean", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/InnerRangeDoorInfoType" - }, - "nullable" : true - }, - "skyTunnelSN" : { + "transactionId" : { "type" : "string", "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true } } }, - "InnerRangeConsoleType" : { + "Facerecognition_faceevent_CreateTailgatingRuleWSRequest" : { "type" : "object", + "description" : "The IntelliGuard tailgating rule to create.", "properties" : { - "doorList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InnerRangeDoorType" - }, - "nullable" : true - }, - "skyTunnelSN" : { - "type" : "string", - "nullable" : true + "rule" : { + "$ref" : "#/components/schemas/IntelliGuardTailgatingRule" } } }, - "InnerRangeDoorInfoType" : { + "Facerecognition_faceevent_DeleteFaceEventWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request object for deleting a face event.", "properties" : { - "assignedCameraList" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "clipDuration" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "doorName" : { - "type" : "string", - "nullable" : true - }, - "leadingSeconds" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "locationUuid" : { + "eventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "readerIds" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "remoteUnlock" : { - "type" : "boolean", - "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" } } }, - "InnerRangeDoorType" : { + "Facerecognition_faceevent_DeleteFaceEventWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a face event." + }, + "Facerecognition_faceevent_DeleteTailgatingRuleWSRequest" : { "type" : "object", + "description" : "The IntelliGuard tailgating rule to delete.", "properties" : { - "id" : { - "type" : "string", - "nullable" : true - }, - "name" : { + "ruleUuid" : { "type" : "string", - "nullable" : true - }, - "readerIds" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "description" : "Uuid of the tailgating rule to delete. Required.", "nullable" : true } } }, - "InnerRangeType" : { + "Facerecognition_faceevent_DetectCoOccurrenceWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "consoleToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/InnerRangeConsoleSettings" - }, - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/InnerRangeDoorInfoType" - }, - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "skyTunnelSN" : { - "type" : "string", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "One recognized-face sighting to evaluate against the org's IntelliGuard co-occurrence rules in-request. The org is taken from the session; the server stamps the sighting timestamp as now.", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "orgUuid" : { + "faceName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Recognized face name. At least one of faceName / personUuid is required.", "nullable" : true }, - "userUuid" : { + "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -92079,151 +94088,74 @@ } } }, - "IntegratedDoorPositionIndicatorType" : { + "Facerecognition_faceevent_DetectCoOccurrenceWSResponse" : { + "type" : "object", + "description" : "Acknowledgement for a co-occurrence detect submission. Empty by design: any alert fires server-side inside IntelliGuard, and the call is best-effort." + }, + "Facerecognition_faceevent_ExportFaceEventsByOrgWSRequest" : { "type" : "object", + "description" : "Request object for exporting face events by organization with search filtering.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "dpiType" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "port" : { - "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" - }, - "portImmutable" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "searchFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSearchFilter" } } }, - "IntegratedDoorRelayType" : { + "Facerecognition_faceevent_ExternalFaceEvent" : { "type" : "object", + "description" : "External face event object containing face recognition data with person matches, embeddings, and metadata.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "detectionConfidence" : { + "type" : "number", + "format" : "float", + "description" : "Confidence value indicating the likelihood that the detected image is a face", + "example" : 0.98, "nullable" : true }, - "name" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "embeddingConfidence" : { + "type" : "number", + "format" : "float", + "description" : "Confidence value associated with the embedding generated for the face image", + "example" : 0.95, "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "eventTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the face event occurred", + "example" : 1640995200000, "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "port" : { - "$ref" : "#/components/schemas/DoorRelayPortType" - }, - "portImmutable" : { - "type" : "boolean", + "faceName" : { + "type" : "string", + "description" : "Name of the person that matched the face image. If selectedPersonMatch is not null, faceName will be equal to the name field of selectedPersonMatch.", "nullable" : true }, - "rateLimitingEnabled" : { + "hasEmbedding" : { "type" : "boolean", + "description" : "Whether the face event has an embedding", + "example" : true, "nullable" : true }, - "relayType" : { - "$ref" : "#/components/schemas/DoorRelayEnumType" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "imageS3Key" : { + "type" : "string", + "description" : "S3 key for the face event image", + "example" : "face-events/images/event_123.jpg", "nullable" : true }, - "uuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "IntegratedGenericButtonType" : { - "type" : "object", - "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "buttonType" : { - "$ref" : "#/components/schemas/ButtonEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "mode" : { - "$ref" : "#/components/schemas/ButtonModeEnum" - }, - "name" : { - "type" : "string", - "nullable" : true }, "orgUuid" : { "type" : "string", @@ -92232,29 +94164,36 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "personUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "selectedPersonMatch" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" }, - "port" : { - "$ref" : "#/components/schemas/ButtonPortType" + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "portImmutable" : { - "type" : "boolean", + "thumbnailS3Key" : { + "type" : "string", + "description" : "S3 key for the face event thumbnail", + "example" : "face-events/thumbnails/event_123.jpg", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "topPersonMatches" : { + "type" : "array", + "description" : "Top person matches found for the face image.", + "items" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalPersonMatch" + }, "nullable" : true }, "uuid" : { @@ -92266,204 +94205,198 @@ } } }, - "IntegratedGenericInputType" : { + "Facerecognition_faceevent_ExternalFaceEventSearchFilter" : { "type" : "object", + "description" : "Search filter for face events with embedding presence filtering.", "properties" : { - "auxType" : { - "$ref" : "#/components/schemas/AuxiliaryEnumType" - }, - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "deviceUuids" : { + "type" : "array", + "description" : "Optional filter by a set of devices.", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "name" : { + "faceNameContains" : { "type" : "string", + "description" : "Optional filter by name substring. The face event is a match if its face name contains the specified value. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.", "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "faceNames" : { + "type" : "array", + "description" : "Optional filter by people names.", + "items" : { + "type" : "string", + "description" : "Optional filter by people names.", + "nullable" : true + }, "nullable" : true }, - "ownerDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "hasEmbedding" : { + "type" : "boolean", + "description" : "Optional filter by the presence or absence of an embedding.", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "port" : { - "$ref" : "#/components/schemas/AuxiliaryInputPortType" - }, - "portImmutable" : { + "hasName" : { "type" : "boolean", + "description" : "Optional filter by the presence or absence of a person name.", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" + "labels" : { + "type" : "array", + "description" : "Optional filter by labels.", + "items" : { + "type" : "string", + "description" : "Optional filter by labels.", + "nullable" : true + }, + "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "locationUuids" : { + "type" : "array", + "description" : "Optional filter by a set of locations.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "personUuids" : { + "type" : "array", + "description" : "Optional filter by a set of people.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true + }, + "timestampFilter" : { + "$ref" : "#/components/schemas/TimestampFilter" } } }, - "IntegratedGenericRelayType" : { + "Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" : { "type" : "object", + "description" : "Search filter for finding similar face events with similarity thresholds and confidence settings.", "properties" : { - "auxType" : { - "$ref" : "#/components/schemas/AuxiliaryEnumType" - }, - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "deviceUuids" : { + "type" : "array", + "description" : "Optional filter by a set of devices.", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, - "name" : { - "type" : "string", + "embeddingConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Optional face embedding confidence threshold used to filter out face events with embeddingconfidence values less than the specified threshold. Valid range [0,1].", + "maximum" : 1, + "minimum" : 0, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "faceMatchDistanceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Optional face match distance threshold used to compare face event images. Defaults to 0.7.Valid range [0,1].", + "maximum" : 1, + "minimum" : 0, "nullable" : true }, - "originator" : { - "$ref" : "#/components/schemas/BaseEventOriginator" - }, - "ownerDeviceUuid" : { + "faceNameContains" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Optional filter by name substring. The face event is a match if its face name contains the specified value. The search will only be performed if the provided value is at least 3 characters long after trimming leading and trailing spaces. If both faceNameContains and faceNames are specified, faceNameContains takes a precedence.", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "port" : { - "$ref" : "#/components/schemas/AuxiliaryRelayPortType" + "faceNames" : { + "type" : "array", + "description" : "Optional filter by people names.", + "items" : { + "type" : "string", + "description" : "Optional filter by people names.", + "nullable" : true + }, + "nullable" : true }, - "portImmutable" : { + "hasName" : { "type" : "boolean", + "description" : "Optional filter by the presence or absence of a person name.", "nullable" : true }, - "relayDurationSec" : { - "type" : "integer", - "format" : "int32", - "deprecated" : true, - "description" : "Deprecated, do not use.", + "labels" : { + "type" : "array", + "description" : "Optional filter by labels.", + "items" : { + "type" : "string", + "description" : "Optional filter by labels.", + "nullable" : true + }, "nullable" : true }, - "stateChangedAtMillis" : { - "type" : "integer", - "format" : "int64", + "locationUuids" : { + "type" : "array", + "description" : "Optional filter by a set of locations.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "steadyState" : { - "$ref" : "#/components/schemas/GenericRelayStateEnumType" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "personUuids" : { + "type" : "array", + "description" : "Optional filter by a set of people.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "timestampFilter" : { + "$ref" : "#/components/schemas/TimestampFilter" } } }, - "IntegratedRequestToExitType" : { + "Facerecognition_faceevent_ExternalPersonMatch" : { "type" : "object", + "description" : "Person match information for face recognition events with confidence scoring.", "properties" : { - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "intentOnly" : { - "type" : "boolean", - "nullable" : true - }, - "intentOnlyEvents" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", + "confidence" : { + "type" : "number", + "format" : "float", + "description" : "Match confidence level expressed as a value in range[0,1]", + "example" : 0.95, "nullable" : true }, - "normalState" : { - "$ref" : "#/components/schemas/NormalStateEnumType" - }, - "orgUuid" : { + "faceId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Face ID associated with the person match", + "example" : "face_12345", "nullable" : true }, - "ownerDeviceUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "port" : { - "$ref" : "#/components/schemas/RequestToExitPortType" - }, - "portImmutable" : { - "type" : "boolean", - "nullable" : true - }, - "rexType" : { - "$ref" : "#/components/schemas/RequestToExitEnumType" - }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "description" : "Name of the person matched", + "example" : "John Doe", "nullable" : true }, "uuid" : { @@ -92475,563 +94408,914 @@ } } }, - "IntegrationActionStatusEnum" : { - "type" : "string", - "enum" : [ "SUCCESS", "ERROR", "BACKOFF", "IGNORED", "UNKNOWN" ] - }, - "IntegrationAuditEvent" : { + "Facerecognition_faceevent_FindCoOccurrenceRulesWSResponse" : { "type" : "object", + "description" : "The IntelliGuard co-occurrence rules for the caller's org (org is taken from the session).", "properties" : { - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "integrationAuditEvent" : { - "$ref" : "#/components/schemas/IntegrationAuditEventEnum" - }, - "user" : { - "type" : "string", - "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rules" : { + "type" : "array", + "description" : "The org's co-occurrence rules.", + "items" : { + "$ref" : "#/components/schemas/IntelliGuardCoOccurrenceRule" + }, "nullable" : true } } }, - "IntegrationAuditEventEnum" : { - "type" : "string", - "enum" : [ "UPDATE", "DELETE" ] - }, - "IntegrationCommandActionType" : { + "Facerecognition_faceevent_FindFaceEventsByDeviceForReportingWSRequest" : { "type" : "object", + "description" : "Request object for finding face events by device for reporting purposes with timestamp filtering and pagination.", "properties" : { - "commandPayload" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "delaySecs" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "timestampFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" } } }, - "IntegrationDiagnosticEventType" : { + "Facerecognition_faceevent_FindFaceEventsByDeviceForReportingWSResponse" : { "type" : "object", + "description" : "Response object containing face events by device for reporting purposes with pagination information.", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/DiagnosticActivityEnum" - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "thirdPartyDeviceId" : { - "type" : "string", - "nullable" : true - }, - "thirdPartyDeviceName" : { - "type" : "string", + "faceEvents" : { + "type" : "array", + "description" : "List of face events by device for reporting purposes", + "items" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + }, "nullable" : true }, - "timestamp" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "date-time", + "description" : "Pagination key for retrieving the next page of face events by device for reporting", + "example" : "next_page_key_123", "nullable" : true - }, - "uuid" : { + } + } + }, + "Facerecognition_faceevent_FindFaceEventsByLocationForReportingWSRequest" : { + "type" : "object", + "description" : "Request object for finding face events by location for reporting purposes with timestamp filtering and pagination.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "timestampFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" } } }, - "IntegrationEnum" : { - "type" : "string", - "enum" : [ "AVIGILON_ALTA", "BOULEVARD", "BRIVO", "BUTTERFLY_MX", "DEVICE_INTEGRATION", "DICE", "ENVOY", "FLIC", "GENEA", "GOOGLE", "GUEST_MANAGEMENT", "INFORMACAST", "INNER_RANGE", "KISI", "LUMEO", "MICROSOFT_TEAMS", "OMNIALERT", "OPENAI", "OPENTECH_ALLIANCE", "PIMLOC", "PLACE_OS", "PRODATAKEY", "SHELLY", "TOAST", "WEBHOOKS", "ZAPIER", "RAPTOR", "NINEONEONE_CELLULAR", "SLACK", "APERIO", "PAR_POS", "UNKNOWN" ] - }, - "IntegrationNotificationActionType" : { + "Facerecognition_faceevent_FindFaceEventsByLocationForReportingWSResponse" : { "type" : "object", + "description" : "Response object containing face events by location for reporting purposes with pagination information.", "properties" : { - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "notificationEntity" : { - "type" : "string", + "faceEvents" : { + "type" : "array", + "description" : "List of face events by location for reporting purposes", + "items" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + }, "nullable" : true }, - "notificationTarget" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Pagination key for retrieving the next page of face events by location for reporting", + "example" : "next_page_key_123", "nullable" : true } } }, - "Integration_BaseIntegrationWSRequest" : { - "type" : "object", - "description" : "Base request object for integration operations." - }, - "Integration_CreateEnvoyInviteWSRequest" : { + "Facerecognition_faceevent_FindFaceEventsByOrgForReportingWSRequest" : { "type" : "object", + "description" : "Request object for finding face events by organization for reporting purposes with timestamp filtering and pagination.", "properties" : { - "invitation" : { - "$ref" : "#/components/schemas/EnvoyInvite" + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "timestampFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ReportTimestampFilter" } } }, - "Integration_GetAccessControlIntegrationsForAlmWSResponse" : { + "Facerecognition_faceevent_FindFaceEventsByOrgForReportingWSResponse" : { "type" : "object", + "description" : "Response object containing face events for reporting purposes with pagination information.", "properties" : { - "badDoors" : { + "faceEvents" : { "type" : "array", + "description" : "List of face events for reporting purposes", "items" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Pagination key for retrieving the next page of face events for reporting", + "example" : "next_page_key_123", "nullable" : true + } + } + }, + "Facerecognition_faceevent_FindFaceEventsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding face events by organization with search filtering and pagination.", + "properties" : { + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" }, - "integrations" : { + "searchFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSearchFilter" + } + } + }, + "Facerecognition_faceevent_FindFaceEventsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing face events for an organization with pagination information.", + "properties" : { + "faceEvents" : { "type" : "array", + "description" : "List of face events matching the search criteria", "items" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, - "warningMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Pagination key for retrieving the next page of results", + "example" : "next_page_key_123", "nullable" : true } } }, - "Integration_GetAllGuestsWSResponse" : { + "Facerecognition_faceevent_FindSimilarFaceEventsByEmbeddingWSRequest" : { "type" : "object", + "description" : "Request object for finding face events similar to a face embedding with search filtering and pagination.", "properties" : { - "allGuests" : { + "embedding" : { + "$ref" : "#/components/schemas/Embedding" + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "searchFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" + } + } + }, + "Facerecognition_faceevent_FindSimilarFaceEventsByEmbeddingWSResponse" : { + "type" : "object", + "description" : "Response object containing face events similar to a face embedding with pagination information.", + "properties" : { + "faceEvents" : { "type" : "array", + "description" : "List of face events similar to the specified face embedding", "items" : { - "$ref" : "#/components/schemas/Guest" + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Pagination key for retrieving the next page of similar face events", + "example" : "next_page_key_123", "nullable" : true } } }, - "Integration_GetAllOrgIntegrationsV2WSResponse" : { + "Facerecognition_faceevent_FindSimilarFaceEventsByFaceMatchmakerWSRequest" : { "type" : "object", + "description" : "Request object for finding face events similar to a face ID using face matchmaker with search filtering and pagination.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "faceId" : { "type" : "string", + "description" : "Face ID to find similar face events for", + "example" : "face_12345", "nullable" : true }, - "orgIntegrationsV2" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IBaseIntegrationType" + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "searchFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" + } + } + }, + "Facerecognition_faceevent_FindSimilarFaceEventsByFaceMatchmakerWSResponse" : { + "type" : "object", + "description" : "Response object containing face events similar to a face ID using face matchmaker with pagination information.", + "properties" : { + "faceEvents" : { + "type" : "array", + "description" : "List of face events similar to the specified face ID", + "items" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, - "warningMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Pagination key for retrieving the next page of similar face events", + "example" : "next_page_key_123", "nullable" : true } } }, - "Integration_GetAmtReadersWSRequest" : { + "Facerecognition_faceevent_FindSimilarFaceEventsWSRequest" : { "type" : "object", + "description" : "Request object for finding face events similar to a specified face event with search filtering and pagination.", "properties" : { - "email" : { + "faceEventUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "password" : { - "type" : "string", - "nullable" : true + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "searchFilter" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEventSimilaritySearchFilter" } } }, - "Integration_GetAperioIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving Aperio integration configuration." - }, - "Integration_GetAperioIntegrationWSResponse" : { + "Facerecognition_faceevent_FindSimilarFaceEventsWSResponse" : { "type" : "object", - "description" : "Response object containing Aperio integration configuration and door controllers.", + "description" : "Response object containing face events similar to a specified face event with pagination information.", "properties" : { - "aperioSettings" : { - "$ref" : "#/components/schemas/IAperioType" - }, - "doorControllers" : { + "faceEvents" : { "type" : "array", - "description" : "List of Rhombus door controllers with Aperio integration", + "description" : "List of face events similar to the specified face event", "items" : { - "$ref" : "#/components/schemas/Integration_aperio_AperioRhombusDoorControllerView" + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" }, "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "Pagination key for retrieving the next page of similar face events", + "example" : "next_page_key_123", "nullable" : true } } }, - "Integration_GetApiTokenApplicationsWSRequest" : { - "type" : "object" - }, - "Integration_GetApiTokenApplicationsWSResponse" : { + "Facerecognition_faceevent_FindTailgatingRulesWSResponse" : { "type" : "object", + "description" : "The IntelliGuard tailgating rules for the caller's org.", "properties" : { - "applications" : { + "rules" : { "type" : "array", + "description" : "The org's tailgating rules.", "items" : { - "$ref" : "#/components/schemas/ApiTokenApplicationType" + "$ref" : "#/components/schemas/IntelliGuardTailgatingRule" }, "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + } + } + }, + "Facerecognition_faceevent_GetFaceEventWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving a specific face event by UUID.", + "properties" : { + "eventUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Facerecognition_faceevent_GetFaceEventWSResponse" : { + "type" : "object", + "description" : "Response object containing a specific face event.", + "properties" : { + "faceEvent" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + } + } + }, + "Facerecognition_faceevent_ProcessFaceEventSearchImageWSResponse" : { + "type" : "object", + "description" : "Response object containing processed face search image with embedding and base64 image data.", + "properties" : { + "embedding" : { + "$ref" : "#/components/schemas/Embedding" }, - "warningMsg" : { + "imageBase64" : { "type" : "string", + "description" : "Base64 encoded image used for embedding generation. The image in the request may have been modified(cropped) in order to generate embedding.", "nullable" : true } } }, - "Integration_GetApiTokensWSRequest" : { + "Facerecognition_faceevent_ReportTimestampFilter" : { "type" : "object", - "description" : "Request object for retrieving API tokens.", + "description" : "Filter object for reporting face events with timestamp range and interval configuration.", "properties" : { - "optionalFilter" : { - "type" : "array", - "description" : "Optional filter for API client types", - "items" : { - "$ref" : "#/components/schemas/ApiClientTypeEnum" - }, + "rangeStart" : { + "type" : "string", + "format" : "date-time", + "description" : "Start date for the reporting range", + "example" : "2024-01-01T00:00:00Z", "nullable" : true + }, + "reportInterval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" } } }, - "Integration_GetApiTokensWSResponse" : { + "Facerecognition_faceevent_UpdateFaceEventWSRequest" : { "type" : "object", - "description" : "Response object containing API tokens.", + "description" : "Request object for updating a face event with person association information.", "properties" : { - "apiTokens" : { - "type" : "array", - "description" : "List of API tokens", - "items" : { - "$ref" : "#/components/schemas/ApiTokenType" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", + "eventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "personName" : { "type" : "string", + "description" : "Name of the person associated with the face event. Ignored if person UUID matches to one of the top person matches.", "nullable" : true }, - "warningMsg" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Integration_GetBadgeIntegrationDoorsWSResponse" : { + "Facerecognition_faceevent_UpdateFaceEventWSResponse" : { "type" : "object", + "description" : "Response object for updating a face event.", "properties" : { - "authError" : { - "type" : "boolean", + "faceEvent" : { + "$ref" : "#/components/schemas/Facerecognition_faceevent_ExternalFaceEvent" + } + } + }, + "Facerecognition_faceevent_UpdateTailgatingRuleWSRequest" : { + "type" : "object", + "description" : "The IntelliGuard tailgating rule to update.", + "properties" : { + "rule" : { + "$ref" : "#/components/schemas/IntelliGuardTailgatingRule" + } + } + }, + "Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSRequest" : { + "type" : "object", + "description" : "Request object for creating a face matchmaker from a face event sighting.", + "properties" : { + "faceEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doors" : { + "personUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Facerecognition_matchmaker_CreateFaceMatchmakerFromSightingWSResponse" : { + "type" : "object", + "description" : "Response object for creating a face matchmaker from a face event sighting.", + "properties" : { + "faceMatchmaker" : { + "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" + } + } + }, + "Facerecognition_matchmaker_CreatePersonAndFaceMatchmakersWSResponse" : { + "type" : "object", + "description" : "Response object for creating a person and associated face matchmakers.", + "properties" : { + "faceMatchmakers" : { "type" : "array", + "description" : "List of created face matchmakers for the person", "items" : { - "$ref" : "#/components/schemas/DoorType" + "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true + "person" : { + "$ref" : "#/components/schemas/Person" }, - "errorMsg" : { + "transactionId" : { "type" : "string", + "description" : "Transaction ID for tracking the creation process", + "example" : "txn_12345", "nullable" : true - }, - "warningMsg" : { + } + } + }, + "Facerecognition_matchmaker_DeleteFaceMatchmakerWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a face matchmaker.", + "properties" : { + "faceId" : { "type" : "string", + "description" : "Face ID of the matchmaker to delete", + "example" : "face_12345", "nullable" : true } } }, - "Integration_GetBadgeIntegrationGenericDoorsWSResponse" : { + "Facerecognition_matchmaker_DeleteFaceMatchmakerWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a face matchmaker." + }, + "Facerecognition_matchmaker_ExternalFaceMatchmaker" : { "type" : "object", + "description" : "External face matchmaker object containing face recognition matchmaker data and metadata.", "properties" : { - "authError" : { - "type" : "boolean", + "createdOn" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when the face matchmaker was created", + "example" : "2024-01-01T00:00:00Z", "nullable" : true }, - "doors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GenericDoorType" - }, + "id" : { + "type" : "string", + "description" : "Unique identifier for the face matchmaker", + "example" : "face_12345", "nullable" : true }, - "error" : { - "type" : "boolean", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "uploaded" : { + "type" : "boolean", + "description" : "Whether the face matchmaker has been uploaded", + "example" : true, "nullable" : true } } }, - "Integration_GetBadgeIntegrationPlacesWSResponse" : { + "Facerecognition_matchmaker_FileUploadResult" : { "type" : "object", + "description" : "Result of a file upload process for face matchmaker creation, including success status and error messages.", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, - "error" : { - "type" : "boolean", + "fileName" : { + "type" : "string", + "description" : "The name of the uploaded file.", "nullable" : true }, - "errorMsg" : { + "message" : { "type" : "string", + "description" : "Error message that occurred during upload.", "nullable" : true }, - "places" : { + "success" : { + "type" : "boolean", + "description" : "Indicates whether the file upload was successful. Note, that even if upload was successful, subsequent operations, such as adding the uploaded file as a matchmaker, may fail.", + "nullable" : true + } + } + }, + "Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding face matchmakers by organization." + }, + "Facerecognition_matchmaker_FindFaceMatchmakersByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing face matchmakers for an organization.", + "properties" : { + "faceMatchmakers" : { "type" : "array", + "description" : "List of face matchmakers for the organization", "items" : { - "$ref" : "#/components/schemas/PlaceType" + "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, "nullable" : true - }, - "warningMsg" : { + } + } + }, + "Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSRequest" : { + "type" : "object", + "description" : "Request object for finding face matchmakers by person UUID.", + "properties" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Integration_GetBoulevardIntegrationWSResponse" : { + "Facerecognition_matchmaker_FindFaceMatchmakersByPersonWSResponse" : { "type" : "object", - "description" : "Response object for retrieving Boulevard integration settings.", + "description" : "Response object containing face matchmakers for a specific person.", "properties" : { - "error" : { - "type" : "boolean", + "faceMatchmakers" : { + "type" : "array", + "description" : "List of face matchmakers for the specified person", + "items" : { + "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" + }, "nullable" : true - }, - "errorMsg" : { + } + } + }, + "Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSRequest" : { + "type" : "object", + "description" : "Request object for finding face upload metadata by transaction ID.", + "properties" : { + "transactionId" : { "type" : "string", + "description" : "Transaction ID to find face upload metadata for", + "example" : "txn_12345", "nullable" : true - }, - "settings" : { - "$ref" : "#/components/schemas/IBoulevardType" - }, - "warningMsg" : { - "type" : "string", + } + } + }, + "Facerecognition_matchmaker_FindFaceUploadMetadataByTransactionWSResponse" : { + "type" : "object", + "description" : "Response object containing face upload metadata for a transaction.", + "properties" : { + "faceUploadMetadata" : { + "type" : "array", + "description" : "List of face upload metadata for the transaction", + "items" : { + "$ref" : "#/components/schemas/FaceUploadMetadata" + }, "nullable" : true - }, - "webhookUrl" : { - "type" : "string", - "description" : "Webhook URL for Boulevard to send notifications to", + } + } + }, + "Facerecognition_matchmaker_GetFaceMatchingConfigWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving face matching configuration." + }, + "Facerecognition_matchmaker_GetFaceMatchingConfigWSResponse" : { + "type" : "object", + "description" : "Response object containing face matching configuration settings.", + "properties" : { + "faceMatchConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Face match confidence threshold value", + "example" : 0.7, "nullable" : true } } }, - "Integration_GetBrivoDoorsWSRequest" : { + "Facerecognition_matchmaker_GetFaceMatchmakerWSRequest" : { "type" : "object", + "description" : "Request object for retrieving a face matchmaker by face ID.", "properties" : { - "password" : { + "faceId" : { "type" : "string", + "description" : "Face ID to retrieve the matchmaker for", + "example" : "face_12345", "nullable" : true + } + } + }, + "Facerecognition_matchmaker_GetFaceMatchmakerWSResponse" : { + "type" : "object", + "description" : "Response object containing a face matchmaker.", + "properties" : { + "faceMatchmaker" : { + "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" + } + } + }, + "Facerecognition_matchmaker_SearchFaceMatchmakerResult" : { + "type" : "object", + "description" : "A single candidate face matchmaker returned from a face image search, with the confidence of the match.", + "properties" : { + "faceMatchmaker" : { + "$ref" : "#/components/schemas/Facerecognition_matchmaker_ExternalFaceMatchmaker" }, - "username" : { - "type" : "string", + "matchConfidence" : { + "type" : "number", + "format" : "float", + "description" : "Confidence that the supplied image is of the same person as this matchmaker, in [0.0, 1.0].", + "example" : 0.93, "nullable" : true } } }, - "Integration_GetBrivoDoorsWSResponse" : { + "Facerecognition_matchmaker_SearchFaceMatchmakersByImageWSResponse" : { "type" : "object", + "description" : "Response object for searching face matchmakers by image. Contains ranked candidate matchmakers and metadata about the embedding generated from the supplied image.", "properties" : { - "authError" : { - "type" : "boolean", + "embeddingConfidence" : { + "type" : "number", + "format" : "float", + "description" : "Confidence of the embedding generated from the supplied image. A low value indicates the image is unlikely to produce reliable matches.", + "example" : 0.97, "nullable" : true }, - "doors" : { + "searchResults" : { "type" : "array", + "description" : "Ranked list of candidate face matchmakers that matched the supplied image, ordered by matchConfidence descending. Empty if no candidates passed the matching threshold.", "items" : { - "$ref" : "#/components/schemas/DoorType" + "$ref" : "#/components/schemas/Facerecognition_matchmaker_SearchFaceMatchmakerResult" }, "nullable" : true - }, - "error" : { - "type" : "boolean", + } + } + }, + "Facerecognition_matchmaker_UpdateFaceMatchingConfigWSRequest" : { + "type" : "object", + "description" : "Request object for updating face matching configuration settings.", + "properties" : { + "faceMatchConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Minimum confidence level required for the system to automatically assign a match. If null, the system uses the built-in default.", + "maximum" : 1.0, + "minimum" : 0.0, "nullable" : true - }, - "errorMsg" : { - "type" : "string", + } + } + }, + "Facerecognition_matchmaker_UpdateFaceMatchingConfigWSResponse" : { + "type" : "object", + "description" : "Response object for updating face matching configuration settings.", + "properties" : { + "faceMatchConfidenceThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Updated face match confidence threshold value", + "example" : 0.7, "nullable" : true + } + } + }, + "Facerecognition_matchmaker_UploadFaceMatchmakerForPersonWSResponse" : { + "type" : "object", + "description" : "Response object for uploading a face matchmaker for a specific person.", + "properties" : { + "fileUploadResult" : { + "$ref" : "#/components/schemas/Facerecognition_matchmaker_FileUploadResult" }, - "warningMsg" : { + "transactionId" : { "type" : "string", + "description" : "Transaction ID to track face matchmaker upload progress", + "example" : "txn_12345", "nullable" : true } } }, - "Integration_GetButterflymxPanelsWSRequest" : { + "Facerecognition_matchmaker_UploadFaceMatchmakersWSResponse" : { "type" : "object", + "description" : "Response object for uploading face matchmakers with transaction tracking and upload results.", "properties" : { - "email" : { - "type" : "string", + "fileUploadResults" : { + "type" : "array", + "description" : "List of file upload results for each uploaded face matchmaker", + "items" : { + "$ref" : "#/components/schemas/Facerecognition_matchmaker_FileUploadResult" + }, "nullable" : true }, - "password" : { + "transactionId" : { "type" : "string", + "description" : "Transaction ID to track face matchmakers upload progress", + "example" : "txn_12345", "nullable" : true } } }, - "Integration_GetButterflymxPanelsWSResponse" : { + "Facerecognition_matchmaker_ValidateFaceMatchmakerImageWSResponse" : { "type" : "object", + "description" : "Response object for validating face matchmaker images with validation status and error information.", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, - "buildings" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ButterflymxBuilding" - }, + "errorMessage" : { + "type" : "string", + "description" : "Error message if validation failed", + "example" : "Image quality too low", "nullable" : true }, - "error" : { + "valid" : { "type" : "boolean", + "description" : "Whether the face matchmaker image is valid", + "example" : true, "nullable" : true - }, - "errorMsg" : { + } + } + }, + "Facerecognition_person_AddPersonLabelWSRequest" : { + "type" : "object", + "description" : "Request object for adding a label to a person for face recognition purposes.", + "properties" : { + "label" : { "type" : "string", + "description" : "Label to add to the person", + "example" : "VIP", "nullable" : true }, - "warningMsg" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Integration_GetCalendlyEventDetailsWSRequest" : { + "Facerecognition_person_AddPersonLabelWSResponse" : { + "type" : "object", + "description" : "Response object for adding a label to a person for face recognition purposes." + }, + "Facerecognition_person_CreatePersonWSRequest" : { "type" : "object", + "description" : "Request object for creating a person for face recognition purposes.", "properties" : { - "eventUuid" : { + "name" : { "type" : "string", + "description" : "Name of the person to create", + "example" : "John Doe", "nullable" : true } } }, - "Integration_GetCalendlyEventDetailsWSResponse" : { + "Facerecognition_person_CreatePersonWSResponse" : { "type" : "object", + "description" : "Response object for creating a person for face recognition purposes.", "properties" : { - "email" : { + "person" : { + "$ref" : "#/components/schemas/Person" + } + } + }, + "Facerecognition_person_DeletePersonWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a person for face recognition purposes.", + "properties" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Facerecognition_person_DeletePersonWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a person for face recognition purposes." + }, + "Facerecognition_person_FindPeopleByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding people by organization for face recognition purposes." + }, + "Facerecognition_person_FindPeopleByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing people for an organization for face recognition purposes.", + "properties" : { + "people" : { + "type" : "array", + "description" : "List of people for the organization", + "items" : { + "$ref" : "#/components/schemas/Person" + }, "nullable" : true - }, - "error" : { - "type" : "boolean", + } + } + }, + "Facerecognition_person_FindPersonLabelsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding person labels by organization for face recognition purposes." + }, + "Facerecognition_person_FindPersonLabelsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing person labels by organization for face recognition purposes.", + "properties" : { + "labelsByPerson" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of person UUIDs to their associated labels", + "items" : { + "type" : "string", + "description" : "Map of person UUIDs to their associated labels", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : "Map of person UUIDs to their associated labels", "nullable" : true - }, - "errorMsg" : { + } + } + }, + "Facerecognition_person_GetPersonWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving a person by UUID.", + "properties" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "name" : { + } + } + }, + "Facerecognition_person_GetPersonWSResponse" : { + "type" : "object", + "description" : "Response object containing a person.", + "properties" : { + "person" : { + "$ref" : "#/components/schemas/Person" + } + } + }, + "Facerecognition_person_RemovePersonLabelWSRequest" : { + "type" : "object", + "description" : "Request object for removing a label from a person for face recognition purposes.", + "properties" : { + "label" : { "type" : "string", + "description" : "Label to remove from the person", + "example" : "VIP", "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "warningMsg" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Integration_GetEnvoyDeliveriesWSRequest" : { + "Facerecognition_person_RemovePersonLabelWSResponse" : { + "type" : "object", + "description" : "Response object for removing a label from a person for face recognition purposes." + }, + "Facerecognition_person_UpdatePersonWSRequest" : { "type" : "object", + "description" : "Request object for updating a person for face recognition purposes.", "properties" : { - "endTimestampMs" : { - "type" : "integer", - "format" : "int64", + "personSelectiveUpdate" : { + "$ref" : "#/components/schemas/PersonSelectiveUpdate" + } + } + }, + "Facerecognition_person_UpdatePersonWSResponse" : { + "type" : "object", + "description" : "Response object for updating a person for face recognition purposes.", + "properties" : { + "person" : { + "$ref" : "#/components/schemas/Person" + } + } + }, + "FeatureCompatabilityType" : { + "type" : "object", + "description" : "List of feature compatibility information", + "properties" : { + "betaRolloutOrgFlag" : { + "type" : "string", "nullable" : true }, - "locationIds" : { + "betaRolloutOrgFlags" : { "type" : "array", "items" : { "type" : "string", @@ -93039,141 +95323,119 @@ }, "nullable" : true }, - "startTimestampMs" : { - "type" : "integer", - "format" : "int64", + "deviceFeatureEnablement" : { + "$ref" : "#/components/schemas/DeviceFeatureEnum" + }, + "featureName" : { + "type" : "string", "nullable" : true - } - } - }, - "Integration_GetEnvoyDeliveriesWSResponse" : { - "type" : "object", - "properties" : { - "collectedDeliveries" : { + }, + "generatedActivities" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/EnvoyDelivery" + "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true }, - "error" : { - "type" : "boolean", + "hardwareDefaultMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { + "requiredFirmwareVersion" : { "type" : "string", "nullable" : true }, - "pendingDeliveries" : { + "requiredLicenses" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/EnvoyDelivery" + "$ref" : "#/components/schemas/LicenseEnum" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "supportedHardware" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, "nullable" : true } } }, - "Integration_GetEnvoyEmployeesWSRequest" : { + "Feature_DeviceFeaturesType" : { "type" : "object", + "description" : "Device features configuration with feature enablement mapping.", "properties" : { - "locationIds" : { - "type" : "array", - "items" : { - "type" : "string", + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "featureMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "description" : "Map of device features to their enabled/disabled status", "nullable" : true }, + "description" : "Map of device features to their enabled/disabled status", "nullable" : true } } }, - "Integration_GetEnvoyEmployeesWSResponse" : { + "Feature_GetDeviceEventTypesWSRequest" : { "type" : "object", + "description" : "Request object for retrieving possible event types for a device based on enabled features.", "properties" : { - "employees" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EnvoyPersonInfo" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Integration_GetEnvoyLocationsWSRequest" : { - "type" : "object" - }, - "Integration_GetEnvoyLocationsWSResponse" : { + "Feature_GetDeviceEventTypesWSResponse" : { "type" : "object", + "description" : "Response object containing possible event types for a device based on enabled features.", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "locationList" : { + "eventTypes" : { "type" : "array", + "description" : "List of possible event types for the device", "items" : { - "$ref" : "#/components/schemas/EnvoyLocation" + "$ref" : "#/components/schemas/ActivityEnum" }, "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Integration_GetEnvoyVisitorsWSRequest" : { + "Feature_GetDeviceFeaturesListWSRequest" : { "type" : "object", + "description" : "Request object for retrieving enabled features for multiple devices in an organization.", "properties" : { - "endTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "includeSignedOutVisitors" : { - "type" : "boolean", - "nullable" : true - }, - "locationIds" : { + "deviceUuids" : { "type" : "array", + "description" : "List of device UUIDs to retrieve features for", "items" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true - }, - "startTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "Integration_GetEnvoyVisitorsWSResponse" : { + "Feature_GetDeviceFeaturesListWSResponse" : { "type" : "object", + "description" : "Response object containing enabled features for multiple devices in an organization.", "properties" : { "error" : { "type" : "boolean", @@ -93183,17 +95445,11 @@ "type" : "string", "nullable" : true }, - "invites" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EnvoyExpectedGuest" - }, - "nullable" : true - }, - "visitors" : { + "featureList" : { "type" : "array", + "description" : "List of device features for each requested device", "items" : { - "$ref" : "#/components/schemas/EnvoyGuest" + "$ref" : "#/components/schemas/Feature_DeviceFeaturesType" }, "nullable" : true }, @@ -93203,30 +95459,23 @@ } } }, - "Integration_GetFlicDevicesWSRequest" : { + "Feature_GetDeviceFeaturesWSRequest" : { "type" : "object", + "description" : "Request object for retrieving enabled features for a device.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true } } }, - "Integration_GetFlicDevicesWSResponse" : { + "Feature_GetDeviceFeaturesWSResponse" : { "type" : "object", + "description" : "Response object containing enabled features for a device.", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -93235,15 +95484,8 @@ "type" : "string", "nullable" : true }, - "flicDevices" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/FlicDevice" - }, - "nullable" : true - }, - "flicModule" : { - "$ref" : "#/components/schemas/FlicDevice" + "features" : { + "$ref" : "#/components/schemas/Feature_DeviceFeaturesType" }, "warningMsg" : { "type" : "string", @@ -93251,22 +95493,14 @@ } } }, - "Integration_GetGeneaDoorsWSRequest" : { + "Feature_GetFeatureCompatabilityMatrixWSRequest" : { "type" : "object", - "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - } - } + "description" : "Request object for retrieving the feature compatibility matrix." }, - "Integration_GetGeneaDoorsWSResponse" : { + "Feature_GetFeatureCompatabilityMatrixWSResponse" : { "type" : "object", + "description" : "Response object containing the feature compatibility matrix.", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -93275,10 +95509,11 @@ "type" : "string", "nullable" : true }, - "panelList" : { + "featureCompatabilityMatrix" : { "type" : "array", + "description" : "List of feature compatibility information", "items" : { - "$ref" : "#/components/schemas/PanelType" + "$ref" : "#/components/schemas/FeatureCompatabilityType" }, "nullable" : true }, @@ -93288,28 +95523,32 @@ } } }, - "Integration_GetGuestWSResponse" : { + "Feature_UpdateDeviceFeaturesWSRequest" : { "type" : "object", + "description" : "Request object for updating enabled features for a device.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "guest" : { - "$ref" : "#/components/schemas/Guest" - }, - "warningMsg" : { - "type" : "string", + "featureMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "description" : "Map of device features to their new enabled/disabled status", + "nullable" : true + }, + "description" : "Map of device features to their new enabled/disabled status", "nullable" : true } } }, - "Integration_GetInformacastScenariosWSResponse" : { + "Feature_UpdateDeviceFeaturesWSResponse" : { "type" : "object", + "description" : "Response object for updating enabled features for a device.", "properties" : { "error" : { "type" : "boolean", @@ -93319,1337 +95558,1547 @@ "type" : "string", "nullable" : true }, - "scenarios" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InformacastScenario" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Integration_GetInnerRangeConsolesWSRequest" : { - "type" : "object" - }, - "Integration_GetInnerRangeConsolesWSResponse" : { + "Fidoauth_DeleteCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { - "consoles" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InnerRangeConsoleType" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "credentialId" : { "type" : "string", + "description" : "The id of the credential to be deleted", "nullable" : true } - } - }, - "Integration_GetInnerRangeDoorsWSRequest" : { - "type" : "object" + }, + "required" : [ "credentialId" ] }, - "Integration_GetInnerRangeDoorsWSResponse" : { + "Fidoauth_DeleteCredentialForCurrentUserWSResponse" : { "type" : "object", "properties" : { - "doors" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InnerRangeDoorType" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "credentials" : { + "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, - "Integration_GetIntegrationDiagnosticEventsWSRequest" : { + "Fidoauth_FindCredentialsForCurrentUserWSRequest" : { "type" : "object", "properties" : { - "timestampMsAfter" : { - "type" : "integer", - "format" : "int64", + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", "nullable" : true }, - "timestampMsBefore" : { + "maxPageSize" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", "nullable" : true } } }, - "Integration_GetIntegrationDiagnosticEventsWSResponse" : { + "Fidoauth_FindCredentialsForCurrentUserWSResponse" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "integrationDiagnosticEvents" : { + "credentials" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/IntegrationDiagnosticEventType" + "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, "nullable" : true }, - "warningMsg" : { + "lastEvaluatedKey" : { "type" : "string", + "description" : "If a max page size was specified and there are additional results that can be retrievedthis will be non-null and should be supplied in the next request to retrieve the next page of results.", "nullable" : true } } }, - "Integration_GetKisiDoorsWSRequest" : { + "Fidoauth_InitiateCredentialRegistrationForCurrentUserWSRequest" : { "type" : "object", "properties" : { - "apiSecretKey" : { - "type" : "string", + "reduceRequirementsForMultiFactorAuthOnlyCred" : { + "type" : "boolean", "nullable" : true } } }, - "Integration_GetKisiDoorsWSResponse" : { + "Fidoauth_InitiateCredentialRegistrationForCurrentUserWSResponse" : { "type" : "object", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "placeToDoorMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DoorType" - }, - "nullable" : true - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "registrationRequest" : { + "$ref" : "#/components/schemas/JsonNode" } } }, - "Integration_GetKisiIntegrationWSResponse" : { + "Fidoauth_InitiateMultiFactorAuthCredentialUpgradeForCurrentUserWSRequest" : { "type" : "object", - "description" : "Response object containing Kisi integration settings.", "properties" : { - "authError" : { - "type" : "boolean", - "description" : "Whether an authentication error occurred during update", - "example" : false, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "failedGuids" : { - "type" : "array", - "description" : "List of GUIDs that failed to update", - "items" : { - "type" : "string", - "description" : "List of GUIDs that failed to update", - "nullable" : true - }, - "nullable" : true - }, - "kisiSettings" : { - "$ref" : "#/components/schemas/KisiSettings" - }, - "misconfiguredDoors" : { - "type" : "array", - "description" : "List of door names that are assigned to multiple Rhombus locations", - "items" : { - "type" : "string", - "description" : "List of door names that are assigned to multiple Rhombus locations", - "nullable" : true - }, - "nullable" : true - }, - "warningMsg" : { + "credentialId" : { "type" : "string", + "description" : "The id of a mfa credential to attempt upgrading", "nullable" : true } - } + }, + "required" : [ "credentialId" ] }, - "Integration_GetKisiPlacesWSRequest" : { + "Fidoauth_InitiateMultiFactorAuthCredentialUpgradeForCurrentUserWSResponse" : { "type" : "object", "properties" : { - "apiSecretKey" : { - "type" : "string", - "nullable" : true + "upgradeRequest" : { + "$ref" : "#/components/schemas/JsonNode" } } }, - "Integration_GetMicrosoftUsersJoinedTeamsWSResponse" : { + "Fidoauth_RegisterCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "teamsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "registrationResponse" : { + "$ref" : "#/components/schemas/JsonNode" } - } + }, + "required" : [ "registrationResponse" ] }, - "Integration_GetNineOneOneCSZonesWSRequest" : { - "type" : "object" + "Fidoauth_RegisterCredentialForCurrentUserWSResponse" : { + "type" : "object", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/RhombusUserFidoCredential" + } + } }, - "Integration_GetNineOneOneCSZonesWSResponse" : { + "Fidoauth_UpdateCredentialForCurrentUserWSRequest" : { "type" : "object", "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "credentialId" : { "type" : "string", + "description" : "The id of the credential to be updated", "nullable" : true }, - "warningMsg" : { + "displayName" : { "type" : "string", + "description" : "A new display name to apply to the credential", "nullable" : true + } + }, + "required" : [ "credentialId" ] + }, + "Fidoauth_UpdateCredentialForCurrentUserWSResponse" : { + "type" : "object", + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/RhombusUserFidoCredential" }, - "zone" : { - "$ref" : "#/components/schemas/SecurityZoneInfoType" - }, - "zoneMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SecurityZoneInfoType" - }, - "nullable" : true + "credentials" : { + "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, - "Integration_GetOpenAIModelsWSRequest" : { + "Fidoauth_UpgradeMultiFactorAuthCredentialForCurrentUserWSRequest" : { "type" : "object", - "description" : "Request object for retrieving OpenAI models.", "properties" : { - "openAISettings" : { - "$ref" : "#/components/schemas/IOpenAIType" + "upgradeResponse" : { + "$ref" : "#/components/schemas/JsonNode" } - } + }, + "required" : [ "upgradeResponse" ] }, - "Integration_GetOpenAIModelsWSResponse" : { + "Fidoauth_UpgradeMultiFactorAuthCredentialForCurrentUserWSResponse" : { "type" : "object", - "description" : "Response object containing available OpenAI models.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "models" : { - "type" : "array", - "description" : "List of available OpenAI models", - "items" : { - "$ref" : "#/components/schemas/OpenAIModel" - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "credential" : { + "$ref" : "#/components/schemas/RhombusUserFidoCredential" } } }, - "Integration_GetOpenpathDoorsWSRequest" : { + "FirmwareUpdateIntervalType" : { "type" : "object", + "nullable" : true, "properties" : { - "email" : { - "type" : "string", + "minuteOfWeekStart" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "password" : { - "type" : "string", + "minuteOfWeekStop" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Integration_GetOpenpathLockdownsWSResponse" : { + "FirmwareUpdateModeEnum" : { + "type" : "string", + "enum" : [ "MANUAL", "SCHEDULED" ] + }, + "FirmwareUpdateSettingsOverrideType" : { "type" : "object", + "description" : "Overrides default firmware update settings.", + "nullable" : true, "properties" : { - "authError" : { - "type" : "boolean", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "lockdownPlans" : { + "deviceTypes" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/LockdownType" + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "firmwareUpdateSettings" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" } } }, - "Integration_GetOpentechAllianceFacilitiesWSRequest" : { - "type" : "object" - }, - "Integration_GetOpentechAllianceFacilitiesWSResponse" : { + "FirmwareUpdateSettingsType" : { "type" : "object", + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "facilities" : { + "intervalsV2" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/OpentechAllianceFacilityType" + "$ref" : "#/components/schemas/FirmwareUpdateIntervalType" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "mode" : { + "$ref" : "#/components/schemas/FirmwareUpdateModeEnum" } } }, - "Integration_GetOrgIntegrationsV2WSResponse" : { + "FirstInFirmwareStatusEnum" : { + "type" : "string", + "enum" : [ "DISABLED", "NOT_CONFIGURED", "REQUIRED", "SATISFIED", "UNKNOWN" ] + }, + "FirstInResetEnum" : { + "type" : "string", + "enum" : [ "DAILY" ] + }, + "FirstInShadow" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "source" : { + "$ref" : "#/components/schemas/FirstInSourceEnum" }, - "orgIntegrationV2" : { - "$ref" : "#/components/schemas/IBaseIntegrationType" + "state" : { + "$ref" : "#/components/schemas/FirstInFirmwareStatusEnum" }, - "warningMsg" : { - "type" : "string", + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Integration_GetOrgIntegrationsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving organization integrations." + "FirstInSourceEnum" : { + "type" : "string", + "enum" : [ "CONFIG_MANUAL_OVERRIDE", "CONFIG_REQUIREMENT_CHANGE", "CONFIG_MEMBERSHIP", "SCHEDULED_RESET", "LOCAL_BADGE_EVENT", "LOCKDOWN", "UNKNOWN" ] }, - "Integration_GetOrgIntegrationsWSResponse" : { + "FirstInState" : { "type" : "object", - "description" : "Response object containing organization integrations configuration.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" }, - "errorMsg" : { - "type" : "string", + "requestedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "orgIntegrations" : { - "$ref" : "#/components/schemas/OrgIntegrationsType" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum" } } }, - "Integration_GetPartnerApiTokensWSRequest" : { - "type" : "object" - }, - "Integration_GetPdkDoorsWSRequest" : { + "FirstInState_Minimal" : { "type" : "object", "properties" : { - "ouId" : { - "type" : "string", + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator_Minimal" + }, + "requestedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/FirstInStatusEnum_Minimal" } } }, - "Integration_GetPdkDoorsWSResponse" : { + "FirstInStatusEnum" : { + "type" : "string", + "enum" : [ "REQUIRED", "SATISFIED" ] + }, + "FirstInStatusEnum_Minimal" : { + "type" : "string", + "enum" : [ "REQUIRED", "SATISFIED" ] + }, + "FisheyeDisplayModeEnum" : { + "type" : "string", + "enum" : [ "RAW", "IMMERSIVE", "TILES", "RAW_PANO" ] + }, + "FixedPosition" : { "type" : "object", "properties" : { - "authError" : { - "type" : "boolean", + "left" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "error" : { - "type" : "boolean", + "page" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { + "place_key" : { "type" : "string", "nullable" : true }, - "panelList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PanelType" - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "top" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Integration_GetPdkSystemIdWSRequest" : { + "FlicDevice" : { "type" : "object", "properties" : { - "configurationToken" : { + "flicAction" : { "type" : "string", "nullable" : true - } - } - }, - "Integration_GetPdkSystemIdWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", + }, + "flicBatteryLevel" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "flicHub" : { + "$ref" : "#/components/schemas/FlicHub" + }, + "flicName" : { "type" : "string", "nullable" : true }, - "systemId" : { + "flicSerialNumber" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "flicTimestamp" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "flicUuid" : { + "type" : "string", + "nullable" : true + }, + "lastClickedTimestamp" : { + "type" : "string", + "nullable" : true + }, + "moduleUuid" : { "type" : "string", "nullable" : true } } }, - "Integration_GetPlaceOsDoorsWSRequest" : { + "FlicHub" : { "type" : "object", "properties" : { - "apiUrl" : { + "flicHubName" : { + "type" : "string", + "nullable" : true + }, + "flicHubSerialNumber" : { + "type" : "string", + "nullable" : true + }, + "flicHubUuid" : { "type" : "string", "nullable" : true } } }, - "Integration_GetRaptorBuildingsWSResponse" : { + "FlicType" : { "type" : "object", - "properties" : { - "buildings" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RaptorBuilding" + "allOf" : [ { + "type" : "object", + "properties" : { + "apiKey" : { + "type" : "string", + "nullable" : true + }, + "apiSecret" : { + "type" : "string", + "nullable" : true + }, + "associatedLocations" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "moduleUploaded" : { + "type" : "boolean", + "nullable" : true + }, + "webhookId" : { + "type" : "string", + "nullable" : true }, + "webhookToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "error" : { - "type" : "boolean", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Integration_GetRaptorTemplatesWSResponse" : { + "FloorPlanType" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", + "eastEdge" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "errorMsg" : { + "floorLabel" : { "type" : "string", "nullable" : true }, - "templates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RaptorTemplate" - }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { + "imageUrl" : { + "type" : "string", + "format" : "url", + "nullable" : true + }, + "mediaUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "northEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "rotation" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "southEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "westEdge" : { + "type" : "number", + "format" : "double", "nullable" : true } } }, - "Integration_GetToastEventsTableAllLocationsWSRequest" : { + "FollowUpAction" : { "type" : "object", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/NotificationFollowUp" + } ], "properties" : { - "businessDate" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ChatFollowUpActionEnum" } } }, - "Integration_GetToastEventsTableAllLocationsWSResponse" : { + "FootageBoundingBoxType" : { "type" : "object", + "description" : "List of shared footage bounding boxes", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "a" : { + "$ref" : "#/components/schemas/ActivityEnum" }, - "errorMsg" : { - "type" : "string", + "al" : { + "type" : "boolean", + "description" : "alerted on this?", "nullable" : true }, - "eventTable" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse_EventTableRow" - }, + "b" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - bottom permyriad", "nullable" : true }, - "failedGuids" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "c" : { + "type" : "number", + "format" : "float", + "description" : "confidence", "nullable" : true }, - "warningMsg" : { + "cd" : { "type" : "string", + "description" : "Custom activity display description, maximum 100 characters", "nullable" : true - } - } - }, - "Integration_GetToastEventsTableWSRequest" : { - "type" : "object", - "properties" : { - "businessDate" : { + }, + "cdn" : { "type" : "string", + "description" : "custom activity display name", "nullable" : true }, - "restaurantGuid" : { + "croppedImageLocator" : { "type" : "string", "nullable" : true - } - } - }, - "Integration_GetToastEventsTableWSResponse" : { - "type" : "object", - "properties" : { - "error" : { + }, + "customActivityColor" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" + }, + "dw" : { "type" : "boolean", + "description" : "bounding box is in a loiter state", "nullable" : true }, - "errorMsg" : { + "fn" : { "type" : "string", + "description" : "face names", "nullable" : true }, - "eventTable" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse_EventTableRow" + "kp" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PointType" }, + "description" : "pose keypoints", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "l" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - left permyriad", "nullable" : true - } - } - }, - "Integration_GetToastEventsTableWSResponse_EventTableRow" : { - "type" : "object", - "properties" : { - "assignedCameraList" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + }, + "loudness" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "employeeName" : { + "lp" : { "type" : "string", + "description" : "license plate", "nullable" : true }, - "orderGuid" : { - "type" : "string", + "m" : { + "type" : "boolean", + "description" : "object in motion?", "nullable" : true }, - "paymentType" : { - "type" : "string", + "objectId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "restaurantName" : { + "p" : { "type" : "string", + "description" : "pose", "nullable" : true }, - "revenueCenterName" : { - "type" : "string", + "r" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - right permyriad", "nullable" : true }, - "serviceAreaName" : { - "type" : "string", + "reid" : { + "type" : "integer", + "format" : "int32", + "description" : "Stable track ID for re-identification across track segments", "nullable" : true }, - "timestamp" : { - "type" : "string", + "ro" : { + "type" : "array", + "description" : "recognized objects", + "items" : { + "type" : "string", + "description" : "recognized objects", + "nullable" : true + }, "nullable" : true }, - "tipAmount" : { - "type" : "string", + "sensorValType" : { + "$ref" : "#/components/schemas/SensorValType" + }, + "t" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - top permyriad", "nullable" : true }, - "totalAmount" : { - "type" : "string", + "toastOrderIdInfo" : { + "$ref" : "#/components/schemas/ToastOrderIdType" + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "timestamp in milliseconds since epoch", "nullable" : true }, - "totalDiscountAmount" : { + "uf" : { "type" : "string", + "description" : "FaceId for an unidentified face", "nullable" : true }, - "voided" : { + "vn" : { "type" : "string", + "description" : "vehicle name", "nullable" : true } - } + }, + "required" : [ "a", "b", "l", "r", "t", "ts" ] }, - "Integration_GetToastServiceAreasWSRequest" : { - "type" : "object", - "properties" : { - "restaurantGuid" : { - "type" : "string", - "nullable" : true - } - } + "FootageSeekPointColorEnum" : { + "type" : "string", + "enum" : [ "BLUE", "RED", "PURPLE", "TAN", "ORANGE", "TEAL", "GRAY", "BLACK" ] }, - "Integration_GetToastServiceAreasWSResponse" : { + "FootageSeekPointType" : { "type" : "object", + "description" : "List of shared footage seekpoints", "properties" : { - "error" : { + "a" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "al" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "b" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "fn" : { "type" : "string", "nullable" : true }, - "serviceAreas" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GenericPosType" + "kp" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PointType" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "l" : { + "type" : "number", + "format" : "float", "nullable" : true - } - } - }, - "Integration_GuestWSRequest" : { - "type" : "object", - "description" : "Request object for guest-related operations.", - "properties" : { - "email" : { + }, + "lp" : { "type" : "string", - "description" : "Email address of the guest", - "example" : "guest@example.com", "nullable" : true }, - "error" : { - "type" : "boolean", + "p" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "r" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "ro" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true - } - } - }, - "Integration_InitiateBrivoOAuthWSRequest" : { - "type" : "object", - "description" : "Request object for initiating Brivo OAuth authentication flow with API key.", - "properties" : { - "apiKey" : { - "type" : "string", - "description" : "Brivo Mashery API key obtained from Brivo Developer Portal", - "example" : "brivo_api_key_12345", + }, + "t" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "param" : { - "type" : "string", - "description" : "Additional OAuth parameter", - "example" : "state_param", + "ts" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "requestUrl" : { + "uf" : { "type" : "string", - "description" : "OAuth request URL", - "example" : "https://oauth.provider.com/auth", "nullable" : true }, - "rhombusOrgUserUuid" : { + "vn" : { "type" : "string", - "description" : "Rhombus organization user UUID", "nullable" : true } } }, - "Integration_InitiateCallbackAuthRequest" : { + "FootageSeekPointV2Type" : { "type" : "object", + "description" : "List of shared footage seekpoints (deprecated)", "properties" : { - "rhombusOrgUserUuid" : { + "a" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "ae" : { "type" : "string", + "description" : "area being entered", "nullable" : true - } - } - }, - "Integration_InitiateCallbackAuthResponse" : { - "type" : "object", - "properties" : { - "error" : { + }, + "al" : { "type" : "boolean", + "description" : "alerted on this?", "nullable" : true }, - "errorMsg" : { + "ax" : { "type" : "string", + "description" : "area being exited", "nullable" : true }, - "integratorUrl" : { + "bs" : { "type" : "string", + "description" : "badge status (e.g. Active, Lost)", "nullable" : true }, - "warningMsg" : { + "bt" : { "type" : "string", + "description" : "badge type", "nullable" : true - } - } - }, - "Integration_InitiateOAuthWSRequest" : { - "type" : "object", - "description" : "Request object for initiating OAuth authentication flow.", - "properties" : { - "param" : { + }, + "cc" : { + "$ref" : "#/components/schemas/FootageSeekPointColorEnum" + }, + "cd" : { "type" : "string", - "description" : "Additional OAuth parameter", - "example" : "state_param", + "description" : "Custom activity display description, maximum 100 characters", "nullable" : true }, - "requestUrl" : { + "cdn" : { "type" : "string", - "description" : "OAuth request URL", - "example" : "https://oauth.provider.com/auth", + "description" : "Custom activity display name, maximum 32 characters", "nullable" : true }, - "rhombusOrgUserUuid" : { + "ch" : { "type" : "string", - "description" : "Rhombus organization user UUID", + "description" : "badge holder's name", "nullable" : true - } - } - }, - "Integration_InitiateOAuthWSResponse" : { - "type" : "object", - "description" : "Response object containing OAuth redirect URL.", - "properties" : { - "error" : { + }, + "dcao" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "dwelling" : { + "type" : "boolean", "nullable" : true }, - "redirectUrl" : { + "em" : { + "type" : "boolean", + "description" : "access granted and entry made (false = no entry / possible tailgating)", + "nullable" : true + }, + "fn" : { "type" : "string", - "description" : "OAuth redirect URL for authentication", - "example" : "https://oauth.provider.com/auth?client_id=123&redirect_uri=callback", + "description" : "face names", "nullable" : true }, - "warningMsg" : { + "id" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "loudness" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "lp" : { "type" : "string", + "description" : "license plate", "nullable" : true - } - } - }, - "Integration_RefreshGoogleAccessTokenWSRequest" : { - "type" : "object", - "description" : "Request object for refreshing Google access token.", - "properties" : { - "refreshUserToken" : { + }, + "m" : { "type" : "boolean", - "description" : "Whether to refresh the user token", - "example" : true, + "description" : "object in motion?", "nullable" : true - } - } - }, - "Integration_RefreshGoogleAccessTokenWSResponse" : { - "type" : "object", - "description" : "Response object containing refreshed Google access token.", - "properties" : { - "accessToken" : { + }, + "p" : { "type" : "string", - "description" : "Refreshed Google access token", - "example" : "ya29.a0AfH6SMC...", + "description" : "pose", "nullable" : true }, - "error" : { - "type" : "boolean", + "ro" : { + "type" : "array", + "description" : "recognized objects", + "items" : { + "type" : "string", + "description" : "recognized objects", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { + "sensorValType" : { + "$ref" : "#/components/schemas/SensorValType" + }, + "stableTrackId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "toi" : { + "$ref" : "#/components/schemas/ToastOrderIdType" + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "timestamp", + "nullable" : true + }, + "tu" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "uf" : { + "type" : "string", + "description" : "FaceId for an unidentified face", + "nullable" : true + }, + "vn" : { "type" : "string", + "description" : "vehicle name", "nullable" : true } - } + }, + "required" : [ "a", "ts" ] }, - "Integration_RevokeApiTokenWSRequest" : { + "FormDataBodyPart" : { "type" : "object", - "description" : "Request object for revoking an API token.", + "nullable" : true, "properties" : { - "tokenUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "content" : { + "type" : "object", "nullable" : true - } - } - }, - "Integration_RevokeApiTokenWSResponse" : { - "type" : "object", - "description" : "Response object for revoking an API token.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" + }, + "entity" : { + "type" : "object", "nullable" : true }, - "errorMsg" : { + "fileName" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "formDataContentDisposition" : { + "$ref" : "#/components/schemas/FormDataContentDisposition" + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "mediaType" : { + "$ref" : "#/components/schemas/MediaType" + }, + "messageBodyWorkers" : { + "$ref" : "#/components/schemas/MessageBodyWorkers" + }, + "name" : { "type" : "string", "nullable" : true - } - } - }, - "Integration_RevokeGoogleDriveAccessWSRequest" : { - "type" : "object", - "description" : "Request object for revoking Google Drive access permissions.", - "properties" : { - "revokeUserAccount" : { + }, + "parameterizedHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterizedHeader" + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "parent" : { + "$ref" : "#/components/schemas/MultiPart" + }, + "providers" : { + "$ref" : "#/components/schemas/Providers" + }, + "simple" : { "type" : "boolean", - "description" : "If set to true, revokes Rhombus Systems access to a user's Google Drive account, otherwise revokes Rhombus Systems access to the org's shared Google Drive account", - "example" : true, + "nullable" : true + }, + "value" : { + "type" : "string", "nullable" : true } } }, - "Integration_SubmitApiTokenApplicationWSRequest" : { + "FormDataContentDisposition" : { "type" : "object", - "description" : "Request object for submitting an API token application.", "properties" : { - "authType" : { - "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" - }, - "csr" : { + "creationDate" : { "type" : "string", - "description" : "Certificate Signing Request (CSR) for token authentication", - "example" : "-----BEGIN CERTIFICATE REQUEST-----...", + "format" : "date-time", "nullable" : true }, - "displayName" : { + "fileName" : { "type" : "string", - "description" : "Display name for the API token", - "example" : "Production API Token", "nullable" : true }, - "permissionGroupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "permissionGroupUuid" ] - }, - "Integration_SubmitApiTokenApplicationWSResponse" : { - "type" : "object", - "properties" : { - "apiKey" : { + "modificationDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "cert" : { + "name" : { "type" : "string", "nullable" : true }, - "error" : { - "type" : "boolean", + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { + "readDate" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "validCSR" : { - "type" : "boolean", + "size" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "type" : { "type" : "string", "nullable" : true } } }, - "Integration_SubscribeZapierWebhookWSRequest" : { + "FormDataMultiPart" : { "type" : "object", - "description" : "Request object for subscribing to Zapier webhook events.", + "nullable" : true, "properties" : { - "backoffSec" : { - "type" : "integer", - "format" : "int32", - "description" : "Backoff time in seconds", - "example" : 30, + "bodyParts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BodyPart" + }, "nullable" : true }, - "doorState" : { - "$ref" : "#/components/schemas/DoorStatusEnum" + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" }, - "hookUrl" : { - "type" : "string", - "description" : "Zapier webhook URL", - "example" : "https://hooks.zapier.com/hooks/catch/123456/abc123/", + "entity" : { + "type" : "object", "nullable" : true }, - "humidityLowerThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Lower humidity threshold for environmental sensors", - "example" : 30.0, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FormDataBodyPart" + }, + "nullable" : true + }, "nullable" : true }, - "humidityUpperThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Upper humidity threshold for environmental sensors", - "example" : 80.0, - "nullable" : true + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } }, - "tempLowerThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Lower temperature threshold for environmental sensors", - "example" : 65.0, - "nullable" : true + "mediaType" : { + "$ref" : "#/components/schemas/MediaType" }, - "tempUpperThreshold" : { - "type" : "number", - "format" : "float", - "description" : "Upper temperature threshold for environmental sensors", - "example" : 85.5, - "nullable" : true + "messageBodyWorkers" : { + "$ref" : "#/components/schemas/MessageBodyWorkers" }, - "uuids" : { - "type" : "array", - "description" : "Set of device UUIDs to monitor", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "parameterizedHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterizedHeader" + }, "nullable" : true }, "nullable" : true, - "uniqueItems" : true + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } }, - "zapEnum" : { - "$ref" : "#/components/schemas/ZapierEnum" + "parent" : { + "$ref" : "#/components/schemas/MultiPart" + }, + "providers" : { + "$ref" : "#/components/schemas/Providers" } } }, - "Integration_SubscribeZapierWebhookWSResponse" : { + "FormaSensorType" : { "type" : "object", - "description" : "Response object for Zapier webhook subscription.", "properties" : { - "error" : { - "type" : "boolean", + "ch2oPpb" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "relHumid" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "tempC" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "webhookId" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "timestampSec" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Integration_TestBoulevardConnectionWSRequest" : { + "Freight" : { "type" : "object", - "description" : "Request object for testing Boulevard API connection.", "properties" : { - "apiToken" : { - "type" : "string", - "description" : "Boulevard API token to test", + "warehouse" : { + "$ref" : "#/components/schemas/WarehouseEnum" + } + } + }, + "FrequencyUnitEnum" : { + "type" : "string", + "enum" : [ "HOURS", "DAYS", "WEEKS", "MONTHS", "UNKNOWN" ] + }, + "FrontendEqualizerSettings" : { + "type" : "object", + "properties" : { + "frequency" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "boulevardBusinessId" : { - "type" : "string", - "description" : "Boulevard business ID to test", + "gain" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "q" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Integration_TestBoulevardConnectionWSResponse" : { + "FullDeviceStateType" : { "type" : "object", - "description" : "Response object for testing Boulevard API connection.", + "description" : "Detailed state information for the specified NVR", "properties" : { - "error" : { + "afSupport" : { "type" : "boolean", "nullable" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Error message if connection test failed", + "audioSupported" : { + "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "baseVideoOperationUri" : { "type" : "string", "nullable" : true }, - "locations" : { - "type" : "array", - "description" : "List of Boulevard locations available for the business", - "items" : { - "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSResponse_BoulevardLocationInfo" - }, + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "connectionTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "success" : { - "type" : "boolean", - "description" : "Whether the connection test was successful", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "defaultInterface" : { "type" : "string", "nullable" : true - } - } - }, - "Integration_TestBoulevardConnectionWSResponse_BoulevardLocationInfo" : { - "type" : "object", - "description" : "Information about a Boulevard location.", - "properties" : { - "id" : { + }, + "defaultInterfaceMac" : { "type" : "string", - "description" : "Boulevard location ID", "nullable" : true }, - "name" : { + "directionRadians" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "externalIPAddress" : { "type" : "string", - "description" : "Boulevard location name", "nullable" : true - } - } - }, - "Integration_TogglePowerWSRequest" : { - "type" : "object", - "description" : "Request object for toggling device power state.", - "properties" : { - "deviceId" : { + }, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "firmwareUpdateInProgress" : { + "type" : "boolean", + "nullable" : true + }, + "firmwareVersion" : { "type" : "string", - "description" : "Device ID to toggle power for", - "example" : "device_12345", "nullable" : true }, - "targetState" : { + "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Target power state (0=off, 1=on)", - "example" : 1, "nullable" : true - } - } - }, - "Integration_TogglePowerWSResponse" : { - "type" : "object", - "description" : "Response object for device power toggle operations.", - "properties" : { - "error" : { + }, + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "latestFirmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "liveStreamShared" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "newState" : { + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "maxZoomPercent" : { "type" : "integer", "format" : "int32", - "description" : "New power state after toggle (0=off, 1=on)", - "example" : 1, "nullable" : true }, - "warningMsg" : { + "mediaRegion" : { "type" : "string", "nullable" : true - } - } - }, - "Integration_UnlockDoorWSResponse" : { - "type" : "object", - "description" : "Response object for door unlock operations.", - "properties" : { - "error" : { + }, + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "mummified" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "onCameraState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true + }, "nullable" : true - } - } - }, - "Integration_UnlockGeneaDoorWSRequest" : { - "type" : "object", - "description" : "Request object for unlocking a Genea door.", - "properties" : { - "cameraUuid" : { + }, + "onCloudState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true + }, + "nullable" : true + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorId" : { + "region" : { "type" : "string", - "description" : "Genea door ID to unlock", - "example" : "door_12345", "nullable" : true - } - } - }, - "Integration_UnlockIntegrationGenericDoorWSRequest" : { - "type" : "object", - "properties" : { - "cameraUuid" : { + }, + "secondaryLanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "serialNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorId" : { + "ssid" : { "type" : "string", "nullable" : true - } - } - }, - "Integration_UnlockKisiDoorWSRequest" : { - "type" : "object", - "description" : "Request object for unlocking a Kisi door.", - "properties" : { - "cameraUuid" : { + }, + "stateUpdatedTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorId" : { + "versionsBehind" : { "type" : "integer", "format" : "int32", - "description" : "Kisi door ID to unlock", - "example" : 12345, "nullable" : true }, - "placeId" : { + "wifiApMac" : { + "type" : "string", + "nullable" : true + }, + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "wifiSignalStrength" : { "type" : "integer", "format" : "int32", - "description" : "Kisi place ID representing the physical space", - "example" : 67890, "nullable" : true } } }, - "Integration_UnlockOpenpathDoorWSRequest" : { + "FunctionalityEnum" : { + "type" : "string", + "enum" : [ "DEVICE_ADMINISTRATION", "ORG_ADMINISTRATION", "AUTH_ADMINISTRATION", "FIRMWARE_ADMINISTRATION", "DOOR_ACCESS_ADMINISTRATION", "CAMERA_ADMINISTRATION", "REGISTER_DEVICES", "DELETE_DEVICES", "LOCATION_ADMINISTRATION", "POLICY_ADMINISTRATION", "USER_ADMINISTRATION", "REPORT_ADMINISTRATION", "NOTIFICATION_ADMINISTRATION", "LICENSE_ADMINISTRATION", "RECEIVE_EMAILS", "MANAGE_FACES", "MANAGE_LICENSEPLATES", "API_ADMINISTRATION", "INTEGRATION_ADMINISTRATION", "DATA_EXFILTRATION", "ALERT_MONITORING_ADMINISTRATION", "ALERT_MONITORING_VIEWONLY", "ALERT_MONITORING_OPERATOR", "GUEST_MANAGEMENT_ADMINISTRATION", "GUEST_MANAGEMENT_VIEWONLY", "CLIP_MANAGEMENT", "VIEW_SAVED_VIDEO", "VIEW_AND_MANAGE_SAVED_VIDEO", "CLLM_ADMINISTRATION", "UNKNOWN" ] + }, + "GeneaSettings" : { "type" : "object", - "description" : "Request object for unlocking an Openpath door.", "properties" : { - "cameraUuid" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorId" : { - "type" : "integer", - "format" : "int32", - "description" : "Openpath door ID to unlock", - "example" : 12345, + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Integration_UnsubscribeZapierWebhookWSRequest" : { - "type" : "object", - "description" : "Request object for unsubscribing from a Zapier webhook.", - "properties" : { - "webhookId" : { + }, + "migrated" : { + "type" : "boolean", + "nullable" : true + }, + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + }, + "webhookUuid" : { + "type" : "string", + "nullable" : true } } }, - "Integration_UpdateAmtIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating AMT access control integration settings.", - "properties" : { - "amtSettings" : { - "$ref" : "#/components/schemas/AmtSettings" - } - } - }, - "Integration_UpdateAperioIntegrationWSRequest" : { + "GeneaType" : { "type" : "object", - "description" : "Request object for updating Aperio integration configuration.", - "properties" : { - "aperioSettings" : { - "$ref" : "#/components/schemas/IAperioType" + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + }, + "webhookUuid" : { + "type" : "string", + "nullable" : true + } } - }, - "required" : [ "aperioSettings" ] - }, - "Integration_UpdateApiTokenWSRequest" : { - "type" : "object", - "description" : "Request object for updating API token properties.", + } ], + "nullable" : true, "properties" : { - "newDisplayName" : { - "type" : "string", - "description" : "New display name for the API token", - "example" : "Updated API Token", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "newPermissionGroupUuid" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -94658,169 +97107,211 @@ } } }, - "Integration_UpdateApiTokenWSResponse" : { + "GenericButtonShadowType" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/GenericButtonStateEnumType" + }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "supervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Integration_UpdateAvigilonAltaV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Avigilon Alta V2 integration settings.", - "properties" : { - "avigilonAltaSettings" : { - "$ref" : "#/components/schemas/IAvigilonAltaType" - } - } + "GenericButtonStateEnumType" : { + "type" : "string", + "enum" : [ "BUTTON_DOWN", "BUTTON_UP", "UNKNOWN" ] }, - "Integration_UpdateAwsIntegrationWSRequest" : { + "GenericDoorType" : { "type" : "object", "properties" : { - "awsSettings" : { - "$ref" : "#/components/schemas/AwsSettings" + "id" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true } } }, - "Integration_UpdateBoulevardIntegrationWSRequest" : { + "GenericInputShadowType" : { "type" : "object", - "description" : "Request object for updating Boulevard access control integration settings.", + "allOf" : [ { + "type" : "object", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/GenericInputStateEnumType" + }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "supervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "accessWindowAfterMinutes" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes after appointment to allow access", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "accessWindowBeforeMinutes" : { + "createdAtMillis" : { "type" : "integer", - "format" : "int32", - "description" : "Number of minutes before appointment to allow access", + "format" : "int64", "nullable" : true }, - "apiToken" : { + "orgUuid" : { "type" : "string", - "description" : "Boulevard API token", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "boulevardBusinessId" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Boulevard business ID", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "boulevardLocationToRhombusLocationMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "description" : "Mapping of Boulevard location IDs to Rhombus location UUIDs", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "enabled" : { - "type" : "boolean", - "description" : "Whether the Boulevard integration is enabled", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Integration_UpdateBoxIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Box file storage integration settings.", - "properties" : { - "boxSettings" : { - "$ref" : "#/components/schemas/BoxSettings" - } - } - }, - "Integration_UpdateBrivoIntegrationV2WSRequest" : { - "type" : "object", - "properties" : { - "brivoSettings" : { - "$ref" : "#/components/schemas/IBrivoType" - } - } - }, - "Integration_UpdateBrivoIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Brivo access control integration settings.", - "properties" : { - "brivoSettings" : { - "$ref" : "#/components/schemas/BrivoSettings" - } - } - }, - "Integration_UpdateButterflymxIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating ButterflyMX V2 integration settings with enhanced intercom features.", - "properties" : { - "butterflymxSettings" : { - "$ref" : "#/components/schemas/IButterflyMXType" - } - } - }, - "Integration_UpdateButterflymxIntegrationWSRequest" : { + "GenericInputStateChangeEventType" : { "type" : "object", - "description" : "Request object for updating ButterflyMX intercom integration settings.", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/ButterflyMXSettings" + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "newState" : { + "$ref" : "#/components/schemas/GenericInputStateEnumType" + }, + "newSupervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } } - } - }, - "Integration_UpdateDeviceIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating device integration settings and device properties.", + } ], + "nullable" : true, "properties" : { - "createNewDevice" : { - "type" : "boolean", - "description" : "Whether to create a new device", - "example" : true, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceIntegrationSettings" : { - "$ref" : "#/components/schemas/IDeviceIntegrationType" + "correlationId" : { + "type" : "string", + "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the device location", - "example" : 37.7749, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the device location", - "example" : -122.4194, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "orgUuid" : { "type" : "string", - "description" : "Name of the device", - "example" : "Main Entrance Camera", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updateDevice" : { - "type" : "boolean", - "description" : "Whether to update an existing device", - "example" : false, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updateDeviceUuid" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -94829,1247 +97320,628 @@ } } }, - "Integration_UpdateDiceIntegrationWSRequest" : { + "GenericInputStateEnumType" : { + "type" : "string", + "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] + }, + "GenericObjectEmbedding" : { "type" : "object", - "description" : "Request object for updating Dice access control integration settings.", - "properties" : { - "diceSettings" : { - "$ref" : "#/components/schemas/IDiceType" - } - } - }, - "Integration_UpdateDropboxIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Dropbox integration settings.", - "properties" : { - "dropboxSettings" : { - "$ref" : "#/components/schemas/DropboxSettingsV2" - } - } - }, - "Integration_UpdateEmailIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating email notification integration settings.", - "properties" : { - "emailSettings" : { - "$ref" : "#/components/schemas/EmailSettings" - } - } - }, - "Integration_UpdateEnvoyIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Envoy V2 integration settings with enhanced visitor management features.", - "properties" : { - "envoySettings" : { - "$ref" : "#/components/schemas/IEnvoyType" - } - } - }, - "Integration_UpdateEnvoyIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Envoy visitor management integration settings.", - "properties" : { - "envoySettings" : { - "$ref" : "#/components/schemas/EnvoySettings" - } - } - }, - "Integration_UpdateFlicIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Flic smart button integration settings.", - "properties" : { - "flicSettings" : { - "$ref" : "#/components/schemas/IFlicType" - } - } - }, - "Integration_UpdateGeneaIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Genea V2 integration settings with enhanced access control features.", - "properties" : { - "geneaSettings" : { - "$ref" : "#/components/schemas/IGeneaType" - } - } - }, - "Integration_UpdateGeneaIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Genea access control integration settings.", "properties" : { - "geneaSettings" : { - "$ref" : "#/components/schemas/GeneaSettings" - } - } - }, - "Integration_UpdateGoogleIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Google V2 integration settings with enhanced features.", - "properties" : { - "googleSettings" : { - "$ref" : "#/components/schemas/IGoogleType" - } - } - }, - "Integration_UpdateGoogleIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Google integration settings.", - "properties" : { - "googleSettings" : { - "$ref" : "#/components/schemas/GoogleSettings" - } - } - }, - "Integration_UpdateGuestByTokenWSRequest" : { - "type" : "object", - "description" : "Request object for updating guest information using a token.", - "properties" : { - "fileName" : { - "type" : "string", - "description" : "File name for guest-related data", - "example" : "guest_data.csv", + "b" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - bottom permyriad", "nullable" : true }, - "guest" : { - "$ref" : "#/components/schemas/Guest" - }, - "token" : { - "type" : "string", - "description" : "Token for guest identification and authentication", - "example" : "guest_token_12345", - "nullable" : true - } - } - }, - "Integration_UpdateGuestManagementIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating guest management integration settings.", - "properties" : { - "guestManagementSettings" : { - "$ref" : "#/components/schemas/IGuestManagementType" - } - } - }, - "Integration_UpdateGuestWSRequest" : { - "type" : "object", - "properties" : { - "fileName" : { - "type" : "string", - "description" : "File name for guest-related data", - "example" : "guest_data.csv", + "clipEndMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "guest" : { - "$ref" : "#/components/schemas/Guest" - }, - "sendGuestEmail" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "Integration_UpdateHaloIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Halo access control integration settings.", - "properties" : { - "haloSettings" : { - "$ref" : "#/components/schemas/HaloSettings" - } - } - }, - "Integration_UpdateInformacastIntegrationRequest" : { - "type" : "object", - "properties" : { - "informacastSettings" : { - "$ref" : "#/components/schemas/IInformacastType" - } - } - }, - "Integration_UpdateInnerRangeIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating InnerRange access control integration settings.", - "properties" : { - "innerRangeSettings" : { - "$ref" : "#/components/schemas/IInnerRangeType" - } - } - }, - "Integration_UpdateIntuifaceIntegrationWSRequest" : { - "type" : "object", - "properties" : { - "settings" : { - "$ref" : "#/components/schemas/IntuifaceSettings" - } - } - }, - "Integration_UpdateKisiIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Kisi V2 integration settings with enhanced features.", - "properties" : { - "kisiSettings" : { - "$ref" : "#/components/schemas/IKisiType" - } - } - }, - "Integration_UpdateKisiIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Kisi access control integration settings.", - "properties" : { - "kisiSettings" : { - "$ref" : "#/components/schemas/KisiSettings" - } - } - }, - "Integration_UpdateLumeoIntegrationWSRequest" : { - "type" : "object", - "properties" : { - "lumeoSettings" : { - "$ref" : "#/components/schemas/ILumeoType" - } - } - }, - "Integration_UpdateMattermostIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Mattermost team communication integration settings.", - "properties" : { - "mattermostSettings" : { - "$ref" : "#/components/schemas/MattermostSettings" - } - } - }, - "Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" : { - "type" : "object", - "properties" : { - "teamId" : { + "deviceUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - } - } - }, - "Integration_UpdateMicrosoftTeamsIntegrationV2WSRequest" : { - "type" : "object", - "properties" : { - "microsoftTeamsSettings" : { - "$ref" : "#/components/schemas/IMicrosoftTeamsType" }, - "teamsToUpdate" : { + "embedding" : { "type" : "array", "items" : { - "type" : "string", + "type" : "number", + "format" : "float", "nullable" : true }, "nullable" : true - } - } - }, - "Integration_UpdateMicrosoftTeamsIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Microsoft Teams integration settings.", - "properties" : { - "microsoftTeamsSettings" : { - "$ref" : "#/components/schemas/MicrosoftTeamsSettings" - } - } - }, - "Integration_UpdateNineOneOneCellularIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating 911 Cellular emergency notification integration settings.", - "properties" : { - "nineOneOneCellularSettings" : { - "$ref" : "#/components/schemas/INineOneOneCellularType" - } - } - }, - "Integration_UpdateNoonlightSettingsWSRequest" : { - "type" : "object", - "properties" : { - "noonlightSettings" : { - "$ref" : "#/components/schemas/NoonlightSettings" - } - } - }, - "Integration_UpdateOffice365IntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Office 365 integration settings.", - "properties" : { - "office365Settings" : { - "$ref" : "#/components/schemas/Office365Settings" - } - } - }, - "Integration_UpdateOmnialertIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Omnialert emergency notification integration settings.", - "properties" : { - "omnialertSettings" : { - "$ref" : "#/components/schemas/IOmnialertType" - } - } - }, - "Integration_UpdateOmnialertIntegrationWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "embeddingId" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "isMatch" : { "type" : "string", + "description" : "Match confidence for the query: \"YES\", \"MAYBE\", or \"NO\". Set on CHARON model results; null for CLIP.", "nullable" : true }, - "webhookToken" : { + "l" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - left permyriad", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Integration_UpdateOpenAIIntegrationRequest" : { - "type" : "object", - "properties" : { - "openAISettings" : { - "$ref" : "#/components/schemas/IOpenAIType" - } - } - }, - "Integration_UpdateOpenpathIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Openpath access control integration settings.", - "properties" : { - "openpathSettings" : { - "$ref" : "#/components/schemas/OpenpathSettings" - } - } - }, - "Integration_UpdateOpentechAllianceIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating OpenTech Alliance V2 integration settings with enhanced features.", - "properties" : { - "opentechAllianceSettings" : { - "$ref" : "#/components/schemas/IOpentechAllianceType" - } - } - }, - "Integration_UpdateOpentechAllianceIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating OpenTech Alliance integration settings.", - "properties" : { - "opentechAllianceSettings" : { - "$ref" : "#/components/schemas/OpentechAllianceSettings" - } - } - }, - "Integration_UpdateOrgIntegrationsWSResponse" : { - "type" : "object", - "description" : "Response object for updating organization integrations.", - "properties" : { - "authError" : { - "type" : "boolean", - "description" : "Whether an authentication error occurred during update", - "example" : false, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "model" : { + "$ref" : "#/components/schemas/ObjectSearchModelEnum" }, - "failedGuids" : { - "type" : "array", - "description" : "List of GUIDs that failed to update", - "items" : { - "type" : "string", - "description" : "List of GUIDs that failed to update", - "nullable" : true - }, + "objectId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "misconfiguredDoors" : { - "type" : "array", - "description" : "List of door names that are assigned to multiple Rhombus locations", - "items" : { - "type" : "string", - "description" : "List of door names that are assigned to multiple Rhombus locations", - "nullable" : true - }, + "objectType" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Integration_UpdatePagerDutyIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating PagerDuty incident management integration settings.", - "properties" : { - "pagerDutySettings" : { - "$ref" : "#/components/schemas/PagerDutySettings" - } - } - }, - "Integration_UpdatePdkIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Pro Data Key (PDK) V2 integration settings with enhanced access control features.", - "properties" : { - "pdkSettings" : { - "$ref" : "#/components/schemas/IProDataKeyType" - } - } - }, - "Integration_UpdatePdkIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Pro Data Key (PDK) integration settings.", - "properties" : { - "pdkSettings" : { - "$ref" : "#/components/schemas/ProDataKeySettings" - } - } - }, - "Integration_UpdatePimlocIntegrationRequest" : { - "type" : "object", - "properties" : { - "pimlocSettings" : { - "$ref" : "#/components/schemas/IPimlocType" - } - } - }, - "Integration_UpdatePlaceOsSettingsV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating PlaceOS V2 integration settings for smart building management.", - "properties" : { - "placeOsSettings" : { - "$ref" : "#/components/schemas/IPlaceOsType" - } - } - }, - "Integration_UpdatePlaceOsSettingsWSRequest" : { - "type" : "object", - "properties" : { - "placeOsSettings" : { - "$ref" : "#/components/schemas/PlaceOsSettings" - } - } - }, - "Integration_UpdateRaptorIntegrationRequest" : { - "type" : "object", - "properties" : { - "raptorSettings" : { - "$ref" : "#/components/schemas/IRaptorType" - } - } - }, - "Integration_UpdateServiceNowIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating ServiceNow IT service management integration settings.", - "properties" : { - "serviceNowSettings" : { - "$ref" : "#/components/schemas/ServiceNowSettings" - } - } - }, - "Integration_UpdateShellyIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Shelly smart device integration settings.", - "properties" : { - "shellySettings" : { - "$ref" : "#/components/schemas/IShellyType" - } - } - }, - "Integration_UpdateSlackIntegrationV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating Slack integration V2 settings with enhanced user management.", - "properties" : { - "adminRequest" : { - "type" : "boolean", - "description" : "Whether this is an admin request", - "example" : true, + }, + "r" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - right permyriad", "nullable" : true }, - "requestUrl" : { - "type" : "string", - "description" : "Request URL for Slack OAuth", - "example" : "https://slack.com/oauth/v2/authorize?client_id=123&scope=...", + "stableTrackId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "revokeUserAccessToken" : { - "type" : "boolean", - "description" : "Whether to revoke user access token", - "example" : false, + "t" : { + "type" : "integer", + "format" : "int32", + "description" : "bounding box - top permyriad", "nullable" : true }, - "rhombusOrgUserUuid" : { + "thumbnailLocation" : { "type" : "string", - "description" : "Rhombus organization user UUID", - "example" : "user-uuid-12345", "nullable" : true }, - "slackSettingsV2" : { - "$ref" : "#/components/schemas/SlackSettingsV2" - }, - "userAssociate" : { - "type" : "boolean", - "description" : "Whether to associate user", - "example" : true, + "thumbnailUri" : { + "type" : "string", "nullable" : true }, - "userRequest" : { - "type" : "boolean", - "description" : "Whether this is a user request", - "example" : false, + "timestamp" : { + "type" : "integer", + "format" : "int64", "nullable" : true } - }, - "required" : [ "requestUrl" ] + } }, - "Integration_UpdateSlackIntegrationWSRequest" : { + "GenericObjectEmbeddingMatch" : { "type" : "object", - "description" : "Request object for updating Slack integration settings.", + "description" : "List of similar object embedding matches", "properties" : { - "slackSettings" : { - "$ref" : "#/components/schemas/SlackSettings" + "distance" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "embedding" : { + "$ref" : "#/components/schemas/GenericObjectEmbedding" + }, + "matchedEmbeddingId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Integration_UpdateToastIntegrationV2WSRequest" : { + "GenericPosSettings" : { "type" : "object", + "description" : "Collection of service area settings for this restaurant", + "nullable" : true, "properties" : { - "restaurantGuids" : { + "assignedCameraList" : { "type" : "array", + "description" : "A list of camera uuids from Rhombus that are assigned to the PoS device", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "toastSettings" : { - "$ref" : "#/components/schemas/IToastType" - } - } - }, - "Integration_UpdateToastIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating Toast POS integration settings.", - "properties" : { - "toastSettings" : { - "$ref" : "#/components/schemas/ToastSettings" + "posName" : { + "type" : "string", + "description" : "The name of the point of sale device", + "nullable" : true } } }, - "Integration_UpdateWebhookIntegrationV2WSRequest" : { + "GenericPosType" : { "type" : "object", - "description" : "Request object for updating webhook V2 integration settings with enhanced configuration options.", "properties" : { - "disabled" : { - "type" : "boolean", - "description" : "Whether the webhook is disabled", - "example" : false, - "nullable" : true - }, - "isDiagnostic" : { - "type" : "boolean", - "description" : "Whether this is a diagnostic webhook", - "example" : false, + "id" : { + "type" : "string", "nullable" : true }, - "updatedWebhookSettings" : { - "$ref" : "#/components/schemas/IWebhooksType" - }, - "webhookUrl" : { + "name" : { "type" : "string", - "description" : "Webhook URL for receiving notifications", - "example" : "https://api.example.com/webhook/rhombus", "nullable" : true } } }, - "Integration_UpdateWebhookIntegrationV2WSResponse" : { + "GenericRelayShadowType" : { "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "state" : { + "$ref" : "#/components/schemas/GenericRelayStateEnumType" + }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "webhookSecret" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Integration_UpdateWebhookIntegrationWSRequest" : { - "type" : "object", - "description" : "Request object for updating webhook integration settings.", - "properties" : { - "webhookSettings" : { - "$ref" : "#/components/schemas/WebhookSettings" - } - } - }, - "Integration_ValidateKisiApiKeyWSRequest" : { - "type" : "object", - "description" : "Request object for validating Kisi API key.", - "properties" : { - "apiKey" : { + }, + "ownerDeviceUuid" : { "type" : "string", - "description" : "Kisi API key to validate", - "example" : "kisi_api_key_123456789", - "nullable" : true - } - } - }, - "Integration_aperio_AperioDeviceView" : { - "type" : "object", - "description" : "View object containing Aperio device information.", - "properties" : { - "aperioId" : { - "type" : "array", - "description" : "Aperio device ID", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Aperio device ID", - "nullable" : true - }, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "gatewayId" : { - "type" : "array", - "description" : "Gateway ID associated with the device", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Gateway ID associated with the device", - "nullable" : true - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "lastSeenMs" : { + "updatedAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the device was last seen", - "example" : 1642233600000, - "nullable" : true - }, - "rawType" : { - "type" : "string", - "format" : "byte", - "description" : "Raw device type", - "example" : "MQ==", "nullable" : true } } }, - "Integration_aperio_AperioDoorView" : { + "GenericRelayStateChangeEventType" : { "type" : "object", - "description" : "View object containing Aperio door information and status.", + "allOf" : [ { + "type" : "object", + "properties" : { + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "steadyState" : { + "$ref" : "#/components/schemas/GenericRelayStateEnumType" + }, + "steadyStateChangedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "transientState" : { + "$ref" : "#/components/schemas/GenericRelayStateEnumType" + } + } + } ], + "nullable" : true, "properties" : { - "accessControlledDoorUuid" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "aperioDoorDeviceId" : { + "correlationId" : { "type" : "string", - "description" : "Aperio door device ID", "nullable" : true }, - "aperioGatewayId" : { - "type" : "string", - "description" : "Aperio gateway ID that brokers communication with this door", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "aperioId" : { + "locationUuid" : { "type" : "string", - "description" : "Aperio door ID (device group ID) for controlling the locking mechanism", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "connected" : { - "type" : "boolean", - "description" : "Whether the Aperio door is currently connected", - "example" : true, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorExtensionComponentId" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dtcs" : { - "type" : "array", - "description" : "List of diagnostic trouble codes (DTCs) for the door", - "items" : { - "$ref" : "#/components/schemas/Integration_aperio_DtcInfoView" - }, - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "lastSeenMs" : { + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the door was last seen", - "example" : 1642233600000, "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the Aperio door", - "example" : "Main Entrance", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "rawActivatorState" : { - "type" : "integer", - "format" : "int32", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "rawDoorMode" : { + } + } + }, + "GenericRelayStateEnumType" : { + "type" : "string", + "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] + }, + "GenericRs485PhysicalPortEnum" : { + "type" : "string", + "enum" : [ "RS485" ] + }, + "GenericRs485Port" : { + "type" : "object", + "properties" : { + "boardNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "rawHandleState" : { + "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "rawKeyCylinderState" : { - "type" : "integer", - "format" : "int32", + "portType" : { + "$ref" : "#/components/schemas/GenericRs485PhysicalPortEnum" + } + } + }, + "GenericVideoEmbedding" : { + "type" : "object", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "rawTamperState" : { - "type" : "integer", - "format" : "int32", + "embedding" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, "nullable" : true }, - "removed" : { - "type" : "boolean", - "description" : "Whether the door has been removed from the gateway", - "example" : false, + "embeddingId" : { + "type" : "string", "nullable" : true }, - "stateUpdateEventTimestampMs" : { + "endTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/Integration_aperio_AperioIntegrationStatus" - } - } - }, - "Integration_aperio_AperioGatewayView" : { - "type" : "object", - "description" : "View object containing Aperio gateway information and status.", - "properties" : { - "aperioGatewayId" : { + "locationUuid" : { "type" : "string", - "description" : "Aperio gateway ID (device interface unit ID)", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" + "model" : { + "$ref" : "#/components/schemas/VideoSimilarityModelEnum" }, - "componentUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "connected" : { - "type" : "boolean", - "description" : "Whether the Aperio gateway is currently connected", - "example" : true, - "nullable" : true - }, - "devices" : { - "type" : "array", - "description" : "List of Aperio devices associated with this gateway", - "items" : { - "$ref" : "#/components/schemas/Integration_aperio_AperioDeviceView" - }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true - }, - "doors" : { - "type" : "array", - "description" : "List of Aperio doors associated with this gateway", - "items" : { - "$ref" : "#/components/schemas/Integration_aperio_AperioDoorView" - }, + } + } + }, + "GenericVideoEmbeddingMatch" : { + "type" : "object", + "description" : "List of similar video embedding matches", + "properties" : { + "distance" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "dtcs" : { - "type" : "array", - "description" : "List of diagnostic trouble codes (DTCs) for the gateway", - "items" : { - "$ref" : "#/components/schemas/Integration_aperio_DtcInfoView" - }, - "nullable" : true + "embedding" : { + "$ref" : "#/components/schemas/GenericVideoEmbedding" }, - "expectedOemCode" : { + "matchedEmbeddingId" : { "type" : "string", - "description" : "Expected OEM code for the gateway (only available after system configuration)", "nullable" : true - }, - "firmwareVersion" : { + } + } + }, + "GeoIpLocationType" : { + "type" : "object", + "properties" : { + "city_name" : { "type" : "string", - "description" : "Firmware version of the Aperio gateway", - "example" : "1.2.3", "nullable" : true }, - "hardwareModel" : { + "country_code" : { "type" : "string", "nullable" : true }, - "hwVersion" : { - "type" : "array", - "description" : "Hardware version of the Aperio gateway", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "Hardware version of the Aperio gateway", - "nullable" : true - }, - "nullable" : true - }, - "ipAddress" : { + "country_name" : { "type" : "string", - "description" : "IP address of the Aperio gateway", - "example" : "192.168.1.100", - "nullable" : true - }, - "lastSeenMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the gateway was last seen", - "example" : 1642233600000, "nullable" : true }, - "protocolVersion" : { + "region_name" : { "type" : "string", - "description" : "Protocol version of the Aperio gateway", - "example" : "1.0.0", "nullable" : true + } + } + }, + "GeodeticCoordinates" : { + "type" : "object", + "properties" : { + "error" : { + "$ref" : "#/components/schemas/GpsError" }, - "rawTamperState" : { + "floor" : { "type" : "integer", "format" : "int32", - "description" : "Raw tamper state of the Aperio gateway", - "example" : 0, "nullable" : true }, - "reportedOemCode" : { - "type" : "string", - "description" : "OEM code reported by the gateway for authenticity verification", + "lat" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/Integration_aperio_AperioIntegrationStatus" + "lon" : { + "type" : "number", + "format" : "double", + "nullable" : true } } }, - "Integration_aperio_AperioIntegrationStatus" : { - "type" : "string", - "description" : "Integration status of the Aperio gateway", - "enum" : [ "UNKNOWN", "DISCOVERED", "PAIRING", "CONFIGURED", "ERROR_OEM", "ERROR_OWNER" ] - }, - "Integration_aperio_AperioRhombusDoorControllerView" : { + "GetTemporaryOrgTokenResponse" : { "type" : "object", - "description" : "View object containing Rhombus door controller information for Aperio integration.", "properties" : { - "aperioGateways" : { - "type" : "array", - "description" : "List of Aperio gateways associated with this door controller", - "items" : { - "$ref" : "#/components/schemas/Integration_aperio_AperioGatewayView" - }, - "nullable" : true - }, - "deviceUuid" : { + "tempOrgToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "hwId" : { - "type" : "string", - "description" : "Hardware ID of the Rhombus door controller", - "example" : "DC001", - "nullable" : true - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "name" : { - "type" : "string", - "description" : "Name of the Rhombus door controller", - "example" : "Main Door Controller", - "nullable" : true - }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the Rhombus door controller", - "example" : "RHDC123456789", - "nullable" : true } } }, - "Integration_aperio_ClearAperioDtcWSRequest" : { + "GoogleCaptchaSourceEnum" : { + "type" : "string", + "description" : "Source of the Google reCAPTCHA (legacy or V3)", + "enum" : [ "LEGACY", "RHOMBUS_CONSOLE_WEB", "RHOMBUS_CONSOLE_ANDROID_APP", "RHOMBUS_CONSOLE_IOS_APP", "RHOMBUS_KEY_ANDROID_APP", "RHOMBUS_KEY_IOS_APP" ] + }, + "GoogleSettings" : { "type" : "object", - "description" : "Request object for clearing Aperio DTC (Diagnostic Trouble Code) from a device.", + "description" : "Google integration settings to update", "properties" : { - "aperioDeviceId" : { + "accountUser" : { "type" : "string", - "description" : "The Aperio device id (hex string) of the device to which this command is issued.", "nullable" : true }, - "aperioGatewayId" : { - "type" : "string", - "description" : "The Aperio device id (hex string) of the gateway hosting the device.", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "controllerUuid" : { + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "registeredComponentUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "aperioDeviceId", "aperioGatewayId", "controllerUuid" ] - }, - "Integration_aperio_ClearAperioDtcWSResponse" : { - "type" : "object", - "description" : "Response object for clearing Aperio DTC (Diagnostic Trouble Code) from a device.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "folderId" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "teamDriveId" : { "type" : "string", "nullable" : true } } }, - "Integration_aperio_DownloadCertificateWSRequest" : { + "GoogleSettingsV2" : { "type" : "object", - "description" : "Request object for downloading Aperio certificate.", "properties" : { - "ownerDeviceUuid" : { + "defaultAlertFolderId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "ownerDeviceUuid" ] - }, - "Integration_aperio_DtcInfoView" : { - "type" : "object", - "description" : "View object containing Aperio diagnostic trouble code (DTC) information.", - "properties" : { - "code" : { - "type" : "array", - "description" : "DTC code as byte array", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "DTC code as byte array", - "nullable" : true - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "description" : "Whether the DTC represents an error condition", - "example" : true, "nullable" : true }, - "failing" : { - "type" : "boolean", - "description" : "Whether the DTC is currently failing", - "example" : true, + "defaultAlertFolderName" : { + "type" : "string", "nullable" : true }, - "hasFailed" : { - "type" : "boolean", - "description" : "Whether the DTC has failed in the past", - "example" : false, + "defaultFolderId" : { + "type" : "string", "nullable" : true }, - "name" : { + "defaultFolderName" : { "type" : "string", - "description" : "Display name of the DTC", - "example" : "Communication Error", "nullable" : true }, - "testCompleted" : { + "enabled" : { "type" : "boolean", - "description" : "Whether the DTC test has completed", - "example" : true, "nullable" : true }, - "time" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the DTC was reported (seconds since 1970-01-01)", - "example" : 1642233600, - "nullable" : true - } - } - }, - "Integration_aperio_RebootAperioGatewayWSRequest" : { - "type" : "object", - "description" : "Request object for rebooting an Aperio gateway.", - "properties" : { - "aperioGatewayId" : { - "type" : "string", - "description" : "The Aperio device id (hex string) of the gateway.", - "nullable" : true - }, - "controllerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "aperioGatewayId", "controllerUuid" ] - }, - "Integration_aperio_RebootAperioGatewayWSResponse" : { - "type" : "object", - "description" : "Response object for rebooting an Aperio gateway.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", "nullable" : true }, - "warningMsg" : { + "enablingUser" : { "type" : "string", "nullable" : true - } - } - }, - "Internal_AddPartnerAsSuperAdminWSRequest" : { - "type" : "object", - "description" : "Request object for adding a partner as a super admin to an organization.", - "properties" : { - "loginAccessAllowed" : { - "type" : "boolean", - "description" : "Whether login access is allowed for the partner", - "example" : true, - "nullable" : true }, - "orgUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "partnerEmail" : { - "type" : "string", - "description" : "Email address of the partner", - "example" : "partner@company.com", - "nullable" : true - }, - "partnerName" : { + "refreshToken" : { "type" : "string", - "description" : "Name of the partner", - "example" : "Partner Solutions Inc", "nullable" : true }, - "partnerUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Internal_AddPartnerAsSuperAdminWSResponse" : { - "type" : "object", - "description" : "Response object for adding a partner as a super admin to an organization.", - "properties" : { - "error" : { + "saveAllAlerts" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "superAdminGroupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "saveClips" : { + "type" : "boolean", "nullable" : true } } }, - "Internal_CreateCombinedLicensesFromV1WSRequest" : { + "GoogleType" : { "type" : "object", - "properties" : { - "accountDataMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Internal_CreateCombinedLicensesFromV1WSRequest_AccountData" + "allOf" : [ { + "type" : "object", + "properties" : { + "allowUserStorage" : { + "type" : "boolean", + "nullable" : true }, - "nullable" : true - } - } - }, - "Internal_CreateCombinedLicensesFromV1WSRequest_AccountData" : { - "type" : "object", - "properties" : { - "opportunityIds" : { - "type" : "array", - "items" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "nullable" : true - } - } - }, - "Internal_CreateCombinedLicensesFromV1WSResponse" : { - "type" : "object", - "nullable" : true, - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "failedAccounts" : { - "type" : "object", - "additionalProperties" : { + "defaultAlertFolderId" : { "type" : "string", "nullable" : true }, - "nullable" : true - }, - "successfulAccounts" : { - "type" : "array", - "items" : { + "defaultAlertFolderName" : { "type" : "string", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "defaultFolderId" : { + "type" : "string", + "nullable" : true + }, + "defaultFolderName" : { + "type" : "string", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "saveAllAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "userSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/GoogleUserSettings" + }, + "nullable" : true + } } - } - }, - "Internal_CreateOrgWSRequest" : { - "type" : "object", - "description" : "Request object for creating a new organization with account owner and company information.", + } ], + "nullable" : true, "properties" : { - "accountOwnerEmail" : { - "type" : "string", - "description" : "Email address of the account owner", - "example" : "owner@company.com", - "nullable" : true - }, - "accountOwnerName" : { - "type" : "string", - "description" : "Full name of the account owner", - "example" : "John Smith", - "nullable" : true - }, - "companyName" : { - "type" : "string", - "description" : "Name of the company or organization", - "example" : "Acme Corporation", - "nullable" : true - }, - "developmentPartnerOrg" : { - "type" : "boolean", - "description" : "Whether this is a development partner organization", - "example" : false, - "nullable" : true - }, - "licenseEntitlementEnabled" : { + "enabled" : { "type" : "boolean", - "description" : "Whether license entitlement is enabled for this organization", - "example" : true, - "nullable" : true - }, - "salesforceId" : { - "type" : "string", - "description" : "Salesforce ID for the organization (sensitive field)", "nullable" : true }, - "sendWelcomeEmail" : { - "type" : "boolean", - "description" : "Whether to send a welcome email to the account owner", - "example" : true, - "nullable" : true - } - } - }, - "Internal_CreateOrgWSResponse" : { - "type" : "object", - "description" : "Response object for creating a new organization.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "errorMsg" : { - "type" : "string", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, "orgUuid" : { @@ -96079,127 +97951,87 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Internal_CreatePartnerOrgWSRequest" : { + "GoogleUserSettings" : { "type" : "object", - "description" : "Request object for creating a new partner organization.", + "nullable" : true, "properties" : { - "accountOwnerEmail" : { + "defaultAlertFolderId" : { "type" : "string", - "description" : "Email address of the partner account owner", - "example" : "partner@company.com", "nullable" : true }, - "accountOwnerName" : { + "defaultAlertFolderName" : { "type" : "string", - "description" : "Full name of the partner account owner", - "example" : "Sarah Wilson", "nullable" : true }, - "companyName" : { + "defaultFolderId" : { "type" : "string", - "description" : "Name of the partner company", - "example" : "Partner Solutions Inc", "nullable" : true }, - "salesforceId" : { + "defaultFolderName" : { "type" : "string", - "description" : "Salesforce ID for the partner organization (sensitive field)", "nullable" : true }, - "sendWelcomeEmail" : { - "type" : "boolean", - "description" : "Whether to send a welcome email to the partner account owner", - "example" : true, - "nullable" : true - } - } - }, - "Internal_CreatePartnerOrgWSResponse" : { - "type" : "object", - "description" : "Response object for creating a new partner organization.", - "properties" : { - "error" : { - "type" : "boolean", + "refreshToken" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "saveAllAlerts" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "tokenValid" : { + "type" : "boolean", "nullable" : true } } }, - "Internal_CreateReturnedInventoryAuditReservationWSRequest" : { + "GpsError" : { "type" : "object", - "description" : "Request object for creating a returned inventory audit reservation.", "properties" : { - "clientOrgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "miscNotes" : { - "type" : "string", - "description" : "Miscellaneous notes for the inventory audit (deprecated)", - "example" : "Damaged packaging, missing accessories", - "nullable" : true - }, - "partnerOrgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "majorAxis" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "returnType" : { - "$ref" : "#/components/schemas/ReturnTypeEnum" - }, - "salesforceOppId" : { - "type" : "string", - "description" : "Salesforce opportunity ID for the inventory audit", - "example" : "0061234567890ABC", + "minorAxis" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "trackingNumber" : { - "type" : "string", - "description" : "Tracking number for the returned inventory (deprecated)", - "example" : "1Z999AA1234567890", + "rotation" : { + "type" : "number", + "format" : "double", "nullable" : true } } }, - "Internal_CreateReturnedInventoryAuditReservationWSResponse" : { + "Group_AddUsersToOrgGroupWSRequest" : { "type" : "object", - "description" : "Response object for creating a returned inventory audit reservation.", + "description" : "Request to add users to an organization group.", "properties" : { - "auditReservationUuid" : { + "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "auditReservationUuids" : { + "userUuids" : { "type" : "array", - "description" : "List of UUIDs for the created audit reservations", + "description" : "List of user UUIDs to add to the group", "items" : { "type" : "string", "format" : "RUUID", @@ -96208,139 +98040,100 @@ "nullable" : true }, "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Internal_CreateSupportAuthorityWSRequest" : { + "Group_AddUsersToOrgGroupWSResponse" : { "type" : "object", - "description" : "Request object for creating a support authority.", + "description" : "Response for adding users to an organization group.", "properties" : { - "supportAuthority" : { - "$ref" : "#/components/schemas/SupportAuthorityType" + "groupMembers" : { + "type" : "array", + "description" : "Users added to the group successfully from the original request", + "items" : { + "$ref" : "#/components/schemas/OrgGroupMemberType" + }, + "nullable" : true } } }, - "Internal_CreateSupportAuthorityWSResponse" : { + "Group_CreateOrgGroupWSRequest" : { "type" : "object", - "description" : "Response object for creating a support authority.", + "description" : "Request to create an organization group.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "description" : { "type" : "string", + "description" : "Description of the group", + "example" : "Software engineering team members", "nullable" : true }, - "supportAuthorityUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Internal_DeveloperNewsletterEnrollWSRequest" : { - "type" : "object", - "description" : "Request object for enrolling in the developer newsletter.", - "properties" : { - "developerNewsletter" : { - "type" : "boolean", - "description" : "Whether to subscribe to the developer newsletter", - "example" : true, - "nullable" : true - }, - "email" : { - "type" : "string", - "description" : "Email address for newsletter subscription", - "example" : "developer@company.com", - "nullable" : true - }, - "firstName" : { - "type" : "string", - "description" : "First name of the subscriber", - "example" : "Alex", - "nullable" : true - }, - "isDeveloper" : { - "type" : "boolean", - "description" : "Whether the subscriber is a developer", - "example" : true, - "nullable" : true - }, - "lastName" : { + "name" : { "type" : "string", - "description" : "Last name of the subscriber", - "example" : "Johnson", + "description" : "Name of the group", + "example" : "Engineering Team", "nullable" : true }, - "orgName" : { - "type" : "string", - "description" : "Name of the organization", - "example" : "TechCorp Solutions", + "userUuids" : { + "type" : "array", + "description" : "List of user UUIDs to add to the group", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true } - } + }, + "required" : [ "name" ] }, - "Internal_DeveloperNewsletterEnrollWSResponse" : { + "Group_CreateOrgGroupWSResponse" : { "type" : "object", - "description" : "Response object for developer newsletter enrollment.", + "description" : "Response for organization group creation.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "group" : { + "$ref" : "#/components/schemas/OrgGroupType" }, - "warningMsg" : { - "type" : "string", + "groupMembers" : { + "type" : "array", + "description" : "List of group members if optionally added when creating the group", + "items" : { + "$ref" : "#/components/schemas/OrgGroupMemberType" + }, "nullable" : true } } }, - "Internal_DeviceStateType" : { + "Group_DeleteOrgGroupWSRequest" : { "type" : "object", + "description" : "Request to delete an organization group.", "properties" : { - "connected" : { - "type" : "boolean", - "nullable" : true - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "serialNumber" : { + "groupUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Internal_GetDeviceStatesForOrgWSRequest" : { + "Group_DeleteOrgGroupWSResponse" : { + "type" : "object", + "description" : "Response indicating successful deletion of an organization group." + }, + "Group_FindAllUsersForOrgGroupWSRequest" : { "type" : "object", + "description" : "Request to find all users for an organization group.", "properties" : { - "orgUuid" : { + "groupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -96349,35 +98142,25 @@ } } }, - "Internal_GetDeviceStatesForOrgWSResponse" : { + "Group_FindAllUsersForOrgGroupWSResponse" : { "type" : "object", + "description" : "Response containing all users for an organization group.", "properties" : { - "deviceStates" : { + "groupMembers" : { "type" : "array", + "description" : "List of group members", "items" : { - "$ref" : "#/components/schemas/Internal_DeviceStateType" + "$ref" : "#/components/schemas/OrgGroupMemberType" }, "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Internal_GetSuperAdminGroupUUIDWSRequest" : { + "Group_FindOrgGroupMembershipsByUserWSRequest" : { "type" : "object", - "description" : "Request object for getting the super admin group UUID for an organization.", + "description" : "Request to find organization group memberships by user.", "properties" : { - "orgUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -96386,143 +98169,144 @@ } } }, - "Internal_GetSuperAdminGroupUUIDWSResponse" : { + "Group_FindOrgGroupMembershipsByUserWSResponse" : { "type" : "object", - "description" : "Response object for getting the super admin group UUID for an organization.", + "description" : "Response containing organization group memberships for a user.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "superAdminGroupUUID" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "userGroupMemberships" : { + "type" : "array", + "description" : "List of user group memberships", + "items" : { + "$ref" : "#/components/schemas/OrgGroupMemberType" + }, "nullable" : true } } }, - "Internal_GetWarrantyApprovedRMAsWSRequest" : { - "type" : "object" + "Group_FindOrgGroupMembershipsForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request to find organization group memberships for current user." }, - "Internal_GetWarrantyApprovedRMAsWSResponse" : { + "Group_FindOrgGroupMembershipsForCurrentUserWSResponse" : { "type" : "object", + "description" : "Response containing organization group memberships for current user.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - }, - "zendeskTickets" : { + "userGroupMemberships" : { "type" : "array", + "description" : "List of current user group memberships", "items" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "$ref" : "#/components/schemas/OrgGroupMemberType" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true } } }, - "Internal_InitiateShipmentWSRequest" : { + "Group_FindOrgGroupsByExactNameWSRequest" : { "type" : "object", - "description" : "Request object for initiating a shipment process.", + "description" : "Request to find organization groups by exact name.", "properties" : { - "rhombusShipmentInfo" : { - "$ref" : "#/components/schemas/RhombusShipmentInfoType" - }, - "salesforceOppId" : { + "groupName" : { "type" : "string", - "description" : "Salesforce opportunity ID for the shipment", - "example" : "0061234567890ABC", + "description" : "Case insensitive name of the group to find, if it exists", + "example" : "Engineering Team", "nullable" : true - }, - "shipmentCategory" : { - "$ref" : "#/components/schemas/CustomerShipmentCategoryEnum" - }, - "shipmentInfo" : { - "$ref" : "#/components/schemas/OutgoingShipmentInfoType" } } }, - "Internal_ListOrgsWSRequest" : { + "Group_FindOrgGroupsByExactNameWSResponse" : { "type" : "object", - "description" : "Request object for listing organizations." + "description" : "Response containing organization group found by exact name.", + "properties" : { + "group" : { + "$ref" : "#/components/schemas/OrgGroupType" + } + } }, - "Internal_ListOrgsWSResponse" : { + "Group_FindOrgGroupsByNamePrefixWSRequest" : { "type" : "object", - "description" : "Response object containing a list of organizations.", + "description" : "Request to find organization groups by name prefix.", "properties" : { - "orgs" : { + "groupNamePrefix" : { + "type" : "string", + "description" : "Name prefix to search for groups", + "example" : "Eng", + "nullable" : true + } + } + }, + "Group_FindOrgGroupsByNamePrefixWSResponse" : { + "type" : "object", + "description" : "Response containing organization groups found by name prefix.", + "properties" : { + "groups" : { "type" : "array", - "description" : "List of organizations", + "description" : "List of organization groups found by name prefix", "items" : { - "$ref" : "#/components/schemas/OrgV2Type" + "$ref" : "#/components/schemas/OrgGroupType" }, "nullable" : true } } }, - "Internal_ParentLifetimeSpendWSRequest" : { + "Group_FindOrgGroupsByOrgWSRequest" : { "type" : "object", - "description" : "Request object for retrieving parent lifetime spend information.", + "description" : "Request to find organization groups by organization." + }, + "Group_FindOrgGroupsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing organization groups found by organization.", "properties" : { - "endAccountIdx" : { - "type" : "integer", - "format" : "int32", - "description" : "Ending account index for the range", - "example" : 100, - "nullable" : true - }, - "startAccountIdx" : { - "type" : "integer", - "format" : "int32", - "description" : "Starting account index for the range", - "example" : 0, + "groups" : { + "type" : "array", + "description" : "List of organization groups found by organization", + "items" : { + "$ref" : "#/components/schemas/OrgGroupType" + }, "nullable" : true } } }, - "Internal_ParentLifetimeSpendWSResponse" : { + "Group_FindOrgGroupsByUserMembershipWSRequest" : { "type" : "object", - "description" : "Response object for parent lifetime spend information.", + "description" : "Request to find organization groups by user membership.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "warningMsg" : { - "type" : "string", + } + } + }, + "Group_FindOrgGroupsByUserMembershipWSResponse" : { + "type" : "object", + "description" : "Response containing organization groups found by user membership.", + "properties" : { + "groups" : { + "type" : "array", + "description" : "List of organization groups found by user membership", + "items" : { + "$ref" : "#/components/schemas/OrgGroupType" + }, "nullable" : true } } }, - "Internal_RemediateMissingFirstAssignedDatesWSRequest" : { + "Group_RemoveUsersFromOrgGroupWSRequest" : { "type" : "object", + "description" : "Request to remove users from an organization group.", "properties" : { - "orgUuids" : { + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuids" : { "type" : "array", + "description" : "List of user UUIDs to remove from the group", "items" : { "type" : "string", "format" : "RUUID", @@ -96534,374 +98318,351 @@ } } }, - "Internal_RemediateMissingFirstAssignedDatesWSResponse" : { + "Group_RemoveUsersFromOrgGroupWSResponse" : { + "type" : "object", + "description" : "Response indicating successful removal of users from an organization group." + }, + "Group_UpdateOrgGroupWSRequest" : { "type" : "object", + "description" : "Request to update an organization group.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "description" : { "type" : "string", + "description" : "New description for the group", + "example" : "Updated software engineering team members", "nullable" : true }, - "updateOrgUuidsToUpdatedLicenseUuids" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "name" : { "type" : "string", + "description" : "New name for the group", + "example" : "Updated Engineering Team", "nullable" : true } } }, - "Internal_RequestHardwareForDevelopmentWSRequest" : { + "Group_UpdateOrgGroupWSResponse" : { "type" : "object", - "description" : "Request object for requesting hardware for development purposes.", + "description" : "Response containing the updated organization group.", + "properties" : { + "group" : { + "$ref" : "#/components/schemas/OrgGroupType" + } + } + }, + "Guest" : { + "type" : "object", + "description" : "Guest information to update", "properties" : { "address1" : { "type" : "string", - "description" : "Street address line 1", - "example" : "123 Main Street", "nullable" : true }, - "city" : { + "address2" : { "type" : "string", - "description" : "City name", - "example" : "San Francisco", "nullable" : true }, - "companyName" : { - "type" : "string", - "description" : "Name of the company or organization", - "example" : "Tech Startup Inc", - "nullable" : true + "backgroundCheckStatus" : { + "$ref" : "#/components/schemas/BackgroundCheckEnum" }, - "country" : { - "type" : "string", - "description" : "Country name", - "example" : "United States", - "nullable" : true + "checkedInEnum" : { + "$ref" : "#/components/schemas/GuestActivityEnum" }, - "email" : { + "city" : { "type" : "string", - "description" : "Email address of the requester", - "example" : "developer@company.com", "nullable" : true }, - "firstName" : { + "companyName" : { "type" : "string", - "description" : "First name of the requester", - "example" : "Jane", "nullable" : true }, - "jobTitle" : { + "countryCode" : { "type" : "string", - "description" : "Job title of the requester", - "example" : "Senior Developer", "nullable" : true }, - "lastName" : { + "crime" : { "type" : "string", - "description" : "Last name of the requester", - "example" : "Doe", "nullable" : true }, - "phoneNumber" : { - "type" : "string", - "description" : "Phone number of the requester", - "example" : "+1-555-123-4567", + "documentLastSignedMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "nullable" : true }, - "requestReason" : { + "email" : { "type" : "string", - "description" : "Reason for requesting hardware for development", - "example" : "Testing new camera integration features", "nullable" : true }, - "state" : { + "emailCaseSensitive" : { "type" : "string", - "description" : "State or province", - "example" : "CA", "nullable" : true }, - "zip" : { + "faceImage" : { "type" : "string", - "description" : "ZIP or postal code", - "example" : "94105", - "nullable" : true - } - } - }, - "Internal_RequestHardwareForDevelopmentWSResponse" : { - "type" : "object", - "description" : "Response object for hardware development request.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "firstName" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Internal_SendShipmentShippedEmailWSRequest" : { - "type" : "object", - "description" : "Request object for sending shipment shipped email notification.", - "properties" : { - "salesforceOppId" : { - "type" : "string", - "description" : "Salesforce opportunity ID for the shipment email", - "example" : "0061234567890ABC", - "nullable" : true - } - } - }, - "Internal_SetOpportunityForPurchaseOrderWSRequest" : { - "type" : "object", - "description" : "Request object for setting opportunity information for a purchase order.", - "properties" : { - "cancellationReason" : { - "type" : "string", - "description" : "Reason for cancellation if the purchase order is not accepted", - "example" : "Budget constraints", + "lastCheckedInMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "isAccepted" : { - "type" : "boolean", - "description" : "Whether the purchase order is accepted", - "example" : true, + "lastCheckedOutMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "purchaseOrderNumber" : { + "lastName" : { "type" : "string", - "description" : "Purchase order number", - "example" : "PO-2024-001", "nullable" : true }, - "purchaseOrderUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "salesforceOppId" : { + "orgUuid" : { "type" : "string", - "description" : "Salesforce opportunity ID (sensitive field)", - "nullable" : true - } - } - }, - "Internal_SetOpportunityForPurchaseOrderWSResponse" : { - "type" : "object", - "description" : "Response object for setting opportunity information for a purchase order.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "personUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "phoneNumber" : { "type" : "string", "nullable" : true - } - } - }, - "Internal_ShipmentEmailWSResponse" : { - "type" : "object", - "description" : "Response object for shipment email operations.", - "properties" : { - "customerShipmentEmailState" : { - "$ref" : "#/components/schemas/CustomerShipmentEmailStateEnum" }, - "error" : { - "type" : "boolean", + "postalCode" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "profileImageKey" : { "type" : "string", "nullable" : true }, - "legacyMsg" : { + "profileImageUrl" : { "type" : "string", - "description" : "Legacy message for the shipment email", - "example" : "Shipment has been processed", "nullable" : true }, - "trackingIdentifier" : { + "state" : { "type" : "string", - "description" : "Tracking identifier for the shipment", - "example" : "1Z999AA1234567890", "nullable" : true }, - "warningMsg" : { + "status" : { + "$ref" : "#/components/schemas/GuestStatusEnum" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Internal_VerifyCanMigrateOrgFromV1JsonWSResponse" : { + "GuestActivityEnum" : { + "type" : "string", + "enum" : [ "CHECKED_IN", "CHECKED_OUT", "AUTO_CHECKED_OUT", "UPDATED_INFO", "INVITED", "SENT_DOCUMENTS_FOR_SIGNING", "SIGNED_DOCUMENTS", "UPDATED_INVITE", "RESENT_INVITE", "RESCINDED_INVITE" ] + }, + "GuestActivityLog" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", + "accessStartTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "activity" : { + "$ref" : "#/components/schemas/GuestActivityEnum" + }, + "agent" : { "type" : "string", "nullable" : true }, - "results" : { + "associatedCameras" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Internal_VerifyCanMigrateOrgFromV1JsonWSResponseEntry" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Internal_VerifyCanMigrateOrgFromV1JsonWSResponseEntry" : { - "type" : "object", - "properties" : { - "canMigrate" : { + "detailsUpdated" : { "type" : "boolean", "nullable" : true }, - "errorMessages" : { + "documentUuids" : { "type" : "array", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "nullable" : true, + "uniqueItems" : true + }, + "email" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "guestType" : { + "$ref" : "#/components/schemas/GuestTypeEnum" + }, + "guestUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Internal_VerifyCanMigrateOrgFromV1WSRequest" : { - "type" : "object", - "properties" : { - "entries" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Internal_VerifyCanMigrateOrgFromV1WSRequestEntry" - }, + }, + "hostUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Internal_VerifyCanMigrateOrgFromV1WSRequestEntry" : { - "type" : "object", - "properties" : { - "orgUuid" : { + }, + "inviteUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "productCodeToLicensesPurchasedMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Internal_VerifyCanMigrateOrgFromV1WSResponse" : { - "type" : "object", - "properties" : { - "error" : { + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rescinded" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "signingEnvelopeId" : { "type" : "string", "nullable" : true }, - "invalidOrgsToErrorMessages" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "walkIn" : { + "type" : "boolean", "nullable" : true } } }, - "IntuifaceSettings" : { + "GuestInvite" : { "type" : "object", + "description" : "The invitation after the update, with every field and not only the ones the request changed. Absent only when the update failed, in which case error is set.", "properties" : { - "deviceToTriggerMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/TriggerContent" - }, + "accessEndTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "accessStartTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "enabledTimestampMs" : { + "checkedInEnum" : { + "$ref" : "#/components/schemas/GuestActivityEnum" + }, + "checkedInMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "enablingUser" : { + "checkedOutMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdByUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "email" : { "type" : "string", "nullable" : true }, - "enablingUserUuid" : { + "guestType" : { + "$ref" : "#/components/schemas/GuestTypeEnum" + }, + "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "InvalidPhysicalPortConfigType" : { - "type" : "object", - "properties" : { - "boardNum" : { + }, + "hostUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastSentAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "componentUuids" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "meetingParticipants" : { "type" : "array", "items" : { "type" : "string", @@ -96913,593 +98674,802 @@ "nullable" : true, "uniqueItems" : true }, - "portNum" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "phoneNumber" : { + "type" : "string", + "nullable" : true + }, + "rescindedAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "reason" : { - "$ref" : "#/components/schemas/InvalidPhysicalPortReasonEnumType" + "rescindedByUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "signedDocuments" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SignedDocument" + }, + "nullable" : true + }, + "signingEnvelopeId" : { + "type" : "string", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "walkIn" : { + "type" : "boolean", + "nullable" : true } } }, - "InvalidPhysicalPortReasonEnumType" : { + "GuestInviteAccessActionEnum" : { "type" : "string", - "enum" : [ "NON_EXISTANT_COMPONENT_BOARD_NUM", "NON_EXISTANT_COMPONENT_PORT_NUM", "CONFLICTING_COMPONENT_PORT_TYPES", "COMPONENT_PORT_TYPE_NOT_SUPPORTED_BY_PORT", "MAX_COMPONENTS_PER_PORT_TYPE_EXCEEDED" ] + "description" : "Discriminator for the access mode.", + "enum" : [ "ADD_NEW", "ADD_REUSE", "EDIT", "REMOVE" ] }, - "InvoiceStatusEnum" : { - "type" : "string", - "enum" : [ "PAID", "UNPAID_PENDING", "UNPAID_OVERDUE", "CANCELLED" ] + "GuestInviteAccessUpdate" : { + "type" : "object", + "description" : "Polymorphic access change for a guest invite, discriminated on 'action'.", + "discriminator" : { + "propertyName" : "action" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AddNewPassAccessUpdate" + }, { + "$ref" : "#/components/schemas/AddReusePassAccessUpdate" + }, { + "$ref" : "#/components/schemas/EditPeriodAccessUpdate" + }, { + "$ref" : "#/components/schemas/RemoveAccessUpdate" + } ], + "properties" : { + "action" : { + "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" + } + }, + "required" : [ "action" ] }, - "InvoiceType" : { + "GuestInviteSelectiveUpdateByInvocation" : { "type" : "object", - "description" : "Invoice details and information", + "description" : "Guest invite to update", "properties" : { - "addOnLicenseInvoices" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AddOnLicenseInvoiceType" - }, + "accessEndTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "additionalEmails" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "accessStartTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "attachCsv" : { - "type" : "boolean", + "checkedInEnum" : { + "$ref" : "#/components/schemas/GuestActivityEnum" + }, + "checkedInMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "cameraPurchaseCount" : { + "checkedOutMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "cameraPurchasePrice" : { - "type" : "number", - "format" : "float", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "clientOrgUuid" : { + "createdByUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "companyName" : { + "email" : { "type" : "string", "nullable" : true }, - "customerAddress" : { - "type" : "string", - "nullable" : true + "guestType" : { + "$ref" : "#/components/schemas/GuestTypeEnum" }, - "customerEmail" : { + "guestUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "customerName" : { + "hostUserUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "date" : { + "lastSentAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "domePurchaseCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "domePurchasePrice" : { - "type" : "number", - "format" : "float", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "domeSubItems" : { + "meetingParticipants" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true - }, - "dueDate" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "externalId" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "installationPrice" : { - "type" : "number", - "format" : "float", + "phoneNumber" : { + "type" : "string", "nullable" : true }, - "license" : { - "$ref" : "#/components/schemas/LicenseEnum" - }, - "licenseCount" : { + "rescindedAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "licensePrice" : { - "type" : "number", - "format" : "float", + "rescindedByUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "licenseSubItems" : { + "signedDocuments" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/LicenseInvoiceSubItem" + "$ref" : "#/components/schemas/SignedDocument" }, "nullable" : true }, - "notes" : { + "signingEnvelopeId" : { "type" : "string", "nullable" : true }, - "partnerOrgUuid" : { + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "r1Camera1024" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HardwareInvoiceSubItem" - }, + "walkIn" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "GuestManagementCatalogItem" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "durationMonths" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "r1Camera512" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HardwareInvoiceSubItem" - }, + "productCode" : { + "type" : "string", "nullable" : true }, - "r1CameraPurchaseCount" : { + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + } + } + }, + "GuestManagementDocument" : { + "type" : "object", + "properties" : { + "createdAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "r1CameraPurchasePrice" : { - "type" : "number", - "format" : "float", - "nullable" : true + "defaultSigningCadence" : { + "$ref" : "#/components/schemas/SigningCadence" }, - "r1CameraSubItems" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HardwareInvoiceSubItem" - }, + "displayName" : { + "type" : "string", "nullable" : true }, - "r1LargeCameraPurchaseCount" : { - "type" : "integer", - "format" : "int32", + "docUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "r1LargeCameraPurchasePrice" : { - "type" : "number", - "format" : "float", + "fileName" : { + "type" : "string", "nullable" : true }, - "r1LargeSubItems" : { + "fixedPositions" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + "$ref" : "#/components/schemas/FixedPosition" }, "nullable" : true }, - "r1MediumSubItems" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HardwareInvoiceSubItem" - }, + "format" : { + "type" : "string", "nullable" : true }, - "salespersonName" : { + "lastUpdatedByUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "shippingPrice" : { - "type" : "number", - "format" : "float", + "lastUpdatedTimestampMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/InvoiceStatusEnum" + "mediaUrl" : { + "type" : "string", + "nullable" : true }, - "tax" : { - "type" : "number", - "format" : "float", + "places" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Place" + }, "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "signingCadenceOverrides" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SigningCadence" + }, "nullable" : true } } }, - "Invoice_InvoiceChargeV2WSRequest" : { + "GuestManagementLicenseType" : { "type" : "object", - "description" : "Request object for charging an invoice.", + "description" : "List of guest management licenses available for the client organization", "properties" : { - "invoiceUuid" : { + "claimKeyUuid" : { "type" : "string", - "description" : "UUID of the invoice to charge", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sourceToken" : { + "createdOn" : { "type" : "string", - "description" : "Payment source token for charging the invoice", - "example" : "tok_1234567890abcdef", + "format" : "date-time", "nullable" : true - } - } - }, - "Invoice_InvoiceChargeWSRequest" : { - "type" : "object", - "description" : "Request object for charging an invoice.", - "properties" : { - "invoiceUuid" : { + }, + "firstAssignedDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sourceToken" : { + "maxDeleteDate" : { "type" : "string", - "description" : "Payment source token for charging the invoice", - "example" : "tok_1234567890abcdef", + "format" : "date-time", "nullable" : true - } - } - }, - "Invoice_InvoiceChargeWSResponse" : { - "type" : "object", - "description" : "Response object for invoice charging operations.", - "properties" : { - "chargeSucceeded" : { - "type" : "boolean", - "description" : "Whether the invoice charge was successful", - "example" : true, + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { - "type" : "boolean", + "ownerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMessage" : { + "priorClaimKeyUuid" : { "type" : "string", - "description" : "Error message if the charge failed", - "example" : "Insufficient funds", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "productCode" : { "type" : "string", "nullable" : true }, - "previouslyInitialized" : { + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { "type" : "boolean", - "description" : "Whether the invoice was previously initialized for charging", - "example" : false, "nullable" : true }, - "warningMsg" : { + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Invoice_InvoiceDetailsV1WSResponse" : { + "GuestManagementLocationSettings" : { "type" : "object", - "description" : "Response object containing invoice details version 1.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "assignableDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "errorMsg" : { - "type" : "string", + "assignableElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "defaultAssignedDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "defaultAssignedElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "defaultAutoAccessEndMinuteOfDay" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "invoice" : { - "$ref" : "#/components/schemas/Invoice_InvoiceV1Type" + "defaultAutoAccessStartOffsetMinutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Invoice_InvoiceDetailsV2WSRequest" : { - "type" : "object", - "properties" : { - "netsuiteInvoiceUuid" : { + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Invoice_InvoiceDetailsV2WSResponse" : { + "GuestManagementOrgSettings" : { "type" : "object", "properties" : { - "error" : { + "createSeekPoints" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "documents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GuestManagementDocument" + }, + "nullable" : true + }, + "hexIdentityColor" : { "type" : "string", "nullable" : true }, - "invoice" : { - "$ref" : "#/components/schemas/NetsuiteInvoiceDetails" + "indexFaces" : { + "type" : "boolean", + "nullable" : true }, - "warningMsg" : { + "locationReceptionHostUserUuidMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "logoImageString" : { "type" : "string", "nullable" : true - } - } - }, - "Invoice_InvoiceDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for retrieving invoice details.", - "properties" : { - "invoiceUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "userHostNotificationSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "nullable" : true } } }, - "Invoice_InvoiceDetailsWSResponse" : { + "GuestManagementSettingsSelectiveUpdate" : { "type" : "object", - "description" : "Response object containing invoice details.", "properties" : { - "error" : { + "createSeekPoints" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "documents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GuestManagementDocument" + }, "nullable" : true }, - "invoice" : { - "$ref" : "#/components/schemas/InvoiceType" - }, - "warningMsg" : { + "hexIdentityColor" : { "type" : "string", "nullable" : true - } - } - }, - "Invoice_InvoiceV1LineItemType" : { - "type" : "object", - "description" : "Line item information for invoice version 1.", - "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the product", - "example" : "4K Ultra HD Security Camera with Night Vision", + }, + "indexFaces" : { + "type" : "boolean", "nullable" : true }, - "family" : { - "type" : "string", - "description" : "Product family category", - "example" : "Cameras", + "locationReceptionHostUserUuidMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "name" : { + "logoImageString" : { "type" : "string", - "description" : "Name of the product", - "example" : "Security Camera", "nullable" : true }, - "productCode" : { + "orgUuid" : { "type" : "string", - "description" : "Product code for the line item", - "example" : "CAM-001", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "quantity" : { - "type" : "number", - "format" : "float", - "description" : "Quantity of the product", - "example" : 2.0, + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "subtotal" : { - "type" : "number", - "format" : "float", - "description" : "Subtotal for this line item (quantity × unit price)", - "example" : 199.98, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true }, - "unitPrice" : { - "type" : "number", - "format" : "float", - "description" : "Unit price of the product", - "example" : 99.99, + "userHostNotificationSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + }, "nullable" : true } } }, - "Invoice_InvoiceV1Type" : { + "GuestManagementType" : { "type" : "object", - "description" : "Invoice version 1 type containing comprehensive billing and line item information.", + "allOf" : [ { + "type" : "object", + "properties" : { + "locationSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/LocationSettings" + }, + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "billingContactEmail" : { - "type" : "string", - "description" : "Email address of the billing contact", - "example" : "billing@company.com", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "billingContactMailingCity" : { - "type" : "string", - "description" : "Billing contact mailing city", - "example" : "Los Angeles", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "billingContactMailingCountry" : { + "orgUuid" : { "type" : "string", - "description" : "Billing contact mailing country", - "example" : "United States", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "billingContactMailingPostalCode" : { + "userUuid" : { "type" : "string", - "description" : "Billing contact mailing postal code", - "example" : "90210", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "billingContactMailingState" : { + } + } + }, + "GuestPassEventOriginator" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "guestPassName" : { + "type" : "string", + "nullable" : true + }, + "guestPassUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" + } + } + }, + "GuestPassIntervalSourceEnum" : { + "type" : "string", + "enum" : [ "ABSOLUTE", "DAILY", "AUTO" ] + }, + "GuestSelectiveUpdateByInvocation" : { + "type" : "object", + "description" : "The fields to change. The guest is identified by the update's uuid, or by its email when no uuid is given.", + "properties" : { + "address1" : { "type" : "string", - "description" : "Billing contact mailing state", - "example" : "CA", "nullable" : true }, - "billingContactMailingStreet" : { + "address2" : { "type" : "string", - "description" : "Billing contact mailing street address", - "example" : "456 Billing St", "nullable" : true }, - "billingContactName" : { + "backgroundCheckStatus" : { + "$ref" : "#/components/schemas/BackgroundCheckEnum" + }, + "checkedInEnum" : { + "$ref" : "#/components/schemas/GuestActivityEnum" + }, + "city" : { "type" : "string", - "description" : "Name of the billing contact", - "example" : "Jane Doe", "nullable" : true }, "companyName" : { "type" : "string", - "description" : "Name of the company", - "example" : "Acme Corporation", "nullable" : true }, - "dueDate" : { + "countryCode" : { "type" : "string", - "description" : "Due date in YYYY-MM-DD format", - "example" : "2024-02-14", "nullable" : true }, - "grandTotal" : { - "type" : "number", - "format" : "float", - "description" : "Grand total amount including tax and shipping", - "example" : 225.98, + "crime" : { + "type" : "string", "nullable" : true }, - "invoiceDate" : { - "type" : "string", - "description" : "Invoice date in YYYY-MM-DD format", - "example" : "2024-01-15", + "documentLastSignedMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "nullable" : true }, - "invoiceNumber" : { + "email" : { "type" : "string", - "description" : "Invoice number", - "example" : "INV-2024-001", "nullable" : true }, - "lineItems" : { - "type" : "array", - "description" : "List of line items on the invoice", - "items" : { - "$ref" : "#/components/schemas/Invoice_InvoiceV1LineItemType" - }, + "emailCaseSensitive" : { + "type" : "string", "nullable" : true }, - "notes" : { + "faceImage" : { "type" : "string", - "description" : "Additional notes for the invoice", - "example" : "Payment due within 30 days", "nullable" : true }, - "partnerBillingCity" : { + "firstName" : { "type" : "string", - "description" : "Partner billing city", - "example" : "San Francisco", "nullable" : true }, - "partnerBillingCountry" : { + "lastCheckedInMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastCheckedOutMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastName" : { "type" : "string", - "description" : "Partner billing country", - "example" : "United States", "nullable" : true }, - "partnerBillingPostalCode" : { + "locationUuid" : { "type" : "string", - "description" : "Partner billing postal code", - "example" : "94105", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "partnerBillingState" : { + "orgUuid" : { "type" : "string", - "description" : "Partner billing state", - "example" : "CA", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "partnerBillingStreet" : { + "personUuid" : { "type" : "string", - "description" : "Partner billing street address", - "example" : "123 Business Ave", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "partnerName" : { + "phoneNumber" : { "type" : "string", - "description" : "Name of the partner", - "example" : "Partner Solutions Inc", "nullable" : true }, - "salespersonName" : { + "postalCode" : { "type" : "string", - "description" : "Name of the salesperson", - "example" : "John Smith", "nullable" : true }, - "shipping" : { - "type" : "number", - "format" : "float", - "description" : "Shipping cost", - "example" : 9.99, + "profileImageKey" : { + "type" : "string", "nullable" : true }, - "status" : { + "profileImageUrl" : { "type" : "string", - "description" : "Status of the invoice", - "example" : "Paid", "nullable" : true }, - "subtotal" : { - "type" : "number", - "format" : "float", - "description" : "Subtotal amount before tax and shipping", - "example" : 199.99, + "state" : { + "type" : "string", "nullable" : true }, - "tax" : { - "type" : "number", - "format" : "float", - "description" : "Tax amount", - "example" : 16.0, + "status" : { + "$ref" : "#/components/schemas/GuestStatusEnum" + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true }, "uuid" : { @@ -97511,200 +99481,183 @@ } } }, - "JakartaFamilyEnum" : { - "type" : "string", - "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] - }, - "JakartaSameSiteEnum" : { + "GuestStatusEnum" : { "type" : "string", - "enum" : [ "NONE", "LAX", "STRICT" ] + "enum" : [ "INVITED", "PENDING", "APPROVED", "DENIED" ] }, - "JavaTimeUnitEnum" : { + "GuestTypeEnum" : { "type" : "string", - "description" : "Time granularity for the uptime report", - "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] + "enum" : [ "CONTRACTOR", "INTERVIEWER", "GENERAL_VISITOR", "UNPLANNED_VISITOR", "PARTNER", "MEETINGS" ] }, - "JsonNode" : { + "Guestmanagement_ActivateKioskWSRequest" : { "type" : "object", - "description" : "A WebAuthn credential auth response" - }, - "KeypadCommandEnum" : { - "type" : "string", - "description" : "Command being executed with the current keypad.", - "enum" : [ "ALARM_RAISED", "ARM", "ARMED", "ARMING_COUNTDOWN", "CANCEL", "COUNTDOWN", "DISARM", "DISARMED", "DISARMING", "DISMISSING", "LOGS_REQUESTED", "PENDING_ARMED", "THREAT_DETECTED", "VERIFYING", "UNKNOWN" ] + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } }, - "KeypadConfigType" : { + "Guestmanagement_ActivateKioskWSResponse" : { "type" : "object", - "description" : "List of all registered keypads for the organization", "properties" : { - "additionalFeaturesDisabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "armCountdownSecs" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "buildingAdminPhoneNumber" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "connectionState" : { - "$ref" : "#/components/schemas/KeypadConnectionStateEnum" - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "ipAddress" : { + "redirectUrl" : { "type" : "string", "nullable" : true }, - "lastModified" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationName" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Guestmanagement_BaseGuestManagementWSRequest" : { + "type" : "object", + "description" : "Base request object for guest management operations." + }, + "Guestmanagement_CreateEnvelopeWSRequest" : { + "type" : "object", + "properties" : { + "docUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true }, - "locationUuid" : { + "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "logoUuid" : { + "signerEmail" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "signerName" : { + "type" : "string", "nullable" : true }, - "name" : { + "title" : { "type" : "string", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Guestmanagement_CreateEnvelopeWSResponse" : { + "type" : "object", + "properties" : { + "ceremonyUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "platform" : { - "$ref" : "#/components/schemas/KeypadPlatformEnum" - }, - "qualifiedAddress" : { - "$ref" : "#/components/schemas/QualifiedAddressType" + "envelopeId" : { + "type" : "string", + "nullable" : true }, - "showCallBuildingAdmin" : { + "error" : { "type" : "boolean", "nullable" : true }, - "signalStrength" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "tz" : { + "status" : { "type" : "string", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Guestmanagement_CreateGuestInviteWSRequest" : { + "type" : "object", + "description" : "Request object for creating a visit for an existing guest.", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/GuestInviteAccessUpdate" }, - "videoWallUuid" : { + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" + }, + "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } - }, - "KeypadConnectionStateEnum" : { - "type" : "string", - "enum" : [ "ONLINE", "OFFLINE" ] - }, - "KeypadPlatformEnum" : { - "type" : "string", - "description" : "The keypad platform (IOS or ANDROID)", - "enum" : [ "ANDROID", "IOS" ] + }, + "required" : [ "guestInvite", "guestUuid" ] }, - "Keypad_AuthenticatePinRequest" : { + "Guestmanagement_CreateGuestInviteWSResponse" : { "type" : "object", - "description" : "Request object for authenticating a keypad PIN.", + "description" : "Response object describing the visit that was created, and any access provisioned for it. No email is sent, so there is nothing here about one.", "properties" : { - "pin" : { + "accessPeriodUuid" : { "type" : "string", - "description" : "PIN code to authenticate", - "example" : "1234", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Keypad_AuthenticatePinResponse" : { - "type" : "object", - "description" : "Response object for keypad PIN authentication.", - "properties" : { - "authenticated" : { + }, + "error" : { "type" : "boolean", - "description" : "Whether the PIN authentication was successful", - "example" : true, "nullable" : true - } - } - }, - "Keypad_ClaimKeypadActivationTokenRequest" : { - "type" : "object", - "description" : "Request object for claiming a keypad activation token to connect a keypad to Rhombus services.", - "properties" : { - "activationToken" : { + }, + "errorMsg" : { "type" : "string", - "description" : "Activation token for claiming the keypad", - "example" : "act_token_12345", "nullable" : true }, - "locationUuid" : { + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" + }, + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + }, + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", - "description" : "Name for the keypad", - "example" : "Main Entrance Keypad", "nullable" : true } } }, - "Keypad_ClaimKeypadActivationTokenResponse" : { + "Guestmanagement_CreateGuestManagementSettingsWSRequest" : { + "type" : "object", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/GuestManagementOrgSettings" + } + } + }, + "Guestmanagement_CreateGuestManagementSettingsWSResponse" : { "type" : "object", - "description" : "Response object for claiming a keypad activation token.", "properties" : { "error" : { "type" : "boolean", @@ -97720,13 +99673,19 @@ } } }, - "Keypad_GetCurrentKeypadWSRequest" : { + "Guestmanagement_CreateGuestV2WSRequest" : { "type" : "object", - "description" : "Request object for getting the current keypad information." + "description" : "Request object for creating a guest. Identity only - no visit is created.", + "properties" : { + "guest" : { + "$ref" : "#/components/schemas/Guest" + } + }, + "required" : [ "guest" ] }, - "Keypad_GetCurrentKeypadWSResponse" : { + "Guestmanagement_CreateGuestV2WSResponse" : { "type" : "object", - "description" : "Response object containing current keypad configuration information.", + "description" : "Response object describing the guest that was created.", "properties" : { "error" : { "type" : "boolean", @@ -97736,8 +99695,15 @@ "type" : "string", "nullable" : true }, - "keypad" : { - "$ref" : "#/components/schemas/KeypadConfigType" + "guest" : { + "$ref" : "#/components/schemas/Guest" + }, + "guestUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -97745,11 +99711,34 @@ } } }, - "Keypad_GetKeypadsForLocationWSRequest" : { + "Guestmanagement_CreateGuestWSRequest" : { "type" : "object", - "description" : "Request object for getting all registered keypads for a specific location.", + "description" : "Request object for creating a guest with optional file attachment.", "properties" : { - "locationUuid" : { + "fileName" : { + "type" : "string", + "description" : "Optional file name for guest attachment", + "example" : "guest_photo.jpg", + "nullable" : true + }, + "guest" : { + "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" + }, + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" + } + } + }, + "Guestmanagement_DeleteGuestWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a guest, named by uuid or by email.", + "properties" : { + "email" : { + "type" : "string", + "description" : "Email of the guest to delete. Used only when no uuid is given.", + "nullable" : true + }, + "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -97758,108 +99747,113 @@ } } }, - "Keypad_GetKeypadsForLocationWSResponse" : { + "Guestmanagement_ExportGuestActivitiesWSRequest" : { "type" : "object", - "description" : "Response object containing all registered keypads for a specific location.", "properties" : { - "error" : { - "type" : "boolean", + "beginTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "email" : { "type" : "string", "nullable" : true }, - "keypads" : { + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "includeGuestTypes" : { "type" : "array", - "description" : "List of all registered keypads for the specified location", "items" : { - "$ref" : "#/components/schemas/KeypadConfigType" + "$ref" : "#/components/schemas/GuestTypeEnum" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "includeLocations" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Keypad_GetKeypadsForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting all registered keypads for an organization." - }, - "Keypad_GetKeypadsForOrgWSResponse" : { + "Guestmanagement_ExportGuestsWSRequest" : { "type" : "object", - "description" : "Response object containing all registered keypads for an organization.", "properties" : { - "error" : { - "type" : "boolean", + "beginTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "endTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "keypads" : { + "includeGuestTypes" : { "type" : "array", - "description" : "List of all registered keypads for the organization", "items" : { - "$ref" : "#/components/schemas/KeypadConfigType" + "$ref" : "#/components/schemas/GuestTypeEnum" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "includeLocations" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Keypad_KeypadCheckinWSRequest" : { + "Guestmanagement_GetActivityLogsForGuestWSRequest" : { "type" : "object", - "description" : "Request object for keypad online/offline checkin processing.", "properties" : { - "ipAddress" : { + "email" : { "type" : "string", - "description" : "Local IP address of the keypad for discoverability", "nullable" : true }, - "platform" : { - "$ref" : "#/components/schemas/KeypadPlatformEnum" - }, - "signalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "Signal strength of the keypad connection", - "example" : -45, + "guestUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Keypad_KeypadCheckinWSResponse" : { - "type" : "object", - "description" : "Response object for keypad checkin operations." - }, - "Keypad_PublishKeypadCommandWSRequest" : { + "Guestmanagement_GetActivityLogsForLocationWSRequest" : { "type" : "object", - "description" : "Request object for sending a STOMP containing a keypad command.", "properties" : { - "command" : { - "$ref" : "#/components/schemas/KeypadCommandEnum" + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "executeAtMs" : { + "createdBeforeMs" : { "type" : "integer", "format" : "int64", - "description" : "Epoch timestamp (ms) when to execute the command if applicable.", "nullable" : true - } - }, - "required" : [ "command" ] - }, - "Keypad_UnregisterKeypadRequest" : { - "type" : "object", - "description" : "Request object for unregistering a keypad.", - "properties" : { - "keypadUuid" : { + }, + "dynamoPageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -97868,9 +99862,9 @@ } } }, - "Keypad_UnregisterKeypadResponse" : { + "Guestmanagement_GetAllGuestInvitesWSResponse" : { "type" : "object", - "description" : "Response object for unregistering a keypad.", + "description" : "Response object containing all guest invites.", "properties" : { "error" : { "type" : "boolean", @@ -97880,118 +99874,119 @@ "type" : "string", "nullable" : true }, + "guestInvites" : { + "type" : "array", + "description" : "List of all guest invites", + "items" : { + "$ref" : "#/components/schemas/GuestInvite" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Keypad_UpdateKeypadRequest" : { + "Guestmanagement_GetAllGuestsWSResponse" : { "type" : "object", - "description" : "Request object for updating keypad settings and configuration.", + "description" : "Response object containing all guests.", "properties" : { - "additionalFeaturesDisabled" : { - "type" : "boolean", + "allGuests" : { + "type" : "array", + "description" : "List of all guests", + "items" : { + "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" + }, "nullable" : true }, - "armCountdownSecs" : { - "type" : "integer", - "format" : "int32", - "description" : "Arm countdown seconds for the keypad", - "example" : 30, + "error" : { + "type" : "boolean", "nullable" : true }, - "buildingAdminPhoneNumber" : { + "errorMsg" : { "type" : "string", - "description" : "Phone number of the building administrator", - "example" : "+1-555-123-4567", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the keypad is located", - "example" : 1, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "keypadUuid" : { + } + } + }, + "Guestmanagement_GetDocumentsToSignV2WSRequest" : { + "type" : "object", + "description" : "Request object for listing the documents a guest is due to sign for a visit.", + "properties" : { + "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the keypad location", - "example" : 37.7749, - "nullable" : true - }, - "locationName" : { - "type" : "string", - "description" : "Name of the location where the keypad is installed", - "example" : "Main Building", - "nullable" : true - }, - "locationUuid" : { + "inviteUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "logoUuid" : { + "timeZone" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Timezone the day is resolved in when no inviteUuid is given. Defaults to the guest's location.", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the keypad location", - "example" : -122.4194, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The moment the visit is being assessed at. Defaults to now.", "nullable" : true - }, - "name" : { + } + }, + "required" : [ "guestUuid" ] + }, + "Guestmanagement_GetDocumentsToSignWSRequest" : { + "type" : "object", + "description" : "Request object for the documents a guest has left to sign on a given visit.", + "properties" : { + "email" : { "type" : "string", - "description" : "Name of the keypad", - "example" : "Main Entrance Keypad", + "description" : "Email address of the guest", + "example" : "guest@example.com", "nullable" : true }, - "qualifiedAddress" : { - "$ref" : "#/components/schemas/QualifiedAddressType" - }, - "showCallBuildingAdmin" : { - "type" : "boolean", - "description" : "Whether to show the call building admin option", - "example" : true, + "inviteUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "timeZoneId" : { + "timeZone" : { "type" : "string", - "description" : "Time zone ID for the keypad location", + "description" : "IANA zone id of the requesting device", "example" : "America/Los_Angeles", "nullable" : true }, - "videoWallUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch millis the request is being made for; defaults to now", "nullable" : true } } }, - "Keypad_UpdateKeypadResponse" : { + "Guestmanagement_GetDocumentsToSignWSResponse" : { "type" : "object", - "description" : "Response object for updating keypad settings.", "properties" : { + "documents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GuestManagementDocument" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -98006,108 +100001,100 @@ } } }, - "Kiosk" : { + "Guestmanagement_GetEnvelopeWSRequest" : { "type" : "object", - "description" : "List of all registered kiosks for the organization", "properties" : { - "batteryLevel" : { - "type" : "number", - "format" : "float", + "envelopeId" : { + "type" : "string", + "nullable" : true + } + } + }, + "Guestmanagement_GetEnvelopeWSResponse" : { + "type" : "object", + "properties" : { + "ceremonyUrl" : { + "type" : "string", "nullable" : true }, - "connectionStatus" : { - "$ref" : "#/components/schemas/ConnectionStatusEnum" + "envelopeId" : { + "type" : "string", + "nullable" : true }, - "deleted" : { + "error" : { "type" : "boolean", "nullable" : true }, - "hostUserUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "lastUpdateTimeMs" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", + "status" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Guestmanagement_GetGuestActivityLogsWSRequest" : { + "type" : "object", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "name" : { - "type" : "string", + "dynamoPageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + } + }, + "Guestmanagement_GetGuestActivityLogsWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "printerIP" : { - "type" : "string", + "guestActivities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GuestActivityLog" + }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "KioskSelectiveUpdate" : { + "Guestmanagement_GetGuestInviteForDayWSRequest" : { "type" : "object", - "description" : "Selective update information for the kiosk", "properties" : { - "batteryLevel" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "connectionStatus" : { - "$ref" : "#/components/schemas/ConnectionStatusEnum" - }, - "deleted" : { - "type" : "boolean", + "email" : { + "type" : "string", "nullable" : true }, - "hostUserUuid" : { + "guestUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastUpdateTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -98115,85 +100102,109 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "Guestmanagement_GetGuestInviteWSResponse" : { + "type" : "object", + "description" : "Response object containing guest invite information.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" + }, + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Guestmanagement_GetGuestInvitesWSResponse" : { + "type" : "object", + "description" : "Response object containing guest invites.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "printerIP" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true + "guestInvites" : { + "type" : "array", + "description" : "List of guest invites", + "items" : { + "$ref" : "#/components/schemas/GuestInvite" }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Kiosk_ClaimKioskActivationTokenRequest" : { + "Guestmanagement_GetGuestManagementLocationSettingsForOrgWSResponse" : { "type" : "object", - "description" : "Request object for claiming a kiosk activation token to connect a kiosk to Rhombus services.", "properties" : { - "activationToken" : { - "type" : "string", - "description" : "Activation token for claiming the kiosk", - "example" : "kiosk_token_12345", + "error" : { + "type" : "boolean", "nullable" : true }, - "hostUserUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationUuid" : { + "settings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GuestManagementLocationSettings" + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Guestmanagement_GetGuestManagementLocationSettingsWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", - "description" : "Name for the kiosk", - "example" : "Lobby Guest Kiosk", "nullable" : true }, - "permissionGroupUuid" : { + "settings" : { + "$ref" : "#/components/schemas/GuestManagementLocationSettings" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Kiosk_ClaimKioskActivationTokenResponse" : { + "Guestmanagement_GetGuestManagementSettingsWSResponse" : { "type" : "object", - "description" : "Response object for claiming a kiosk activation token.", "properties" : { "error" : { "type" : "boolean", @@ -98203,28 +100214,39 @@ "type" : "string", "nullable" : true }, + "settings" : { + "$ref" : "#/components/schemas/GuestManagementOrgSettings" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Kiosk_DeleteKioskWSRequest" : { + "Guestmanagement_GetGuestPassesForOrgWSRequest" : { "type" : "object", - "description" : "Request object for deleting a kiosk.", + "description" : "Request object for listing the org's guest-management guest passes.", "properties" : { - "kioskUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "paginateRequest" : { + "$ref" : "#/components/schemas/PaginateRequest" + }, + "startAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Only return passes starting at or after this time.", + "nullable" : true + }, + "startBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Only return passes starting at or before this time.", "nullable" : true } } }, - "Kiosk_DeleteKioskWSResponse" : { + "Guestmanagement_GetGuestPassesWSResponse" : { "type" : "object", - "description" : "Response object for deleting a kiosk.", + "description" : "Response object containing guest-management guest passes.", "properties" : { "error" : { "type" : "boolean", @@ -98234,19 +100256,28 @@ "type" : "string", "nullable" : true }, + "guestPasses" : { + "type" : "array", + "description" : "The org's guest passes whose principal is a guest-management guest. Passes created outside guest management are deliberately not returned.", + "items" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + }, + "nullable" : true + }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Cursor to pass back as paginateRequest.lastEvaluatedKey for the next page. Absent on the last page.", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Kiosk_GetCurrentKioskWSRequest" : { - "type" : "object", - "description" : "Request object for getting the current kiosk information." - }, - "Kiosk_GetCurrentKioskWSResponse" : { + "Guestmanagement_GetGuestWSResponse" : { "type" : "object", - "description" : "Response object containing current kiosk information.", + "description" : "Response object containing guest information.", "properties" : { "error" : { "type" : "boolean", @@ -98256,8 +100287,16 @@ "type" : "string", "nullable" : true }, - "kiosk" : { - "$ref" : "#/components/schemas/Kiosk_KioskWithInfo" + "guest" : { + "$ref" : "#/components/schemas/Guest" + }, + "guestPasses" : { + "type" : "array", + "description" : "The guest's live guest passes - lifecycle ACTIVE or SUSPENDED. Expired and archived passes are deliberately omitted. A guest can have more than one.", + "items" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + }, + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -98265,22 +100304,26 @@ } } }, - "Kiosk_GetKiosksForLocationWSRequest" : { + "Guestmanagement_GetInvitesForOrgWSRequest" : { "type" : "object", - "description" : "Request object for getting all registered kiosks for a specific location.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "invitedAfterMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "invitedBeforeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true + }, + "paginateRequest" : { + "$ref" : "#/components/schemas/PaginateRequest" } } }, - "Kiosk_GetKiosksForLocationWSResponse" : { + "Guestmanagement_GetKioskInfoWSResponse" : { "type" : "object", - "description" : "Response object containing all registered kiosks for a specific location.", "properties" : { "error" : { "type" : "boolean", @@ -98290,13 +100333,8 @@ "type" : "string", "nullable" : true }, - "kiosks" : { - "type" : "array", - "description" : "List of all registered kiosks for the specified location", - "items" : { - "$ref" : "#/components/schemas/Kiosk" - }, - "nullable" : true + "kiosk" : { + "$ref" : "#/components/schemas/Kiosk" }, "warningMsg" : { "type" : "string", @@ -98304,13 +100342,8 @@ } } }, - "Kiosk_GetKiosksForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting all registered kiosks for an organization." - }, - "Kiosk_GetKiosksForOrgWSResponse" : { + "Guestmanagement_GetKiosksForOrgWSResponse" : { "type" : "object", - "description" : "Response object containing all registered kiosks for an organization.", "properties" : { "error" : { "type" : "boolean", @@ -98322,7 +100355,6 @@ }, "kiosks" : { "type" : "array", - "description" : "List of all registered kiosks for the organization", "items" : { "$ref" : "#/components/schemas/Kiosk" }, @@ -98334,712 +100366,668 @@ } } }, - "Kiosk_KioskCheckinWSRequest" : { + "Guestmanagement_GetNametagTemplateForGuestWSRequest" : { "type" : "object", - "description" : "Request object for kiosk heartbeat and online/offline processing.", "properties" : { - "batterLevel" : { - "type" : "number", - "format" : "float", - "description" : "Battery level of the kiosk device", - "example" : 0.85, + "email" : { + "type" : "string", "nullable" : true }, - "signalStrength" : { + "inviteUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "nullable" : true + }, + "timestampMs" : { "type" : "integer", - "format" : "int32", - "description" : "Signal strength of the kiosk connection", - "example" : -45, + "format" : "int64", "nullable" : true } } }, - "Kiosk_KioskCheckinWSResponse" : { - "type" : "object", - "description" : "Response object for kiosk heartbeat operations." - }, - "Kiosk_KioskWithInfo" : { + "Guestmanagement_GetNametagTemplateForGuestWSResponse" : { "type" : "object", - "description" : "Kiosk information with additional location details.", "properties" : { - "batteryLevel" : { - "type" : "number", - "format" : "float", - "nullable" : true + "badgeTemplate" : { + "$ref" : "#/components/schemas/BadgeTemplate" }, - "connectionStatus" : { - "$ref" : "#/components/schemas/ConnectionStatusEnum" + "companyLogoUrl" : { + "type" : "string", + "nullable" : true }, - "deleted" : { + "error" : { "type" : "boolean", "nullable" : true }, - "hostUserUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastUpdateTimeMs" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Guestmanagement_GetSignedDocumentsWSResponse" : { + "type" : "object", + "properties" : { + "documents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Guestmanagement_SignedDocumentWSType" + }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", + "error" : { + "type" : "boolean", "nullable" : true }, - "locationName" : { + "errorMsg" : { "type" : "string", - "description" : "Name of the location where the kiosk is installed", - "example" : "Main Lobby", "nullable" : true }, - "locationUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Guestmanagement_GuestByEmailWSRequest" : { + "type" : "object", + "description" : "Request object for finding a guest by email address.", + "properties" : { + "email" : { + "type" : "string", + "description" : "Email address of the guest to find", + "example" : "guest@example.com", + "nullable" : true + } + } + }, + "Guestmanagement_GuestByUuidWSRequest" : { + "type" : "object", + "description" : "Request object for finding a guest by uuid.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", + } + }, + "required" : [ "uuid" ] + }, + "Guestmanagement_GuestCheckinV2WSRequest" : { + "type" : "object", + "description" : "Request object for checking a guest into a visit that already exists.", + "properties" : { + "guestUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "inviteUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "printerIP" : { + } + }, + "required" : [ "guestUuid", "locationUuid" ] + }, + "Guestmanagement_GuestCheckinWSRequest" : { + "type" : "object", + "description" : "Request object for guest check-in operations.", + "properties" : { + "email" : { "type" : "string", + "description" : "Email address of the guest checking in", + "example" : "guest@example.com", "nullable" : true }, - "uuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "email", "locationUuid" ] }, - "Kiosk_UnregisterKioskRequest" : { + "Guestmanagement_GuestInviteWSRequest" : { "type" : "object", - "description" : "Request object for unregistering a kiosk.", + "description" : "Request object for guest invite operations.", "properties" : { - "kioskUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "uuid" ] }, - "Kiosk_UnregisterKioskResponse" : { + "Guestmanagement_GuestInvitesByEmailWSRequest" : { "type" : "object", - "description" : "Response object for unregistering a kiosk.", + "description" : "Request object for finding guest invites by email address.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "email" : { "type" : "string", + "description" : "Email of the guest to invite", + "example" : "guest@example.com", "nullable" : true - }, - "warningMsg" : { + } + }, + "required" : [ "email" ] + }, + "Guestmanagement_GuestInvitesByGuestUuidWSRequest" : { + "type" : "object", + "description" : "Request object for listing a guest's visits.", + "properties" : { + "guestUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "guestUuid" ] }, - "Kiosk_UpdateKioskResponse" : { + "Guestmanagement_GuestManagementLocationSettingsWSRequest" : { "type" : "object", - "description" : "Response object for updating kiosk settings.", + "description" : "Addresses the guest-management settings of a single location.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Guestmanagement_GuestWSRequest" : { + "type" : "object", + "description" : "Request object containing guest information.", + "properties" : { + "guest" : { + "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" } } }, - "Kiosk_UpdateKioskSelectiveRequest" : { + "Guestmanagement_InviteGuestWSRequest" : { "type" : "object", - "description" : "Request object for selectively updating kiosk settings.", + "description" : "Request object for inviting a guest.", "properties" : { - "kioskUpdate" : { - "$ref" : "#/components/schemas/KioskSelectiveUpdate" + "access" : { + "$ref" : "#/components/schemas/GuestInviteAccessUpdate" + }, + "guest" : { + "$ref" : "#/components/schemas/Guestmanagement_legacykiosk_LegacyKioskGuest" + }, + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" } } }, - "KisiSettings" : { + "Guestmanagement_InviteGuestWSResponse" : { "type" : "object", + "description" : "Response object describing the invitation that was sent, and the guest-pass access provisioned for it.", "properties" : { - "alertUnauthorizedFaces" : { + "accessPeriodUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "error" : { "type" : "boolean", "nullable" : true }, - "apiSecretKey" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" }, - "defaultOptions" : { - "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + "guestPassUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "doorToCameraMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", + } + } + }, + "Guestmanagement_SignedDocumentWSType" : { + "type" : "object", + "properties" : { + "deliverableId" : { + "type" : "string", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "downloadUrl" : { + "type" : "string", "nullable" : true }, - "enabledTimestampMs" : { + "generatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "enablingUser" : { + "name" : { "type" : "string", "nullable" : true + } + } + }, + "Guestmanagement_UpdateGuestInviteWSRequest" : { + "type" : "object", + "description" : "Request object for updating guest invite information.", + "properties" : { + "accessUpdate" : { + "$ref" : "#/components/schemas/GuestInviteAccessUpdate" }, - "enablingUserUuid" : { + "inviteUpdate" : { + "$ref" : "#/components/schemas/GuestInviteSelectiveUpdateByInvocation" + }, + "suppressGuestEmail" : { + "type" : "boolean", + "default" : false, + "description" : "Set to keep this edit off the guest's inbox even when it changes something they were told. For corrections the sender is following up on themselves.", + "nullable" : true + } + }, + "required" : [ "inviteUpdate" ] + }, + "Guestmanagement_UpdateGuestInviteWSResponse" : { + "type" : "object", + "description" : "Response object describing the invitation as it now stands, the access it carries, and whether the guest was told about the change.", + "properties" : { + "accessPeriodUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "identifyFacesFromBadge" : { + "error" : { "type" : "boolean", "nullable" : true }, - "migrated" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "placeId" : { - "type" : "integer", - "format" : "int32", + "guestEmailSent" : { + "type" : "boolean", + "description" : "Whether a revised invitation reached the guest. False when the edit changed nothing they were told, when the request suppressed the email, or when the invite is rescinded.", "nullable" : true }, - "placeToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationSettings" - }, - "nullable" : true + "guestInvite" : { + "$ref" : "#/components/schemas/GuestInvite" }, - "rhombusToken" : { + "guestPass" : { + "$ref" : "#/components/schemas/LocationAccessControlGuestPass" + }, + "guestPassUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "webhookId" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "KisiType" : { + "Guestmanagement_UpdateGuestManagementDocumentWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "apiSecretKey" : { - "type" : "string", - "nullable" : true - }, - "defaultOptions" : { - "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "placeToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationSettings" - }, - "nullable" : true - } - } - } ], - "nullable" : true, "properties" : { - "enabled" : { - "type" : "boolean", + "docUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "document" : { + "$ref" : "#/components/schemas/GuestManagementDocument" + } + } + }, + "Guestmanagement_UpdateGuestManagementDocumentWSResponse" : { + "type" : "object", + "properties" : { + "document" : { + "$ref" : "#/components/schemas/GuestManagementDocument" }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "LEDModeEnum" : { - "type" : "string", - "enum" : [ "LED_OFF", "LED_RED_SOLID", "LED_GREEN_SOLID", "LED_ORANGE_SOLID", "LED_RED_BLINK", "LED_GREEN_BLINK", "LED_ORANGE_BLINK", "LED_NORMAL" ] - }, - "LabelIdentificationActivityEventType" : { + "Guestmanagement_UpdateGuestManagementLocationSettingsWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "alertLabelSet" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "description" : "Upserts one location's guest-management settings. Send each set in full; null leaves a set unchanged and empty clears it.", + "properties" : { + "assignableDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "alertUnidentified" : { - "type" : "boolean", + "nullable" : true, + "uniqueItems" : true + }, + "assignableElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "allowedLabelSet" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - } ], - "nullable" : true, - "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" - } - } - }, - "LastSeenInfo" : { - "type" : "object", - "properties" : { - "lastSeenAtMillis" : { + "nullable" : true, + "uniqueItems" : true + }, + "defaultAssignedDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "defaultAssignedElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "defaultAutoAccessEndMinuteOfDay" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "nullable" : true + }, + "defaultAutoAccessStartOffsetMinutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "LeakProbeType" : { + "Guestmanagement_UpdateGuestManagementLocationSettingsWSResponse" : { "type" : "object", "properties" : { - "adcMv" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "adcRaw" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "leakDetected" : { + "error" : { "type" : "boolean", "nullable" : true }, - "moistDetected" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "present" : { - "type" : "boolean", - "nullable" : true + "settings" : { + "$ref" : "#/components/schemas/GuestManagementLocationSettings" }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "LicenseEnum" : { - "type" : "string", - "enum" : [ "STARTER", "STANDARD", "ENTERPRISE", "LEGACY" ] - }, - "LicenseFeature" : { + "Guestmanagement_UpdateGuestManagementSettingsWSRequest" : { "type" : "object", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true + "settingsUpdate" : { + "$ref" : "#/components/schemas/GuestManagementSettingsSelectiveUpdate" } } }, - "LicenseGroupStats" : { + "Guestmanagement_UpdateGuestManagementSettingsWSResponse" : { "type" : "object", "properties" : { - "assignedCount" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "lastEndDate" : { + "errorMsg" : { "type" : "string", - "format" : "date-time", - "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, - "nearExpirationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently close to expiration.", - "nullable" : true - }, - "nextEndDate" : { + "warningMsg" : { "type" : "string", - "format" : "date-time", - "description" : "The closest future date on which licenses belonging to the group will expire.", - "nullable" : true - }, - "stateStats" : { - "$ref" : "#/components/schemas/LicenseStateStats" - }, - "totalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group.", "nullable" : true } } }, - "LicenseInvoiceSubItem" : { + "Guestmanagement_UpdateGuestV2WSRequest" : { "type" : "object", + "description" : "Request object for updating a guest. Identity only - no visit is created or edited.", "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "description" : { + "guestUpdate" : { + "$ref" : "#/components/schemas/GuestSelectiveUpdateByInvocation" + } + }, + "required" : [ "guestUpdate" ] + }, + "Guestmanagement_UpdateGuestWSRequest" : { + "type" : "object", + "description" : "Request object for updating guest information.", + "properties" : { + "fileName" : { "type" : "string", + "description" : "File name for guest-related data", + "example" : "guest_data.csv", "nullable" : true }, - "license" : { - "$ref" : "#/components/schemas/LicenseEnum" + "guest" : { + "$ref" : "#/components/schemas/Guest" }, - "price" : { - "type" : "number", - "format" : "float", - "nullable" : true + "guestUpdate" : { + "$ref" : "#/components/schemas/GuestSelectiveUpdateByInvocation" } } }, - "LicenseStateEnum" : { - "type" : "string", - "enum" : [ "CLAIMED", "RENEWED", "PENDING_RETURN", "NOT_RENEWED", "EXPIRED", "PERMANENTLY_EXPIRED" ] - }, - "LicenseStateStats" : { + "Guestmanagement_legacykiosk_LegacyKioskGuest" : { "type" : "object", + "description" : "Who is visiting - name, email, phone, and the rest of their identity.", "properties" : { - "claimedCount" : { + "accessEndTimeMs" : { "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently in the CLAIMED state.", + "format" : "int64", "nullable" : true }, - "expiredCount" : { + "accessStartTimeMs" : { "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently in the EXPIRED state.", + "format" : "int64", "nullable" : true }, - "notRenewedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently in the NOT_RENEWED state.", + "address1" : { + "type" : "string", "nullable" : true }, - "pendingReturnCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently in the PENDING_RETURN state.", + "address2" : { + "type" : "string", "nullable" : true }, - "permanentlyExpiredCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently in the PERMANENTLY_EXPIRED state.", - "nullable" : true + "backgroundCheckStatus" : { + "$ref" : "#/components/schemas/BackgroundCheckEnum" }, - "renewedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently in the RENEWED state.", - "nullable" : true - } - } - }, - "LicenseToUnassignEmailStateEnum" : { - "type" : "string", - "enum" : [ "INITIAL_EMAIL_SUCCEEDED", "INITIAL_EMAIL_FAILED", "FIFTEEN_DAY_WARNING_EMAIL_SUCCEEDED", "FIFTEEN_DAY_WARNING_EMAIL_FAILED", "FOURTY_EIGHT_HOUR_WARNING_EMAIL_SUCCEEDED", "FOURTY_EIGHT_HOUR_WARNING_EMAIL_FAILED", "UNKNOWN" ] - }, - "LicenseUsageCatalogItem" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "addOnLicenseType" : { - "$ref" : "#/components/schemas/AddOnLicenseEnum" - }, - "cloudArchiveDays" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "licenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" - } - } - } ], - "nullable" : true, - "properties" : { - "durationMonths" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "checkedInEnum" : { + "$ref" : "#/components/schemas/GuestActivityEnum" }, - "productCode" : { + "city" : { "type" : "string", "nullable" : true }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - } - } - }, - "LicenseUsageStats" : { - "type" : "object", - "properties" : { - "addOnLicenseStats" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AddOnLicenseStats" - }, + "companyName" : { + "type" : "string", "nullable" : true }, - "assignedCount" : { - "type" : "integer", - "format" : "int32", + "countryCode" : { + "type" : "string", "nullable" : true }, - "lastEndDate" : { + "crime" : { "type" : "string", - "format" : "date-time", - "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, - "nearExpirationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently close to expiration.", + "documentLastSignedMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "nullable" : true }, - "nextEndDate" : { + "email" : { "type" : "string", - "format" : "date-time", - "description" : "The closest future date on which licenses belonging to the group will expire.", - "nullable" : true - }, - "stateStats" : { - "$ref" : "#/components/schemas/LicenseStateStats" - }, - "totalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group.", "nullable" : true - } - } - }, - "LicenseUsageType" : { - "type" : "object", - "description" : "List of licenses available for the client organization", - "properties" : { - "addOnLicenseType" : { - "$ref" : "#/components/schemas/AddOnLicenseEnum" - }, - "additionalPerceptionFeatures" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PerceptionTypeEnum" - }, - "nullable" : true, - "uniqueItems" : true }, - "claimKeyUuid" : { + "emailCaseSensitive" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "cloudArchiveDays" : { - "type" : "integer", - "format" : "int32", + "faceImage" : { + "type" : "string", "nullable" : true }, - "createdOn" : { + "firstName" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "deviceUuid" : { + "guestType" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firstAssignedDate" : { + "hostUserUuid" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "license" : { - "$ref" : "#/components/schemas/AddOnLicenseEnum" - }, - "licenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + "lastCheckedInMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "licenseToUnassignEmailState" : { - "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + "lastCheckedOutMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "maxDeleteDate" : { + "lastName" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "perceptionTypes" : { + "meetingParticipants" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PerceptionTypeEnum" + "type" : "string", + "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "priorClaimKeyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "productCode" : { + "phoneNumber" : { "type" : "string", "nullable" : true }, - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - }, - "state" : { - "$ref" : "#/components/schemas/LicenseStateEnum" + "postalCode" : { + "type" : "string", + "nullable" : true }, - "trial" : { - "type" : "boolean", + "profileImageUrl" : { + "type" : "string", "nullable" : true }, - "updatedOn" : { + "state" : { "type" : "string", - "format" : "date-time", "nullable" : true }, + "status" : { + "$ref" : "#/components/schemas/GuestStatusEnum" + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -99049,67 +101037,132 @@ } } }, - "License_AssignACUDoorLicenseWSRequest" : { + "HaloSettings" : { "type" : "object", - "description" : "Request object for assigning ACU door license.", "properties" : { - "doorUuid" : { + "alertAgression" : { + "type" : "boolean", + "nullable" : true + }, + "alertCO" : { + "type" : "boolean", + "nullable" : true + }, + "alertCO2" : { + "type" : "boolean", + "nullable" : true + }, + "alertGunshot" : { + "type" : "boolean", + "nullable" : true + }, + "alertHelp" : { + "type" : "boolean", + "nullable" : true + }, + "alertMasking" : { + "type" : "boolean", + "nullable" : true + }, + "alertTHC" : { + "type" : "boolean", + "nullable" : true + }, + "alertTamper" : { + "type" : "boolean", + "nullable" : true + }, + "alertTemp" : { + "type" : "boolean", + "nullable" : true + }, + "alertVOC" : { + "type" : "boolean", + "nullable" : true + }, + "alertVape" : { + "type" : "boolean", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "licenseUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_AssignACUDoorLicenseWSResponse" : { - "type" : "object", - "description" : "Response object for assigning ACU door license.", - "properties" : { - "acuDoorLicense" : { - "$ref" : "#/components/schemas/ACUDoorLicenseType" - } - } - }, - "License_AssignAlertMonitoringLicenseWSRequest" : { - "type" : "object", - "description" : "Request object for assigning alert monitoring license.", - "properties" : { - "licenseUuid" : { + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "savedClipDurationMs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sensorName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationUuid" : { + "sensorToCamerasMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "triggerNotification" : { + "type" : "boolean", + "nullable" : true + }, + "url" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "License_AssignAlertMonitoringLicenseWSResponse" : { + "HardwareInvoiceSubItem" : { "type" : "object", - "description" : "Response object for assigning alert monitoring license.", "properties" : { - "alertMonitoringLicense" : { - "$ref" : "#/components/schemas/AlertMonitoringLicenseType" + "count" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "price" : { + "type" : "number", + "format" : "float", + "nullable" : true } } }, - "License_AssignDeviceLicenseWSRequest" : { + "HardwareType" : { "type" : "object", - "description" : "Request object for assigning or unassigning a device license.", "properties" : { "deviceUuid" : { "type" : "string", @@ -99118,101 +101171,80 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "licenseUuid" : { + "enforcedMinFirmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "firmwareUpdateTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "hwSupportDomain" : { + "type" : "string", + "nullable" : true + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "mac" : { + "type" : "string", + "nullable" : true + }, + "manufacturedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_AssignDeviceLicenseWSResponse" : { - "type" : "object", - "description" : "Response object for assigning or unassigning a device license.", - "properties" : { - "deviceLicense" : { - "$ref" : "#/components/schemas/DeviceLicenseType" - } - } - }, - "License_AssignLicenseWSRequest" : { - "type" : "object", - "description" : "Request object for assigning an add-on license to a device.", - "properties" : { - "deviceUuid" : { + }, + "otaDisabled" : { + "type" : "boolean", + "nullable" : true + }, + "pendingRegistrationDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "licenseUuid" : { + "pendingRegistrationOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_AssignLicenseWSResponse" : { - "type" : "object", - "description" : "Response object for assigning an add-on license to a device.", - "properties" : { - "licenseUsage" : { - "$ref" : "#/components/schemas/LicenseUsageType" - } - } - }, - "License_CalculateLicensesStatsForClientOrgWSRequest" : { - "type" : "object", - "description" : "Request object for calculating license statistics for client organization.", - "properties" : { - "orgUuid" : { + }, + "pendingRegistrationToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_CalculateLicensesStatsForClientOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing license statistics for client organization.", - "properties" : { - "orgLicenseStats" : { - "$ref" : "#/components/schemas/OrgLicenseStats" - } - } - }, - "License_CalculateLicensesStatsForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for calculating license statistics for organization.", - "properties" : { - "excludeTrialLicensesFromExpiredCount" : { - "type" : "boolean", - "description" : "Whether to exclude trial licenses from expired count", - "example" : false, + }, + "sdSize" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "License_CalculateLicensesStatsForOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing license statistics for organization.", - "properties" : { - "orgLicenseStats" : { - "$ref" : "#/components/schemas/OrgLicenseStats" - } - } - }, - "License_CreateACUDoorLicenseWSRequest" : { - "type" : "object", - "description" : "Request object for creating ACU door license.", - "properties" : { - "orgUuid" : { + }, + "serialNumber" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -99221,89 +101253,143 @@ } } }, - "License_CreateACUDoorLicenseWSResponse" : { + "HardwareVariationEnum" : { + "type" : "string", + "enum" : [ "RASPBERRY_PI_3", "CAMERA_R1", "CAMERA_R2", "CAMERA_R2_LONG_RANGE", "CAMERA_R2_180", "CAMERA_R3", "CAMERA_R4", "CAMERA_R100", "CAMERA_R120", "CAMERA_R170", "CAMERA_R200", "CAMERA_R500", "CAMERA_R510", "CAMERA_R520", "CAMERA_R600", "SENSOR_ASSET_TAG_T1", "SENSOR_DOOR_D1", "SENSOR_DOOR_D20", "SENSOR_ENVIRONMENTAL_E1", "SENSOR_ENVIRONMENTAL_E15", "SENSOR_ENVIRONMENTAL_E2", "SENSOR_MOTION_M1", "SENSOR_MOTION_M15", "GATEWAY_A1", "GATEWAY_A100", "GATEWAY_ENVIRONMENTAL_E50", "CAMERA_R220", "CAMERA_R230", "CAMERA_R36S", "CAMERA_R410", "CAMERA_R540", "CAMERA_R545", "BADGE_READER_DR1", "BADGE_READER_DR40", "BADGE_READER_DR20", "DOOR_CONTROLLER_DC1", "DOOR_CONTROLLER_DC20", "DOOR_CONTROLLER_DC10", "ETHERNET_TESTER_ET1", "IO_BOARD_TB1", "BLE_BUTTON_B10", "BLE_BUTTON_B15", "CAMERA_THIRD_PARTY_RELAY", "CAMERA_THIRD_PARTY_NVR", "CAMERA_THIRD_PARTY_NVR_MULTISENSOR", "NVR_N100", "CAMERA_R130", "NVR_N500", "CAMERA_R150", "ROBOT_RC1", "CAMERA_R210", "CAMERA_R650", "NVR_N550", "NVR_N551", "UNSPECIFIED" ] + }, + "HealthNotificationConditionTypeEnum" : { + "type" : "string", + "enum" : [ "DEVICE_OFFLINE", "CLOUD_ARCHIVE_LAG", "LOCAL_RECORDING_FAILURE" ] + }, + "HealthNotificationRuleType" : { "type" : "object", - "description" : "Response object for creating ACU door license.", + "description" : "List of health notification rules", "properties" : { - "error" : { - "type" : "boolean", + "conditionType" : { + "$ref" : "#/components/schemas/HealthNotificationConditionTypeEnum" + }, + "deviceCountThreshold" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "durationMinutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { "type" : "string", "nullable" : true - } - } - }, - "License_CreateAlertMonitoringLicenseWSRequest" : { - "type" : "object", - "description" : "Request object for creating alert monitoring license.", - "properties" : { - "allowedDeviceCount" : { - "type" : "integer", - "format" : "int32", + }, + "notifyOnRecovery" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "reAlertAfterMinutes" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "scope" : { + "$ref" : "#/components/schemas/DeviceTargetScopeEnum" + }, + "targetUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "License_CreateAlertMonitoringLicenseWSResponse" : { + "HeatIndexRangeWarningEnum" : { + "type" : "string", + "description" : "Heat index range warning status", + "enum" : [ "HEAT_INDEX_OK", "HEAT_INDEX_WARNING", "HEAT_INDEX_UNSUPPORTED" ] + }, + "Help_CreateTicketWSRequest" : { "type" : "object", + "description" : "Request object for creating a support ticket.", "properties" : { - "error" : { - "type" : "boolean", + "body" : { + "type" : "string", + "description" : "Body content of the support ticket", + "example" : "My camera is not connecting to the network properly.", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "collaborators" : { + "type" : "array", + "description" : "List of collaborator email addresses", + "items" : { + "type" : "string", + "description" : "List of collaborator email addresses", + "nullable" : true + }, "nullable" : true }, - "warningMsg" : { + "consoleAccessGranted" : { + "type" : "boolean", + "description" : "Whether console access has been granted for troubleshooting", + "example" : true, + "nullable" : true + }, + "productType" : { "type" : "string", "nullable" : true - } - } - }, - "License_CreateDeviceLicenseWSRequest" : { - "type" : "object", - "properties" : { - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "licenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + "serialNumbers" : { + "type" : "array", + "description" : "List of device serial numbers related to the issue", + "items" : { + "type" : "string", + "description" : "List of device serial numbers related to the issue", + "nullable" : true + }, + "nullable" : true }, - "licenseType" : { - "$ref" : "#/components/schemas/LicenseEnum" + "serviceType" : { + "type" : "string", + "nullable" : true }, - "orgUuid" : { + "subject" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Subject of the support ticket", + "example" : "Camera connectivity issue", "nullable" : true } } }, - "License_CreateDeviceLicenseWSResponse" : { + "Help_CreateTicketWSResponse" : { "type" : "object", + "description" : "Response object for creating a support ticket.", "properties" : { "error" : { "type" : "boolean", @@ -99313,11 +101399,23 @@ "type" : "string", "nullable" : true }, - "licenseUuid" : { + "failureReason" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Reason for failure if ticket creation was unsuccessful", + "example" : "Invalid email address", + "nullable" : true + }, + "success" : { + "type" : "boolean", + "description" : "Whether the ticket creation was successful", + "example" : true, + "nullable" : true + }, + "ticketId" : { + "type" : "integer", + "format" : "int32", + "description" : "ID of the created support ticket", + "example" : 12345, "nullable" : true }, "warningMsg" : { @@ -99326,34 +101424,29 @@ } } }, - "License_CreateLicenseWSRequest" : { + "Help_GetOpenTicketsV2WSRequest" : { "type" : "object", + "description" : "Request object for retrieving open support tickets V2 with time range filtering.", "properties" : { - "cloudArchiveDays" : { + "endTimeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "End time in milliseconds for filtering tickets", + "example" : 1642319999999, "nullable" : true }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - }, - "license" : { - "$ref" : "#/components/schemas/AddOnLicenseEnum" - }, - "licenseFamily" : { - "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds for filtering tickets", + "example" : 1642233600000, "nullable" : true } } }, - "License_CreateLicenseWSResponse" : { + "Help_GetOpenTicketsV2WSResponse" : { "type" : "object", + "description" : "Response object containing open support tickets V2 with organization and user tickets.", "properties" : { "error" : { "type" : "boolean", @@ -99363,11 +101456,20 @@ "type" : "string", "nullable" : true }, - "licenseUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "tickets" : { + "type" : "array", + "description" : "List of organization support tickets", + "items" : { + "$ref" : "#/components/schemas/Help_TicketInformation" + }, + "nullable" : true + }, + "userTickets" : { + "type" : "array", + "description" : "List of user-specific support tickets", + "items" : { + "$ref" : "#/components/schemas/Help_TicketInformation" + }, "nullable" : true }, "warningMsg" : { @@ -99376,30 +101478,29 @@ } } }, - "License_DeleteAlertMonitoringLicenseWSRequest" : { + "Help_GetOpenTicketsWSRequest" : { "type" : "object", - "description" : "Request object for deleting alert monitoring license.", + "description" : "Request object for retrieving open support tickets with pagination.", "properties" : { - "licenseUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "pageNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Page number used for paginated response. If empty, the search will return the first page.", "nullable" : true } } }, - "License_DeleteAlertMonitoringLicenseWSResponse" : { + "Help_GetOpenTicketsWSResponse" : { "type" : "object", - "description" : "Response object for deleting alert monitoring license.", + "description" : "Response object containing open support tickets with pagination information.", "properties" : { + "currentPage" : { + "type" : "integer", + "format" : "int32", + "description" : "Current page number in the paginated response", + "example" : 1, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -99408,73 +101509,73 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "hasNexPage" : { + "type" : "boolean", + "description" : "True if there is a next page, false otherwise", "nullable" : true - } - } - }, - "License_DeleteDeviceLicenseWSRequest" : { - "type" : "object", - "description" : "Request object for deleting an unassigned device license from an organization.", - "properties" : { - "licenseUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "tickets" : { + "type" : "array", + "description" : "List of open support tickets", + "items" : { + "$ref" : "#/components/schemas/Help_TicketInformation" + }, "nullable" : true }, - "orgUuid" : { + "totalTickets" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of tickets, not limited to the current page", + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "License_DeleteDeviceLicenseWSResponse" : { + "Help_ProcessRMAWSRequest" : { "type" : "object", - "description" : "Response object for deleting an unassigned device license from an organization.", + "description" : "Request object for processing a Return Merchandise Authorization (RMA).", "properties" : { - "error" : { - "type" : "boolean", + "contactName" : { + "type" : "string", + "description" : "Contact name for the RMA", + "example" : "John Doe", "nullable" : true }, - "errorMsg" : { + "contactPhoneNumber" : { "type" : "string", + "description" : "Contact phone number for the RMA", + "example" : "+1-555-123-4567", "nullable" : true }, - "warningMsg" : { + "deviceName" : { "type" : "string", + "description" : "Name of the device for RMA", + "example" : "Rhombus Camera Pro", "nullable" : true - } - } - }, - "License_DeleteLicenseWSRequest" : { - "type" : "object", - "description" : "Request object for deleting an unassigned add-on license from an organization.", - "properties" : { - "licenseUuid" : { + }, + "problem" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Description of the problem with the device", + "example" : "Camera not recording properly", "nullable" : true }, - "orgUuid" : { + "returnShippingAddress" : { + "$ref" : "#/components/schemas/Help_ShippingAddress" + }, + "serialNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Serial number of the device", + "example" : "RHCAM123456789", "nullable" : true } } }, - "License_DeleteLicenseWSResponse" : { + "Help_ProcessRMAWSResponse" : { "type" : "object", - "description" : "Response object for deleting an unassigned add-on license from an organization.", + "description" : "Response object for processing a Return Merchandise Authorization (RMA).", "properties" : { "error" : { "type" : "boolean", @@ -99484,28 +101585,46 @@ "type" : "string", "nullable" : true }, + "failureReason" : { + "type" : "string", + "description" : "Reason for failure if RMA processing was unsuccessful", + "example" : "Invalid serial number", + "nullable" : true + }, + "success" : { + "type" : "boolean", + "description" : "Whether the RMA processing was successful", + "example" : true, + "nullable" : true + }, + "ticketId" : { + "type" : "integer", + "format" : "int32", + "description" : "ID of the RMA ticket created", + "example" : 12345, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "License_FindLicensesByClaimKeyWSRequest" : { + "Help_SendFeedbackWSRequest" : { "type" : "object", - "description" : "Request object for finding licenses by claim key.", + "description" : "Request object for sending system feedback.", "properties" : { - "claimKeyUuid" : { + "feedback" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Feedback message about the system", + "example" : "The new interface is much more user-friendly!", "nullable" : true } } }, - "License_FindLicensesByClaimKeyWSResponse" : { + "Help_SendFeedbackWSResponse" : { "type" : "object", - "description" : "Response object containing licenses found by claim key.", + "description" : "Response object for sending system feedback.", "properties" : { "error" : { "type" : "boolean", @@ -99515,69 +101634,16 @@ "type" : "string", "nullable" : true }, - "licenses" : { - "type" : "array", - "description" : "List of licenses found by claim key", - "items" : { - "$ref" : "#/components/schemas/BaseLicenseType" - }, - "nullable" : true - }, - "warningMsg" : { + "failureReason" : { "type" : "string", - "nullable" : true - } - } - }, - "License_GetACUDoorLicensesForClientOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of access controlled door licenses available for a client organization.", - "properties" : { - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "License_GetACUDoorLicensesForClientOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing list of access controlled door licenses available for a client organization.", - "properties" : { - "acuDoorLicenses" : { - "type" : "array", - "description" : "List of access controlled door licenses available for the client organization", - "items" : { - "$ref" : "#/components/schemas/ACUDoorLicenseType" - }, - "nullable" : true - } - } - }, - "License_GetACUDoorLicensesWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of access controlled door licenses available in organization." - }, - "License_GetACUDoorLicensesWSResponse" : { - "type" : "object", - "description" : "Response object containing list of access controlled door licenses available in organization.", - "properties" : { - "acuDoorLicenses" : { - "type" : "array", - "description" : "List of access controlled door licenses available in the organization", - "items" : { - "$ref" : "#/components/schemas/ACUDoorLicenseType" - }, + "description" : "Reason for failure if feedback sending was unsuccessful", + "example" : "Invalid feedback content", "nullable" : true }, - "error" : { + "success" : { "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", + "description" : "Whether the feedback was sent successfully", + "example" : true, "nullable" : true }, "warningMsg" : { @@ -99586,164 +101652,97 @@ } } }, - "License_GetAlertMonitoringLicensesForClientOrgWSRequest" : { + "Help_ShippingAddress" : { "type" : "object", - "description" : "Request object for getting list of alert monitoring licenses available for a client organization.", + "description" : "Shipping address information for RMA returns.", "properties" : { - "orgUuid" : { + "returnAddressCity" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "License_GetAlertMonitoringLicensesForClientOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing list of alert monitoring licenses available for a client organization.", - "properties" : { - "alertMonitoringLicenses" : { - "type" : "array", - "description" : "List of alert monitoring licenses available for the client organization", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringLicenseType" - }, - "nullable" : true - } - } - }, - "License_GetAlertMonitoringLicensesWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of alert monitoring licenses available in organization." - }, - "License_GetAlertMonitoringLicensesWSResponse" : { - "type" : "object", - "description" : "Response object containing list of alert monitoring licenses available in organization.", - "properties" : { - "alertMonitoringLicenses" : { - "type" : "array", - "description" : "List of alert monitoring licenses available in the organization", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringLicenseType" - }, + "description" : "City for return shipping", + "example" : "San Francisco", "nullable" : true }, - "error" : { - "type" : "boolean", + "returnAddressCountry" : { + "type" : "string", + "description" : "Country for return shipping", + "example" : "United States", "nullable" : true }, - "errorMsg" : { + "returnAddressPostalCode" : { "type" : "string", + "description" : "Postal code for return shipping", + "example" : "94105", "nullable" : true }, - "warningMsg" : { + "returnAddressState" : { "type" : "string", + "description" : "State/province for return shipping", + "example" : "CA", "nullable" : true - } - } - }, - "License_GetDeviceLicensesForClientOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of device licenses available for a client organization.", - "properties" : { - "orgUuid" : { + }, + "returnAddressStreet" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "License_GetDeviceLicensesForClientOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing list of device licenses available for a client organization.", - "properties" : { - "deviceLicenses" : { - "type" : "array", - "description" : "List of device licenses available for the client organization", - "items" : { - "$ref" : "#/components/schemas/DeviceLicenseType" - }, + "description" : "Street address for return shipping", + "example" : "123 Main Street", "nullable" : true } } }, - "License_GetDeviceLicensesWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of device licenses available in organization.", - "properties" : { - "optionalDeviceTypeFilter" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - } - } - }, - "License_GetDeviceLicensesWSResponse" : { + "Help_TicketInformation" : { "type" : "object", - "description" : "Response object containing list of device licenses available in organization.", + "description" : "Information about a support ticket.", "properties" : { - "deviceLicenses" : { - "type" : "array", - "description" : "List of device licenses available in the organization", - "items" : { - "$ref" : "#/components/schemas/DeviceLicenseType" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when the ticket was created", + "example" : "2024-01-15T10:30:00Z", "nullable" : true }, - "error" : { - "type" : "boolean", + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "Unique identifier for the support ticket", + "example" : 12345, "nullable" : true }, - "errorMsg" : { + "status" : { "type" : "string", + "description" : "Current status of the support ticket", + "example" : "Open", "nullable" : true }, - "warningMsg" : { + "subject" : { "type" : "string", + "description" : "Subject of the support ticket", + "example" : "Camera connectivity issue", "nullable" : true } } }, - "License_GetLicensesForClientOrgWSRequest" : { + "Help_TriageDeviceWSRequest" : { "type" : "object", - "description" : "Request object for getting list of licenses available for a client organization.", + "description" : "Request object for triaging device connection/recording issues.", "properties" : { - "orgUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_GetLicensesForClientOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing list of licenses available for a client organization.", - "properties" : { - "licenses" : { - "type" : "array", - "description" : "List of licenses available for the client organization", - "items" : { - "$ref" : "#/components/schemas/LicenseUsageType" - }, + }, + "startDateSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Start date in seconds for triage analysis", + "example" : 1642233600, "nullable" : true } } }, - "License_GetLicensesWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of add-on licenses available in organization.", - "properties" : { - "optionalDeviceTypeFilter" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" - } - } - }, - "License_GetLicensesWSResponse" : { + "Help_TriageDeviceWSResponse" : { "type" : "object", - "description" : "Response object containing list of add-on licenses available in organization.", + "description" : "Response object containing device triage diagnostic information.", "properties" : { "error" : { "type" : "boolean", @@ -99753,44 +101752,52 @@ "type" : "string", "nullable" : true }, - "licenses" : { + "firmwareUpdates" : { "type" : "array", - "description" : "List of add-on licenses available in the organization", + "description" : "List of firmware update diagnostic events", "items" : { - "$ref" : "#/components/schemas/LicenseUsageType" + "$ref" : "#/components/schemas/DiagnosticEventType" }, "nullable" : true }, - "warningMsg" : { + "hardwareFailureEvents" : { + "type" : "array", + "description" : "List of hardware failure diagnostic events", + "items" : { + "$ref" : "#/components/schemas/DiagnosticEventType" + }, + "nullable" : true + }, + "message" : { "type" : "string", + "description" : "Triage analysis message", + "example" : "Device appears to be functioning normally", "nullable" : true - } - } - }, - "License_catalog_FindCatalogItemsWSRequest" : { - "type" : "object", - "properties" : { - "productType" : { - "$ref" : "#/components/schemas/ProductTypeEnum" - } - } - }, - "License_catalog_FindCatalogItemsWSResponse" : { - "type" : "object", - "properties" : { - "catalogItems" : { + }, + "presenceWindows" : { "type" : "array", + "description" : "List of device presence time windows", "items" : { - "$ref" : "#/components/schemas/BaseCatalogItem" + "$ref" : "#/components/schemas/TimeWindowSeconds" }, "nullable" : true }, - "error" : { - "type" : "boolean", + "suggestedArticles" : { + "type" : "array", + "description" : "List of suggested help articles for the device issue", + "items" : { + "type" : "string", + "description" : "List of suggested help articles for the device issue", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "uptimeWindows" : { + "type" : "array", + "description" : "List of device uptime time windows", + "items" : { + "$ref" : "#/components/schemas/TimeWindowSeconds" + }, "nullable" : true }, "warningMsg" : { @@ -99799,40 +101806,108 @@ } } }, - "License_catalog_GetCatalogItemByProductCodeWSRequest" : { + "HoneywellElementsType" : { "type" : "object", - "properties" : { - "productCode" : { - "type" : "string", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiKey" : { + "type" : "string", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "baseUrl" : { + "type" : "string", + "nullable" : true + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "siteId" : { + "type" : "string", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } } - } - }, - "License_catalog_GetCatalogItemByProductCodeWSResponse" : { - "type" : "object", + } ], + "nullable" : true, "properties" : { - "catalogItem" : { - "$ref" : "#/components/schemas/BaseCatalogItem" - }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_ClaimLicensesForClientOrgWSRequest" : { - "type" : "object", - "properties" : { - "claimCode" : { - "type" : "string", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, "orgUuid" : { @@ -99841,198 +101916,156 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_claimkey_ClaimLicensesForClientOrgWSResponse" : { - "type" : "object", - "properties" : { - "claimKeyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "License_claimkey_ClaimLicensesWSRequest" : { - "type" : "object", - "properties" : { - "claimCode" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_ClaimLicensesWSResponse" : { - "type" : "object", - "properties" : { - "claimKeyUuid" : { + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "License_claimkey_CreateClaimKeyWSRequest" : { + "HoneywellNetBoxType" : { "type" : "object", - "properties" : { - "endDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "entry" : { - "$ref" : "#/components/schemas/ClaimKeyEntry" - }, - "migratedRenewal" : { - "type" : "boolean", - "nullable" : true - }, - "requestId" : { - "type" : "string", - "nullable" : true - }, - "startDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "trial" : { - "type" : "boolean", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "baseUrl" : { + "type" : "string", + "nullable" : true + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } } - } - }, - "License_claimkey_CreateClaimKeyWSResponse" : { - "type" : "object", + } ], + "nullable" : true, "properties" : { - "claimCode" : { - "type" : "string", - "nullable" : true - }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_CreateRenewalClaimKeyWSRequest" : { - "type" : "object", - "properties" : { - "endDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "entries" : { + "integrationAuditMap" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/ClaimKeyEntry" + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, - "requestId" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_CreateRenewalClaimKeyWSResponse" : { - "type" : "object", - "properties" : { - "claimCode" : { - "type" : "string", - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "License_claimkey_FindClaimKeysByOrgWSRequest" : { + "HoneywellOnGuardType" : { "type" : "object", - "properties" : { - "claimKeySearchFilter" : { - "$ref" : "#/components/schemas/ClaimKeySearchFilter" + "allOf" : [ { + "type" : "object", + "properties" : { + "deploymentToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OnGuardDeploymentSettings" + }, + "nullable" : true + } } - } - }, - "License_claimkey_FindClaimKeysByOrgWSResponse" : { - "type" : "object", + } ], + "nullable" : true, "properties" : { - "claimKeys" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BaseClaimKey" - }, - "nullable" : true - }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_GetClaimKeyByCodeForClientOrgWSRequest" : { - "type" : "object", - "properties" : { - "claimCode" : { - "type" : "string", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, "orgUuid" : { @@ -100041,38 +102074,8 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "License_claimkey_GetClaimKeyByCodeForClientWSResponse" : { - "type" : "object", - "properties" : { - "claimKey" : { - "$ref" : "#/components/schemas/BaseClaimKey" - } - } - }, - "License_claimkey_GetClaimKeyByCodeWSRequest" : { - "type" : "object", - "properties" : { - "claimCode" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_GetClaimKeyByCodeWSResponse" : { - "type" : "object", - "properties" : { - "claimKey" : { - "$ref" : "#/components/schemas/BaseClaimKey" - } - } - }, - "License_claimkey_GetClaimKeyWSRequest" : { - "type" : "object", - "properties" : { - "uuid" : { + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -100081,114 +102084,183 @@ } } }, - "License_claimkey_GetClaimKeyWSResponse" : { + "HttpHeaders" : { "type" : "object", - "properties" : { - "claimKey" : { - "$ref" : "#/components/schemas/BaseClaimKey" - }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "additionalProperties" : { + "type" : "array", + "items" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "License_claimkey_ReturnClaimKeyProductQuantitiesWSRequest" : { - "type" : "object", + "nullable" : true + }, + "nullable" : true, "properties" : { - "productQuantities" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "accept" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaType" }, "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "License_claimkey_ReturnClaimKeyProductQuantitiesWSResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "boolean", + "acceptCharset" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "registered" : { + "type" : "boolean", + "nullable" : true + } + } + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "acceptLanguage" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "range" : { + "type" : "string", + "nullable" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + } + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "LineItems" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", + "acceptLanguageAsLocales" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } + }, "nullable" : true }, - "productCode" : { - "type" : "string", + "acceptPatch" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaType" + }, "nullable" : true }, - "productcode" : { - "type" : "string", + "accessControlAllowCredentials" : { + "type" : "boolean", "nullable" : true }, - "quantity" : { - "type" : "number", + "accessControlAllowHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "subtotal" : { - "type" : "number", + "accessControlAllowMethods" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpMethod" + }, "nullable" : true }, - "unitPrice" : { - "type" : "number", + "accessControlAllowOrigin" : { + "type" : "string", "nullable" : true }, - "unitprice" : { - "type" : "number", - "nullable" : true - } - } - }, - "Link" : { - "type" : "object", - "nullable" : true, - "properties" : { - "params" : { - "type" : "object", - "additionalProperties" : { + "accessControlExposeHeaders" : { + "type" : "array", + "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, - "rel" : { - "type" : "string", + "accessControlMaxAge" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "rels" : { + "accessControlRequestHeaders" : { "type" : "array", "items" : { "type" : "string", @@ -100196,302 +102268,372 @@ }, "nullable" : true }, - "title" : { - "type" : "string", - "nullable" : true + "accessControlRequestMethod" : { + "$ref" : "#/components/schemas/HttpMethod" }, - "type" : { - "type" : "string", - "nullable" : true + "all" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "writeOnly" : true }, - "uri" : { - "type" : "string", - "format" : "uri", - "nullable" : true + "allow" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "nullable" : true, + "uniqueItems" : true }, - "uriBuilder" : { - "$ref" : "#/components/schemas/UriBuilder" - } - } - }, - "LiveNotificationActionRecordType" : { - "type" : "object", - "properties" : { - "status" : { - "$ref" : "#/components/schemas/LiveNotificationActionStatusEnum" - } - } - }, - "LiveNotificationActionStatusEnum" : { - "type" : "string", - "enum" : [ "SUCCESS", "ERROR", "IGNORED", "MUTED", "BACKOFF", "UNKNOWN" ] - }, - "LocalDateTimeIntervalType" : { - "type" : "object", - "nullable" : true, - "properties" : { - "localEndDateTime" : { + "basicAuth" : { "type" : "string", - "description" : "Interval end time in 'yyyy-MM-ddTHH:mm:ss' format. Interval end time is exclusive.", - "nullable" : true + "nullable" : true, + "writeOnly" : true }, - "localStartDateTime" : { - "type" : "string", - "description" : "Interval start time in 'yyyy-MM-ddTHH:mm:ss' format. Interval start time is inclusive.", - "nullable" : true - } - }, - "required" : [ "localEndDateTime", "localStartDateTime" ] - }, - "LocalInterval" : { - "type" : "object", - "description" : "List of intervals each specifying door state during date range. List must contain at least one element", - "properties" : { - "localEndDateTime" : { + "bearerAuth" : { "type" : "string", - "description" : "Interval end time in 'yyyy-MM-ddTHH:mm:ss' format. Interval end time is exclusive.", - "nullable" : true + "nullable" : true, + "writeOnly" : true }, - "localStartDateTime" : { + "cacheControl" : { "type" : "string", - "description" : "Interval start time in 'yyyy-MM-ddTHH:mm:ss' format. Interval start time is inclusive.", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" - } - }, - "required" : [ "localEndDateTime", "localStartDateTime", "state" ] - }, - "LocationALMConfig" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "acceptedTermsOfService" : { - "type" : "boolean", - "description" : "Indication of whether the org accepted the terms of service for alarm monitoring at this location.\n", + "connection" : { + "type" : "array", + "items" : { + "type" : "string", "nullable" : true }, - "defaultEmergencyContact" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, - "mode" : { - "$ref" : "#/components/schemas/MonitoringModeEnum" - } - } - } ], - "nullable" : true, - "properties" : { - "deleted" : { - "type" : "boolean", - "description" : "Indication of whether this config was deleted.", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" }, - "type" : { - "$ref" : "#/components/schemas/TypeEnum" + "contentLanguage" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } }, - "versionInfo" : { - "$ref" : "#/components/schemas/ALMModificationMetadata" + "contentLength" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "zoneId" : { + "contentType" : { + "$ref" : "#/components/schemas/MediaType" + }, + "date" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "empty" : { + "type" : "boolean", + "nullable" : true + }, + "etag" : { "type" : "string", "nullable" : true - } - }, - "required" : [ "defaultEmergencyContact", "locationUuid" ] - }, - "LocationAccessGrantType" : { - "type" : "object", - "description" : "The access grant to update", - "properties" : { - "accessControlledDoorUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + }, + "expires" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "host" : { + "type" : "object", "nullable" : true, - "uniqueItems" : true + "properties" : { + "address" : { + "type" : "object", + "nullable" : true, + "properties" : { + "address" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "anyLocalAddress" : { + "type" : "boolean", + "nullable" : true + }, + "canonicalHostName" : { + "type" : "string", + "nullable" : true + }, + "hostAddress" : { + "type" : "string", + "nullable" : true + }, + "hostName" : { + "type" : "string", + "nullable" : true + }, + "linkLocalAddress" : { + "type" : "boolean", + "nullable" : true + }, + "loopbackAddress" : { + "type" : "boolean", + "nullable" : true + }, + "mcglobal" : { + "type" : "boolean", + "nullable" : true + }, + "mclinkLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcnodeLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcorgLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcsiteLocal" : { + "type" : "boolean", + "nullable" : true + }, + "multicastAddress" : { + "type" : "boolean", + "nullable" : true + }, + "siteLocalAddress" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "hostName" : { + "type" : "string", + "nullable" : true + }, + "hostString" : { + "type" : "string", + "nullable" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "unresolved" : { + "type" : "boolean", + "nullable" : true + } + } }, - "accessControlledElevatorLandingUuids" : { + "ifMatch" : { "type" : "array", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "createdAtMillis" : { + "ifModifiedSince" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "doorLabelIds" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "groupUuids" : { + "ifNoneMatch" : { "type" : "array", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "ifUnmodifiedSince" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "name" : { - "type" : "string", + "lastModified" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "orgUuid" : { + "location" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "uri", "nullable" : true }, - "scheduleUuid" : { + "origin" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sortKey" : { + "pragma" : { "type" : "string", - "nullable" : true, - "readOnly" : true + "nullable" : true }, - "storedInS3" : { - "type" : "boolean", + "range" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpRange" + }, "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "upgrade" : { + "type" : "string", "nullable" : true }, - "userUuids" : { + "vary" : { "type" : "array", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "LocationAccessRevocationType" : { + "HttpMethod" : { + "type" : "object" + }, + "HttpRange" : { + "type" : "object" + }, + "HttpStatusCode" : { "type" : "object", - "description" : "The access revocation to update", "properties" : { - "accessControlledDoorUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "error" : { + "type" : "boolean", + "nullable" : true }, - "accessControlledElevatorLandingUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "is1xxInformational" : { + "type" : "boolean", + "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "is2xxSuccessful" : { + "type" : "boolean", "nullable" : true }, - "doorLabelIds" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "is3xxRedirection" : { + "type" : "boolean", + "nullable" : true }, - "groupUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "is4xxClientError" : { + "type" : "boolean", + "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "is5xxServerError" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "HydratedTrackedObjectSearch" : { + "type" : "object", + "description" : "Saved Custom Detection search with its query", + "properties" : { + "objectSearchQuery" : { + "$ref" : "#/components/schemas/ObjectSearchQuery" + }, + "trackedObjectSearch" : { + "$ref" : "#/components/schemas/TrackedObjectSearch" + } + } + }, + "IAperioType" : { + "type" : "object", + "description" : "The updated Aperio integration configuration.", + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, "orgUuid" : { @@ -100501,320 +102643,229 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduleUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "IAudioUserConfig" : { + "type" : "object", + "description" : "Audio gateway configuration settings", + "properties" : { + "ai_license_invalid" : { + "type" : "boolean", + "nullable" : true }, - "sortKey" : { - "type" : "string", - "nullable" : true, - "readOnly" : true + "audio_aec_via_software" : { + "type" : "boolean", + "nullable" : true }, - "storedInS3" : { + "audio_ai_disabled" : { "type" : "boolean", "nullable" : true }, - "updatedAtMillis" : { + "audio_analysis_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "audio_analysis_params" : { + "$ref" : "#/components/schemas/AudioParamConfig" + }, + "audio_external_mic_boost" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "userUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "audio_external_mic_volume" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "audio_external_speaker_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true - } - } - }, - "LocationFirstInSettings" : { - "type" : "object", - "description" : "The updated location first-in settings.", - "properties" : { - "createdAtMillis" : { + }, + "audio_internal_mic_aec_enabled" : { + "type" : "boolean", + "nullable" : true + }, + "audio_internal_mic_boost" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "description" : { - "type" : "string", + "audio_internal_mic_volume" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "doorAuthFirstInOutOfSync" : { + "audio_internal_speaker_volume" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "audio_min_echo_amplitude" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "audio_playback_gain_percent" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "audio_record" : { "type" : "boolean", "nullable" : true }, - "doorAuthFirstInState" : { - "$ref" : "#/components/schemas/FirstInState" + "audio_supported" : { + "type" : "boolean", + "nullable" : true }, - "doorAuthRequirementEnabled" : { + "audio_use_external_mic" : { "type" : "boolean", "nullable" : true }, - "doorScheduleFirstInOutOfSync" : { + "audio_use_external_speaker" : { "type" : "boolean", "nullable" : true }, - "doorScheduleFirstInState" : { - "$ref" : "#/components/schemas/FirstInState" + "audio_use_internal_speaker" : { + "type" : "boolean", + "nullable" : true }, - "doorScheduleRequirementEnabled" : { + "bandwidth_reports_disabled" : { "type" : "boolean", "nullable" : true }, - "doorUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "cloud_ai_smart_crop_enabled" : { + "type" : "boolean", + "nullable" : true }, - "elevatorLandingUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "cloud_ai_stream_enabled" : { + "type" : "boolean", + "nullable" : true }, - "groupUuids" : { + "cloud_archive_days" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "cloud_archive_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "cloud_archive_upload_schedule" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, - "nullable" : true, - "uniqueItems" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { - "type" : "string", + "cloud_archive_upload_schedule_inverted" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "cloud_archive_upload_schedule_uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "resets" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BaseFirstInReset" - }, - "nullable" : true - }, - "settingsUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "device_mic_enabled" : { + "type" : "boolean", "nullable" : true }, - "userUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "LocationFunctionalityEnum" : { - "type" : "string", - "description" : "Location functionality enum for exposing to OpenAPI component schemas", - "enum" : [ "ACCESS_CONDITIONS", "ACCESS_SCHEDULES", "DOOR_SETTINGS", "FIRST_IN_SETTINGS", "HARDWARE_CONFIG", "LOCKDOWN_MANAGEMENT", "UNKNOWN" ] - }, - "LocationLockdownActivatedRuleTriggerType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" - } - } - }, - "LocationLockdownDeactivatedRuleTriggerType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" - } - } - }, - "LocationLockdownPlanType" : { - "type" : "object", - "description" : "The updated location lockdown plan.", - "properties" : { - "activationPlan" : { - "$ref" : "#/components/schemas/LockdownActivationPlanType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "device_near_audio_silenced" : { + "type" : "boolean", "nullable" : true }, - "deactivationPlan" : { - "$ref" : "#/components/schemas/LockdownDeactivationPlanType" + "device_speaker_enabled" : { + "type" : "boolean", + "nullable" : true }, - "defaultLockdownState" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + "event_clip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" }, - "doorLockdownStateMap" : { + "firmware_dev_settings" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + "type" : "string", + "nullable" : true }, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "frontendEqualizerHighShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "name" : { - "type" : "string", - "nullable" : true + "frontendEqualizerLowShelf" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "frontendEqualizerPeaking1" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "physicalAccess" : { - "$ref" : "#/components/schemas/LockdownPhysicalAccessType" + "frontendEqualizerPeaking2" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "scopeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "frontendEqualizerPeaking3" : { + "$ref" : "#/components/schemas/FrontendEqualizerSettings" }, - "testPlan" : { - "$ref" : "#/components/schemas/LockdownTestPlanType" + "frontendNoiseSuppression" : { + "type" : "boolean", + "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" + "lastModified" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "updatedAtMillis" : { + "led_mode_blink_period_ms" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "led_mode_when_active" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_mode_when_inactive" : { + "$ref" : "#/components/schemas/LEDModeEnum" + }, + "led_stealth_mode" : { + "type" : "boolean", "nullable" : true - } - } - }, - "LocationLockdownStateEnumType" : { - "type" : "string", - "enum" : [ "STANDARD_SECURITY", "LOCKED_DOWN" ] - }, - "LocationLockdownStateType" : { - "type" : "object", - "description" : "The lockdown state for the location.", - "properties" : { - "activeLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true, - "uniqueItems" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "lightweight_detection_disabled" : { + "type" : "boolean", "nullable" : true }, - "followingTestPlan" : { + "live_license_invalid" : { "type" : "boolean", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "max_event_duration_ms" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "media_ttl_minutes" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "on_demand_license_invalid" : { + "type" : "boolean", "nullable" : true }, "orgUuid" : { @@ -100824,1038 +102875,871 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/LocationLockdownStateEnumType" + "snapshot_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" }, - "stateChangedAtMillis" : { + "splice_clip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" + }, + "storage_target_free_megabytes" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "updatedAtMillis" : { + "storage_target_free_space_permyriad" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true + }, + "thumbstrip_upload_target" : { + "$ref" : "#/components/schemas/UploadTargetEnum" } } }, - "LocationSettings" : { + "IAvigilonAltaType" : { "type" : "object", - "nullable" : true, + "description" : "Avigilon Alta V2 integration settings to update", "properties" : { - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "printBadge" : { + "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true - } - } - }, - "LocationType" : { - "type" : "object", - "description" : "Location information to update", - "properties" : { - "address1" : { + }, + "apiToken" : { "type" : "string", "nullable" : true }, - "address2" : { - "type" : "string", + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", "nullable" : true }, - "countryCode" : { - "type" : "string", + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", "nullable" : true }, - "floorPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/FloorPlanType" - }, + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "labels" : { - "type" : "array", - "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", - "items" : { - "type" : "string", - "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", - "nullable" : true + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", + "doorToCameraMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "doorsValidated" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "email" : { "type" : "string", - "description" : "Name of this location", "nullable" : true }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "postalCode" : { - "type" : "string", + "eventToWebhookIdMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "nullable" : true }, - "subLocations" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LocationType" + "eventToWebhookMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/WebhookMapEntry" }, - "nullable" : true, - "uniqueItems" : true - }, - "tz" : { - "type" : "string", - "description" : "Timezone for this location", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Location_AddLocationLabelWSRequest" : { - "type" : "object", - "description" : "Request object for adding a label to a location.", - "properties" : { - "label" : { - "type" : "string", - "description" : "Label to add to the location", + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "locationIdentifier" : { - "type" : "string", - "description" : "Location identifier (name or ID)", - "nullable" : true - } - } - }, - "Location_AddLocationLabelWSResponse" : { - "type" : "object", - "description" : "Response object for adding a label to a location.", - "properties" : { - "error" : { + "indexFaces" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true - } - } - }, - "Location_CreateLocationWSRequest" : { - "type" : "object", - "description" : "Request object for creating a location.", - "properties" : { - "location" : { - "$ref" : "#/components/schemas/LocationType" }, - "parentLocationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Location_CreateLocationWSResponse" : { - "type" : "object", - "description" : "Response object for creating a location.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "password" : { "type" : "string", "nullable" : true }, - "uuid" : { + "refreshToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Location_DeleteLocationWSRequest" : { - "type" : "object", - "description" : "Request object for removing a location.", - "properties" : { - "uuid" : { + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Location_DeleteLocationWSResponse" : { - "type" : "object", - "description" : "Response object for removing a location.", - "properties" : { - "error" : { + }, + "saveClips" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Location_GeoCodeWSRequest" : { - "type" : "object", - "description" : "Request object for getting the latitude and longitude of an address.", - "properties" : { - "address" : { - "type" : "string", - "description" : "Address to geocode", - "example" : "1600 Pennsylvania Avenue NW, Washington, DC", + }, + "webhookId" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Location_GeoCodeWSResponse" : { + "IBaseIntegrationType" : { "type" : "object", - "description" : "Response object containing the latitude and longitude of an address.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the address", - "example" : 38.8977, - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the address", - "example" : -77.0365, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Location_GetLocationLabelsForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting all location labels for an organization." - }, - "Location_GetLocationLabelsForOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing all location labels for an organization.", + "discriminator" : { + "propertyName" : "integration" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AperioType" + }, { + "$ref" : "#/components/schemas/AvigilonAltaType" + }, { + "$ref" : "#/components/schemas/BoulevardType" + }, { + "$ref" : "#/components/schemas/BrivoType" + }, { + "$ref" : "#/components/schemas/ButterflyMXType" + }, { + "$ref" : "#/components/schemas/DeviceIntegrationType" + }, { + "$ref" : "#/components/schemas/DiceType" + }, { + "$ref" : "#/components/schemas/EnvoyType" + }, { + "$ref" : "#/components/schemas/FlicType" + }, { + "$ref" : "#/components/schemas/GeneaType" + }, { + "$ref" : "#/components/schemas/GoogleType" + }, { + "$ref" : "#/components/schemas/GuestManagementType" + }, { + "$ref" : "#/components/schemas/HoneywellElementsType" + }, { + "$ref" : "#/components/schemas/InformacastType" + }, { + "$ref" : "#/components/schemas/InnerRangeType" + }, { + "$ref" : "#/components/schemas/KisiType" + }, { + "$ref" : "#/components/schemas/LumeoType" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsType" + }, { + "$ref" : "#/components/schemas/NineOneOneCellularType" + }, { + "$ref" : "#/components/schemas/OmnialertType" + }, { + "$ref" : "#/components/schemas/OpenAIType" + }, { + "$ref" : "#/components/schemas/OpentechAllianceType" + }, { + "$ref" : "#/components/schemas/PimlocType" + }, { + "$ref" : "#/components/schemas/PlaceOsType" + }, { + "$ref" : "#/components/schemas/ProDataKeyType" + }, { + "$ref" : "#/components/schemas/RaptorType" + }, { + "$ref" : "#/components/schemas/ShellyType" + }, { + "$ref" : "#/components/schemas/ToastType" + }, { + "$ref" : "#/components/schemas/WebhooksType" + }, { + "$ref" : "#/components/schemas/ZapierType" + }, { + "$ref" : "#/components/schemas/ParPOSType" + }, { + "$ref" : "#/components/schemas/HoneywellOnGuardType" + }, { + "$ref" : "#/components/schemas/HoneywellNetBoxType" + }, { + "$ref" : "#/components/schemas/SignatureApiType" + } ], "properties" : { - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "locationLabels" : { + "integrationAuditMap" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "description" : "Map of location name or location id to label set", - "items" : { - "type" : "string", - "description" : "Map of location name or location id to label set", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, - "description" : "Map of location name or location id to label set", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Location_GetLocationWSRequest" : { - "type" : "object", - "description" : "Request object for getting location by ID.", - "properties" : { - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsRequired" : { - "type" : "boolean", - "description" : "Whether sub-locations are required in the response", - "example" : false, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "locationUuid" ] + } }, - "Location_GetLocationWSResponse" : { + "IBoulevardType" : { "type" : "object", - "description" : "Response object containing location information.", + "description" : "Boulevard integration settings", "properties" : { - "error" : { - "type" : "boolean", + "accessWindowAfterMinutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "accessWindowBeforeMinutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "location" : { - "$ref" : "#/components/schemas/LocationType" - }, - "warningMsg" : { + "apiToken" : { "type" : "string", "nullable" : true - } - } - }, - "Location_GetLocationsByGeoRequest" : { - "type" : "object", - "description" : "Request object for getting list of locations given latitude and longitude.", - "properties" : { - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate", - "example" : 37.7749, - "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate", - "example" : -122.4194, + "boulevardBusinessId" : { + "type" : "string", "nullable" : true - } - } - }, - "Location_GetLocationsByGeoResponse" : { - "type" : "object", - "description" : "Response object containing list of locations given latitude and longitude.", - "properties" : { - "locations" : { - "type" : "array", - "description" : "Collection of locations found at the specified coordinates", - "items" : { - "$ref" : "#/components/schemas/LocationType" + }, + "boulevardLocationToRhombusLocationMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true - } - } - }, - "Location_GetLocationsBySubLocationsHierarchyKeyWSRequest" : { - "type" : "object", - "description" : "Request object for getting nested locations by subLocationHierarchyKey.", - "properties" : { - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - } - } - }, - "Location_GetLocationsBySubLocationsHierarchyKeyWSResponse" : { - "type" : "object", - "description" : "Response object containing nested locations by subLocationHierarchyKey.", - "properties" : { - "error" : { + }, + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "location" : { - "$ref" : "#/components/schemas/LocationType" + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "warningMsg" : { + "refreshToken" : { "type" : "string", "nullable" : true - } - } - }, - "Location_GetLocationsV2WSRequest" : { - "type" : "object", - "description" : "Request object for getting list of locations in organization with pagination support.", - "properties" : { - "lastEvaluatedKey" : { + }, + "rhombusToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "maxPageSize" : { - "type" : "integer", - "format" : "int32", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "nameBeginsWithFilter" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Location_GetLocationsV2WSResponse" : { + "IBrivoType" : { "type" : "object", - "description" : "Response object containing list of locations in organization with pagination support.", "properties" : { - "error" : { + "accessToken" : { + "type" : "string", + "nullable" : true + }, + "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "apiKey" : { "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "locations" : { - "type" : "array", - "description" : "List of locations in the organization", - "items" : { - "$ref" : "#/components/schemas/LocationType" - }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "clientId" : { "type" : "string", "nullable" : true - } - } - }, - "Location_GetLocationsWSRequest" : { - "type" : "object", - "description" : "Request object for getting list of locations in organization.", - "properties" : { - "subLocationsIncluded" : { - "type" : "boolean", - "description" : "Whether to include sub-locations in the response", - "example" : false, + }, + "clientSecret" : { + "type" : "string", "nullable" : true - } - } - }, - "Location_GetLocationsWSResponse" : { - "type" : "object", - "description" : "Response object containing list of locations in organization.", - "properties" : { - "error" : { + }, + "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "locations" : { - "type" : "array", - "description" : "List of locations in the organization", - "items" : { - "$ref" : "#/components/schemas/LocationType" + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "doorsValidated" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Location_QualifiedAddressTypeWithValidation" : { - "type" : "object", - "description" : "Qualified address with validation information", - "properties" : { - "addressComplete" : { + }, + "enabled" : { "type" : "boolean", "nullable" : true }, - "addressLine2" : { - "type" : "string", - "description" : "apt, suite, or unit", + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "addressline1" : { - "type" : "string", - "description" : "street address", + "indexFaces" : { + "type" : "boolean", "nullable" : true }, - "administrativeArea" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", - "description" : "state", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locality" : { + "password" : { "type" : "string", - "description" : "city", "nullable" : true }, - "postalCode" : { + "refreshToken" : { "type" : "string", - "description" : "zip code", "nullable" : true }, - "regionCode" : { + "rhombusToken" : { "type" : "string", - "description" : "country", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "validatedAddressline1" : { + "saveClips" : { "type" : "boolean", "nullable" : true }, - "validatedAdminestrativeArea" : { + "tokenValid" : { "type" : "boolean", "nullable" : true }, - "validatedLocality" : { - "type" : "boolean", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "validatedPostalCode" : { - "type" : "boolean", + "username" : { + "type" : "string", "nullable" : true }, - "validatedRegionCode" : { - "type" : "boolean", + "version" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "validatedSubpremise" : { - "type" : "boolean", + "webhookId" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Location_RemoveLocationLabelWSRequest" : { + "IButterflyMXType" : { "type" : "object", - "description" : "Request object for removing a label from a location.", + "description" : "ButterflyMX V2 integration settings to update", "properties" : { - "label" : { - "type" : "string", - "description" : "Label to remove from the location", + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "locationIdentifier" : { + "apiToken" : { "type" : "string", - "description" : "Location identifier (name or ID)", "nullable" : true - } - } - }, - "Location_RemoveLocationLabelWSResponse" : { - "type" : "object", - "description" : "Response object for removing a label from a location.", - "properties" : { - "error" : { + }, + "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "buildingWebhookIdMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "createAccessAnomalyAlerts" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Location_SelectiveUpdateLocationWSRequest" : { - "type" : "object", - "description" : "Request object for selectively updating a location.", - "properties" : { - "address1" : { - "type" : "string", - "description" : "First line of the address", + }, + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "address2" : { - "type" : "string", - "description" : "Second line of the address", + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, "nullable" : true }, - "countryCode" : { - "type" : "string", - "description" : "Country code of the location", + "doorsValidated" : { + "type" : "boolean", "nullable" : true }, - "floorPlans" : { - "type" : "array", - "description" : "Floor plans for the location", - "items" : { - "$ref" : "#/components/schemas/FloorPlanType" + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, - "labels" : { + "misconfiguredDoors" : { "type" : "array", - "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "items" : { "type" : "string", - "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "nullable" : true }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the location", - "nullable" : true - }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the location", + "panelInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ButterflymxPanelInfoType" + }, "nullable" : true }, - "name" : { + "refreshToken" : { "type" : "string", - "description" : "Name of this location", "nullable" : true }, - "policyUuid" : { + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "postalCode" : { - "type" : "string", - "description" : "Postal code of the location", - "nullable" : true - }, - "timezoneId" : { - "type" : "string", - "description" : "Timezone identifier, e.g. America/Los_Angeles, EST, GMT+0, etc.", - "nullable" : true - }, - "tz" : { - "type" : "object", - "description" : "Use timezoneId field instead", - "nullable" : true, - "properties" : { - "displayName" : { - "type" : "string", - "nullable" : true - }, - "dstsavings" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "id" : { - "type" : "string", - "nullable" : true - }, - "rawOffset" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } - }, - "required" : [ "locationUuid" ] - }, - "Location_SelectiveUpdateLocationWSResponse" : { - "type" : "object", - "description" : "Response object for selectively updating a location.", - "nullable" : true, - "properties" : { - "error" : { + "saveClips" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Location_UpdateLocationWSRequest" : { - "type" : "object", - "description" : "Request object for updating a location. NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation.", - "properties" : { - "location" : { - "$ref" : "#/components/schemas/LocationType" - } - } - }, - "Location_UpdateLocationWSResponse" : { - "type" : "object", - "description" : "Response object for updating a location.", - "properties" : { - "error" : { + "tokenValid" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Location_ValidateAndUpdateLocationAddressWSRequest" : { + "IClimateUserConfig" : { "type" : "object", + "description" : "Climate sensor configuration", "properties" : { - "address1" : { - "type" : "string", + "accelerometer_change_tamper_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "address2" : { - "type" : "string", + "accelerometer_disabled" : { + "type" : "boolean", "nullable" : true }, - "administrativeArea" : { - "type" : "string", + "alert_window_minutes" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "countryCode" : { + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locality" : { - "type" : "string", + "lastModified" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "overrideAllValidation" : { + "pressure_switch_tamper_disabled" : { "type" : "boolean", "nullable" : true }, - "overrideMissingSubPremise" : { - "type" : "boolean", + "smoke_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "postalCode" : { - "type" : "string", + "thc_ai_threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vape_ai_threshold" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "Location_ValidateAndUpdateLocationAddressWSResponse" : { + "IDeviceIntegrationType" : { "type" : "object", - "description" : "Response object for validating and updating a location address for Alarm Monitoring.", + "description" : "Device integration settings to update", "properties" : { - "error" : { + "deviceSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DeviceIntegrationSettings" + }, + "nullable" : true + }, + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "qualifiedAddress" : { - "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" - }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Location_ValidateLocationAddressV2WSRequest" : { + "IDiceType" : { "type" : "object", + "description" : "Dice access control integration settings to update", "properties" : { - "address1" : { - "type" : "string", - "nullable" : true - }, - "address2" : { - "type" : "string", - "nullable" : true - }, - "administrativeArea" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "countryCode" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "locality" : { - "type" : "string", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "postalCode" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Location_ValidateLocationAddressV2WSResponse" : { + "IEnvoyType" : { "type" : "object", - "description" : "Response object for validating and updating a location address for Alarm Monitoring.", + "description" : "Envoy V2 integration settings to update", "properties" : { - "acceptable" : { + "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, - "acceptableExceptingSubPremise" : { + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { "type" : "boolean", "nullable" : true }, - "acceptableIfOverridden" : { + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, - "error" : { + "createSeekPoints" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, "nullable" : true }, - "hasChangedElements" : { + "doorsValidated" : { "type" : "boolean", - "nullable" : true, - "writeOnly" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "qualifiedAddress" : { - "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" + "enabled" : { + "type" : "boolean", + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "envoyIntegrationInstalled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Location_ValidateLocationWSRequest" : { - "type" : "object", - "description" : "Request object for validating a location address for Alarm Monitoring.", - "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "envoyUserSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/EnvoyUserSettings" + }, "nullable" : true - } - } - }, - "Location_ValidateLocationWSResponse" : { - "type" : "object", - "description" : "Response object for validating a location address for Alarm Monitoring.", - "properties" : { - "acceptable" : { + }, + "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, - "error" : { + "indexFaces" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "locationUuid" : { + "locationInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/EnvoyLocationInfoType" + }, + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "qualifiedAddress" : { - "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" - }, - "warningMsg" : { + "refreshToken" : { "type" : "string", "nullable" : true - } - } - }, - "LockdownActivatedStateEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "activatedLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - }, - "activeLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - }, - "deactivatedLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true }, - "followingTestPlan" : { + "saveClips" : { "type" : "boolean", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "originator" : { - "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" - }, - "stateChangedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, - "LockdownActivationPlanType" : { + "IFlicType" : { "type" : "object", + "description" : "Flic smart button integration settings to update", "properties" : { - "groupUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "apiKey" : { + "type" : "string", + "nullable" : true }, - "rhombusKeyNotificationMessage" : { + "apiSecret" : { "type" : "string", "nullable" : true }, - "userUuids" : { + "associatedLocations" : { "type" : "array", "items" : { "type" : "string", @@ -101866,296 +103750,236 @@ }, "nullable" : true, "uniqueItems" : true - } - } - }, - "LockdownActivationResultEnumType" : { - "type" : "string", - "description" : "The result of the lockdown activation operation.", - "enum" : [ "SUCCESS", "INVALID_LOCKDOWN_PLANS", "OPTIMISTIC_CONCURRENCY" ] - }, - "LockdownDeactivatedStateEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "deactivatedLockdownPlans" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LockdownPlanReference" - }, - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + }, + "enabled" : { + "type" : "boolean", "nullable" : true }, - "followingTestPlan" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "moduleUploaded" : { "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "originator" : { - "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" - }, - "stateChangedAtMillis" : { - "type" : "integer", - "format" : "int64", + "webhookId" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/LockdownStateEventEnumType" + "webhookToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "LockdownDeactivationPlanType" : { + "IGeneaType" : { "type" : "object", + "description" : "Genea V2 integration settings to update", "properties" : { - "groupUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true }, - "rhombusKeyNotificationMessage" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "userUuids" : { + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "LockdownDeactivationResultEnumType" : { - "type" : "string", - "description" : "The result of the lockdown deactivation operation.", - "enum" : [ "SUCCESS", "OPTIMISTIC_CONCURRENCY" ] - }, - "LockdownEventOriginatorEnumType" : { - "type" : "string", - "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "UNKNOWN" ] - }, - "LockdownPhysicalAccessType" : { - "type" : "object", - "properties" : { - "groupUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "userUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "LockdownPlanReference" : { - "type" : "object", - "properties" : { - "lockdownPlanUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scope" : { - "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" + "refreshToken" : { + "type" : "string", + "nullable" : true }, - "scopeUuid" : { + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "LockdownPlanScopeEnumType" : { - "type" : "string", - "enum" : [ "ORG_LOCKDOWN", "LOCATION_LOCKDOWN" ] - }, - "LockdownStateEventEnumType" : { - "type" : "string", - "enum" : [ "LOCKDOWN_ACTIVATED", "LOCKDOWN_DEACTIVATED" ] - }, - "LockdownTestPlanType" : { - "type" : "object", - "properties" : { - "doorStateOverrideEnabled" : { + }, + "saveClips" : { "type" : "boolean", "nullable" : true }, - "userAccessOverrideEnabled" : { + "tokenValid" : { "type" : "boolean", "nullable" : true - } - } - }, - "LockdownType" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "isActive" : { - "type" : "boolean", + "webhookSignatureSecret" : { + "type" : "string", "nullable" : true }, - "name" : { + "webhookUuid" : { "type" : "string", "nullable" : true } } }, - "LocomotionMovementEnum" : { - "type" : "string", - "description" : "Filter events by locomotion movement type", - "enum" : [ "ARRIVAL", "DEPARTURE", "MOVED_SIGNIFICANTLY", "UNKNOWN" ] - }, - "Logistics_GetRMAsWSRequest" : { - "type" : "object", - "description" : "Request object for getting RMAs (Return Merchandise Authorizations)." - }, - "Logistics_GetRMAsWSResponse" : { + "IGoogleType" : { "type" : "object", - "description" : "Response object containing RMAs (Return Merchandise Authorizations).", + "description" : "Google V2 integration settings to update", "properties" : { - "error" : { + "allowUserStorage" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "rmaList" : { - "type" : "array", - "description" : "List of RMAs (Return Merchandise Authorizations)", - "items" : { - "$ref" : "#/components/schemas/RMAType" - }, + "defaultAlertFolderId" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "defaultAlertFolderName" : { "type" : "string", "nullable" : true - } - } - }, - "Logistics_GetShipmentsWSRequest" : { - "type" : "object", - "description" : "Request object for getting shipments within a time range.", - "properties" : { - "endTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in seconds (Unix timestamp)", - "example" : 1641081600, - "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in seconds (Unix timestamp)", - "example" : 1640995200, + "defaultFolderId" : { + "type" : "string", "nullable" : true - } - } - }, - "Logistics_GetShipmentsWSResponse" : { - "type" : "object", - "description" : "Response object containing shipments within the specified time range.", - "properties" : { - "customerShipmentList" : { - "type" : "array", - "description" : "List of customer shipments within the specified time range", - "items" : { - "$ref" : "#/components/schemas/CustomerShipmentType" - }, + }, + "defaultFolderName" : { + "type" : "string", "nullable" : true }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "refreshToken" : { "type" : "string", "nullable" : true - } - } - }, - "LumeoSettings" : { - "type" : "object", - "properties" : { - "enabled" : { + }, + "saveAllAlerts" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "enablingUserUuid" : { + "userSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/GoogleUserSettings" + }, + "nullable" : true + }, + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -102164,10 +103988,9 @@ } } }, - "LumeoType" : { + "IGuestManagementType" : { "type" : "object", - "allOf" : [ ], - "nullable" : true, + "description" : "Guest management integration settings to update", "properties" : { "enabled" : { "type" : "boolean", @@ -102183,6 +104006,13 @@ }, "nullable" : true }, + "locationSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/LocationSettings" + }, + "nullable" : true + }, "orgUuid" : { "type" : "string", "format" : "RUUID", @@ -102199,628 +104029,482 @@ } } }, - "ManualAccessStateChangeEnum" : { - "type" : "string", - "enum" : [ "DOOR_STATE_OVERRIDE", "CANCELLED_DOOR_STATE_OVERRIDE" ] - }, - "ManualAccessStateChangeEnum_Minimal" : { - "type" : "string", - "enum" : [ "DOOR_STATE_OVERRIDE", "CANCELLED_DOOR_STATE_OVERRIDE" ] - }, - "ManualAlarmPolicy" : { + "IHoneywellElementsType" : { "type" : "object", - "description" : "Threat-detection policy that applies when this zone is in manual monitoring mode.", - "nullable" : true, "properties" : { - "rules" : { - "type" : "array", - "description" : "The rules governing threat detection and subsequent actions.", - "items" : { - "$ref" : "#/components/schemas/AlarmRule" - }, + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/MonitoringModeEnum" - } - }, - "required" : [ "rules" ] - }, - "Maps_GenerateMapUrlWSRequest" : { - "type" : "object", - "description" : "Request object for generating a map URL.", - "properties" : { - "baseUrl" : { + "apiKey" : { "type" : "string", - "description" : "Base URL for the map", - "example" : "https://maps.google.com/maps?q=", "nullable" : true - } - } - }, - "Maps_GenerateMapUrlWSResponse" : { - "type" : "object", - "description" : "Response object containing the generated map URL.", - "properties" : { - "signedUrl" : { + }, + "apiToken" : { "type" : "string", - "description" : "Signed URL for the map", - "example" : "https://maps.google.com/maps?q=123+Main+St&key=abc123", "nullable" : true - } - } - }, - "MattermostSettings" : { - "type" : "object", - "properties" : { - "channel" : { + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "baseUrl" : { "type" : "string", "nullable" : true }, - "enabled" : { + "createAccessAnomalyAlerts" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, "nullable" : true }, - "enablingUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "doorsValidated" : { + "type" : "boolean", "nullable" : true }, - "webhookUrl" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true - } - } - }, - "MediaType" : { - "type" : "object", - "properties" : { - "charset" : { - "type" : "object", - "nullable" : true, - "properties" : { - "registered" : { - "type" : "boolean", - "nullable" : true - } - } }, - "concrete" : { + "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, - "parameters" : { + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { "type" : "object", "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { "type" : "string", "nullable" : true }, "nullable" : true }, - "qualityValue" : { - "type" : "number", - "format" : "double", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subtype" : { + "refreshToken" : { "type" : "string", "nullable" : true }, - "subtypeSuffix" : { + "rhombusToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "siteId" : { "type" : "string", "nullable" : true }, - "wildcardSubtype" : { + "tokenValid" : { "type" : "boolean", "nullable" : true }, - "wildcardType" : { - "type" : "boolean", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Mediadevice_GetBulkMediaDeviceDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for getting media information of any video-supporting media device.", - "properties" : { - "devices" : { - "type" : "array", - "description" : "Set of device facet UUIDs to get media details for", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Mediadevice_GetBulkMediaDeviceDetailsWSResponse" : { + "IHoneywellNetBoxType" : { "type" : "object", - "description" : "Response object containing media information for video-supporting media devices.", "properties" : { - "error" : { + "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "mediaDeviceDetails" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Mediadevice_MediaDeviceDetailsType" - }, - "description" : "Map of device facet UUIDs to their media device details", + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Mediadevice_MediaDeviceDetailsType" : { - "type" : "object", - "description" : "Detailed information about a media device including streaming URLs and device characteristics.", - "properties" : { - "audioGateways" : { - "type" : "array", - "description" : "List of audio gateway UUIDs associated with the device", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" }, - "deviceFacetUuid" : { + "baseUrl" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true }, - "lanCheckUrls" : { - "type" : "array", - "description" : "URLs to check if the device is available on LAN", - "items" : { - "type" : "string", - "description" : "URLs to check if the device is available on LAN", - "nullable" : true + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, - "lanLiveH264Uris" : { - "type" : "array", - "description" : "LAN live H264 streaming URIs", - "items" : { - "type" : "string", - "description" : "LAN live H264 streaming URIs", - "nullable" : true - }, + "doorsValidated" : { + "type" : "boolean", "nullable" : true }, - "lanLiveM3u8Uris" : { - "type" : "array", - "description" : "LAN live M3U8 streaming URIs", - "items" : { - "type" : "string", - "description" : "LAN live M3U8 streaming URIs", - "nullable" : true - }, + "enabled" : { + "type" : "boolean", "nullable" : true }, - "lanLiveMpdUris" : { - "type" : "array", - "description" : "LAN live MPD streaming URIs", - "items" : { - "type" : "string", - "description" : "LAN live MPD streaming URIs", - "nullable" : true - }, + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "lanVodM3u8UrisTemplates" : { - "type" : "array", - "description" : "LAN VOD M3U8 URI templates", - "items" : { - "type" : "string", - "description" : "LAN VOD M3U8 URI templates", - "nullable" : true + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, - "lanVodMpdUrisTemplates" : { + "misconfiguredDoors" : { "type" : "array", - "description" : "LAN VOD MPD URI templates", "items" : { "type" : "string", - "description" : "LAN VOD MPD URI templates", "nullable" : true }, "nullable" : true }, - "name" : { + "orgUuid" : { "type" : "string", - "description" : "Name of the device", - "example" : "Front Door Camera", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { + "refreshToken" : { "type" : "string", - "description" : "Region where the device is located", - "example" : "us-west-2", "nullable" : true }, - "timezone" : { - "type" : "object", - "description" : "Timezone of the device", - "nullable" : true, - "properties" : { - "displayName" : { - "type" : "string", - "nullable" : true - }, - "dstsavings" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "id" : { - "type" : "string", - "nullable" : true - }, - "rawOffset" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - }, - "uri" : { + "rhombusToken" : { "type" : "string", - "description" : "URI of the device", - "example" : "rtsp://device.local/stream", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wanLiveH264Uri" : { - "type" : "string", - "description" : "WAN live H264 streaming URI", - "example" : "https://stream.rhombussystems.com/live/device123.h264", + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "wanLiveM3u8Uri" : { - "type" : "string", - "description" : "WAN live M3U8 streaming URI", - "example" : "https://stream.rhombussystems.com/live/device123.m3u8", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "wanLiveMpdUri" : { + "userUuid" : { "type" : "string", - "description" : "WAN live MPD streaming URI", - "example" : "https://stream.rhombussystems.com/live/device123.mpd", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "IHoneywellOnGuardType" : { + "type" : "object", + "properties" : { + "deploymentToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OnGuardDeploymentSettings" + }, "nullable" : true }, - "wanVodH264UriTemplate" : { - "type" : "string", - "description" : "WAN VOD H264 URI template", - "example" : "https://vod.rhombussystems.com/{timestamp}/device123.h264", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "wanVodM3u8UriTemplate" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", - "description" : "WAN VOD M3U8 URI template", - "example" : "https://vod.rhombussystems.com/{timestamp}/device123.m3u8", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wanVodMpdUriTemplate" : { + "userUuid" : { "type" : "string", - "description" : "WAN VOD MPD URI template", - "example" : "https://vod.rhombussystems.com/{timestamp}/device123.mpd", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "MessageBodyWorkers" : { - "type" : "object", - "nullable" : true - }, - "MetaDataLocationType" : { + "IInformacastType" : { "type" : "object", "properties" : { - "region" : { + "apiToken" : { "type" : "string", "nullable" : true - } - } - }, - "Metric_LogEventWSRequest" : { - "type" : "object", - "description" : "Request object for logging events.", - "properties" : { - "logMap" : { + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { "type" : "object", "additionalProperties" : { - "type" : "object", - "description" : "Map containing log event data", - "nullable" : true + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, - "description" : "Map containing log event data", "nullable" : true - } - } - }, - "Metric_LogEventWSResponse" : { - "type" : "object", - "description" : "Response object for logging events.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "locationSiteMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InformacastSite" + }, "nullable" : true }, - "errorMsg" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "refreshToken" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Metric_ReportErrorWSRequest" : { + "IInnerRangeType" : { "type" : "object", - "description" : "Request object for reporting errors.", + "description" : "InnerRange access control integration settings to update", "properties" : { - "errorMap" : { + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "consoleToSettingsMap" : { "type" : "object", "additionalProperties" : { - "type" : "object", - "description" : "Map containing error information", - "nullable" : true + "$ref" : "#/components/schemas/InnerRangeConsoleSettings" }, - "description" : "Map containing error information", "nullable" : true - } - } - }, - "Metric_ReportErrorWSResponse" : { - "type" : "object", - "description" : "Response object for reporting errors.", - "properties" : { - "error" : { + }, + "createSeekPoints" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InnerRangeDoorInfoType" + }, "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "MetricsAgentSettings" : { - "type" : "object", - "properties" : { - "batch_on" : { + "enabled" : { "type" : "boolean", - "default" : true, "nullable" : true }, - "batch_size" : { - "type" : "integer", - "format" : "int32", - "default" : 100000, - "maximum" : 1000000, - "minimum" : 10000, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "count_flush_interval" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "minimum" : 1, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "level" : { - "$ref" : "#/components/schemas/MetricsLevelEnum" + "refreshToken" : { + "type" : "string", + "nullable" : true }, - "log_update_interval" : { - "type" : "integer", - "format" : "int32", - "default" : 1800, - "minimum" : 1, + "skyTunnelSN" : { + "type" : "string", "nullable" : true }, - "server_flush_interval" : { - "type" : "integer", - "format" : "int32", - "default" : 15, - "minimum" : 1, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "MetricsAgentSettingsSelectiveUpdate" : { + "IKisiType" : { "type" : "object", + "description" : "Kisi V2 integration settings to update", "properties" : { - "batch_on" : { - "type" : "boolean", - "default" : true, + "apiSecretKey" : { + "type" : "string", "nullable" : true }, - "batch_size" : { - "type" : "integer", - "format" : "int32", - "default" : 100000, - "maximum" : 1000000, - "minimum" : 10000, - "nullable" : true + "defaultOptions" : { + "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" }, - "count_flush_interval" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "minimum" : 1, + "doorsValidated" : { + "type" : "boolean", "nullable" : true }, - "level" : { - "$ref" : "#/components/schemas/MetricsLevelEnum" - }, - "log_update_interval" : { - "type" : "integer", - "format" : "int32", - "default" : 1800, - "minimum" : 1, + "enabled" : { + "type" : "boolean", "nullable" : true }, - "server_flush_interval" : { - "type" : "integer", - "format" : "int32", - "default" : 15, - "minimum" : 1, - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "updatedSetMethodMap" : { + "integrationAuditMap" : { "type" : "object", "additionalProperties" : { - "type" : "boolean", - "nullable" : true + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true - } - } - }, - "MetricsLevelEnum" : { - "type" : "string", - "default" : "ESSENTIAL", - "enum" : [ "OFF", "FILE", "ESSENTIAL", "BASIC", "FULL" ] - }, - "MfaTokenTypeEnum" : { - "type" : "string", - "enum" : [ "EMAIL", "SMS", "VIRTUAL_MFA", "FIDO" ] - }, - "MicrosoftTeamsChannelSettings" : { - "type" : "object", - "nullable" : true, - "properties" : { - "botInstallationId" : { + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "channelId" : { - "type" : "string", + "placeToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationSettings" + }, "nullable" : true }, - "installingUserUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "sendChannelNotifications" : { - "type" : "boolean", - "nullable" : true } } }, - "MicrosoftTeamsSettings" : { + "ILumeoType" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "enablingUser" : { - "type" : "string", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "enablingUserUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "webhookUrl" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "MicrosoftTeamsType" : { + "IMicrosoftTeamsType" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "adminConsent" : { - "type" : "boolean", - "nullable" : true - }, - "allowUserNotifications" : { - "type" : "boolean", - "nullable" : true - }, - "microsoftTeamSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MicrosoftTeamsChannelSettings" - }, - "nullable" : true - }, - "microsoftTeamsUserSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MicrosoftTeamsUserSettings" - }, - "nullable" : true - }, - "tenantId" : { - "type" : "string", - "nullable" : true - } - } - } ], - "nullable" : true, "properties" : { + "adminConsent" : { + "type" : "boolean", + "nullable" : true + }, + "allowUserNotifications" : { + "type" : "boolean", + "nullable" : true + }, "enabled" : { "type" : "boolean", "nullable" : true @@ -102835,6 +104519,20 @@ }, "nullable" : true }, + "microsoftTeamSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MicrosoftTeamsChannelSettings" + }, + "nullable" : true + }, + "microsoftTeamsUserSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MicrosoftTeamsUserSettings" + }, + "nullable" : true + }, "orgUuid" : { "type" : "string", "format" : "RUUID", @@ -102842,6 +104540,10 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "tenantId" : { + "type" : "string", + "nullable" : true + }, "userUuid" : { "type" : "string", "format" : "RUUID", @@ -102851,291 +104553,355 @@ } } }, - "MicrosoftTeamsUserSettings" : { + "INineOneOneCellularType" : { "type" : "object", - "nullable" : true, + "description" : "911 Cellular emergency notification integration settings to update", "properties" : { - "botInstallationId" : { + "bearerToken" : { "type" : "string", "nullable" : true }, - "chatId" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "refreshToken" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sendUserNotifications" : { + "saveClips" : { "type" : "boolean", "nullable" : true }, - "teamIds" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true + "securityZoneMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SecurityZoneInfoType" }, "nullable" : true }, - "userId" : { + "triggerNotification" : { + "type" : "boolean", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "webhookToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "zonesValidated" : { + "type" : "boolean", "nullable" : true } } }, - "MinimalAudioGatewayStateType" : { + "IOmnialertType" : { "type" : "object", - "description" : "List of minimal audio gateway state information", + "description" : "Omnialert emergency notification integration settings to update", "properties" : { "associatedCameras" : { "type" : "array", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "defaultInterface" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "defaultInterfaceMac" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "externalIPAddress" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "firmwareUpdateInProgress" : { + "triggerNotification" : { "type" : "boolean", "nullable" : true }, - "firmwareVersion" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "webhookToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "IOpenAIType" : { + "type" : "object", + "properties" : { + "apiToken" : { + "type" : "string", + "nullable" : true }, - "lanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "baseUrl" : { + "type" : "string", + "description" : "The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", + "defaultModel" : { + "type" : "string", + "description" : "The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.", "nullable" : true }, - "liveStreamShared" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "liveStreamsSharedCount" : { - "type" : "integer", - "format" : "int32", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "refreshToken" : { + "type" : "string", "nullable" : true }, - "mediaRegion" : { + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "IOpentechAllianceType" : { + "type" : "object", + "description" : "OpenTech Alliance V2 integration settings to update", + "properties" : { + "apiKey" : { "type" : "string", "nullable" : true }, - "mediaStorageDeviceUuid" : { + "apiSecret" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "mummified" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", + "facilityToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" + }, "nullable" : true }, - "policyUuid" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { - "type" : "string", - "nullable" : true - }, - "secondaryLanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "sensorUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "IPimlocType" : { + "type" : "object", + "properties" : { + "baseAPIUrl" : { + "$ref" : "#/components/schemas/PimlocBaseAPIUrlEnum" }, - "serialNumber" : { + "clientId" : { "type" : "string", "nullable" : true }, - "ssid" : { + "clientSecret" : { "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "enabled" : { + "type" : "boolean", + "nullable" : true }, - "supportedFacets" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiApMac" : { + "rhombusToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "validCredentials" : { + "type" : "boolean", "nullable" : true } } }, - "MinimalDeviceStateType" : { + "IPlaceOsType" : { "type" : "object", - "description" : "List of minimal camera state information", + "description" : "PlaceOS V2 smart building management integration settings to update", "properties" : { - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "defaultInterface" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "defaultInterfaceMac" : { + "apiUrl" : { "type" : "string", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", "nullable" : true }, - "externalIPAddress" : { - "type" : "string", + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", "nullable" : true }, - "facetNameMap" : { + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { "type" : "object", "additionalProperties" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, - "firmwareUpdateInProgress" : { + "doorsValidated" : { "type" : "boolean", "nullable" : true }, - "firmwareVersion" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" + "indexFaces" : { + "type" : "boolean", + "nullable" : true }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true }, - "lanAddresses" : { + "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", @@ -103143,172 +104909,110 @@ }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "liveStreamShared" : { - "type" : "boolean", - "nullable" : true - }, - "liveStreamsSharedCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "mediaRegion" : { - "type" : "string", - "nullable" : true - }, - "mediaStorageDeviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "mummified" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { + "refreshToken" : { "type" : "string", "nullable" : true }, - "policyUuid" : { + "rhombusToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { - "type" : "string", - "nullable" : true - }, - "secondaryLanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "serialNumber" : { - "type" : "string", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "ssid" : { - "type" : "string", + "triggerNotification" : { + "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "supportedFacets" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "uuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiApMac" : { + "webhookSignatureSecret" : { "type" : "string", "nullable" : true - }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } } }, - "MinimalNVRStateType" : { + "IProDataKeyType" : { "type" : "object", - "description" : "List of minimal NVR state information for all NVRs in the organization", + "description" : "Pro Data Key (PDK) V2 integration settings to update", "properties" : { - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "defaultInterface" : { + "apiToken" : { "type" : "string", "nullable" : true }, - "defaultInterfaceMac" : { - "type" : "string", + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", "nullable" : true }, - "externalIPAddress" : { - "type" : "string", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "facetNameMap" : { + "doorInfoMap" : { "type" : "object", "additionalProperties" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, - "firmwareUpdateInProgress" : { + "doorsValidated" : { "type" : "boolean", "nullable" : true }, - "firmwareVersion" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", + "identifyFacesFromBadge" : { + "type" : "boolean", "nullable" : true }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" + "indexFaces" : { + "type" : "boolean", + "nullable" : true }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true }, - "lanAddresses" : { + "misconfiguredDoors" : { "type" : "array", "items" : { "type" : "string", @@ -103316,454 +105020,495 @@ }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "liveStreamShared" : { - "type" : "boolean", - "nullable" : true - }, - "liveStreamsSharedCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "organizationId" : { + "type" : "string", "nullable" : true }, - "mediaRegion" : { + "refreshToken" : { "type" : "string", "nullable" : true }, - "mediaStorageDeviceUuid" : { + "rhombusToken" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mummified" : { + "saveClips" : { "type" : "boolean", "nullable" : true }, - "name" : { + "systemId" : { "type" : "string", "nullable" : true }, - "numThirdPartyCamerasAssigned" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "numThirdPartyCamerasSupported" : { - "type" : "integer", - "format" : "int32", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "policyUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { + "webhookId" : { "type" : "string", "nullable" : true }, - "secondaryLanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + } + } + }, + "IRModesEnum" : { + "type" : "string", + "enum" : [ "ON", "OFF", "AUTO" ] + }, + "IRaptorType" : { + "type" : "object", + "properties" : { + "apiToken" : { + "type" : "string", "nullable" : true }, - "serialNumber" : { + "clientId" : { "type" : "string", "nullable" : true }, - "ssid" : { + "clientSecret" : { "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "clientUid" : { + "type" : "string", + "nullable" : true }, - "supportedFacets" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiApMac" : { + "refreshToken" : { "type" : "string", "nullable" : true }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", + "tokenValid" : { + "type" : "boolean", "nullable" : true }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "MinimalObservableDeviceStateType" : { + "IShellyType" : { "type" : "object", - "description" : "List of minimal state information for doorbell cameras", + "description" : "Shelly smart device integration settings to update", "properties" : { - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "canSendDiagnosticNotifications" : { + "type" : "boolean", "nullable" : true }, - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "createdAtMillis" : { + "diagnosticQuietPeriodSecs" : { "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "defaultInterface" : { - "type" : "string", - "nullable" : true - }, - "defaultInterfaceMac" : { - "type" : "string", + "format" : "int32", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "externalIPAddress" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "facetNameMap" : { + "integrationAuditMap" : { "type" : "object", "additionalProperties" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, - "firmwareUpdateInProgress" : { - "type" : "boolean", - "nullable" : true - }, - "firmwareVersion" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", + "shellyDeviceMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ShellyDevice" + }, "nullable" : true }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lanAddresses" : { - "type" : "array", - "items" : { + "thirdPartyDeviceToLocationMap" : { + "type" : "object", + "additionalProperties" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "liveStreamShared" : { - "type" : "boolean", - "nullable" : true - }, - "liveStreamsSharedCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "locationUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "mediaRegion" : { + "webhookToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "mediaStorageDeviceUuid" : { + } + } + }, + "IToastType" : { + "type" : "object", + "properties" : { + "currentToastRestaurantGuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "mummified" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { + "restaurantSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ToastRestaurantSettings" + }, + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "IWebhooksType" : { + "type" : "object", + "description" : "Updated webhook V2 integration settings", + "properties" : { + "activityWebhooks" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "secondaryLanAddresses" : { - "type" : "array", - "items" : { + "activityWebhooksV2" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/WebhookInfo" + }, + "nullable" : true + }, + "diagnosticWebhooks" : { + "type" : "object", + "additionalProperties" : { "type" : "string", "nullable" : true }, "nullable" : true }, - "serialNumber" : { - "type" : "string", + "diagnosticWebhooksV2" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/WebhookInfo" + }, "nullable" : true }, - "ssid" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "supportedFacets" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiApMac" : { + "userUuid" : { "type" : "string", - "nullable" : true - }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "MinimalRobotStateType" : { + "ImmixSettings" : { "type" : "object", - "description" : "List of minimal device state information for robots", "properties" : { - "associatedCameras" : { + "deviceList" : { "type" : "array", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "batteryPercent" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "charging" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" + "serverUrl" : { + "type" : "string", + "nullable" : true + } + } + }, + "InactivityObjectTypeEnum" : { + "type" : "string", + "enum" : [ "HUMAN", "VEHICLE" ] + }, + "IncidentReport" : { + "type" : "object", + "description" : "An incident report containing information about the incident.", + "properties" : { + "contributors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ReportContributor" + }, + "description" : "Users who have contributed to the report, including its creator, keyed by user UUID.", + "nullable" : true }, - "createdAtMillis" : { + "createdAtMs" : { "type" : "integer", "format" : "int64", + "description" : "Timestamp when the report was created, in milliseconds since the epoch.", "nullable" : true }, - "defaultInterface" : { + "createdBy" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "defaultInterfaceMac" : { - "type" : "string", + "generationFinishedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Time when system generation of the report completed, in milliseconds since the epoch. Only system-generated reports carry this timestamp, and it stays null until generation completes. A report without it may be missing timeline entries. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", + "generationStartedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Time when system generation of the report started, in milliseconds since the epoch. Only system-generated reports carry this timestamp, and it stays null until generation starts. A report carrying it without a generationFinishedAtMs may still be generating. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, - "externalIPAddress" : { + "locationName" : { "type" : "string", + "description" : "Location name at the time the report was created, or null when the report has no location. It may differ from the current location name. Populated by the service. Any caller-supplied value is ignored.", "nullable" : true }, - "facetNameMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firmwareUpdateInProgress" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/IncidentReportStatusEnum" + }, + "systemGenerated" : { "type" : "boolean", + "description" : "Whether the report was generated by the system rather than created by a user.", "nullable" : true }, - "firmwareVersion" : { + "threatCaseUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", + "title" : { + "type" : "string", + "description" : "Title of the incident report.", + "maxLength" : 200, "nullable" : true }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lanAddresses" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the report was last updated, in milliseconds since the epoch.", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", + "updatedBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "liveStreamShared" : { - "type" : "boolean", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "liveStreamsSharedCount" : { + } + } + }, + "IncidentReportAnnotation" : { + "type" : "object", + "description" : "A note attached to an incident report timeline entry, optionally pinned to a position on the entry's image.", + "properties" : { + "createdAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "description" : "Timestamp when the annotation was created, in milliseconds since the epoch.", "nullable" : true }, - "locationUuid" : { + "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "entryUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mapId" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mediaRegion" : { + "position" : { + "$ref" : "#/components/schemas/AnnotationPosition" + }, + "reportUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mediaStorageDeviceUuid" : { + "text" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "description" : "Text content of the annotation.", + "maxLength" : 5000, "nullable" : true }, - "mode" : { - "$ref" : "#/components/schemas/RobotOperatingModeEnum" - }, - "mummified" : { - "type" : "boolean", + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the annotation was last updated, in milliseconds since the epoch.", "nullable" : true }, - "name" : { + "updatedBy" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orientation" : { - "type" : "number", - "format" : "double", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "policyUuid" : { + } + } + }, + "IncidentReportAnnotationSelectiveUpdate" : { + "type" : "object", + "description" : "Fields of an incident report annotation to update. Only the fields supplied are changed.", + "properties" : { + "entryUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -103771,330 +105516,481 @@ "nullable" : true }, "position" : { - "type" : "number", - "format" : "double", - "nullable" : true + "$ref" : "#/components/schemas/AnnotationPosition" }, - "region" : { + "reportUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "roamingLatitude" : { - "type" : "number", - "format" : "double", + "text" : { + "type" : "string", + "description" : "Text content of the annotation.", + "maxLength" : 5000, "nullable" : true }, - "roamingLongitude" : { - "type" : "number", - "format" : "double", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true }, - "secondaryLanAddresses" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "entryUuid", "reportUuid", "uuid" ] + }, + "IncidentReportFilter" : { + "type" : "object", + "description" : "Filtering criteria for incident reports.", + "properties" : { + "contributorUuids" : { "type" : "array", + "description" : "Filters incident reports by contributor. Reports with contributions from any of the specified users match.", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "serialNumber" : { - "type" : "string", - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "ssid" : { - "type" : "string", - "nullable" : true + "createdAtFilter" : { + "$ref" : "#/components/schemas/EventTimestampFilter" }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "incidentReportStatuses" : { + "type" : "array", + "description" : "Filters incident reports by status. Reports with any of the specified statuses match.", + "items" : { + "$ref" : "#/components/schemas/IncidentReportStatusEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "supportedFacets" : { + "locationUuids" : { "type" : "array", + "description" : "Filters incident reports by location. Reports at any of the specified locations match.", "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "uuid" : { + "systemGenerated" : { + "type" : "boolean", + "description" : "Filters incident reports by whether they were generated by the system. Null applies no filter.", + "nullable" : true + } + } + }, + "IncidentReportNote" : { + "type" : "object", + "description" : "A note attached to an incident report.", + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the note was created, in milliseconds since the epoch.", + "nullable" : true + }, + "createdBy" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiApMac" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "MinimalThresholdEventType" : { - "type" : "object", - "description" : "List of threshold crossing events for the device", - "properties" : { - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" - }, - "direction" : { - "$ref" : "#/components/schemas/CrossingDirectionEnum" }, - "objectId" : { - "type" : "integer", - "format" : "int32", + "text" : { + "type" : "string", + "description" : "Text content of the note.", + "maxLength" : 5000, "nullable" : true }, - "timestampMs" : { + "updatedAtMs" : { "type" : "integer", "format" : "int64", - "nullable" : true - } - } - }, - "MinuteOfDayIntervalType" : { - "type" : "object", - "properties" : { - "dayOfWeek" : { - "type" : "integer", - "format" : "int32", + "description" : "Timestamp when the note was last updated, in milliseconds since the epoch.", "nullable" : true }, - "minuteOfDayStartInclusive" : { - "type" : "integer", - "format" : "int32", + "updatedBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "minuteOfDayStopExclusive" : { - "type" : "integer", - "format" : "int32", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "MobileTokenOSEnum" : { + "IncidentReportStatusEnum" : { "type" : "string", - "enum" : [ "IOS", "ANDROID" ] + "description" : "Incident report status.", + "enum" : [ "OPEN", "CLOSED" ] }, - "Mobile_LoginToOrg2FARequiredResponse" : { + "IncomingWebhookRuleTriggerType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "get2FAIdentifier" : { + "displayName" : { + "type" : "string", + "nullable" : true + }, + "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "get2FAType" : { - "$ref" : "#/components/schemas/MfaTokenTypeEnum" - }, - "numDaysSkip2FAForTrustedDevices" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of days to skip 2FA for trusted devices", - "example" : 30, - "nullable" : true } } } ], - "description" : "Login to organization response indicating two-factor authentication is required.", "nullable" : true, "properties" : { "type" : { - "type" : "string" + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, - "Mobile_LoginToOrgBaseResponse" : { + "Inference_GetPersonReidentificationEmbeddingFromImageWSResponse" : { "type" : "object", - "description" : "Base response object for login to organization operations with polymorphic response types.", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Mobile_LoginToOrgSuccessResponse" - }, { - "$ref" : "#/components/schemas/Mobile_LoginToOrgSsoRequiredResponse" - }, { - "$ref" : "#/components/schemas/Mobile_LoginToOrg2FARequiredResponse" - } ], + "description" : "Response for Person Reidentification embedding from image.", "properties" : { - "type" : { - "type" : "string" + "embedding" : { + "type" : "array", + "description" : "Reidentification embedding for the uploaded image", + "items" : { + "type" : "number", + "format" : "double", + "description" : "Reidentification embedding for the uploaded image", + "nullable" : true + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } - }, - "required" : [ "type" ] + } }, - "Mobile_LoginToOrgRequest" : { + "Inference_SegmentWithBoxesWSResponse" : { "type" : "object", - "description" : "Request object for allowing a multi-org user on mobile to login to a different org they are able to access.", + "description" : "Response for segmentation using box prompts.", "properties" : { - "csr" : { + "boxesXyxy" : { "type" : "array", - "description" : "Certificate Signing Request (CSR) data", + "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", + "items" : { + "type" : "array", + "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", + "items" : { + "type" : "number", + "format" : "float", + "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "imageHeight" : { + "type" : "integer", + "format" : "int32", + "description" : "Height of the input image in pixels.", + "nullable" : true + }, + "imageWidth" : { + "type" : "integer", + "format" : "int32", + "description" : "Width of the input image in pixels.", + "nullable" : true + }, + "maskFormat" : { + "type" : "string", + "description" : "Format of the returned masks (ex: png_base64).", + "nullable" : true + }, + "masks" : { + "type" : "array", + "description" : "Base64-encoded mask images.", "items" : { "type" : "string", - "format" : "byte", - "description" : "Certificate Signing Request (CSR) data", + "description" : "Base64-encoded mask images.", "nullable" : true }, "nullable" : true }, - "orgUuid" : { + "scores" : { + "type" : "array", + "description" : "Confidence score for each returned mask.", + "items" : { + "type" : "number", + "format" : "float", + "description" : "Confidence score for each returned mask.", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Mobile_LoginToOrgSsoRequiredResponse" : { + "Inference_SegmentWithPointsWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "redirectUri" : { + "description" : "Response for segmentation using point prompts.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "imageHeight" : { + "type" : "integer", + "format" : "int32", + "description" : "Height of the input image in pixels.", + "nullable" : true + }, + "imageWidth" : { + "type" : "integer", + "format" : "int32", + "description" : "Width of the input image in pixels.", + "nullable" : true + }, + "labels" : { + "type" : "string", + "description" : "Point labels payload that was provided.", + "nullable" : true + }, + "maskFormat" : { + "type" : "string", + "description" : "Format of the returned masks (ex: png_base64).", + "nullable" : true + }, + "masks" : { + "type" : "array", + "description" : "Base64-encoded mask images.", + "items" : { "type" : "string", - "description" : "Redirect URI for SSO authentication", - "example" : "https://sso.example.com/login", + "description" : "Base64-encoded mask images.", "nullable" : true - } - } - } ], - "description" : "Login to organization response indicating SSO authentication is required.", - "nullable" : true, - "properties" : { - "type" : { - "type" : "string" + }, + "nullable" : true + }, + "points" : { + "type" : "string", + "description" : "Point coordinates payload that was provided.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Mobile_LoginToOrgSuccessResponse" : { + "Inference_SegmentWithTextWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "cert" : { + "description" : "Response for segmentation using a text prompt.", + "properties" : { + "boxesXyxy" : { + "type" : "array", + "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", + "items" : { "type" : "array", - "description" : "Certificate data for the successful login session", + "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "items" : { - "type" : "string", - "format" : "byte", - "description" : "Certificate data for the successful login session", + "type" : "number", + "format" : "float", + "description" : "Bounding boxes in [x1, y1, x2, y2] pixel coordinates.", "nullable" : true }, "nullable" : true }, - "orgUuid" : { + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "imageHeight" : { + "type" : "integer", + "format" : "int32", + "description" : "Height of the input image in pixels.", + "nullable" : true + }, + "imageWidth" : { + "type" : "integer", + "format" : "int32", + "description" : "Width of the input image in pixels.", + "nullable" : true + }, + "maskFormat" : { + "type" : "string", + "description" : "Format of the returned masks (ex: png_base64).", + "nullable" : true + }, + "masks" : { + "type" : "array", + "description" : "Base64-encoded mask images.", + "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Base64-encoded mask images.", "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scores" : { + "type" : "array", + "description" : "Confidence score for each returned mask.", + "items" : { + "type" : "number", + "format" : "float", + "description" : "Confidence score for each returned mask.", "nullable" : true - } - } - } ], - "description" : "Successful login to organization response containing session information.", - "nullable" : true, - "properties" : { - "type" : { - "type" : "string" + }, + "nullable" : true + }, + "text" : { + "type" : "string", + "description" : "The text prompt used for segmentation.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Mobile_LoginVerifiedSupportAuthorityMobileRequest" : { + "InformacastScenario" : { "type" : "object", - "description" : "Request object for mobile login of partner to client org as verified support authority.", "properties" : { - "authorityUuid" : { + "id" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "clientType" : { - "$ref" : "#/components/schemas/SessionClientTypeEnum" + "locationEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true } } }, - "Mobile_LoginVerifiedSupportAuthorityMobileResponse" : { + "InformacastSite" : { "type" : "object", - "description" : "Response object for mobile login of partner to client org as verified support authority.", + "nullable" : true, "properties" : { - "supportAuthoritySessionUuid" : { + "id" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "valid" : { - "type" : "boolean", - "description" : "Whether the support authority login is valid", - "example" : true, + "name" : { + "type" : "string", "nullable" : true } } }, - "Mobile_LogoutMobileUserRequest" : { - "type" : "object", - "description" : "Request object for logging out a mobile user." - }, - "Mobile_LogoutMobileUserResponse" : { - "type" : "object", - "description" : "Response object for logging out a mobile user." - }, - "Mobile_RefreshMobileSessionRequest" : { + "InformacastType" : { "type" : "object", - "description" : "Request object for refreshing a mobile session.", - "properties" : { - "csr" : { - "type" : "array", - "description" : "Certificate Signing Request (CSR) data", - "items" : { + "allOf" : [ { + "type" : "object", + "properties" : { + "apiToken" : { "type" : "string", - "format" : "byte", - "description" : "Certificate Signing Request (CSR) data", "nullable" : true }, - "nullable" : true - } - } - }, - "Mobile_RefreshMobileSessionResponse" : { - "type" : "object", - "description" : "Response object for refreshing a mobile session.", - "properties" : { - "cert" : { - "type" : "array", - "description" : "Certificate data for the refreshed session", - "items" : { + "locationSiteMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InformacastSite" + }, + "nullable" : true + }, + "refreshToken" : { "type" : "string", - "format" : "byte", - "description" : "Certificate data for the refreshed session", "nullable" : true }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, "orgUuid" : { @@ -104113,78 +106009,113 @@ } } }, - "Mobile_UpdateMobileNotificationTokenRequest" : { + "InnerRangeConsoleSettings" : { "type" : "object", - "description" : "Request object for updating mobile notification token for Console app.", + "nullable" : true, "properties" : { - "androidV2" : { - "type" : "boolean", - "description" : "New Android App", - "example" : false, + "apiKey" : { + "type" : "string", "nullable" : true }, - "forceNewEndpoint" : { + "createSeekPoints" : { "type" : "boolean", "nullable" : true }, - "token" : { + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InnerRangeDoorInfoType" + }, + "nullable" : true + }, + "skyTunnelSN" : { "type" : "string", - "description" : "Mobile notification token", - "example" : "abc123def456", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", "nullable" : true } } }, - "Mobile_UpdateMobileNotificationTokenResponse" : { - "type" : "object", - "description" : "Response object for updating mobile notification token for Console app." - }, - "Mobile_UpdateRhombusKeyMobileNotificationTokenRequest" : { + "InnerRangeConsoleType" : { "type" : "object", - "description" : "Request object for updating mobile notification token for Rhombus Key app.", "properties" : { - "token" : { + "doorList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InnerRangeDoorType" + }, + "nullable" : true + }, + "skyTunnelSN" : { "type" : "string", - "description" : "Rhombus Key mobile notification token", - "example" : "xyz789abc123", "nullable" : true } } }, - "Mobile_UpdateRhombusKeyMobileNotificationTokenResponse" : { - "type" : "object", - "description" : "Response object for updating mobile notification token for Rhombus Key app." - }, - "ModelStatusEnum" : { - "type" : "string", - "enum" : [ "READY", "QUANTIZE_IN_PROGRESS", "QUANTIZE_FAILURE" ] - }, - "ModularAIConfig" : { + "InnerRangeDoorInfoType" : { "type" : "object", - "description" : "List of available modular AI models", + "nullable" : true, "properties" : { - "description" : { + "assignedCameraList" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "clipDuration" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorName" : { "type" : "string", "nullable" : true }, - "distributionUuid" : { + "leadingSeconds" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "modelParams" : { - "$ref" : "#/components/schemas/ModularAIModelParams" - }, - "modelQuantizedBinaryContentLocator" : { - "type" : "string", + "readerIds" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "modelStatus" : { - "$ref" : "#/components/schemas/ModelStatusEnum" + "remoteUnlock" : { + "type" : "boolean", + "nullable" : true }, - "modelUploadZipContentLocator" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + } + }, + "InnerRangeDoorType" : { + "type" : "object", + "properties" : { + "id" : { "type" : "string", "nullable" : true }, @@ -104192,21 +106123,81 @@ "type" : "string", "nullable" : true }, - "pipeline" : { + "readerIds" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PipelineComponent" + "type" : "string", + "nullable" : true + }, + "nullable" : true + } + } + }, + "InnerRangeType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "consoleToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InnerRangeConsoleSettings" + }, + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InnerRangeDoorInfoType" + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true }, + "skyTunnelSN" : { + "type" : "string", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "restrictedOrgUuid" : { + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -104215,59 +106206,57 @@ } } }, - "ModularAIConfigSelectiveUpdate" : { + "IntegratedDoorPositionIndicatorType" : { "type" : "object", - "description" : "Selective update configuration for the modular AI model", "properties" : { - "description" : { - "type" : "string", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "distributionUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "modelParams" : { - "$ref" : "#/components/schemas/ModularAIModelParams" + "dpiType" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" }, - "modelQuantizedBinaryContentLocator" : { + "name" : { "type" : "string", "nullable" : true }, - "modelStatus" : { - "$ref" : "#/components/schemas/ModelStatusEnum" - }, - "modelUploadZipContentLocator" : { - "type" : "string", - "nullable" : true + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" }, - "name" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pipeline" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PipelineComponent" - }, - "nullable" : true - }, - "restrictedOrgUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorPortType" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, "uuid" : { @@ -104279,197 +106268,332 @@ } } }, - "ModularAIDistribution" : { + "IntegratedDoorRelayType" : { "type" : "object", - "description" : "List of available modular AI distributions", "properties" : { - "description" : { - "type" : "string", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, "name" : { "type" : "string", "nullable" : true }, - "restrictedOrgUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ModularAIModelParams" : { - "type" : "object", - "properties" : { - "classOutputMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/DoorRelayPortType" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "inputHeight" : { - "type" : "integer", - "format" : "int32", + "rateLimitingEnabled" : { + "type" : "boolean", "nullable" : true }, - "inputWidth" : { + "relayType" : { + "$ref" : "#/components/schemas/DoorRelayEnumType" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Modularai_AddModelToDeviceWSRequest" : { + "IntegratedGenericButtonType" : { "type" : "object", - "description" : "Request object for adding a modular AI model to a device.", "properties" : { - "deviceUuid" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "buttonType" : { + "$ref" : "#/components/schemas/ButtonEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "mode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" + }, + "name" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "modelUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Modularai_AddModelToDeviceWSResponse" : { - "type" : "object", - "description" : "Response object for adding a modular AI model to a device.", - "properties" : { - "error" : { + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/ButtonPortType" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Modularai_CreateModularAIDistributionWSRequest" : { + "IntegratedGenericInputType" : { "type" : "object", - "description" : "Request object for creating a modular AI distribution.", "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the created model.", + "auxType" : { + "$ref" : "#/components/schemas/AuxiliaryEnumType" + }, + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, "name" : { "type" : "string", - "description" : "Name of the created model.", - "nullable" : true - } - } - }, - "Modularai_CreateModularAIDistributionWSResponse" : { - "type" : "object", - "description" : "Response object for creating a modular AI distribution.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/AuxiliaryInputPortType" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Modularai_CreateModularAIPipelineConfigWSRequest" : { + "IntegratedGenericRelayType" : { "type" : "object", - "description" : "Request object for creating a modular AI pipeline config.", "properties" : { - "description" : { + "auxType" : { + "$ref" : "#/components/schemas/AuxiliaryEnumType" + }, + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "name" : { "type" : "string", - "description" : "Description of the created model.", "nullable" : true }, - "distributionUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "ownerDeviceUuid" : { "type" : "string", - "description" : "Name of the created model.", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "List of pipeline components describing the behavior of the modular ai config.", - "items" : { - "$ref" : "#/components/schemas/PipelineComponent" - }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/AuxiliaryRelayPortType" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "relayDurationSec" : { + "type" : "integer", + "format" : "int32", + "deprecated" : true, + "description" : "Deprecated, do not use.", + "nullable" : true + }, + "stateChangedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "steadyState" : { + "$ref" : "#/components/schemas/GenericRelayStateEnumType" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Modularai_CreateModularAIPipelineConfigWSResponse" : { + "IntegratedRequestToExitType" : { "type" : "object", - "description" : "Response object for creating a modular AI pipeline config.", "properties" : { - "error" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "intentOnly" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "intentOnlyEvents" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { "type" : "string", "nullable" : true }, - "uuid" : { + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Modularai_GetDevicesForModelWSRequest" : { - "type" : "object", - "description" : "Request object for getting devices running a modular AI model.", - "properties" : { - "modelUuid" : { + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/RequestToExitPortType" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "rexType" : { + "$ref" : "#/components/schemas/RequestToExitEnumType" + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -104478,80 +106602,85 @@ } } }, - "Modularai_GetDevicesForModelWSResponse" : { + "IntegrationActionStatusEnum" : { + "type" : "string", + "enum" : [ "SUCCESS", "ERROR", "BACKOFF", "IGNORED", "UNKNOWN" ] + }, + "IntegrationAuditEvent" : { "type" : "object", - "description" : "Response object containing devices running a modular AI model.", "properties" : { - "devices" : { - "type" : "array", - "description" : "List of device facet UUIDs running the modular AI model", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true + "integrationAuditEvent" : { + "$ref" : "#/components/schemas/IntegrationAuditEventEnum" }, - "errorMsg" : { + "user" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Modularai_GetModelsAddedToDeviceWSRequest" : { + "IntegrationAuditEventEnum" : { + "type" : "string", + "enum" : [ "UPDATE", "DELETE" ] + }, + "IntegrationCommandActionType" : { "type" : "object", - "description" : "Request object for getting modular AI models added to a device.", "properties" : { - "deviceUuid" : { + "commandPayload" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true + }, + "delaySecs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" } } }, - "Modularai_GetModelsAddedToDeviceWSResponse" : { + "IntegrationDiagnosticEventType" : { "type" : "object", - "description" : "Response object containing modular AI models added to a device.", "properties" : { - "error" : { - "type" : "boolean", + "activity" : { + "$ref" : "#/components/schemas/DiagnosticActivityEnum" + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "thirdPartyDeviceId" : { "type" : "string", "nullable" : true }, - "models" : { - "type" : "array", - "description" : "List of modular AI models added to the device", - "items" : { - "$ref" : "#/components/schemas/ModularAIConfig" - }, + "thirdPartyDeviceName" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "timestamp" : { "type" : "string", + "format" : "date-time", "nullable" : true - } - } - }, - "Modularai_GetModelsForDistributionWSRequest" : { - "type" : "object", - "description" : "Request object for getting modular AI models for a given distribution.", - "properties" : { - "distributionUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -104560,39 +106689,53 @@ } } }, - "Modularai_GetModelsForDistributionWSResponse" : { + "IntegrationEnum" : { + "type" : "string", + "enum" : [ "AVIGILON_ALTA", "BOULEVARD", "BRIVO", "BUTTERFLY_MX", "DEVICE_INTEGRATION", "DICE", "ENVOY", "FLIC", "GENEA", "GOOGLE", "HONEYWELL_ELEMENTS", "GUEST_MANAGEMENT", "INFORMACAST", "INNER_RANGE", "KISI", "LUMEO", "MICROSOFT_TEAMS", "OMNIALERT", "OPENAI", "OPENTECH_ALLIANCE", "PIMLOC", "PLACE_OS", "PRODATAKEY", "SHELLY", "TOAST", "WEBHOOKS", "ZAPIER", "RAPTOR", "NINEONEONE_CELLULAR", "SLACK", "APERIO", "PAR_POS", "HONEYWELL_ONGUARD", "HONEYWELL_NETBOX", "SIGNATURE_API", "UNKNOWN" ] + }, + "IntegrationNotificationActionType" : { "type" : "object", - "description" : "Response object containing available modular AI models for a given distribution.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "errorMsg" : { + "notificationEntity" : { "type" : "string", "nullable" : true }, - "models" : { - "type" : "array", - "description" : "List of available modular AI models", - "items" : { - "$ref" : "#/components/schemas/ModularAIConfig" - }, - "nullable" : true - }, - "warningMsg" : { + "notificationTarget" : { "type" : "string", "nullable" : true } } }, - "Modularai_GetModelsWSRequest" : { + "IntegrationStateTypeEnum" : { + "type" : "string", + "enum" : [ "HONEYWELL_ONGUARD_VIDEO", "UNKNOWN" ] + }, + "Integration_BaseIntegrationWSRequest" : { "type" : "object", - "description" : "Request object for getting available modular AI models." + "description" : "Base request object for integration operations." }, - "Modularai_GetModelsWSResponse" : { + "Integration_ConnectHoneywellElementsWSRequest" : { "type" : "object", - "description" : "Response object containing available modular AI models.", + "description" : "Step 1 of the Elements setup wizard: validate the API key against Honeywell Elements and persist on success. Subsequent endpoints (sites, devices, update) resolve credentials from the stored row and never require the API key again.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Honeywell Elements API key to validate and store.", + "nullable" : true + }, + "baseUrl" : { + "type" : "string", + "description" : "Optional Elements API base URL. Defaults to https://api.elementssecure.com.", + "nullable" : true + } + } + }, + "Integration_ConnectHoneywellNetBoxIntegrationWSResponse" : { + "type" : "object", + "description" : "Result of activating or updating the Honeywell NetBox integration. Returns the webhook URL and token to configure on the NetBox webhook forwarder. The token is stable across re-calls so the configured forwarder keeps working when the door mapping changes.", "properties" : { "error" : { "type" : "boolean", @@ -104602,36 +106745,78 @@ "type" : "string", "nullable" : true }, - "models" : { + "misconfiguredDoors" : { "type" : "array", - "description" : "List of available modular AI models", "items" : { - "$ref" : "#/components/schemas/ModularAIConfig" + "type" : "string", + "nullable" : true }, "nullable" : true }, + "rhombusToken" : { + "type" : "string", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true + }, + "webhookUrl" : { + "type" : "string", + "nullable" : true } } }, - "Modularai_ListModularAIDistributionsWSRequest" : { + "Integration_ConnectHoneywellNetBoxWSRequest" : { "type" : "object", - "description" : "Request object for getting available modular AI distributions." + "description" : "Activate the Honeywell NetBox integration for the calling org. NetBox is webhook-driven: the on-prem NetBox controller POSTs access events to a Rhombus webhook URL. On first activation, omit any token; the server generates a webhook rhombusToken and returns it (plus the fully-formed webhook URL) for the customer to paste into the NetBox webhook forwarder. Subsequent calls preserve the existing token so the configured forwarder keeps working as the door mapping changes. The request owns the door mapping; map keys are the stable NetBox portal identifiers and values follow the standard Rhombus badge-integration door info shape.", + "properties" : { + "baseUrl" : { + "type" : "string", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + } + } }, - "Modularai_ListModularAIDistributionsWSResponse" : { + "Integration_CreateEnvoyInviteWSRequest" : { "type" : "object", - "description" : "Response object containing available modular AI distributions.", "properties" : { - "distributions" : { - "type" : "array", - "description" : "List of available modular AI distributions", - "items" : { - "$ref" : "#/components/schemas/ModularAIDistribution" + "invitation" : { + "$ref" : "#/components/schemas/EnvoyInvite" + } + } + }, + "Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSRequest" : { + "type" : "object", + "description" : "Activate or update the Honeywell NetBox integration from the on-prem side — the NetBox counterpart of createOrUpdateHoneywellOnGuardIntegration. Called by the Rhombus NetBox connector, which discovers portals via the NetBox GetPortals API and owns the door inventory, while the console owns camera/location assignments. On first activation omit rhombusToken; the server generates the webhook token and returns it. On re-calls pass the token back; the reported door map is merged by portal key — new keys are added unmapped, existing keys get their display name refreshed, console-made camera/location/behavior assignments are never overwritten, and keys absent from the request (e.g. manually-added portals) are preserved.", + "properties" : { + "baseUrl" : { + "type" : "string", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" }, "nullable" : true }, + "rhombusToken" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_CreateOrUpdateHoneywellNetBoxIntegrationWSResponse" : { + "type" : "object", + "description" : "Result of activating/updating the Honeywell NetBox integration from the on-prem side. Mirrors the OnGuard response shape, minus the pre-shared HMAC secret (the NetBox webhook is token-only).", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -104640,35 +106825,52 @@ "type" : "string", "nullable" : true }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true + }, + "webhookUrl" : { + "type" : "string", + "nullable" : true } } }, - "Modularai_RemoveModelFromDeviceWSRequest" : { + "Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSRequest" : { "type" : "object", - "description" : "Request object for removing a modular AI model from a device.", + "description" : "Idempotent create-or-update of one OnGuard deployment for the calling org. An org can have multiple deployments connected at the same time (separate panels, MSP tenants, etc.) — each deployment is identified by its own rhombusToken. On first activation for a deployment, omit rhombusToken; the server generates one and returns it in the response. On subsequent calls, send the previously-returned rhombusToken to update the same deployment's door mapping in place. Map keys are the OnGuard door identifiers; values follow the standard Rhombus badge-integration door info shape.", "properties" : { - "deviceUuid" : { + "displayName" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "modelUuid" : { + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "rhombusToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Modularai_RemoveModelFromDeviceWSResponse" : { + "Integration_CreateOrUpdateHoneywellOnGuardIntegrationWSResponse" : { "type" : "object", - "description" : "Response object for removing a modular AI model from a device.", + "description" : "Result of activating or updating the Honeywell OnGuard integration. Returns the webhook URL, token, and pre-shared secret to configure on the OnGuard side. Token and secret are stable across re-calls so the deployed DLL keeps working when the door mapping changes.", "properties" : { "error" : { "type" : "boolean", @@ -104678,1228 +106880,1210 @@ "type" : "string", "nullable" : true }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "presharedSecret" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true + }, + "webhookUrl" : { + "type" : "string", + "nullable" : true } } }, - "Modularai_UpdateModelWSRequest" : { + "Integration_DeleteHoneywellOnGuardIntegrationWSRequest" : { "type" : "object", - "description" : "Request object for updating modular AI model configuration.", + "description" : "Delete one OnGuard deployment (when rhombusToken is provided) or the entire OnGuard integration row including every deployment (when rhombusToken is omitted).", "properties" : { - "update" : { - "$ref" : "#/components/schemas/ModularAIConfigSelectiveUpdate" + "rhombusToken" : { + "type" : "string", + "nullable" : true } } }, - "Modularai_UpdateModelWSResponse" : { - "type" : "object", - "description" : "Response object for updating modular AI model configuration." - }, - "MonitoringEnableStatus" : { + "Integration_GetAccessControlIntegrationsForAlmWSResponse" : { "type" : "object", - "description" : "Map of location UUIDs to their monitoring enable status", "properties" : { - "devicesWithActiveSirens" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", + "badDoors" : { + "type" : "array", + "items" : { + "type" : "string", "nullable" : true }, "nullable" : true }, - "disabledOnMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "enabledOnMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "noNextTimestampReason" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "notEnabledReason" : { - "type" : "string", + "integrations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, "nullable" : true }, - "recentlyActivatedSirensTimestampMs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "MonitoringModeEnum" : { - "type" : "string", - "enum" : [ "MANUAL", "SCHEDULED", "UNKNOWN" ] - }, - "MultiPart" : { + "Integration_GetAllGuestsWSResponse" : { "type" : "object", - "nullable" : true, "properties" : { - "bodyParts" : { + "allGuests" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/BodyPart" + "$ref" : "#/components/schemas/Guest" }, "nullable" : true }, - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" - }, - "entity" : { - "type" : "object", + "error" : { + "type" : "boolean", "nullable" : true }, - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetAllOrgIntegrationsV2WSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "messageBodyWorkers" : { - "$ref" : "#/components/schemas/MessageBodyWorkers" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "parameterizedHeaders" : { + "orgIntegrationsV2" : { "type" : "object", "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ParameterizedHeader" - }, - "nullable" : true + "$ref" : "#/components/schemas/IBaseIntegrationType" }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } + "nullable" : true }, - "providers" : { - "$ref" : "#/components/schemas/Providers" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "MultivaluedMapStringObject" : { + "Integration_GetAmtReadersWSRequest" : { "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object", + "properties" : { + "email" : { + "type" : "string", "nullable" : true }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", + "password" : { + "type" : "string", "nullable" : true } } }, - "MultivaluedMapStringParameterizedHeader" : { + "Integration_GetAperioIntegrationWSRequest" : { "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ParameterizedHeader" - }, - "nullable" : true - }, - "nullable" : true, + "description" : "Request object for retrieving Aperio integration configuration." + }, + "Integration_GetAperioIntegrationWSResponse" : { + "type" : "object", + "description" : "Response object containing Aperio integration configuration and door controllers.", "properties" : { - "empty" : { + "aperioSettings" : { + "$ref" : "#/components/schemas/IAperioType" + }, + "doorControllers" : { + "type" : "array", + "description" : "List of Rhombus door controllers with Aperio integration", + "items" : { + "$ref" : "#/components/schemas/Integration_aperio_AperioRhombusDoorControllerView" + }, + "nullable" : true + }, + "error" : { "type" : "boolean", "nullable" : true - } - } - }, - "MultivaluedMapStringString" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "NetsuiteInvoiceDetails" : { + "Integration_GetApiTokenApplicationsWSRequest" : { + "type" : "object" + }, + "Integration_GetApiTokenApplicationsWSResponse" : { "type" : "object", "properties" : { - "billingContactEmail" : { - "type" : "string", + "applications" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiTokenApplicationType" + }, "nullable" : true }, - "billingContactName" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "billingcontactemail" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "billingcontactname" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "clientOrgName" : { - "type" : "string", + } + } + }, + "Integration_GetApiTokensWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving API tokens.", + "properties" : { + "optionalFilter" : { + "type" : "array", + "description" : "Optional filter for API client types", + "items" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" + }, + "nullable" : true + } + } + }, + "Integration_GetApiTokensWSResponse" : { + "type" : "object", + "description" : "Response object containing API tokens.", + "properties" : { + "apiTokens" : { + "type" : "array", + "description" : "List of API tokens", + "items" : { + "$ref" : "#/components/schemas/ApiTokenType" + }, "nullable" : true }, - "clientorgname" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true - }, - "dueDate" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "duedate" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "invoiceDate" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Integration_GetBadgeIntegrationDoorsWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", + "nullable" : true }, - "invoiceUuid" : { - "type" : "string", + "doors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DoorType" + }, "nullable" : true }, - "invoicedate" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true + "error" : { + "type" : "boolean", + "nullable" : true }, - "invoiceinternalid" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "invoiceuuid" : { + "warningMsg" : { "type" : "string", - "nullable" : true, - "writeOnly" : true + "nullable" : true + } + } + }, + "Integration_GetBadgeIntegrationGenericDoorsWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", + "nullable" : true }, - "lineItems" : { + "doors" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/LineItems" + "$ref" : "#/components/schemas/GenericDoorType" }, "nullable" : true }, - "lineitems" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LineItems" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "partnerOrgName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "partnerorgname" : { + "warningMsg" : { "type" : "string", - "nullable" : true, - "writeOnly" : true + "nullable" : true + } + } + }, + "Integration_GetBadgeIntegrationPlacesWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", + "nullable" : true }, - "paymentid" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "status" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "totalBalance" : { - "type" : "number", + "places" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PlaceType" + }, "nullable" : true }, - "totalbalance" : { - "type" : "number", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetBoulevardIntegrationWSResponse" : { + "type" : "object", + "description" : "Response object for retrieving Boulevard integration settings.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "transactionId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "transactionid" : { + "settings" : { + "$ref" : "#/components/schemas/IBoulevardType" + }, + "warningMsg" : { "type" : "string", "nullable" : true }, - "unpaidBalance" : { - "type" : "number", + "webhookUrl" : { + "type" : "string", + "description" : "Webhook URL for Boulevard to send notifications to", "nullable" : true - }, - "unpaidbalance" : { - "type" : "number", - "nullable" : true, - "writeOnly" : true } } }, - "Network_GetDeviceNetworkConfigurationWSRequest" : { + "Integration_GetBrivoDoorsWSRequest" : { "type" : "object", "properties" : { - "deviceUuid" : { + "password" : { + "type" : "string", + "nullable" : true + }, + "username" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Network_GetDeviceNetworkConfigurationWSResponse" : { + "Integration_GetBrivoDoorsWSResponse" : { "type" : "object", "properties" : { - "ipConfigurations" : { + "authError" : { + "type" : "boolean", + "nullable" : true + }, + "doors" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Network_IpConfiguration" + "$ref" : "#/components/schemas/DoorType" }, "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Network_IpConfiguration" : { + "Integration_GetButterflymxPanelsWSRequest" : { "type" : "object", "properties" : { - "dnsServer1" : { + "email" : { "type" : "string", - "description" : "Primary DNS server. Will only be set if mode is STATIC.", "nullable" : true }, - "dnsServer2" : { + "password" : { "type" : "string", - "description" : "Secondary DNS server. Will only be set if mode is STATIC.", "nullable" : true - }, - "gateway" : { - "type" : "string", - "description" : "Gateway address. Will only be set if mode is STATIC.", + } + } + }, + "Integration_GetButterflymxPanelsWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", "nullable" : true }, - "ipAddress" : { - "type" : "string", - "description" : "IP address. Will only be set if mode is STATIC.", + "buildings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ButterflymxBuilding" + }, "nullable" : true }, - "isSecondary" : { + "error" : { "type" : "boolean", - "description" : "Indicates whether this IP configuration is secondary. Default is false (primary).", "nullable" : true }, - "mode" : { - "$ref" : "#/components/schemas/Network_NetworkConfigurationModeEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "netmask" : { + "warningMsg" : { "type" : "string", - "description" : "Subnet mask. Will only be set if mode is STATIC.", "nullable" : true } } }, - "Network_NetworkConfigurationModeEnum" : { - "type" : "string", - "description" : "Network configuration mode for devices.", - "enum" : [ "DHCP", "STATIC" ] - }, - "Network_UpdateDeviceIpConfigurationWSRequest" : { + "Integration_GetCalendlyEventDetailsWSRequest" : { "type" : "object", "properties" : { - "deviceUuid" : { + "eventUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ipConfiguration" : { - "$ref" : "#/components/schemas/Network_IpConfiguration" - } - } - }, - "Network_UpdateDeviceIpConfigurationWSResponse" : { - "type" : "object", - "properties" : { - "ipConfiguration" : { - "$ref" : "#/components/schemas/Network_IpConfiguration" } } }, - "NewCookie" : { + "Integration_GetCalendlyEventDetailsWSResponse" : { "type" : "object", - "nullable" : true, "properties" : { - "comment" : { + "email" : { "type" : "string", "nullable" : true }, - "domain" : { - "type" : "string", + "endTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "expiry" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "httpOnly" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "maxAge" : { + "startTimeMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "name" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Integration_GetEnvoyDeliveriesWSRequest" : { + "type" : "object", + "properties" : { + "endTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "path" : { - "type" : "string", + "locationIds" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "sameSite" : { - "$ref" : "#/components/schemas/JakartaSameSiteEnum" + "startTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "Integration_GetEnvoyDeliveriesWSResponse" : { + "type" : "object", + "properties" : { + "collectedDeliveries" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EnvoyDelivery" + }, + "nullable" : true }, - "secure" : { + "error" : { "type" : "boolean", "nullable" : true }, - "value" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "version" : { - "type" : "integer", - "format" : "int32", + "pendingDeliveries" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EnvoyDelivery" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "NineOneOneCellularType" : { + "Integration_GetEnvoyEmployeesWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "bearerToken" : { - "type" : "string", - "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "securityZoneMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SecurityZoneInfoType" - }, - "nullable" : true - }, - "triggerNotification" : { - "type" : "boolean", - "nullable" : true - }, - "webhookToken" : { + "properties" : { + "locationIds" : { + "type" : "array", + "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "zonesValidated" : { - "type" : "boolean", - "nullable" : true - } + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Integration_GetEnvoyEmployeesWSResponse" : { + "type" : "object", "properties" : { - "enabled" : { - "type" : "boolean", + "employees" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EnvoyPersonInfo" + }, "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "NoonlightPromptSelection" : { + "Integration_GetEnvoyLocationsWSRequest" : { + "type" : "object" + }, + "Integration_GetEnvoyLocationsWSResponse" : { "type" : "object", - "description" : "The threat qualification prompt to update.", "properties" : { - "mutable" : { + "authError" : { "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "reasons" : { + "locationList" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/NoonlightReasonEnum" + "$ref" : "#/components/schemas/EnvoyLocation" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "title" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "NoonlightPromptThemeEnum" : { - "type" : "string", - "enum" : [ "THREAT", "HUMAN" ] - }, - "NoonlightReasonEnum" : { - "type" : "string", - "enum" : [ "NO_PERSON", "ROUTINE_EMPLOYEE", "PERSON_OUTSIDE", "PERSON_INSIDE", "OTHER", "SERVICES_ONSITE", "MOVING_VEHICLE", "CAMERA_OBSTRUCTED", "VIDEO_ISSUE", "PERSON_OTHER", "NO_PERSON_OTHER", "LOAD_FAILURE", "ACTIVE_CRIME", "UNKNOWN_PERSON_INSIDE", "UNKNOWN_SUSPECT_OUTSIDE", "UNKNOWN_SUSPECT_INSIDE", "UNKNOWN_PERSON_OUTSIDE", "OTHER_CONCLUSIVE_RESULT", "TIMEOUT" ] - }, - "NoonlightScheduleType" : { + "Integration_GetEnvoyVisitorsWSRequest" : { "type" : "object", "properties" : { - "audioGateways" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "escalationDelayMinutes" : { + "endTimestampMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "monitoredDevices" : { + "includeSignedOutVisitors" : { + "type" : "boolean", + "nullable" : true + }, + "locationIds" : { "type" : "array", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "promptTheme" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + "nullable" : true }, - "promptTitle" : { - "type" : "string", + "startTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "Integration_GetEnvoyVisitorsWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "scheduleUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sirenSettings" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/AMSirenSettingsType" + "invites" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EnvoyExpectedGuest" }, "nullable" : true }, - "triggerSet" : { + "visitors" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/EnvoyGuest" }, - "nullable" : true, - "uniqueItems" : true - }, - "tripwire" : { - "$ref" : "#/components/schemas/TripwireSettings" + "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "verifiedThreatSiren" : { - "$ref" : "#/components/schemas/AMSirenSettingsType" } } }, - "NoonlightSettings" : { + "Integration_GetFlicDevicesWSRequest" : { "type" : "object", "properties" : { - "acceptedTermsOfService" : { + "error" : { "type" : "boolean", "nullable" : true }, - "defaultContactsByLocationMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, - "nullable" : true - }, - "defaultDelayByLocationsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "defaultPromptByLocationsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "emergencyContactsByLocationsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EmergencyResponseContactsIntervalType" - }, - "nullable" : true - }, + } + } + }, + "Integration_GetFlicDevicesWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", "nullable" : true }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "escalationSettingsByLocationsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringSubmissionDelayIntervalType" - }, - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "locationEntryInstructionsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true + "flicDevices" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlicDevice" }, "nullable" : true }, - "pinsByLocationMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringPinType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "nullable" : true + "flicModule" : { + "$ref" : "#/components/schemas/FlicDevice" }, - "verificationPrompt" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "NoonlightVersionedSettingsType" : { + "Integration_GetGeneaDoorsWSRequest" : { "type" : "object", - "description" : "Updated alert monitoring settings configuration for the location", "properties" : { - "acceptedTermsOfService" : { - "type" : "boolean", + "apiToken" : { + "type" : "string", "nullable" : true - }, - "badgeAuthDisablesMonitoring" : { + } + } + }, + "Integration_GetGeneaDoorsWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { "type" : "boolean", "nullable" : true }, - "defaultDelay" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "defaultEmergencyContact" : { - "$ref" : "#/components/schemas/EmergencyContact" - }, - "defaultPromptTheme" : { - "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" - }, - "deleted" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "emergencyContacts" : { + "panelList" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/EmergencyResponseContactsScheduleType" + "$ref" : "#/components/schemas/PanelType" }, "nullable" : true }, - "enabled" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetGuestWSResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "entryInstructions" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "locationUuid" : { + "guest" : { + "$ref" : "#/components/schemas/Guest" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "manualEscalationSettings" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, - "modifiedByEmail" : { + } + } + }, + "Integration_GetHoneywellElementsDevicesWSRequest" : { + "type" : "object", + "description" : "Fetch Honeywell Elements devices. Optional siteId overrides the persisted site — used by the wizard's site dropdown to preview devices for a site without first saving.", + "properties" : { + "siteId" : { "type" : "string", + "description" : "Optional Elements site ID. When omitted, the persisted siteId from the integration row is used.", + "nullable" : true + } + } + }, + "Integration_GetHoneywellElementsDevicesWSResponse" : { + "type" : "object", + "properties" : { + "devices" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Integration_GetHoneywellElementsDevicesWSResponse_ElementsDevice" + }, "nullable" : true }, - "modifiedByIntegration" : { + "error" : { "type" : "boolean", "nullable" : true }, - "modifiedByMetadata" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "modifiedByUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "modifiedTimeMs" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Integration_GetHoneywellElementsDevicesWSResponse_ElementsDevice" : { + "type" : "object", + "properties" : { + "deviceType" : { + "type" : "string", "nullable" : true }, - "monitoringMode" : { - "$ref" : "#/components/schemas/MonitoringModeEnum" - }, - "oneTimePauses" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, + "id" : { + "type" : "string", "nullable" : true }, - "oneTimeSchedules" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" - }, + "name" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "siteId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Integration_GetHoneywellElementsSitesWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "pins" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringPinType" - }, - "nullable" : true, - "uniqueItems" : true - }, - "rules" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "schedules" : { + "sites" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/NoonlightScheduleType" + "$ref" : "#/components/schemas/Integration_GetHoneywellElementsSitesWSResponse_ElementsSite" }, "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "talkdownEnabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "NormalStateEnumType" : { - "type" : "string", - "enum" : [ "NO", "NC" ] - }, - "NotificationEnumType" : { - "type" : "string", - "enum" : [ "SMS", "EMAIL", "APP", "SLACK", "MICROSOFT_TEAMS", "BROWSER", "UNKNOWN" ] - }, - "NotificationFollowUp" : { + "Integration_GetHoneywellElementsSitesWSResponse_ElementsSite" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "userUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - } - } - } ], - "nullable" : true, "properties" : { - "type" : { - "$ref" : "#/components/schemas/ChatFollowUpActionEnum" + "id" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true } } }, - "NotificationIntervalV2Type" : { + "Integration_GetHoneywellElementsWebhookConfigWSResponse" : { "type" : "object", + "description" : "Fully-formed callback URL and suggested payload template for configuring the webhook Automation in the Honeywell Elements admin console.", "properties" : { - "activityTriggerMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceFilterSet" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "diagnosticTriggerMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, + "payloadTemplate" : { + "type" : "string", "nullable" : true }, - "locationActivityTriggerMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true }, - "locationDiagnosticTriggerMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true - }, + "webhookUrl" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetHoneywellNetBoxWebhookConfigWSResponse" : { + "type" : "object", + "description" : "Fully-formed callback URL and suggested payload template for configuring a webhook forwarder in the Honeywell NetBox admin console.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "locationFilterSet" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "locationOnlyFilterSet" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "payloadTemplate" : { + "type" : "string", + "nullable" : true }, - "minuteOfWeekStart" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true }, - "minuteOfWeekStop" : { - "type" : "integer", - "format" : "int32", + "webhookUrl" : { + "type" : "string", "nullable" : true } } }, - "NotificationSettingsType" : { + "Integration_GetInformacastScenariosWSResponse" : { "type" : "object", "properties" : { - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "slackChannel" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "slackEnabled" : { - "type" : "boolean", + "scenarios" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InformacastScenario" + }, "nullable" : true }, - "slackWebhookUrl" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "NotificationTimeFrame" : { + "Integration_GetInformacastSitesWSResponse" : { "type" : "object", "properties" : { - "days" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RhombusDayOfWeekEnum" - }, - "nullable" : true, - "uniqueItems" : true + "error" : { + "type" : "boolean", + "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/MinuteOfDayIntervalType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "mediums" : { + "sites" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" + "$ref" : "#/components/schemas/InformacastSite" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "rows" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationTimeFrameRow" - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "NotificationTimeFrameRow" : { + "Integration_GetInnerRangeConsolesWSRequest" : { + "type" : "object" + }, + "Integration_GetInnerRangeConsolesWSResponse" : { "type" : "object", "properties" : { - "activities" : { + "consoles" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/InnerRangeConsoleType" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "devices" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "error" : { + "type" : "boolean", + "nullable" : true }, - "diagnostics" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DiagnosticActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "locationOnly" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetInnerRangeDoorsWSRequest" : { + "type" : "object" + }, + "Integration_GetInnerRangeDoorsWSResponse" : { + "type" : "object", + "properties" : { + "doors" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/InnerRangeDoorType" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "locationOnlyActivities" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true + "error" : { + "type" : "boolean", + "nullable" : true }, - "locationOnlyDiagnostics" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DiagnosticActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "locations" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetIntegrationDiagnosticEventsWSRequest" : { + "type" : "object", + "properties" : { + "timestampMsAfter" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "promptUuids" : { + "timestampMsBefore" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "Integration_GetIntegrationDiagnosticEventsWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "integrationDiagnosticEvents" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/IntegrationDiagnosticEventType" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "NumericAggregationValue" : { + "Integration_GetKisiDoorsWSRequest" : { "type" : "object", - "description" : "Map of numeric count reports", "properties" : { - "average" : { - "type" : "number", - "format" : "double", + "apiSecretKey" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetKisiDoorsWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", "nullable" : true }, - "eventCount" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "localDate" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "max" : { - "type" : "number", - "format" : "double", + "placeToDoorMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DoorType" + }, + "nullable" : true + }, "nullable" : true }, - "maxValueTimestampMs" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetKisiIntegrationWSResponse" : { + "type" : "object", + "description" : "Response object containing Kisi integration settings.", + "properties" : { + "authError" : { + "type" : "boolean", + "description" : "Whether an authentication error occurred during update", + "example" : false, "nullable" : true }, - "min" : { - "type" : "number", - "format" : "double", + "error" : { + "type" : "boolean", "nullable" : true }, - "minValueTimestampMs" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "sum" : { - "type" : "number", - "format" : "double", + "failedGuids" : { + "type" : "array", + "description" : "List of GUIDs that failed to update", + "items" : { + "type" : "string", + "description" : "List of GUIDs that failed to update", + "nullable" : true + }, "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "kisiSettings" : { + "$ref" : "#/components/schemas/KisiSettings" + }, + "misconfiguredDoors" : { + "type" : "array", + "description" : "List of door names that are assigned to multiple Rhombus locations", + "items" : { + "type" : "string", + "description" : "List of door names that are assigned to multiple Rhombus locations", + "nullable" : true + }, "nullable" : true }, - "utcDate" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "OAuthApplication" : { + "Integration_GetKisiPlacesWSRequest" : { "type" : "object", - "description" : "OAuth application details", "properties" : { - "clientId" : { + "apiSecretKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Integration_GetMicrosoftUsersJoinedTeamsWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "clientSecretHash" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "contactEmail" : { - "type" : "string", + "teamsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "description" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Integration_GetNineOneOneCSZonesWSRequest" : { + "type" : "object" + }, + "Integration_GetNineOneOneCSZonesWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", + "nullable" : true }, - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "redirectUri" : { + "warningMsg" : { "type" : "string", "nullable" : true + }, + "zone" : { + "$ref" : "#/components/schemas/SecurityZoneInfoType" + }, + "zoneMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SecurityZoneInfoType" + }, + "nullable" : true } } }, - "OPERATOREnum" : { - "type" : "string", - "enum" : [ "GT", "LT", "LTE", "GTE", "EQ", "CONTAINS" ] - }, - "Oauth_GetAllApplicationsForOrgWSRequest" : { + "Integration_GetOpenAIModelsWSRequest" : { "type" : "object", - "description" : "Request object for getting all OAuth applications for an organization." + "description" : "Request object for retrieving OpenAI models.", + "properties" : { + "openAISettings" : { + "$ref" : "#/components/schemas/IOpenAIType" + } + } }, - "Oauth_GetAllApplicationsForOrgWSResponse" : { + "Integration_GetOpenAIModelsWSResponse" : { "type" : "object", - "description" : "Response object containing all OAuth applications for an organization.", + "description" : "Response object containing available OpenAI models.", "properties" : { "error" : { "type" : "boolean", @@ -105909,11 +108093,11 @@ "type" : "string", "nullable" : true }, - "oauthApplications" : { + "models" : { "type" : "array", - "description" : "List of OAuth applications for the organization", + "description" : "List of available OpenAI models", "items" : { - "$ref" : "#/components/schemas/OAuthApplication" + "$ref" : "#/components/schemas/OpenAIModel" }, "nullable" : true }, @@ -105923,25 +108107,25 @@ } } }, - "Oauth_GetApplicationByClientIdWSRequest" : { + "Integration_GetOpenpathDoorsWSRequest" : { "type" : "object", - "description" : "Request object for getting OAuth application by client ID.", "properties" : { - "clientId" : { + "email" : { + "type" : "string", + "nullable" : true + }, + "password" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Oauth_GetApplicationByClientIdWSResponse" : { + "Integration_GetOpenpathLockdownsWSResponse" : { "type" : "object", - "description" : "Response object containing OAuth application details.", "properties" : { - "application" : { - "$ref" : "#/components/schemas/OAuthApplication" + "authError" : { + "type" : "boolean", + "nullable" : true }, "error" : { "type" : "boolean", @@ -105951,65 +108135,74 @@ "type" : "string", "nullable" : true }, + "lockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Oauth_OAuthApplicationWSRequest" : { + "Integration_GetOpentechAllianceFacilitiesWSRequest" : { + "type" : "object" + }, + "Integration_GetOpentechAllianceFacilitiesWSResponse" : { "type" : "object", - "description" : "Request object for OAuth application management.", "properties" : { - "clientId" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "contactEmail" : { - "type" : "string", - "description" : "Contact email for the OAuth application", - "example" : "admin@myapp.com", + "error" : { + "type" : "boolean", "nullable" : true }, - "description" : { + "errorMsg" : { "type" : "string", - "description" : "Description of the OAuth application", - "example" : "Integration app for accessing Rhombus API", "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the OAuth application", - "example" : "My Integration App", + "facilities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OpentechAllianceFacilityType" + }, "nullable" : true }, - "redirectUri" : { + "warningMsg" : { "type" : "string", - "description" : "OAuth redirect URI", - "example" : "https://myapp.com/oauth/callback", "nullable" : true } } }, - "Oauth_OAuthApplicationWSResponse" : { + "Integration_GetOrgIntegrationsV2WSResponse" : { "type" : "object", - "description" : "Response object containing OAuth application credentials.", "properties" : { - "clientId" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "clientSecret" : { + "errorMsg" : { "type" : "string", - "description" : "OAuth client secret", "nullable" : true }, + "orgIntegrationV2" : { + "$ref" : "#/components/schemas/IBaseIntegrationType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetOrgIntegrationsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving organization integrations." + }, + "Integration_GetOrgIntegrationsWSResponse" : { + "type" : "object", + "description" : "Response object containing organization integrations configuration.", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -106018,173 +108211,153 @@ "type" : "string", "nullable" : true }, + "orgIntegrations" : { + "$ref" : "#/components/schemas/OrgIntegrationsType" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "ObjectSearchModelEnum" : { - "type" : "string", - "description" : "Object search model to use for embeddings", - "enum" : [ "CLIP_512", "UNKNOWN", "REIDENTIFICATION_NET", "PERSON_VIT", "PERSON_VITS" ] + "Integration_GetPartnerApiTokensWSRequest" : { + "type" : "object" }, - "OccupancyEventType" : { + "Integration_GetPdkDoorsWSRequest" : { "type" : "object", - "description" : "List of occupancy events for the sensor", "properties" : { - "baseStationUuid" : { + "ouId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "batteryPercentage" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Integration_GetPdkDoorsWSResponse" : { + "type" : "object", + "properties" : { + "authError" : { + "type" : "boolean", "nullable" : true }, - "bleDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "bleRssi" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "closeBaseStations" : { + "panelList" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/PanelType" }, "nullable" : true }, - "locationUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "lux" : { - "type" : "integer", - "format" : "int32", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Integration_GetPdkSystemIdWSRequest" : { + "type" : "object", + "properties" : { + "configurationToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "state" : { - "$ref" : "#/components/schemas/OccupancyStateEnum" - }, - "stateChanged" : { + } + } + }, + "Integration_GetPdkSystemIdWSResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "tampered" : { - "type" : "boolean", + "systemId" : { + "type" : "string", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "OccupancyPolicyType" : { + "Integration_GetPlaceOsDoorsWSRequest" : { "type" : "object", - "description" : "List of occupancy policies using the schedule", "properties" : { - "description" : { + "apiUrl" : { "type" : "string", "nullable" : true - }, - "name" : { - "type" : "string", + } + } + }, + "Integration_GetRaptorBuildingsWSResponse" : { + "type" : "object", + "properties" : { + "buildings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RaptorBuilding" + }, "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "error" : { + "type" : "boolean", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/OccupancyScheduledTriggerType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "OccupancyScheduledTriggerType" : { + "Integration_GetRaptorTemplatesWSResponse" : { "type" : "object", "properties" : { - "occupancyThresholdSec" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "triggerSet" : { + "templates" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "$ref" : "#/components/schemas/RaptorTemplate" }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "vacancyThresholdSec" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "OccupancyStateEnum" : { - "type" : "string", - "enum" : [ "VACANT", "MOVEMENT", "OCCUPIED" ] - }, - "OccupancyStatusEnum" : { - "type" : "string", - "description" : "Current occupancy status of the sensor", - "enum" : [ "VACANT", "MOVEMENT", "OCCUPIED" ] - }, - "Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" : { + "Integration_GetToastEventsTableAllLocationsWSRequest" : { "type" : "object", - "description" : "Request object for getting minimal occupancy sensor states for all sensors in organization." + "properties" : { + "businessDate" : { + "type" : "string", + "nullable" : true + } + } }, - "Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" : { + "Integration_GetToastEventsTableAllLocationsWSResponse" : { "type" : "object", - "description" : "Response object containing minimal occupancy sensor states for all sensors in organization.", "properties" : { "error" : { "type" : "boolean", @@ -106194,11 +108367,18 @@ "type" : "string", "nullable" : true }, - "occupancySensorStates" : { + "eventTable" : { "type" : "array", - "description" : "List of minimal occupancy sensor states", "items" : { - "$ref" : "#/components/schemas/Occupancysensor_MinimalOccupancySensorStateType" + "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse_EventTableRow" + }, + "nullable" : true + }, + "failedGuids" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true }, "nullable" : true }, @@ -106208,43 +108388,21 @@ } } }, - "Occupancysensor_GetOccupancyEventsForSensorWSRequest" : { + "Integration_GetToastEventsTableWSRequest" : { "type" : "object", - "description" : "Request object for getting occupancy events for a specific sensor.", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter events created after this timestamp (milliseconds since epoch)", - "example" : 1640908800000, - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter events created before this timestamp (milliseconds since epoch)", - "example" : 1640995200000, - "nullable" : true - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of events to return", - "example" : 100, + "businessDate" : { + "type" : "string", "nullable" : true }, - "sensorUuid" : { + "restaurantGuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Occupancysensor_GetOccupancyEventsForSensorWSResponse" : { + "Integration_GetToastEventsTableWSResponse" : { "type" : "object", - "description" : "Response object containing occupancy events for a specific sensor.", "properties" : { "error" : { "type" : "boolean", @@ -106254,11 +108412,10 @@ "type" : "string", "nullable" : true }, - "events" : { + "eventTable" : { "type" : "array", - "description" : "List of occupancy events for the sensor", "items" : { - "$ref" : "#/components/schemas/OccupancyEventType" + "$ref" : "#/components/schemas/Integration_GetToastEventsTableWSResponse_EventTableRow" }, "nullable" : true }, @@ -106268,295 +108425,266 @@ } } }, - "Occupancysensor_MinimalOccupancySensorStateType" : { + "Integration_GetToastEventsTableWSResponse_EventTableRow" : { "type" : "object", - "description" : "Minimal state information for occupancy sensors including health, location, and sensor data.", "properties" : { - "associatedCameras" : { + "assignedCameraList" : { "type" : "array", - "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "batteryPercent" : { - "type" : "integer", - "format" : "int32", - "description" : "Battery percentage of the sensor", - "example" : 85, + "employeeName" : { + "type" : "string", "nullable" : true }, - "closestBaseStation" : { + "orderGuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "firmwareVersion" : { + "paymentType" : { "type" : "string", - "description" : "Firmware version of the sensor", - "example" : "1.2.3", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the sensor is located", - "example" : 2, + "restaurantName" : { + "type" : "string", "nullable" : true }, - "health" : { - "$ref" : "#/components/schemas/Occupancysensor_MotionSensorHealthEnum" - }, - "healthDetails" : { - "$ref" : "#/components/schemas/Occupancysensor_MotionSensorHealthDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lastSeenSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the sensor was last seen (seconds since epoch)", - "example" : 1640995200, + "revenueCenterName" : { + "type" : "string", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the sensor location", - "example" : 37.7749, + "serviceAreaName" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "timestamp" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the sensor location", - "example" : -122.4194, + "tipAmount" : { + "type" : "string", "nullable" : true }, - "name" : { + "totalAmount" : { "type" : "string", - "description" : "Name of the occupancy sensor", - "example" : "Conference Room Sensor", "nullable" : true }, - "normalizedLux" : { - "type" : "number", - "format" : "float", - "description" : "Normalized lux value (0-1) matching human perception of lighting transitions", - "example" : 0.75, + "totalDiscountAmount" : { + "type" : "string", "nullable" : true }, - "policyUuid" : { + "voided" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "rawLux" : { - "type" : "integer", - "format" : "int32", - "description" : "Raw lux value from the sensor", - "example" : 500, + } + } + }, + "Integration_GetToastServiceAreasWSRequest" : { + "type" : "object", + "properties" : { + "restaurantGuid" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GetToastServiceAreasWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "sensorUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the occupancy sensor", - "example" : "RH123456789", + "serviceAreas" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GenericPosType" + }, "nullable" : true }, - "signalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "Signal strength of the sensor", - "example" : -45, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_GuestWSRequest" : { + "type" : "object", + "description" : "Request object for guest-related operations.", + "properties" : { + "email" : { + "type" : "string", + "description" : "Email address of the guest", + "example" : "guest@example.com", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/OccupancyStatusEnum" + "error" : { + "type" : "boolean", + "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Occupancysensor_MotionSensorHealthDetailsEnum" : { - "type" : "string", - "description" : "Detailed motion sensor health status.", - "enum" : [ "NO_HEARTBEAT", "FIRMWARE_BEHIND", "NONE" ] - }, - "Occupancysensor_MotionSensorHealthEnum" : { - "type" : "string", - "description" : "Motion sensor health status.", - "enum" : [ "RED", "GREEN" ] - }, - "Occupancysensor_UpdateOccupancySensorDetailsWSRequest" : { + "Integration_HoneywellOnGuardDeploymentSummaryType" : { "type" : "object", - "description" : "Request object for updating occupancy sensor details with selective update flags.", + "description" : "Summary of one OnGuard deployment. Never includes the pre-shared secret; the deployment is identified by its rhombusToken, which is also what deleteHoneywellOnGuardIntegration takes.", "properties" : { - "associatedCameras" : { + "assignedCameraUuids" : { "type" : "array", - "description" : "List of associated camera device facet UUIDs", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "associatedCamerasUpdated" : { - "type" : "boolean", - "description" : "Whether the associated cameras should be updated", - "example" : false, + "displayName" : { + "type" : "string", "nullable" : true }, - "deleted" : { - "type" : "boolean", - "description" : "Whether the sensor is marked as deleted", - "example" : false, + "doorCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "deletedUpdated" : { - "type" : "boolean", - "description" : "Whether the deleted status should be updated", - "example" : false, + "rhombusToken" : { + "type" : "string", "nullable" : true - }, - "description" : { + } + } + }, + "Integration_InitiateBrivoOAuthWSRequest" : { + "type" : "object", + "description" : "Request object for initiating Brivo OAuth authentication flow with API key.", + "properties" : { + "apiKey" : { "type" : "string", - "description" : "Description of the occupancy sensor", - "example" : "Motion sensor for conference room A", + "description" : "Brivo Mashery API key obtained from Brivo Developer Portal", + "example" : "brivo_api_key_12345", "nullable" : true }, - "descriptionUpdated" : { - "type" : "boolean", - "description" : "Whether the description should be updated", - "example" : false, + "param" : { + "type" : "string", + "description" : "Additional OAuth parameter", + "example" : "state_param", "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "description" : "Floor number where the sensor is located", - "example" : 2, + "requestUrl" : { + "type" : "string", + "description" : "OAuth request URL", + "example" : "https://oauth.provider.com/auth", "nullable" : true }, - "floorNumberUpdated" : { - "type" : "boolean", - "description" : "Whether the floor number should be updated", - "example" : false, + "rhombusOrgUserUuid" : { + "type" : "string", + "description" : "Rhombus organization user UUID", "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate of the sensor location", - "example" : 37.7749, + } + } + }, + "Integration_InitiateCallbackAuthRequest" : { + "type" : "object", + "properties" : { + "rhombusOrgUserUuid" : { + "type" : "string", "nullable" : true - }, - "latitudeUpdated" : { + } + } + }, + "Integration_InitiateCallbackAuthResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether the latitude should be updated", - "example" : false, "nullable" : true }, - "locationUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationUuidUpdated" : { - "type" : "boolean", - "description" : "Whether the location UUID should be updated", - "example" : false, - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate of the sensor location", - "example" : -122.4194, + "integratorUrl" : { + "type" : "string", "nullable" : true }, - "longitudeUpdated" : { - "type" : "boolean", - "description" : "Whether the longitude should be updated", - "example" : false, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "name" : { + } + } + }, + "Integration_InitiateOAuthWSRequest" : { + "type" : "object", + "description" : "Request object for initiating OAuth authentication flow.", + "properties" : { + "param" : { "type" : "string", - "description" : "Name of the occupancy sensor", - "example" : "Conference Room Sensor", + "description" : "Additional OAuth parameter", + "example" : "state_param", "nullable" : true }, - "nameUpdated" : { - "type" : "boolean", - "description" : "Whether the name should be updated", - "example" : false, + "requestUrl" : { + "type" : "string", + "description" : "OAuth request URL", + "example" : "https://oauth.provider.com/auth", "nullable" : true }, - "policyUuid" : { + "rhombusOrgUserUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Rhombus organization user UUID", "nullable" : true - }, - "policyUuidUpdated" : { + } + } + }, + "Integration_InitiateOAuthWSResponse" : { + "type" : "object", + "description" : "Response object containing OAuth redirect URL.", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether the policy UUID should be updated", - "example" : false, "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key should be updated", - "example" : false, + "redirectUrl" : { + "type" : "string", + "description" : "OAuth redirect URL for authentication", + "example" : "https://oauth.provider.com/auth?client_id=123&redirect_uri=callback", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Occupancysensor_UpdateOccupancySensorDetailsWSResponse" : { + "Integration_ListHoneywellOnGuardIntegrationsWSRequest" : { "type" : "object", - "description" : "Response object for updating occupancy sensor details.", + "description" : "List the calling org's OnGuard deployments. Takes no parameters today; the body is reserved for future filters/paging." + }, + "Integration_ListHoneywellOnGuardIntegrationsWSResponse" : { + "type" : "object", + "description" : "The calling org's OnGuard deployments. Empty list when the integration has never been activated or every deployment has been deleted.", "properties" : { "error" : { "type" : "boolean", @@ -106566,123 +108694,60 @@ "type" : "string", "nullable" : true }, + "integrations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Integration_HoneywellOnGuardDeploymentSummaryType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "OccupiedActivityEventType" : { + "Integration_RefreshGoogleAccessTokenWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "occupancyThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request object for refreshing Google access token.", "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" + "refreshUserToken" : { + "type" : "boolean", + "description" : "Whether to refresh the user token", + "example" : true, + "nullable" : true } } }, - "Office365Settings" : { + "Integration_RefreshGoogleAccessTokenWSResponse" : { "type" : "object", - "description" : "Office 365 integration settings to update", + "description" : "Response object containing refreshed Google access token.", "properties" : { - "driveId" : { + "accessToken" : { "type" : "string", + "description" : "Refreshed Google access token", + "example" : "ya29.a0AfH6SMC...", "nullable" : true }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "enablingUser" : { - "type" : "string", - "nullable" : true - }, - "enablingUserUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tenantId" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "OmnialertType" : { + "Integration_RevokeApiTokenWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "associatedCameras" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "triggerNotification" : { - "type" : "boolean", - "nullable" : true - }, - "webhookToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request object for revoking an API token.", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "userUuid" : { + "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -106691,242 +108756,210 @@ } } }, - "OpenAIModel" : { + "Integration_RevokeApiTokenWSResponse" : { "type" : "object", - "description" : "List of available OpenAI models", + "description" : "Response object for revoking an API token.", "properties" : { - "created" : { - "type" : "string", - "nullable" : true - }, - "id" : { - "type" : "string", - "nullable" : true - }, - "object" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "ownedBy" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "owned_by" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "OpenAIType" : { + "Integration_RevokeGoogleDriveAccessWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "baseUrl" : { - "type" : "string", - "description" : "The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.", - "nullable" : true - }, - "defaultModel" : { - "type" : "string", - "description" : "The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request object for revoking Google Drive access permissions.", "properties" : { - "enabled" : { + "revokeUserAccount" : { "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "If set to true, revokes Rhombus Systems access to a user's Google Drive account, otherwise revokes Rhombus Systems access to the org's shared Google Drive account", + "example" : true, "nullable" : true } } }, - "Openapi_GetOpenApiComponentSchemasWSRequest" : { + "Integration_SendShellyCommandResultEnumType" : { + "type" : "string", + "description" : "Outcome of a manually sent Shelly command.", + "enum" : [ "SUCCESS", "DEVICE_OFFLINE", "NOT_AUTHORIZED", "DEVICE_BUSY", "FAILED" ] + }, + "Integration_SendShellyCommandWSRequest" : { "type" : "object", - "description" : "Request object for exposing custom objects and enums to OpenAPI component schemas.", + "description" : "Request object for manually sending a command to a Shelly device.", "properties" : { - "changeType" : { - "$ref" : "#/components/schemas/ChangeTypeEnum" + "channel" : { + "type" : "integer", + "format" : "int32", + "description" : "Channel to address on a multi-channel device. Defaults to the first channel", + "example" : 0, + "nullable" : true }, - "entity" : { - "$ref" : "#/components/schemas/EntityEnum" + "command" : { + "$ref" : "#/components/schemas/Integration_ShellyCommandEnumType" }, - "locationFunctionality" : { - "$ref" : "#/components/schemas/LocationFunctionalityEnum" + "deviceId" : { + "type" : "string", + "description" : "Shelly device ID, as keyed in the org's Shelly integration settings", + "example" : "e8db84d1f2a0", + "nullable" : true } } }, - "OpenpathSettings" : { + "Integration_SendShellyCommandWSResponse" : { "type" : "object", + "description" : "Response object for manually sending a command to a Shelly device.", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true + "canSendCommands" : { + "$ref" : "#/components/schemas/ShellyDevicePermissionEnum" }, - "createSeekPoints" : { + "error" : { "type" : "boolean", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "doorToCameraMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, + "isOnline" : { + "type" : "boolean", + "description" : "Whether the device was reachable during the attempt", + "example" : true, "nullable" : true }, - "email" : { - "type" : "string", - "nullable" : true + "result" : { + "$ref" : "#/components/schemas/Integration_SendShellyCommandResultEnumType" }, - "enabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Integration_ShellyCommandEnumType" : { + "type" : "string", + "description" : "Command to send to a Shelly relay or light.", + "enum" : [ "TURN_ON", "TURN_OFF", "TOGGLE" ] + }, + "Integration_SubmitApiTokenApplicationWSRequest" : { + "type" : "object", + "description" : "Request object for submitting an API token application.", + "properties" : { + "authType" : { + "$ref" : "#/components/schemas/ApiTokenAuthTypeEnum" }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "csr" : { + "type" : "string", + "description" : "Certificate Signing Request (CSR) for token authentication", + "example" : "-----BEGIN CERTIFICATE REQUEST-----...", "nullable" : true }, - "enablingUser" : { + "displayName" : { "type" : "string", + "description" : "Display name for the API token", + "example" : "Production API Token", "nullable" : true }, - "enablingUserUuid" : { + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "eventToWebhookIdMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true - }, - "eventToWebhookMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/WebhookMapEntry" - }, + } + }, + "required" : [ "permissionGroupUuid" ] + }, + "Integration_SubmitApiTokenApplicationWSResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "cert" : { + "type" : "string", "nullable" : true }, - "migrated" : { + "error" : { "type" : "boolean", "nullable" : true }, - "password" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { + "validCSR" : { "type" : "boolean", "nullable" : true }, - "webhookId" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "OpentechAllianceActionGroupType" : { + "Integration_SubscribeZapierWebhookWSRequest" : { "type" : "object", + "description" : "Request object for subscribing to Zapier webhook events.", "properties" : { - "actionGroupId" : { - "type" : "string", + "backoffSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Backoff time in seconds", + "example" : 30, "nullable" : true }, - "deviceId" : { + "doorState" : { + "$ref" : "#/components/schemas/DoorStatusEnum" + }, + "hookUrl" : { "type" : "string", + "description" : "Zapier webhook URL", + "example" : "https://hooks.zapier.com/hooks/catch/123456/abc123/", "nullable" : true }, - "locationName" : { - "type" : "string", + "humidityLowerThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Lower humidity threshold for environmental sensors", + "example" : 30.0, "nullable" : true }, - "name" : { - "type" : "string", + "humidityUpperThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Upper humidity threshold for environmental sensors", + "example" : 80.0, "nullable" : true - } - } - }, - "OpentechAllianceDoorInfoType" : { - "type" : "object", - "nullable" : true, - "properties" : { - "actionGroupId" : { - "type" : "string", + }, + "tempLowerThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Lower temperature threshold for environmental sensors", + "example" : 65.0, "nullable" : true }, - "assignedCameraList" : { + "tempUpperThreshold" : { + "type" : "number", + "format" : "float", + "description" : "Upper temperature threshold for environmental sensors", + "example" : 85.5, + "nullable" : true + }, + "uuids" : { "type" : "array", + "description" : "Set of device UUIDs to monitor", "items" : { "type" : "string", "format" : "RUUID", @@ -106934,241 +108967,256 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "clipDuration" : { - "type" : "integer", - "format" : "int32", + "zapEnum" : { + "$ref" : "#/components/schemas/ZapierEnum" + } + } + }, + "Integration_SubscribeZapierWebhookWSResponse" : { + "type" : "object", + "description" : "Response object for Zapier webhook subscription.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "doorName" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "leadingSeconds" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true }, - "locationUuid" : { + "webhookId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "remoteUnlock" : { - "type" : "boolean", + } + } + }, + "Integration_TestBoulevardConnectionWSRequest" : { + "type" : "object", + "description" : "Request object for testing Boulevard API connection.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Boulevard API token to test", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "boulevardBusinessId" : { + "type" : "string", + "description" : "Boulevard business ID to test", + "nullable" : true } } }, - "OpentechAllianceFacilitySettings" : { + "Integration_TestBoulevardConnectionWSResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response object for testing Boulevard API connection.", "properties" : { - "alertUnauthorizedFaces" : { + "error" : { "type" : "boolean", "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", + "errorMessage" : { + "type" : "string", + "description" : "Error message if connection test failed", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/OpentechAllianceDoorInfoType" + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "locations" : { + "type" : "array", + "description" : "List of Boulevard locations available for the business", + "items" : { + "$ref" : "#/components/schemas/Integration_TestBoulevardConnectionWSResponse_BoulevardLocationInfo" }, "nullable" : true }, - "identifyFacesFromBadge" : { + "success" : { "type" : "boolean", + "description" : "Whether the connection test was successful", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "OpentechAllianceFacilityType" : { + "Integration_TestBoulevardConnectionWSResponse_BoulevardLocationInfo" : { "type" : "object", + "description" : "Information about a Boulevard location.", "properties" : { - "actionGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/OpentechAllianceActionGroupType" - }, - "nullable" : true - }, - "deviceList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DoorType" - }, - "nullable" : true - }, "id" : { "type" : "string", + "description" : "Boulevard location ID", "nullable" : true }, "name" : { "type" : "string", + "description" : "Boulevard location name", "nullable" : true } } }, - "OpentechAllianceSettings" : { + "Integration_TogglePowerWSRequest" : { "type" : "object", + "description" : "Request object for toggling device power state.", "properties" : { - "apiKey" : { - "type" : "string", - "nullable" : true - }, - "apiSecret" : { + "deviceId" : { "type" : "string", + "description" : "Device ID to toggle power for", + "example" : "device_12345", "nullable" : true }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "enabledTimestampMs" : { + "targetState" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Target power state (0=off, 1=on)", + "example" : 1, "nullable" : true - }, - "enablingUser" : { - "type" : "string", + } + } + }, + "Integration_TogglePowerWSResponse" : { + "type" : "object", + "description" : "Response object for device power toggle operations.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "enablingUserUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "facilityToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" - }, + "newState" : { + "type" : "integer", + "format" : "int32", + "description" : "New power state after toggle (0=off, 1=on)", + "example" : 1, "nullable" : true }, - "migrated" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "OpentechAllianceType" : { + "Integration_UnlockDoorWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "apiKey" : { - "type" : "string", - "nullable" : true - }, - "apiSecret" : { - "type" : "string", - "nullable" : true - }, - "facilityToSettingsMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Response object for door unlock operations.", "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Integration_UnlockGeneaDoorWSRequest" : { + "type" : "object", + "description" : "Request object for unlocking a Genea door.", + "properties" : { + "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "doorId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Genea door ID to unlock", + "example" : "door_12345", "nullable" : true } } }, - "OperationStatus" : { + "Integration_UnlockIntegrationGenericDoorWSRequest" : { "type" : "object", - "description" : "Map of device serial numbers to their reassignment operation status", "properties" : { - "message" : { + "cameraUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/StatusTypeEnum" + "doorId" : { + "type" : "string", + "nullable" : true } } }, - "OrgGroupEnumType" : { - "type" : "string", - "enum" : [ "RHOMBUS_ACCESS_CONTROL", "GUEST_MANAGEMENT_HOST" ] - }, - "OrgGroupMemberType" : { + "Integration_UnlockKisiDoorWSRequest" : { "type" : "object", - "description" : "List of user group memberships", + "description" : "Request object for unlocking a Kisi door.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "groupUuid" : { + "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "doorId" : { + "type" : "integer", + "format" : "int32", + "description" : "Kisi door ID to unlock", + "example" : 12345, + "nullable" : true + }, + "placeId" : { + "type" : "integer", + "format" : "int32", + "description" : "Kisi place ID representing the physical space", + "example" : 67890, + "nullable" : true + } + } + }, + "Integration_UnlockOpenpathDoorWSRequest" : { + "type" : "object", + "description" : "Request object for unlocking an Openpath door.", + "properties" : { + "cameraUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/OrgGroupEnumType" - }, - "updatedAtMillis" : { + "doorId" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Openpath door ID to unlock", + "example" : 12345, "nullable" : true - }, - "userUuid" : { + } + } + }, + "Integration_UnsubscribeZapierWebhookWSRequest" : { + "type" : "object", + "description" : "Request object for unsubscribing from a Zapier webhook.", + "properties" : { + "webhookId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -107177,284 +109225,538 @@ } } }, - "OrgGroupType" : { + "Integration_UpdateAmtIntegrationWSRequest" : { "type" : "object", - "description" : "Updated organization group details", + "description" : "Request object for updating AMT access control integration settings.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "description" : { + "amtSettings" : { + "$ref" : "#/components/schemas/AmtSettings" + } + } + }, + "Integration_UpdateAperioIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Aperio integration configuration.", + "properties" : { + "aperioSettings" : { + "$ref" : "#/components/schemas/IAperioType" + } + }, + "required" : [ "aperioSettings" ] + }, + "Integration_UpdateApiTokenWSRequest" : { + "type" : "object", + "description" : "Request object for updating API token properties.", + "properties" : { + "newDisplayName" : { "type" : "string", + "description" : "New display name for the API token", + "example" : "Updated API Token", "nullable" : true }, - "locationUuid" : { + "newPermissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "tokenUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Integration_UpdateApiTokenWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/OrgGroupEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "OrgIntegrationsType" : { + "Integration_UpdateAvigilonAltaV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Avigilon Alta V2 integration settings.", + "properties" : { + "avigilonAltaSettings" : { + "$ref" : "#/components/schemas/IAvigilonAltaType" + } + } + }, + "Integration_UpdateAwsIntegrationWSRequest" : { "type" : "object", - "description" : "Organization integrations configuration and settings", "properties" : { - "amtSettings" : { - "$ref" : "#/components/schemas/AmtSettings" - }, "awsSettings" : { "$ref" : "#/components/schemas/AwsSettings" + } + } + }, + "Integration_UpdateBoulevardIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Boulevard access control integration settings.", + "properties" : { + "accessWindowAfterMinutes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes after appointment to allow access", + "nullable" : true }, - "backblazeSettings" : { - "$ref" : "#/components/schemas/BackblazeSettings" + "accessWindowBeforeMinutes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes before appointment to allow access", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "description" : "Boulevard API token", + "nullable" : true + }, + "boulevardBusinessId" : { + "type" : "string", + "description" : "Boulevard business ID", + "nullable" : true + }, + "boulevardLocationToRhombusLocationMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "description" : "Mapping of Boulevard location IDs to Rhombus location UUIDs", + "nullable" : true }, + "enabled" : { + "type" : "boolean", + "description" : "Whether the Boulevard integration is enabled", + "nullable" : true + } + } + }, + "Integration_UpdateBoxIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Box file storage integration settings.", + "properties" : { "boxSettings" : { "$ref" : "#/components/schemas/BoxSettings" - }, + } + } + }, + "Integration_UpdateBrivoIntegrationV2WSRequest" : { + "type" : "object", + "properties" : { + "brivoSettings" : { + "$ref" : "#/components/schemas/IBrivoType" + } + } + }, + "Integration_UpdateBrivoIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Brivo access control integration settings.", + "properties" : { "brivoSettings" : { "$ref" : "#/components/schemas/BrivoSettings" - }, + } + } + }, + "Integration_UpdateButterflymxIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating ButterflyMX V2 integration settings with enhanced intercom features.", + "properties" : { "butterflymxSettings" : { - "$ref" : "#/components/schemas/ButterflyMXSettings" - }, - "diceSettings" : { - "$ref" : "#/components/schemas/DiceSettings" - }, - "dropboxSettingsV2" : { - "$ref" : "#/components/schemas/DropboxSettingsV2" - }, - "emailSettings" : { - "$ref" : "#/components/schemas/EmailSettings" - }, - "envoySettings" : { - "$ref" : "#/components/schemas/EnvoySettings" - }, - "geneaSettings" : { - "$ref" : "#/components/schemas/GeneaSettings" - }, - "googleSettings" : { - "$ref" : "#/components/schemas/GoogleSettings" - }, - "googleSettingsV2" : { - "$ref" : "#/components/schemas/GoogleSettingsV2" - }, - "haloSettings" : { - "$ref" : "#/components/schemas/HaloSettings" - }, - "immixSettings" : { - "$ref" : "#/components/schemas/ImmixSettings" - }, - "intuifaceSettings" : { - "$ref" : "#/components/schemas/IntuifaceSettings" - }, - "kisiSettings" : { - "$ref" : "#/components/schemas/KisiSettings" - }, - "lumeoSettings" : { - "$ref" : "#/components/schemas/LumeoSettings" - }, - "mattermostSettings" : { - "$ref" : "#/components/schemas/MattermostSettings" + "$ref" : "#/components/schemas/IButterflyMXType" + } + } + }, + "Integration_UpdateButterflymxIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating ButterflyMX intercom integration settings.", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/ButterflyMXSettings" + } + } + }, + "Integration_UpdateDeviceIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating device integration settings and device properties.", + "properties" : { + "createNewDevice" : { + "type" : "boolean", + "description" : "Whether to create a new device", + "example" : true, + "nullable" : true }, - "microsoftTeamsSettings" : { - "$ref" : "#/components/schemas/MicrosoftTeamsSettings" + "deviceIntegrationSettings" : { + "$ref" : "#/components/schemas/IDeviceIntegrationType" }, - "noonlightSettings" : { - "$ref" : "#/components/schemas/NoonlightSettings" + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the device location", + "example" : 37.7749, + "nullable" : true }, - "office365Settings" : { - "$ref" : "#/components/schemas/Office365Settings" + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the device location", + "example" : -122.4194, + "nullable" : true }, - "openpathSettings" : { - "$ref" : "#/components/schemas/OpenpathSettings" + "name" : { + "type" : "string", + "description" : "Name of the device", + "example" : "Main Entrance Camera", + "nullable" : true }, - "opentechAllianceSettings" : { - "$ref" : "#/components/schemas/OpentechAllianceSettings" + "updateDevice" : { + "type" : "boolean", + "description" : "Whether to update an existing device", + "example" : false, + "nullable" : true }, - "orgUuid" : { + "updateDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pagerDutySettings" : { - "$ref" : "#/components/schemas/PagerDutySettings" - }, - "placeOsSettings" : { - "$ref" : "#/components/schemas/PlaceOsSettings" - }, - "proDataKeySettings" : { - "$ref" : "#/components/schemas/ProDataKeySettings" - }, - "saltoSettings" : { - "$ref" : "#/components/schemas/SaltoSettings" - }, - "serviceNowSettings" : { - "$ref" : "#/components/schemas/ServiceNowSettings" - }, - "slackSettings" : { - "$ref" : "#/components/schemas/SlackSettings" - }, - "slackSettingsV2" : { - "$ref" : "#/components/schemas/SlackSettingsV2" - }, - "squareSettings" : { - "$ref" : "#/components/schemas/SquareSettings" - }, - "toastSettings" : { - "$ref" : "#/components/schemas/ToastSettings" - }, - "tpLinkSettings" : { - "$ref" : "#/components/schemas/TPLinkSettings" - }, - "twilioSettings" : { - "$ref" : "#/components/schemas/TwilioSettings" - }, - "webhookSettings" : { - "$ref" : "#/components/schemas/WebhookSettings" } } }, - "OrgLicenseStats" : { + "Integration_UpdateDiceIntegrationWSRequest" : { "type" : "object", - "description" : "License statistics for the organization", + "description" : "Request object for updating Dice access control integration settings.", "properties" : { - "acuDoorLicenseStats" : { - "$ref" : "#/components/schemas/LicenseGroupStats" - }, - "alertMonitoringLicenseStats" : { - "$ref" : "#/components/schemas/LicenseGroupStats" - }, - "assignedCount" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "deviceLicenseStats" : { - "$ref" : "#/components/schemas/DeviceAssignableLicenseGroupStats" - }, - "lastEndDate" : { + "diceSettings" : { + "$ref" : "#/components/schemas/IDiceType" + } + } + }, + "Integration_UpdateDropboxIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Dropbox integration settings.", + "properties" : { + "dropboxSettings" : { + "$ref" : "#/components/schemas/DropboxSettingsV2" + } + } + }, + "Integration_UpdateEmailIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating email notification integration settings.", + "properties" : { + "emailSettings" : { + "$ref" : "#/components/schemas/EmailSettings" + } + } + }, + "Integration_UpdateEnvoyIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Envoy V2 integration settings with enhanced visitor management features.", + "properties" : { + "envoySettings" : { + "$ref" : "#/components/schemas/IEnvoyType" + } + } + }, + "Integration_UpdateEnvoyIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Envoy visitor management integration settings.", + "properties" : { + "envoySettings" : { + "$ref" : "#/components/schemas/EnvoySettings" + } + } + }, + "Integration_UpdateFlicIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Flic smart button integration settings.", + "properties" : { + "flicSettings" : { + "$ref" : "#/components/schemas/IFlicType" + } + } + }, + "Integration_UpdateGeneaIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Genea V2 integration settings with enhanced access control features.", + "properties" : { + "geneaSettings" : { + "$ref" : "#/components/schemas/IGeneaType" + } + } + }, + "Integration_UpdateGeneaIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Genea access control integration settings.", + "properties" : { + "geneaSettings" : { + "$ref" : "#/components/schemas/GeneaSettings" + } + } + }, + "Integration_UpdateGoogleIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Google V2 integration settings with enhanced features.", + "properties" : { + "googleSettings" : { + "$ref" : "#/components/schemas/IGoogleType" + } + } + }, + "Integration_UpdateGoogleIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Google integration settings.", + "properties" : { + "googleSettings" : { + "$ref" : "#/components/schemas/GoogleSettings" + } + } + }, + "Integration_UpdateGuestByTokenWSRequest" : { + "type" : "object", + "description" : "Request object for updating guest information using a token.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "The closest past date on which licenses belonging to the group expired.", + "description" : "File name for guest-related data", + "example" : "guest_data.csv", "nullable" : true }, - "licenseUsageStats" : { - "$ref" : "#/components/schemas/LicenseUsageStats" + "guest" : { + "$ref" : "#/components/schemas/Guest" }, - "nearExpirationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group that are currently close to expiration.", + "token" : { + "type" : "string", + "description" : "Token for guest identification and authentication", + "example" : "guest_token_12345", "nullable" : true - }, - "nextEndDate" : { + } + } + }, + "Integration_UpdateGuestManagementIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating guest management integration settings.", + "properties" : { + "guestManagementSettings" : { + "$ref" : "#/components/schemas/IGuestManagementType" + } + } + }, + "Integration_UpdateGuestWSRequest" : { + "type" : "object", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "The closest future date on which licenses belonging to the group will expire.", + "description" : "File name for guest-related data", + "example" : "guest_data.csv", "nullable" : true }, - "stateStats" : { - "$ref" : "#/components/schemas/LicenseStateStats" + "guest" : { + "$ref" : "#/components/schemas/Guest" }, - "totalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of licenses in the group.", + "sendGuestEmail" : { + "type" : "boolean", "nullable" : true } } }, - "OrgLockdownPlanType" : { + "Integration_UpdateHaloIntegrationWSRequest" : { "type" : "object", - "allOf" : [ ], - "nullable" : true, + "description" : "Request object for updating Halo access control integration settings.", "properties" : { - "activationPlan" : { - "$ref" : "#/components/schemas/LockdownActivationPlanType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "haloSettings" : { + "$ref" : "#/components/schemas/HaloSettings" + } + } + }, + "Integration_UpdateHoneywellElementsIntegrationWSRequest" : { + "type" : "object", + "properties" : { + "honeywellElementsSettings" : { + "$ref" : "#/components/schemas/IHoneywellElementsType" + } + } + }, + "Integration_UpdateHoneywellNetBoxIntegrationWSRequest" : { + "type" : "object", + "properties" : { + "honeywellNetBoxSettings" : { + "$ref" : "#/components/schemas/IHoneywellNetBoxType" + } + } + }, + "Integration_UpdateHoneywellOnGuardIntegrationWSRequest" : { + "type" : "object", + "properties" : { + "honeywellOnGuardSettings" : { + "$ref" : "#/components/schemas/IHoneywellOnGuardType" + } + } + }, + "Integration_UpdateInformacastIntegrationRequest" : { + "type" : "object", + "properties" : { + "informacastSettings" : { + "$ref" : "#/components/schemas/IInformacastType" + } + } + }, + "Integration_UpdateInnerRangeIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating InnerRange access control integration settings.", + "properties" : { + "innerRangeSettings" : { + "$ref" : "#/components/schemas/IInnerRangeType" + } + } + }, + "Integration_UpdateIntuifaceIntegrationWSRequest" : { + "type" : "object", + "properties" : { + "settings" : { + "$ref" : "#/components/schemas/IntuifaceSettings" + } + } + }, + "Integration_UpdateKisiIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Kisi V2 integration settings with enhanced features.", + "properties" : { + "kisiSettings" : { + "$ref" : "#/components/schemas/IKisiType" + } + } + }, + "Integration_UpdateKisiIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Kisi access control integration settings.", + "properties" : { + "kisiSettings" : { + "$ref" : "#/components/schemas/KisiSettings" + } + } + }, + "Integration_UpdateLumeoIntegrationWSRequest" : { + "type" : "object", + "properties" : { + "lumeoSettings" : { + "$ref" : "#/components/schemas/ILumeoType" + } + } + }, + "Integration_UpdateMattermostIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Mattermost team communication integration settings.", + "properties" : { + "mattermostSettings" : { + "$ref" : "#/components/schemas/MattermostSettings" + } + } + }, + "Integration_UpdateMicrosoftTeamsBotForTeamWSRequest" : { + "type" : "object", + "properties" : { + "teamId" : { + "type" : "string", "nullable" : true + } + } + }, + "Integration_UpdateMicrosoftTeamsIntegrationV2WSRequest" : { + "type" : "object", + "properties" : { + "microsoftTeamsSettings" : { + "$ref" : "#/components/schemas/IMicrosoftTeamsType" }, - "deactivationPlan" : { - "$ref" : "#/components/schemas/LockdownDeactivationPlanType" - }, - "defaultLockdownState" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" - }, - "doorLockdownStateMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + "teamsToUpdate" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true }, "nullable" : true - }, - "name" : { - "type" : "string", + } + } + }, + "Integration_UpdateMicrosoftTeamsIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Microsoft Teams integration settings.", + "properties" : { + "microsoftTeamsSettings" : { + "$ref" : "#/components/schemas/MicrosoftTeamsSettings" + } + } + }, + "Integration_UpdateNineOneOneCellularIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating 911 Cellular emergency notification integration settings.", + "properties" : { + "nineOneOneCellularSettings" : { + "$ref" : "#/components/schemas/INineOneOneCellularType" + } + } + }, + "Integration_UpdateNoonlightSettingsWSRequest" : { + "type" : "object", + "properties" : { + "noonlightSettings" : { + "$ref" : "#/components/schemas/NoonlightSettings" + } + } + }, + "Integration_UpdateOffice365IntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Office 365 integration settings.", + "properties" : { + "office365Settings" : { + "$ref" : "#/components/schemas/Office365Settings" + } + } + }, + "Integration_UpdateOmnialertIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Omnialert emergency notification integration settings.", + "properties" : { + "omnialertSettings" : { + "$ref" : "#/components/schemas/IOmnialertType" + } + } + }, + "Integration_UpdateOmnialertIntegrationWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "physicalAccess" : { - "$ref" : "#/components/schemas/LockdownPhysicalAccessType" - }, - "scopeUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "testPlan" : { - "$ref" : "#/components/schemas/LockdownTestPlanType" - }, - "type" : { - "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", "nullable" : true }, - "uuid" : { + "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -107463,480 +109765,669 @@ } } }, - "OrgSamlSettingsType" : { + "Integration_UpdateOpenAIIntegrationRequest" : { "type" : "object", - "description" : "List of SAML settings to update", "properties" : { - "addUsersOnRoleMismatch" : { - "type" : "boolean", - "nullable" : true - }, - "domain" : { - "$ref" : "#/components/schemas/RhombusSamlDomainEnum" - }, - "enabled" : { + "openAISettings" : { + "$ref" : "#/components/schemas/IOpenAIType" + } + } + }, + "Integration_UpdateOpenpathIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Openpath access control integration settings.", + "properties" : { + "openpathSettings" : { + "$ref" : "#/components/schemas/OpenpathSettings" + } + } + }, + "Integration_UpdateOpentechAllianceIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating OpenTech Alliance V2 integration settings with enhanced features.", + "properties" : { + "opentechAllianceSettings" : { + "$ref" : "#/components/schemas/IOpentechAllianceType" + } + } + }, + "Integration_UpdateOpentechAllianceIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating OpenTech Alliance integration settings.", + "properties" : { + "opentechAllianceSettings" : { + "$ref" : "#/components/schemas/OpentechAllianceSettings" + } + } + }, + "Integration_UpdateOrgIntegrationsWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization integrations.", + "properties" : { + "authError" : { "type" : "boolean", + "description" : "Whether an authentication error occurred during update", + "example" : false, "nullable" : true }, - "enabledForRhombusKey" : { + "error" : { "type" : "boolean", "nullable" : true }, - "idpMetaDataXml" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "justInTimeAccountProvisioningEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "failedGuids" : { + "type" : "array", + "description" : "List of GUIDs that failed to update", + "items" : { + "type" : "string", + "description" : "List of GUIDs that failed to update", + "nullable" : true + }, "nullable" : true }, - "registrationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "misconfiguredDoors" : { + "type" : "array", + "description" : "List of door names that are assigned to multiple Rhombus locations", + "items" : { + "type" : "string", + "description" : "List of door names that are assigned to multiple Rhombus locations", + "nullable" : true + }, "nullable" : true }, - "rhombusKeyAppSettings" : { - "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" - }, - "teamName" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "OrgType" : { + "Integration_UpdatePagerDutyIntegrationWSRequest" : { "type" : "object", - "description" : "Organization information to update", + "description" : "Request object for updating PagerDuty incident management integration settings.", "properties" : { - "accountOwnerEmail" : { - "type" : "string", + "pagerDutySettings" : { + "$ref" : "#/components/schemas/PagerDutySettings" + } + } + }, + "Integration_UpdatePdkIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Pro Data Key (PDK) V2 integration settings with enhanced access control features.", + "properties" : { + "pdkSettings" : { + "$ref" : "#/components/schemas/IProDataKeyType" + } + } + }, + "Integration_UpdatePdkIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Pro Data Key (PDK) integration settings.", + "properties" : { + "pdkSettings" : { + "$ref" : "#/components/schemas/ProDataKeySettings" + } + } + }, + "Integration_UpdatePimlocIntegrationRequest" : { + "type" : "object", + "properties" : { + "pimlocSettings" : { + "$ref" : "#/components/schemas/IPimlocType" + } + } + }, + "Integration_UpdatePlaceOsSettingsV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating PlaceOS V2 integration settings for smart building management.", + "properties" : { + "placeOsSettings" : { + "$ref" : "#/components/schemas/IPlaceOsType" + } + } + }, + "Integration_UpdatePlaceOsSettingsWSRequest" : { + "type" : "object", + "properties" : { + "placeOsSettings" : { + "$ref" : "#/components/schemas/PlaceOsSettings" + } + } + }, + "Integration_UpdateRaptorIntegrationRequest" : { + "type" : "object", + "properties" : { + "raptorSettings" : { + "$ref" : "#/components/schemas/IRaptorType" + } + } + }, + "Integration_UpdateServiceNowIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating ServiceNow IT service management integration settings.", + "properties" : { + "serviceNowSettings" : { + "$ref" : "#/components/schemas/ServiceNowSettings" + } + } + }, + "Integration_UpdateShellyIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Shelly smart device integration settings.", + "properties" : { + "shellySettings" : { + "$ref" : "#/components/schemas/IShellyType" + } + } + }, + "Integration_UpdateSlackIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating Slack integration V2 settings with enhanced user management.", + "properties" : { + "adminRequest" : { + "type" : "boolean", + "description" : "Whether this is an admin request", + "example" : true, "nullable" : true }, - "address1" : { + "requestUrl" : { "type" : "string", + "description" : "Request URL for Slack OAuth", + "example" : "https://slack.com/oauth/v2/authorize?client_id=123&scope=...", "nullable" : true }, - "address2" : { - "type" : "string", + "revokeUserAccessToken" : { + "type" : "boolean", + "description" : "Whether to revoke user access token", + "example" : false, "nullable" : true }, - "countryCode" : { + "rhombusOrgUserUuid" : { "type" : "string", + "description" : "Rhombus organization user UUID", + "example" : "user-uuid-12345", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "firmwareUpdateSettings" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" + "slackSettingsV2" : { + "$ref" : "#/components/schemas/SlackSettingsV2" }, - "itemizedInvoice" : { + "userAssociate" : { "type" : "boolean", + "description" : "Whether to associate user", + "example" : true, "nullable" : true }, - "mfaEnabled" : { + "userRequest" : { "type" : "boolean", + "description" : "Whether this is a user request", + "example" : false, "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "newCameraFramerateMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true - }, - "newCameraResolutionMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true - }, - "newCameraSegmentMaxBytesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", + } + }, + "required" : [ "requestUrl" ] + }, + "Integration_UpdateSlackIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Slack integration settings.", + "properties" : { + "slackSettings" : { + "$ref" : "#/components/schemas/SlackSettings" + } + } + }, + "Integration_UpdateToastIntegrationV2WSRequest" : { + "type" : "object", + "properties" : { + "restaurantGuids" : { + "type" : "array", + "items" : { + "type" : "string", "nullable" : true }, "nullable" : true }, - "newCameraVideoTargetQualityMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "toastSettings" : { + "$ref" : "#/components/schemas/IToastType" + } + } + }, + "Integration_UpdateToastIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Toast POS integration settings.", + "properties" : { + "toastSettings" : { + "$ref" : "#/components/schemas/ToastSettings" + } + } + }, + "Integration_UpdateTritonIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating Triton audio sensor integration settings.", + "properties" : { + "tritonSettings" : { + "$ref" : "#/components/schemas/TritonSettings" + } + } + }, + "Integration_UpdateWebhookIntegrationV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating webhook V2 integration settings with enhanced configuration options.", + "properties" : { + "disabled" : { + "type" : "boolean", + "description" : "Whether the webhook is disabled", + "example" : false, "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/NotificationSettingsType" - }, - "partnerAccessAllowedUntil" : { - "type" : "integer", - "format" : "int32", + "isDiagnostic" : { + "type" : "boolean", + "description" : "Whether this is a diagnostic webhook", + "example" : false, "nullable" : true }, - "planType" : { - "$ref" : "#/components/schemas/PlanTypeEnum" + "updatedWebhookSettings" : { + "$ref" : "#/components/schemas/IWebhooksType" }, - "postalCode" : { + "webhookUrl" : { "type" : "string", + "description" : "Webhook URL for receiving notifications", + "example" : "https://api.example.com/webhook/rhombus", "nullable" : true - }, - "rbacSettings" : { - "$ref" : "#/components/schemas/RBACSettingsType" - }, - "samlSettings" : { - "$ref" : "#/components/schemas/SAMLSettingsType" - }, - "subscriptionEndDate" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Integration_UpdateWebhookIntegrationV2WSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "subscriptionStatus" : { - "$ref" : "#/components/schemas/SubscriptionStatusEnum" - }, - "subscriptionType" : { - "$ref" : "#/components/schemas/SubscriptionTypeEnum" - }, - "supportAccessAllowedUntil" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "teamName" : { + "warningMsg" : { "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/OrgTypeEnum" - }, - "uapSettings" : { - "$ref" : "#/components/schemas/UAPSettingsType" - }, - "uuid" : { + "webhookSecret" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "OrgTypeEnum" : { - "type" : "string", - "enum" : [ "PARTNER", "CUSTOMER", "UNKNOWN" ] + "Integration_UpdateWebhookIntegrationWSRequest" : { + "type" : "object", + "description" : "Request object for updating webhook integration settings.", + "properties" : { + "webhookSettings" : { + "$ref" : "#/components/schemas/WebhookSettings" + } + } }, - "OrgV2Type" : { + "Integration_ValidateHoneywellElementsCredentialsWSRequest" : { "type" : "object", - "description" : "List of Rhombus organizations the user has access to", - "nullable" : true, "properties" : { - "accountBillingContactEmail" : { + "apiKey" : { "type" : "string", "nullable" : true }, - "accountOwnerEmail" : { + "baseUrl" : { "type" : "string", "nullable" : true - }, - "accountTechnicalContactEmail" : { + } + } + }, + "Integration_ValidateKisiApiKeyWSRequest" : { + "type" : "object", + "description" : "Request object for validating Kisi API key.", + "properties" : { + "apiKey" : { "type" : "string", + "description" : "Kisi API key to validate", + "example" : "kisi_api_key_123456789", + "nullable" : true + } + } + }, + "Integration_aperio_AperioDeviceView" : { + "type" : "object", + "description" : "View object containing Aperio device information.", + "properties" : { + "aperioId" : { + "type" : "array", + "description" : "Aperio device ID", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Aperio device ID", + "nullable" : true + }, "nullable" : true }, - "accountTechnicalContacts" : { + "gatewayId" : { "type" : "array", + "description" : "Gateway ID associated with the device", "items" : { "type" : "string", + "format" : "byte", + "description" : "Gateway ID associated with the device", "nullable" : true }, "nullable" : true }, - "address1" : { - "type" : "string", + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the device was last seen", + "example" : 1642233600000, "nullable" : true }, - "address2" : { + "rawType" : { + "type" : "string", + "format" : "byte", + "description" : "Raw device type", + "example" : "MQ==", + "nullable" : true + } + } + }, + "Integration_aperio_AperioDoorView" : { + "type" : "object", + "description" : "View object containing Aperio door information and status.", + "properties" : { + "accessControlledDoorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "audioAnalysisEnabled" : { - "type" : "boolean", + "aperioDoorDeviceId" : { + "type" : "string", + "description" : "Aperio door device ID", "nullable" : true }, - "audioRecordingEnabled" : { - "type" : "boolean", + "aperioGatewayId" : { + "type" : "string", + "description" : "Aperio gateway ID that brokers communication with this door", "nullable" : true }, - "bandwidthReportsDisabled" : { - "type" : "boolean", + "aperioId" : { + "type" : "string", + "description" : "Aperio door ID (device group ID) for controlling the locking mechanism", "nullable" : true }, - "companyLogoUrl" : { - "type" : "string", + "connected" : { + "type" : "boolean", + "description" : "Whether the Aperio door is currently connected", + "example" : true, "nullable" : true }, - "companyLogoUuid" : { + "doorExtensionComponentId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "countryCode" : { - "type" : "string", + "dtcs" : { + "type" : "array", + "description" : "List of diagnostic trouble codes (DTCs) for the door", + "items" : { + "$ref" : "#/components/schemas/Integration_aperio_DtcInfoView" + }, "nullable" : true }, - "createdAtMillis" : { + "lastSeenMs" : { "type" : "integer", "format" : "int64", + "description" : "Timestamp when the door was last seen", + "example" : 1642233600000, "nullable" : true }, - "criticalStatusEnabled" : { - "type" : "boolean", + "name" : { + "type" : "string", + "description" : "Name of the Aperio door", + "example" : "Main Entrance", "nullable" : true }, - "defaultPlayerViewLiveType" : { - "$ref" : "#/components/schemas/PlayerViewLiveTypeEnum" - }, - "deleted" : { - "type" : "boolean", + "rawActivatorState" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "deletedAtMillis" : { + "rawDoorMode" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "developmentPartnerOrg" : { - "type" : "boolean", + "rawHandleState" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "firmwareUpdateSettings" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" - }, - "firmwareUpdateSettingsOverrides" : { - "type" : "array", - "description" : "Overrides default firmware update settings.", - "items" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsOverrideType" - }, + "rawKeyCylinderState" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "inactivityTimeout" : { + "rawTamperState" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "itemizedInvoice" : { + "removed" : { "type" : "boolean", + "description" : "Whether the door has been removed from the gateway", + "example" : false, "nullable" : true }, - "keypadLogoUrl" : { + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/Integration_aperio_AperioIntegrationStatus" + } + } + }, + "Integration_aperio_AperioGatewayView" : { + "type" : "object", + "description" : "View object containing Aperio gateway information and status.", + "properties" : { + "aperioGatewayId" : { "type" : "string", + "description" : "Aperio gateway ID (device interface unit ID)", "nullable" : true }, - "keypadLogoUuid" : { + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "llmUsageEnabled" : { + "connected" : { "type" : "boolean", + "description" : "Whether the Aperio gateway is currently connected", + "example" : true, "nullable" : true }, - "maxAllowedSegmentMaxBytesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "devices" : { + "type" : "array", + "description" : "List of Aperio devices associated with this gateway", + "items" : { + "$ref" : "#/components/schemas/Integration_aperio_AperioDeviceView" }, "nullable" : true }, - "mfaEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "motionGridDisabled" : { - "type" : "boolean", + "doors" : { + "type" : "array", + "description" : "List of Aperio doors associated with this gateway", + "items" : { + "$ref" : "#/components/schemas/Integration_aperio_AperioDoorView" + }, "nullable" : true }, - "motionLightweightDisabled" : { - "type" : "boolean", + "dtcs" : { + "type" : "array", + "description" : "List of diagnostic trouble codes (DTCs) for the gateway", + "items" : { + "$ref" : "#/components/schemas/Integration_aperio_DtcInfoView" + }, "nullable" : true }, - "name" : { + "expectedOemCode" : { "type" : "string", + "description" : "Expected OEM code for the gateway (only available after system configuration)", "nullable" : true }, - "newCameraFramerateMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "firmwareVersion" : { + "type" : "string", + "description" : "Firmware version of the Aperio gateway", + "example" : "1.2.3", "nullable" : true }, - "newCameraResolutionMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "hardwareModel" : { + "type" : "string", "nullable" : true }, - "newCameraSegmentMaxBytesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", + "hwVersion" : { + "type" : "array", + "description" : "Hardware version of the Aperio gateway", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Hardware version of the Aperio gateway", "nullable" : true }, "nullable" : true }, - "newCameraVideoTargetQualityMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "ipAddress" : { + "type" : "string", + "description" : "IP address of the Aperio gateway", + "example" : "192.168.1.100", "nullable" : true }, - "newCameraZeroMotionVideoQualityMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the gateway was last seen", + "example" : 1642233600000, "nullable" : true }, - "notifyForHardwareFailureTickets" : { - "type" : "boolean", + "protocolVersion" : { + "type" : "string", + "description" : "Protocol version of the Aperio gateway", + "example" : "1.0.0", "nullable" : true }, - "partnerAccessAllowedUntil" : { + "rawTamperState" : { "type" : "integer", "format" : "int32", + "description" : "Raw tamper state of the Aperio gateway", + "example" : 0, "nullable" : true }, - "postalCode" : { + "reportedOemCode" : { "type" : "string", + "description" : "OEM code reported by the gateway for authenticity verification", "nullable" : true }, - "rhombusKeyLogoUrl" : { - "type" : "string", + "status" : { + "$ref" : "#/components/schemas/Integration_aperio_AperioIntegrationStatus" + } + } + }, + "Integration_aperio_AperioIntegrationStatus" : { + "type" : "string", + "description" : "Integration status of the Aperio gateway", + "enum" : [ "UNKNOWN", "DISCOVERED", "PAIRING", "CONFIGURED", "ERROR_OEM", "ERROR_OWNER" ] + }, + "Integration_aperio_AperioRhombusDoorControllerView" : { + "type" : "object", + "description" : "View object containing Rhombus door controller information for Aperio integration.", + "properties" : { + "aperioGateways" : { + "type" : "array", + "description" : "List of Aperio gateways associated with this door controller", + "items" : { + "$ref" : "#/components/schemas/Integration_aperio_AperioGatewayView" + }, "nullable" : true }, - "rhombusKeyLogoUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "salesforceAccountId" : { + "hwId" : { "type" : "string", + "description" : "Hardware ID of the Rhombus door controller", + "example" : "DC001", "nullable" : true }, - "shareAiTrainingMediaWithRhombus" : { - "type" : "boolean", - "nullable" : true - }, - "subscriptionEndDate" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "subscriptionStatus" : { - "$ref" : "#/components/schemas/SubscriptionStatusEnum" - }, - "subscriptionType" : { - "$ref" : "#/components/schemas/SubscriptionTypeEnum" - }, - "supportAccessAllowedUntil" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "tenantUrl" : { + "name" : { "type" : "string", + "description" : "Name of the Rhombus door controller", + "example" : "Main Door Controller", "nullable" : true }, - "thumbstripDisabled" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/OrgTypeEnum" - }, - "uapSettings" : { - "$ref" : "#/components/schemas/UAPSettingsType" - }, - "uuid" : { + "serialNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "v3AuthNumDaysSkip2FAForTrustedDevices" : { - "type" : "integer", - "format" : "int32", + "description" : "Serial number of the Rhombus door controller", + "example" : "RHDC123456789", "nullable" : true } } }, - "Org_ClaimActivationTokenWSRequest" : { + "Integration_aperio_ClearAperioDtcWSRequest" : { "type" : "object", + "description" : "Request object for clearing Aperio DTC (Diagnostic Trouble Code) from a device.", "properties" : { - "activationToken" : { + "aperioDeviceId" : { "type" : "string", + "description" : "The Aperio device id (hex string) of the device to which this command is issued.", "nullable" : true }, - "name" : { + "aperioGatewayId" : { "type" : "string", + "description" : "The Aperio device id (hex string) of the gateway hosting the device.", "nullable" : true }, - "permissionGroupUuid" : { + "controllerUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "registeredComponentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "aperioDeviceId", "aperioGatewayId", "controllerUuid" ] }, - "Org_ClaimActivationTokenWSResponse" : { + "Integration_aperio_ClearAperioDtcWSResponse" : { "type" : "object", + "description" : "Response object for clearing Aperio DTC (Diagnostic Trouble Code) from a device.", "properties" : { "error" : { "type" : "boolean", @@ -107952,88 +110443,130 @@ } } }, - "Org_ClaimShipmentRegistrationTokenWSRequest" : { + "Integration_aperio_CreateAperioRs485GatewayWSRequest" : { "type" : "object", "properties" : { - "claimList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Org_DeviceRegistrationClaimType" - }, + "boardNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Board number of the RS-485 line the hub is wired to", + "example" : 0, "nullable" : true }, - "tokenUuid" : { + "eacAddress" : { + "type" : "integer", + "format" : "int32", + "description" : "The hub's base address on the line, 0x01 to 0x0F, set on its DIP switches. Its locks are addressed from there: a hub based at 0x01 has locks at 0x01, 0x11, 0x21 and so on, so two hubs on one line do not overlap.", + "example" : 1, + "nullable" : true + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "portNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Port number of the RS-485 line the hub is wired to", + "example" : 15, + "nullable" : true } - } + }, + "required" : [ "eacAddress", "ownerDeviceUuid" ] }, - "Org_ClaimShipmentRegistrationTokenWSResponse" : { + "Integration_aperio_DownloadCertificateWSRequest" : { + "type" : "object", + "description" : "Request object for downloading Aperio certificate.", + "properties" : { + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "ownerDeviceUuid" ] + }, + "Integration_aperio_DtcInfoView" : { "type" : "object", + "description" : "View object containing Aperio diagnostic trouble code (DTC) information.", "properties" : { + "code" : { + "type" : "array", + "description" : "DTC code as byte array", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "DTC code as byte array", + "nullable" : true + }, + "nullable" : true + }, "error" : { "type" : "boolean", + "description" : "Whether the DTC represents an error condition", + "example" : true, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "failing" : { + "type" : "boolean", + "description" : "Whether the DTC is currently failing", + "example" : true, "nullable" : true }, - "warningMsg" : { + "hasFailed" : { + "type" : "boolean", + "description" : "Whether the DTC has failed in the past", + "example" : false, + "nullable" : true + }, + "name" : { "type" : "string", + "description" : "Display name of the DTC", + "example" : "Communication Error", + "nullable" : true + }, + "testCompleted" : { + "type" : "boolean", + "description" : "Whether the DTC test has completed", + "example" : true, + "nullable" : true + }, + "time" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the DTC was reported (seconds since 1970-01-01)", + "example" : 1642233600, "nullable" : true } } }, - "Org_CreatePendingRegistrationRequest" : { + "Integration_aperio_RebootAperioGatewayWSRequest" : { "type" : "object", - "description" : "Request object for creating pending hardware registration.", + "description" : "Request object for rebooting an Aperio gateway.", "properties" : { - "locationUuid" : { + "aperioGatewayId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "The Aperio device id (hex string) of the gateway.", "nullable" : true }, - "orgUuid" : { + "controllerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the hardware device", - "example" : "RH123456789", - "nullable" : true - }, - "wifiPsk" : { - "type" : "array", - "description" : "WiFi pre-shared key for the device", - "items" : { - "type" : "string", - "format" : "byte", - "description" : "WiFi pre-shared key for the device", - "nullable" : true - }, - "nullable" : true - }, - "wifiSsid" : { - "type" : "string", - "description" : "WiFi SSID for the device", - "example" : "Office_WiFi", - "nullable" : true } - } + }, + "required" : [ "aperioGatewayId", "controllerUuid" ] }, - "Org_CreatePendingRegistrationResponse" : { + "Integration_aperio_RebootAperioGatewayWSResponse" : { "type" : "object", - "description" : "Response object for creating pending hardware registration.", + "description" : "Response object for rebooting an Aperio gateway.", "properties" : { "error" : { "type" : "boolean", @@ -108049,25 +110582,62 @@ } } }, - "Org_DeleteCloudArchivingConfigWSRequest" : { + "Integration_schlage_CreateSchlageRs485GatewayWSRequest" : { "type" : "object", - "description" : "Request object for deleting cloud archiving configuration.", "properties" : { - "scope" : { - "$ref" : "#/components/schemas/DeviceTargetScopeEnum" + "baud" : { + "type" : "integer", + "format" : "int32", + "description" : "Line speed. Optional: RSI fixes it at 9600, so this is an override for hardware that needs one.", + "example" : 9600, + "nullable" : true }, - "targetUuid" : { + "boardNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Board number of the RS-485 line the gateway is wired to", + "example" : 0, + "nullable" : true + }, + "frameCheck" : { + "$ref" : "#/components/schemas/Rs485FrameCheckEnum" + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "portNum" : { + "type" : "integer", + "format" : "int32", + "description" : "Port number of the RS-485 line the gateway is wired to", + "example" : 15, + "nullable" : true + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "description" : "The gateway's RSD address on the line, 0x00 to 0xFE. 0xFF is the panel and 0xAA is the broadcast address, so neither names a gateway. Several gateways may share one line, each at its own address.", + "example" : 1, + "nullable" : true + } + }, + "required" : [ "ownerDeviceUuid", "rs485Address" ] + }, + "Integration_state_FindIntegrationStateKeysWSRequest" : { + "type" : "object", + "description" : "Request to list the state keys present for (org, integrationType).", + "properties" : { + "integrationType" : { + "$ref" : "#/components/schemas/IntegrationStateTypeEnum" } } }, - "Org_DeleteCloudArchivingConfigWSResponse" : { + "Integration_state_FindIntegrationStateKeysWSResponse" : { "type" : "object", - "description" : "Response object for deleting cloud archiving configuration.", + "description" : "The state keys present for (org, integrationType); values are not returned.", "properties" : { "error" : { "type" : "boolean", @@ -108077,19 +110647,35 @@ "type" : "string", "nullable" : true }, + "stateKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Integration_state_IntegrationStateKeyWSType" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_DeleteKeypadLogoWSRequest" : { + "Integration_state_GetIntegrationStateWSRequest" : { "type" : "object", - "description" : "Request object for deleting keypad logo." + "description" : "Request to read an org-scoped integration state entry.", + "properties" : { + "integrationType" : { + "$ref" : "#/components/schemas/IntegrationStateTypeEnum" + }, + "stateKey" : { + "type" : "string", + "nullable" : true + } + } }, - "Org_DeleteKeypadLogoWSResponse" : { + "Integration_state_GetIntegrationStateWSResponse" : { "type" : "object", - "description" : "Response object for deleting keypad logo.", + "description" : "The stored state value, or a null stateValue when no entry exists (a normal condition, not an error).", "properties" : { "error" : { "type" : "boolean", @@ -108099,486 +110685,447 @@ "type" : "string", "nullable" : true }, + "stateValue" : { + "type" : "string", + "nullable" : true + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_DeleteRhombusKeyLogoWSRequest" : { + "Integration_state_IntegrationStateKeyWSType" : { "type" : "object", - "description" : "Request object for deleting Rhombus Key logo.", + "description" : "A state key present for (org, integrationType).", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "stateKey" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Org_DeleteRhombusKeyLogoWSResponse" : { + "Integration_state_UpdateIntegrationStateWSRequest" : { "type" : "object", - "description" : "Response object for deleting Rhombus Key logo.", + "description" : "Request to overwrite an org-scoped integration state entry.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "integrationType" : { + "$ref" : "#/components/schemas/IntegrationStateTypeEnum" }, - "errorMsg" : { + "stateKey" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "stateValue" : { "type" : "string", "nullable" : true } } }, - "Org_DeviceRegistrationClaimType" : { + "Integration_state_UpdateIntegrationStateWSResponse" : { "type" : "object", + "description" : "Result of an integration state write.", "properties" : { - "deviceName" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "hardwareUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "policyUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Org_FindAllHardwareWithPendingRegistrationRequest" : { - "type" : "object" - }, - "Org_FindAllHardwareWithPendingRegistrationResponse" : { + "IntelliGuardCoOccurrenceRule" : { "type" : "object", "properties" : { - "hardwareList" : { - "type" : "array", - "deprecated" : true, - "description" : "Use hardwareWithPendingRegistrationInfoList instead", - "items" : { - "$ref" : "#/components/schemas/HardwareType" - }, + "alertAction" : { + "type" : "boolean", "nullable" : true }, - "hardwareWithPendingRegistrationInfoList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Org_HardwareWithPendingRegistrationInfoType" + "cameraPositions" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CameraPosition" }, "nullable" : true - } - } - }, - "Org_FindHardwareAvailableForPendingRegistrationRequest" : { - "type" : "object" - }, - "Org_FindHardwareAvailableForPendingRegistrationResponse" : { - "type" : "object", - "properties" : { - "hardwareList" : { + }, + "cameraScope" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/HardwareType" + "type" : "string", + "nullable" : true }, "nullable" : true - } - } - }, - "Org_FindIfTeamNameAvailableRequest" : { - "type" : "object", - "description" : "Request object for checking if a team name is available.", - "properties" : { - "teamName" : { + }, + "cooldownMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "description" : { "type" : "string", - "description" : "Team name to check availability for", - "example" : "Engineering Team", "nullable" : true - } - } - }, - "Org_FindIfTeamNameAvailableResponse" : { - "type" : "object", - "description" : "Response object indicating if a team name is available.", - "properties" : { - "available" : { + }, + "disappearanceThresholdMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enabled" : { "type" : "boolean", - "description" : "Whether the team name is available", - "example" : true, "nullable" : true - } - } - }, - "Org_FindSCIMSettingsForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for finding SCIM settings for organization." - }, - "Org_FindSCIMSettingsForOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing SCIM settings for organization.", - "properties" : { - "scimSettings" : { - "$ref" : "#/components/schemas/SCIMSettingsType" - } - } - }, - "Org_GenerateFederatedSessionTokenRequest" : { - "type" : "object", - "description" : "Request object for generating a federated session token.", - "properties" : { - "domain" : { - "type" : "string", - "description" : "The domain that is allowed to use the federated token. The token should begin with a 'dot' and end with a domain suffix. The validation will perform an 'endsWith' operation of the domain supplied by the Referrer header", - "example" : ".rhombus.com", + }, + "faceNames" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "durationSec" : { + "liveNotificationAction" : { + "type" : "boolean", + "nullable" : true + }, + "matchCount" : { "type" : "integer", "format" : "int32", - "description" : "Duration of the federated session token in seconds", - "example" : 3600, - "nullable" : true - } - } - }, - "Org_GenerateFederatedSessionTokenResponse" : { - "type" : "object", - "description" : "Response object containing the generated federated session token.", - "properties" : { - "federatedSessionToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Org_GetAwsIntCloudformationFileRequest" : { - "type" : "object", - "description" : "Request object for getting AWS CloudFormation file." - }, - "Org_GetAwsIntCloudformationFileResponse" : { - "type" : "object", - "description" : "Response object containing AWS CloudFormation file.", - "properties" : { - "fileBase64" : { + }, + "name" : { "type" : "string", - "description" : "Base64 encoded CloudFormation file content", - "example" : "UEsDBBQAAAAIAA...", "nullable" : true - } - } - }, - "Org_GetClientOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting client organization details.", - "properties" : { + }, "orgUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Org_GetClientOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing client organization details.", - "properties" : { - "featureFlags" : { - "type" : "object", - "additionalProperties" : { + }, + "personUuids" : { + "type" : "array", + "items" : { "type" : "string", - "description" : "Map of feature flags for the client organization", "nullable" : true }, - "description" : "Map of feature flags for the client organization", "nullable" : true }, - "org" : { - "$ref" : "#/components/schemas/OrgV2Type" + "proximityMeters" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "partnerOrgPermissionGroup" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" - } - } - }, - "Org_GetCloudArchivingConfigsWSRequest" : { - "type" : "object", - "description" : "Request object for getting cloud archiving configurations." - }, - "Org_GetCloudArchivingConfigsWSResponse" : { - "type" : "object", - "description" : "Response object containing cloud archiving configurations.", - "properties" : { - "archivingConfigs" : { + "scheduleIntervals" : { "type" : "array", - "description" : "List of cloud archiving configurations", "items" : { - "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" + "$ref" : "#/components/schemas/WeeklyMinuteInterval" }, "nullable" : true }, - "error" : { - "type" : "boolean", + "scheduleTimezone" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "scheduleUuid" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Org_GetDeviceFlagsWSRequest" : { - "type" : "object", - "description" : "Request object for getting device flags.", - "properties" : { - "deviceUuid" : { + }, + "uuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "windowMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Org_GetDeviceFlagsWSResponse" : { + "IntelliGuardTailgatingRule" : { "type" : "object", - "description" : "Response object containing device flags.", + "description" : "The tailgating rule to update, including its uuid. Required.", "properties" : { - "error" : { + "alertAction" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "authorizationSource" : { "type" : "string", "nullable" : true }, - "flags" : { - "type" : "object", - "additionalProperties" : { + "bestEffort" : { + "type" : "boolean", + "nullable" : true + }, + "cameraScope" : { + "type" : "array", + "items" : { "type" : "string", - "description" : "Map of device flags", "nullable" : true }, - "description" : "Map of device flags", "nullable" : true }, - "warningMsg" : { + "cooldownMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "crossingSource" : { "type" : "string", "nullable" : true - } - } - }, - "Org_GetFeaturesWSRequest" : { - "type" : "object", - "description" : "Request object for getting organization features." - }, - "Org_GetFeaturesWSResponse" : { - "type" : "object", - "description" : "Response object containing organization feature flags.", - "properties" : { - "behaviorDetection" : { - "type" : "boolean", - "description" : "Whether behavior detection is enabled", - "example" : false, + }, + "description" : { + "type" : "string", "nullable" : true }, - "cloudArchiving" : { - "type" : "boolean", - "description" : "Whether cloud archiving is enabled", - "example" : false, + "doorScope" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "engagementCounting" : { + "enabled" : { "type" : "boolean", - "description" : "Whether engagement counting is enabled", - "example" : false, "nullable" : true }, - "error" : { - "type" : "boolean", + "insideCameraUuid" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "insideInwardActivity" : { "type" : "string", "nullable" : true }, - "faceCounting" : { + "liveNotificationAction" : { "type" : "boolean", - "description" : "Whether face counting is enabled", - "example" : false, "nullable" : true }, - "faceCountingNonUnique" : { - "type" : "boolean", - "description" : "Whether non-unique face counting is enabled", - "example" : false, + "minExtraEntries" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "faceRecognition" : { - "type" : "boolean", - "description" : "Whether face recognition is enabled", - "example" : false, + "name" : { + "type" : "string", "nullable" : true }, - "licensePlateRecognition" : { - "type" : "boolean", - "description" : "Whether license plate recognition is enabled", - "example" : false, + "orgUuid" : { + "type" : "string", "nullable" : true }, - "peopleCounting" : { - "type" : "boolean", - "description" : "Whether people counting is enabled", - "example" : false, + "outsideCameraUuid" : { + "type" : "string", "nullable" : true }, - "ppeDetection" : { - "type" : "boolean", - "description" : "Whether PPE detection is enabled", - "example" : false, + "outsideInwardActivity" : { + "type" : "string", "nullable" : true }, - "rulesEngine" : { - "type" : "boolean", - "description" : "Whether rules engine is enabled (deprecated)", - "example" : false, + "ruleType" : { + "type" : "string", "nullable" : true }, - "vehicleCounting" : { - "type" : "boolean", - "description" : "Whether vehicle counting is enabled", - "example" : false, + "scheduleIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/WeeklyMinuteInterval" + }, "nullable" : true }, - "warningMsg" : { + "scheduleTimezone" : { + "type" : "string", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "nullable" : true + }, + "transitionMaxGapMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { "type" : "string", "nullable" : true + }, + "windowMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "Org_GetLocationFlagsWSRequest" : { - "type" : "object", - "description" : "Request object for getting location flags." - }, - "Org_GetLocationFlagsWSResponse" : { + "IntercomTalkEventType" : { "type" : "object", - "description" : "Response object containing location flags for all locations.", + "allOf" : [ { + "type" : "object", + "properties" : { + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "state" : { + "$ref" : "#/components/schemas/IntercomTalkStateEnumType" + }, + "talkSessionUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "flagsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of location UUIDs to their flags", - "nullable" : true - }, - "description" : "Map of location UUIDs to their flags", - "nullable" : true - }, - "description" : "Map of location UUIDs to their flags", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Org_GetOrgIntegrationsWSRequest" : { - "type" : "object", - "description" : "Request object for getting organization integrations (deprecated, use integration package)." - }, - "Org_GetOrgIntegrationsWSResponse" : { - "type" : "object", - "description" : "Response object containing organization integrations (deprecated, use integration package).", - "properties" : { - "error" : { - "type" : "boolean", + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgIntegrations" : { - "$ref" : "#/components/schemas/OrgIntegrationsType" + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "warningMsg" : { + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Org_GetOrgNotificationTemplateV2WSResponse" : { + "IntercomTalkStateEnumType" : { + "type" : "string", + "description" : "Whether the operator started or ended talking", + "enum" : [ "STARTED", "ENDED" ] + }, + "Internal_AddPartnerAsSuperAdminWSRequest" : { "type" : "object", - "description" : "Response object containing organization notification template V2.", + "description" : "Request object for adding a partner as a super admin to an organization.", "properties" : { - "error" : { + "loginAccessAllowed" : { "type" : "boolean", + "description" : "Whether login access is allowed for the partner", + "example" : true, "nullable" : true }, - "errorMsg" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "partnerEmail" : { "type" : "string", + "description" : "Email address of the partner", + "example" : "partner@company.com", "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/UserNotificationSettingsV4Type" + "partnerName" : { + "type" : "string", + "description" : "Name of the partner", + "example" : "Partner Solutions Inc", + "nullable" : true }, - "warningMsg" : { + "partnerUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Org_GetOrgNotificationTemplateWSRequest" : { - "type" : "object", - "description" : "Request object for getting organization notification template." - }, - "Org_GetOrgNotificationTemplateWSResponse" : { + "Internal_AddPartnerAsSuperAdminWSResponse" : { "type" : "object", - "description" : "Response object containing organization notification template.", + "description" : "Response object for adding a partner as a super admin to an organization.", "properties" : { "error" : { "type" : "boolean", @@ -108588,8 +111135,12 @@ "type" : "string", "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/UserNotificationSettingsV3Type" + "superAdminGroupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "warningMsg" : { "type" : "string", @@ -108597,35 +111148,39 @@ } } }, - "Org_GetOrgV2WSRequest" : { - "type" : "object", - "description" : "Request object for getting organization details V2." - }, - "Org_GetOrgV2WSResponse" : { + "Internal_CreateCombinedLicensesFromV1WSRequest" : { "type" : "object", - "description" : "Response object containing organization details V2 with camera configuration options.", "properties" : { - "cameraConfigDefaults" : { + "accountDataMap" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/Device_config_settings_VideoConfigurationDefault" + "$ref" : "#/components/schemas/Internal_CreateCombinedLicensesFromV1WSRequest_AccountData" }, - "description" : "Map of hardware variations to default video configurations", "nullable" : true - }, - "cameraConfigOptions" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of hardware variations to available video configuration options", - "items" : { - "$ref" : "#/components/schemas/Device_config_settings_VideoConfigurationOption" - }, + } + } + }, + "Internal_CreateCombinedLicensesFromV1WSRequest_AccountData" : { + "type" : "object", + "properties" : { + "opportunityIds" : { + "type" : "array", + "items" : { + "type" : "string", "nullable" : true }, - "description" : "Map of hardware variations to available video configuration options", "nullable" : true }, + "orgUuid" : { + "type" : "string", + "nullable" : true + } + } + }, + "Internal_CreateCombinedLicensesFromV1WSResponse" : { + "type" : "object", + "nullable" : true, + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -108634,67 +111189,75 @@ "type" : "string", "nullable" : true }, - "featureFlags" : { + "failedAccounts" : { "type" : "object", "additionalProperties" : { "type" : "string", - "description" : "Map of feature flags for the organization", "nullable" : true }, - "description" : "Map of feature flags for the organization", "nullable" : true }, - "org" : { - "$ref" : "#/components/schemas/OrgV2Type" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "successfulAccounts" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Org_GetOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting organization details (deprecated)." - }, - "Org_GetOrgWSResponse" : { + "Internal_CreateOrgWSRequest" : { "type" : "object", - "description" : "Response object containing organization details (deprecated).", + "description" : "Request object for creating a new organization with account owner and company information.", "properties" : { - "error" : { - "type" : "boolean", + "accountOwnerEmail" : { + "type" : "string", + "description" : "Email address of the account owner", + "example" : "owner@company.com", "nullable" : true }, - "errorMsg" : { + "accountOwnerName" : { "type" : "string", + "description" : "Full name of the account owner", + "example" : "John Smith", "nullable" : true }, - "featureFlags" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of feature flags for the organization", - "nullable" : true - }, - "description" : "Map of feature flags for the organization", + "companyName" : { + "type" : "string", + "description" : "Name of the company or organization", + "example" : "Acme Corporation", "nullable" : true }, - "org" : { - "$ref" : "#/components/schemas/OrgType" + "developmentPartnerOrg" : { + "type" : "boolean", + "description" : "Whether this is a development partner organization", + "example" : false, + "nullable" : true }, - "warningMsg" : { + "licenseEntitlementEnabled" : { + "type" : "boolean", + "description" : "Whether license entitlement is enabled for this organization", + "example" : true, + "nullable" : true + }, + "salesforceId" : { "type" : "string", + "description" : "Salesforce ID for the organization (sensitive field)", + "nullable" : true + }, + "sendWelcomeEmail" : { + "type" : "boolean", + "description" : "Whether to send a welcome email to the account owner", + "example" : true, "nullable" : true } } }, - "Org_GetSAMLSettingsV2WSRequest" : { - "type" : "object", - "description" : "Request object for getting SAML settings V2." - }, - "Org_GetSAMLSettingsV2WSResponse" : { + "Internal_CreateOrgWSResponse" : { "type" : "object", - "description" : "Response object containing SAML settings V2.", + "description" : "Response object for creating a new organization.", "properties" : { "error" : { "type" : "boolean", @@ -108704,12 +111267,11 @@ "type" : "string", "nullable" : true }, - "samlSettings" : { - "type" : "array", - "description" : "List of SAML settings for the organization", - "items" : { - "$ref" : "#/components/schemas/OrgSamlSettingsType" - }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { @@ -108718,96 +111280,121 @@ } } }, - "Org_GetSAMLSettingsWSRequest" : { - "type" : "object", - "description" : "Request object for getting SAML settings (deprecated)." - }, - "Org_GetSAMLSettingsWSResponse" : { + "Internal_CreatePartnerOrgWSRequest" : { "type" : "object", - "description" : "Response object containing SAML settings (deprecated).", + "description" : "Request object for creating a new partner organization.", "properties" : { - "error" : { - "type" : "boolean", + "accountOwnerEmail" : { + "type" : "string", + "description" : "Email address of the partner account owner", + "example" : "partner@company.com", "nullable" : true }, - "errorMsg" : { + "accountOwnerName" : { "type" : "string", + "description" : "Full name of the partner account owner", + "example" : "Sarah Wilson", "nullable" : true }, - "samlSettings" : { - "$ref" : "#/components/schemas/OrgSamlSettingsType" + "companyName" : { + "type" : "string", + "description" : "Name of the partner company", + "example" : "Partner Solutions Inc", + "nullable" : true }, - "warningMsg" : { + "salesforceId" : { "type" : "string", + "description" : "Salesforce ID for the partner organization (sensitive field)", + "nullable" : true + }, + "sendWelcomeEmail" : { + "type" : "boolean", + "description" : "Whether to send a welcome email to the partner account owner", + "example" : true, "nullable" : true } } }, - "Org_GetScimDisplayInfoResponse" : { + "Internal_CreatePartnerOrgWSResponse" : { "type" : "object", - "description" : "Response object containing SCIM display information.", + "description" : "Response object for creating a new partner organization.", "properties" : { - "azureScimEndpointUrl" : { - "type" : "string", - "description" : "Azure SCIM endpoint URL", - "example" : "https://api.rhombussystems.com/scim/v2/azure", + "error" : { + "type" : "boolean", "nullable" : true }, - "scimEndpointUrl" : { + "errorMsg" : { "type" : "string", - "description" : "SCIM endpoint URL", - "example" : "https://api.rhombussystems.com/scim/v2", "nullable" : true - } - } - }, - "Org_GetTemporaryOrgTokenWSRequest" : { - "type" : "object", - "description" : "Request object for getting temporary organization token." - }, - "Org_HardwareWithPendingRegistrationInfoType" : { - "type" : "object", - "properties" : { - "hardware" : { - "$ref" : "#/components/schemas/HardwareType" }, - "hwUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pendingRegistrationInfo" : { - "$ref" : "#/components/schemas/Org_PendingRegistrationInfoType" + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Org_PeekShipmentRegistrationTokenWSRequest" : { + "Internal_CreateReturnedInventoryAuditReservationWSRequest" : { "type" : "object", + "description" : "Request object for creating a returned inventory audit reservation.", "properties" : { - "tokenUuid" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "miscNotes" : { + "type" : "string", + "description" : "Miscellaneous notes for the inventory audit (deprecated)", + "example" : "Damaged packaging, missing accessories", + "nullable" : true + }, + "partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "returnType" : { + "$ref" : "#/components/schemas/ReturnTypeEnum" + }, + "salesforceOppId" : { + "type" : "string", + "description" : "Salesforce opportunity ID for the inventory audit", + "example" : "0061234567890ABC", + "nullable" : true + }, + "trackingNumber" : { + "type" : "string", + "description" : "Tracking number for the returned inventory (deprecated)", + "example" : "1Z999AA1234567890", + "nullable" : true } } }, - "Org_PeekShipmentRegistrationTokenWSResponse" : { + "Internal_CreateReturnedInventoryAuditReservationWSResponse" : { "type" : "object", + "description" : "Response object for creating a returned inventory audit reservation.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "auditReservationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "hardwareUuidList" : { + "auditReservationUuids" : { "type" : "array", + "description" : "List of UUIDs for the created audit reservations", "items" : { "type" : "string", "format" : "RUUID", @@ -108817,76 +111404,99 @@ }, "nullable" : true }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_PendingRegistrationInfoType" : { + "Internal_CreateSupportAuthorityWSRequest" : { "type" : "object", + "description" : "Request object for creating a support authority.", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "supportAuthority" : { + "$ref" : "#/components/schemas/SupportAuthorityType" + } + } + }, + "Internal_CreateSupportAuthorityWSResponse" : { + "type" : "object", + "description" : "Response object for creating a support authority.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "policyUuid" : { + "supportAuthorityUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Org_RemovePendingRegistrationRequest" : { - "type" : "object", - "properties" : { - "serialNumber" : { + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_RemovePendingRegistrationResponse" : { - "type" : "object" - }, - "Org_RevokeSCIMAccessForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for revoking SCIM access for organization." - }, - "Org_RevokeSCIMAccessForOrgWSResponse" : { - "type" : "object", - "description" : "Response object for revoking SCIM access for organization." - }, - "Org_SetFlagWSRequest" : { + "Internal_DeveloperNewsletterEnrollWSRequest" : { "type" : "object", - "description" : "Request object for setting organization flags.", + "description" : "Request object for enrolling in the developer newsletter.", "properties" : { - "flagName" : { + "developerNewsletter" : { + "type" : "boolean", + "description" : "Whether to subscribe to the developer newsletter", + "example" : true, + "nullable" : true + }, + "email" : { "type" : "string", - "description" : "Name of the flag to set", - "example" : "feature_enabled", + "description" : "Email address for newsletter subscription", + "example" : "developer@company.com", "nullable" : true }, - "flagValue" : { + "firstName" : { "type" : "string", - "description" : "Value of the flag to set", - "example" : "true", + "description" : "First name of the subscriber", + "example" : "Alex", + "nullable" : true + }, + "isDeveloper" : { + "type" : "boolean", + "description" : "Whether the subscriber is a developer", + "example" : true, + "nullable" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name of the subscriber", + "example" : "Johnson", + "nullable" : true + }, + "orgName" : { + "type" : "string", + "description" : "Name of the organization", + "example" : "TechCorp Solutions", "nullable" : true } } }, - "Org_SetFlagWSResponse" : { + "Internal_DeveloperNewsletterEnrollWSResponse" : { "type" : "object", - "description" : "Response object for setting organization flags.", + "description" : "Response object for developer newsletter enrollment.", "properties" : { "error" : { "type" : "boolean", @@ -108902,63 +111512,80 @@ } } }, - "Org_SetupSCIMAccessForOrgWSRequest" : { + "Internal_DeviceStateType" : { "type" : "object", - "description" : "Request object for setting up SCIM access for organization.", "properties" : { - "addUsersOnRoleMismatch" : { + "connected" : { "type" : "boolean", - "description" : "Whether to add users on role mismatch", - "example" : false, "nullable" : true }, - "rhombusKeyAppSettings" : { - "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "sendWelcomeEmailToNewRhombusKeyUsers" : { - "type" : "boolean", - "description" : "Whether to send welcome email to new Rhombus Key users", - "example" : true, + "name" : { + "type" : "string", "nullable" : true }, - "sendWelcomeEmailToNewUsers" : { - "type" : "boolean", - "description" : "Whether to send welcome email to new users", - "example" : true, + "serialNumber" : { + "type" : "string", "nullable" : true } } }, - "Org_SetupSCIMAccessForOrgWSResponse" : { + "Internal_GetActiveRMAsWSRequest" : { + "type" : "object" + }, + "Internal_GetActiveRMAsWSResponse" : { "type" : "object", - "description" : "Response object for setting up SCIM access for organization.", "properties" : { - "scimAccessAlreadySetupFailure" : { + "activeRmasList" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "error" : { "type" : "boolean", "nullable" : true }, - "token" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_UpdateAiTrainingSettingsWSRequest" : { + "Internal_GetDeviceStatesForOrgWSRequest" : { "type" : "object", - "description" : "Request object for updating AI training settings.", "properties" : { - "shareAiTrainingMediaWithRhombus" : { - "type" : "boolean", - "description" : "Whether to share AI training media with Rhombus", - "example" : false, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Org_UpdateAiTrainingSettingsWSResponse" : { + "Internal_GetDeviceStatesForOrgWSResponse" : { "type" : "object", - "description" : "Response object for updating AI training settings.", "properties" : { + "deviceStates" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Internal_DeviceStateType" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -108973,18 +111600,22 @@ } } }, - "Org_UpdateCloudArchivingConfigWSRequest" : { + "Internal_GetSuperAdminGroupUUIDWSRequest" : { "type" : "object", - "description" : "Request object for updating cloud archiving configuration.", + "description" : "Request object for getting the super admin group UUID for an organization.", "properties" : { - "archivingConfig" : { - "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Org_UpdateCloudArchivingConfigWSResponse" : { + "Internal_GetSuperAdminGroupUUIDWSResponse" : { "type" : "object", - "description" : "Response object for updating cloud archiving configuration.", + "description" : "Response object for getting the super admin group UUID for an organization.", "properties" : { "error" : { "type" : "boolean", @@ -108994,35 +111625,38 @@ "type" : "string", "nullable" : true }, + "superAdminGroupUUID" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_UpdateFirmwareSettingsWSRequest" : { + "Internal_GetUserLoginActivityForOrgsWSRequest" : { "type" : "object", - "description" : "Request object for updating firmware settings.", + "description" : "Orgs to look up user login activity for. The window is always the last month.", "properties" : { - "firmwareSettings" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" - }, - "firmwareUpdateSettings" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" - }, - "firmwareUpdateSettingsOverrides" : { + "orgUuids" : { "type" : "array", - "description" : "Overrides default firmware update settings.", + "description" : "Org uuids to look up, 200 or fewer per request", "items" : { - "$ref" : "#/components/schemas/FirmwareUpdateSettingsOverrideType" + "type" : "string", + "description" : "Org uuids to look up, 200 or fewer per request", + "nullable" : true }, "nullable" : true } } }, - "Org_UpdateFirmwareSettingsWSResponse" : { + "Internal_GetUserLoginActivityForOrgsWSResponse" : { "type" : "object", - "description" : "Response object for updating firmware settings.", + "description" : "Most recent user login per org within the last month", "properties" : { "error" : { "type" : "boolean", @@ -109032,68 +111666,50 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Org_UpdateGeneralSettingsWSRequest" : { - "type" : "object", - "description" : "Request object for updating general organization settings.", - "properties" : { - "accountBillingContactEmail" : { - "type" : "string", - "description" : "Email of the account billing contact", - "example" : "billing@acme.com", - "nullable" : true - }, - "accountOwnerEmail" : { - "type" : "string", - "description" : "Email of the account owner", - "example" : "owner@acme.com", + "failedOrgUuids" : { + "type" : "array", + "description" : "Org uuids we could not answer for - the lookup failed, or the uuid was not usable. This is NOT the same as 'no login': the answer is unknown, so leave any stored value untouched and retry on the next run. Recording them as inactive would be a wrong answer indistinguishable from a real one. Echoed back exactly as sent, so an unparseable value is identifiable; a JSON null in the request appears here as the literal \"(null)\".", + "items" : { + "type" : "string", + "description" : "Org uuids we could not answer for - the lookup failed, or the uuid was not usable. This is NOT the same as 'no login': the answer is unknown, so leave any stored value untouched and retry on the next run. Recording them as inactive would be a wrong answer indistinguishable from a real one. Echoed back exactly as sent, so an unparseable value is identifiable; a JSON null in the request appears here as the literal \"(null)\".", + "nullable" : true + }, "nullable" : true }, - "accountTechnicalContactEmail" : { - "type" : "string", - "description" : "Email of the account technical contact", - "example" : "tech@acme.com", + "lastLoginMsByOrgUuid" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch millis of the most recent user login, for orgs that had one within the last month. Orgs with no login are NOT keys here - they are listed in noLoginOrgUuids. The map never contains null values: null map entries do not survive this service's response pipeline.", + "nullable" : true + }, + "description" : "Epoch millis of the most recent user login, for orgs that had one within the last month. Orgs with no login are NOT keys here - they are listed in noLoginOrgUuids. The map never contains null values: null map entries do not survive this service's response pipeline.", "nullable" : true }, - "accountTechnicalContacts" : { + "noLoginOrgUuids" : { "type" : "array", - "description" : "List of account technical contact emails", + "description" : "Org uuids that were queried successfully and had no user login within the last month. This is the authoritative 'not active in the last month' answer.", "items" : { "type" : "string", - "description" : "List of account technical contact emails", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "defaultPlayerViewLiveType" : { - "$ref" : "#/components/schemas/PlayerViewLiveTypeEnum" - }, - "inactivityTimeout" : { - "type" : "integer", - "format" : "int32", - "description" : "Inactivity timeout in minutes", - "example" : 30, - "nullable" : true - }, - "name" : { + "warningMsg" : { "type" : "string", - "description" : "Name of the organization", - "example" : "Acme Corporation", "nullable" : true - }, - "uapSettings" : { - "$ref" : "#/components/schemas/UAPSettingsType" } } }, - "Org_UpdateGeneralSettingsWSResponse" : { + "Internal_GetWarrantyApprovedRMAsWSRequest" : { + "type" : "object" + }, + "Internal_GetWarrantyApprovedRMAsWSResponse" : { "type" : "object", - "description" : "Response object for updating general organization settings.", "properties" : { "error" : { "type" : "boolean", @@ -109106,64 +111722,81 @@ "warningMsg" : { "type" : "string", "nullable" : true + }, + "zendeskTickets" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "Org_UpdateMFASettingsWSRequest" : { + "Internal_InitiateShipmentWSRequest" : { "type" : "object", - "description" : "Request object for updating MFA settings.", + "description" : "Request object for initiating a shipment process.", "properties" : { - "mfaEnabled" : { - "type" : "boolean", - "description" : "Whether MFA is enabled for the organization", - "example" : true, - "nullable" : true + "rhombusShipmentInfo" : { + "$ref" : "#/components/schemas/RhombusShipmentInfoType" }, - "v3AuthNumDaysSkip2FAForTrustedDevices" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of days to skip 2FA for trusted devices (< 0 = forever, 0 = always require 2FA, > 0 = days to skip)", - "example" : 30, + "salesforceOppId" : { + "type" : "string", + "description" : "Salesforce opportunity ID for the shipment", + "example" : "0061234567890ABC", "nullable" : true + }, + "shipmentCategory" : { + "$ref" : "#/components/schemas/CustomerShipmentCategoryEnum" + }, + "shipmentInfo" : { + "$ref" : "#/components/schemas/OutgoingShipmentInfoType" } } }, - "Org_UpdateMFASettingsWSResponse" : { + "Internal_ListOrgsWSRequest" : { "type" : "object", - "description" : "Response object for updating MFA settings.", + "description" : "Request object for listing organizations." + }, + "Internal_ListOrgsWSResponse" : { + "type" : "object", + "description" : "Response object containing a list of organizations.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "org" : { - "$ref" : "#/components/schemas/OrgV2Type" - }, - "warningMsg" : { - "type" : "string", + "orgs" : { + "type" : "array", + "description" : "List of organizations", + "items" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, "nullable" : true } } }, - "Org_UpdateOrgAudioAnalysisPolicyWSRequest" : { + "Internal_ParentLifetimeSpendWSRequest" : { "type" : "object", - "description" : "Request object for updating organization audio analysis policy.", + "description" : "Request object for retrieving parent lifetime spend information.", "properties" : { - "audioAnalysisEnabled" : { - "type" : "boolean", - "description" : "Whether audio analysis is enabled for the organization", - "example" : true, + "endAccountIdx" : { + "type" : "integer", + "format" : "int32", + "description" : "Ending account index for the range", + "example" : 100, + "nullable" : true + }, + "startAccountIdx" : { + "type" : "integer", + "format" : "int32", + "description" : "Starting account index for the range", + "example" : 0, "nullable" : true } } }, - "Org_UpdateOrgAudioAnalysisPolicyWSResponse" : { + "Internal_ParentLifetimeSpendWSResponse" : { "type" : "object", - "description" : "Response object for updating organization audio analysis policy.", + "description" : "Response object for parent lifetime spend information.", "properties" : { "error" : { "type" : "boolean", @@ -109179,21 +111812,24 @@ } } }, - "Org_UpdateOrgAudioRecordingPolicyWSRequest" : { + "Internal_RemediateMissingFirstAssignedDatesWSRequest" : { "type" : "object", - "description" : "Request object for updating organization audio recording policy.", "properties" : { - "audioRecordingEnabled" : { - "type" : "boolean", - "description" : "Whether audio recording is enabled for the organization", - "example" : true, + "orgUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true } } }, - "Org_UpdateOrgAudioRecordingPolicyWSResponse" : { + "Internal_RemediateMissingFirstAssignedDatesWSResponse" : { "type" : "object", - "description" : "Response object for updating organization audio recording policy.", "properties" : { "error" : { "type" : "boolean", @@ -109203,24 +111839,108 @@ "type" : "string", "nullable" : true }, + "updateOrgUuidsToUpdatedLicenseUuids" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_UpdateOrgIntegrationsWSRequest" : { + "Internal_RequestHardwareForDevelopmentWSRequest" : { "type" : "object", - "description" : "Request object for updating organization integrations (deprecated, use integration package).", + "description" : "Request object for requesting hardware for development purposes.", "properties" : { - "orgIntegrations" : { - "$ref" : "#/components/schemas/OrgIntegrationsType" + "address1" : { + "type" : "string", + "description" : "Street address line 1", + "example" : "123 Main Street", + "nullable" : true + }, + "city" : { + "type" : "string", + "description" : "City name", + "example" : "San Francisco", + "nullable" : true + }, + "companyName" : { + "type" : "string", + "description" : "Name of the company or organization", + "example" : "Tech Startup Inc", + "nullable" : true + }, + "country" : { + "type" : "string", + "description" : "Country name", + "example" : "United States", + "nullable" : true + }, + "email" : { + "type" : "string", + "description" : "Email address of the requester", + "example" : "developer@company.com", + "nullable" : true + }, + "firstName" : { + "type" : "string", + "description" : "First name of the requester", + "example" : "Jane", + "nullable" : true + }, + "jobTitle" : { + "type" : "string", + "description" : "Job title of the requester", + "example" : "Senior Developer", + "nullable" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name of the requester", + "example" : "Doe", + "nullable" : true + }, + "phoneNumber" : { + "type" : "string", + "description" : "Phone number of the requester", + "example" : "+1-555-123-4567", + "nullable" : true + }, + "requestReason" : { + "type" : "string", + "description" : "Reason for requesting hardware for development", + "example" : "Testing new camera integration features", + "nullable" : true + }, + "state" : { + "type" : "string", + "description" : "State or province", + "example" : "CA", + "nullable" : true + }, + "zip" : { + "type" : "string", + "description" : "ZIP or postal code", + "example" : "94105", + "nullable" : true } } }, - "Org_UpdateOrgIntegrationsWSResponse" : { + "Internal_RequestHardwareForDevelopmentWSResponse" : { "type" : "object", - "description" : "Response object for updating organization integrations (deprecated, use integration package).", + "description" : "Response object for hardware development request.", "properties" : { "error" : { "type" : "boolean", @@ -109236,91 +111956,87 @@ } } }, - "Org_UpdateOrgLLMUsagePolicyWSRequest" : { + "Internal_SalesforceAccount" : { "type" : "object", - "description" : "Request object for updating organization LLM usage opt-in policy.", "properties" : { - "llmUsageEnabled" : { - "type" : "boolean", - "description" : "Whether the org is opting in to use LLMs", - "example" : true, + "Admin_ID__c" : { + "type" : "string", "nullable" : true } } }, - "Org_UpdateOrgLLMUsagePolicyWSResponse" : { + "Internal_SalesforceOpportunity" : { "type" : "object", - "description" : "Response object for updating organization LLM usage opt-in policy.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "Account" : { + "$ref" : "#/components/schemas/Internal_SalesforceAccount" + } + } + }, + "Internal_SalesforceOpportunityLineItem" : { + "type" : "object", + "properties" : { + "Opportunity" : { + "$ref" : "#/components/schemas/Internal_SalesforceOpportunity" }, - "errorMsg" : { + "OpportunityId" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "ProductCode" : { "type" : "string", "nullable" : true + }, + "Quantity" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "Org_UpdateOrgNotificationTemplateV2WSRequest" : { + "Internal_SendShipmentShippedEmailWSRequest" : { "type" : "object", - "description" : "Request object for updating organization notification template V2.", + "description" : "Request object for sending shipment shipped email notification.", "properties" : { - "summaryEmailEnabled" : { - "type" : "boolean", - "description" : "Whether summary email is enabled", - "example" : true, + "salesforceOppId" : { + "type" : "string", + "description" : "Salesforce opportunity ID for the shipment email", + "example" : "0061234567890ABC", "nullable" : true - }, - "templateUpdate" : { - "$ref" : "#/components/schemas/UserNotificationSelectiveUpdateV2" } } }, - "Org_UpdateOrgNotificationTemplateV2WSResponse" : { + "Internal_SendTrialEvaluationEmailWSRequest" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", + "contractEndDate" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "opportunityOwnerEmail" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "opportunityOwnerName" : { "type" : "string", "nullable" : true - } - } - }, - "Org_UpdateOrgNotificationTemplateWSRequest" : { - "type" : "object", - "description" : "Request object for updating organization notification template.", - "properties" : { - "notificationIntervalsV2" : { - "type" : "array", - "description" : "List of notification intervals V2", - "items" : { - "$ref" : "#/components/schemas/NotificationIntervalV2Type" - }, + }, + "orderNumber" : { + "type" : "string", "nullable" : true }, - "summaryEmailEnabled" : { - "type" : "boolean", - "description" : "Whether summary email is enabled", - "example" : true, + "primaryContactEmail" : { + "type" : "string", + "nullable" : true + }, + "salesEngineerEmail" : { + "type" : "string", "nullable" : true } } }, - "Org_UpdateOrgNotificationTemplateWSResponse" : { + "Internal_SendTrialEvaluationEmailWSResponse" : { "type" : "object", - "description" : "Response object for updating organization notification template.", "properties" : { "error" : { "type" : "boolean", @@ -109336,65 +112052,45 @@ } } }, - "Org_UpdateOrgWSRequest" : { - "type" : "object", - "description" : "Request object for updating organization details (deprecated).", - "properties" : { - "org" : { - "$ref" : "#/components/schemas/OrgType" - } - } - }, - "Org_UpdateOrgWSResponse" : { + "Internal_SetOpportunityForPurchaseOrderWSRequest" : { "type" : "object", - "description" : "Response object for updating organization details (deprecated).", + "description" : "Request object for setting opportunity information for a purchase order.", "properties" : { - "samlEntityIdUniquenessConstraintFailure" : { - "type" : "boolean", + "cancellationReason" : { + "type" : "string", + "description" : "Reason for cancellation if the purchase order is not accepted", + "example" : "Budget constraints", "nullable" : true }, - "teamNameNotAssignedFailure" : { + "isAccepted" : { "type" : "boolean", + "description" : "Whether the purchase order is accepted", + "example" : true, "nullable" : true }, - "teamNameUniquenessConstraintFailure" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "Org_UpdatePendingRegistrationRequest" : { - "type" : "object", - "properties" : { - "hardwareUuid" : { + "purchaseOrderNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Purchase order number", + "example" : "PO-2024-001", "nullable" : true }, - "locationUuid" : { + "purchaseOrderUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { - "type" : "string", - "nullable" : true - }, - "policyUuid" : { + "salesforceOppId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Salesforce opportunity ID (sensitive field)", "nullable" : true } } }, - "Org_UpdatePendingRegistrationResponse" : { + "Internal_SetOpportunityForPurchaseOrderWSResponse" : { "type" : "object", + "description" : "Response object for setting opportunity information for a purchase order.", "properties" : { "error" : { "type" : "boolean", @@ -109410,24 +112106,13 @@ } } }, - "Org_UpdateSAMLSettingsV2WSRequest" : { - "type" : "object", - "description" : "Request object for updating SAML settings V2.", - "properties" : { - "samlSettings" : { - "type" : "array", - "description" : "List of SAML settings to update", - "items" : { - "$ref" : "#/components/schemas/OrgSamlSettingsType" - }, - "nullable" : true - } - } - }, - "Org_UpdateSAMLSettingsV2WSResponse" : { + "Internal_ShipmentEmailWSResponse" : { "type" : "object", - "description" : "Response object for updating SAML settings V2.", + "description" : "Response object for shipment email operations.", "properties" : { + "customerShipmentEmailState" : { + "$ref" : "#/components/schemas/CustomerShipmentEmailStateEnum" + }, "error" : { "type" : "boolean", "nullable" : true @@ -109436,24 +112121,26 @@ "type" : "string", "nullable" : true }, + "legacyMsg" : { + "type" : "string", + "description" : "Legacy message for the shipment email", + "example" : "Shipment has been processed", + "nullable" : true + }, + "trackingIdentifier" : { + "type" : "string", + "description" : "Tracking identifier for the shipment", + "example" : "1Z999AA1234567890", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_UpdateSAMLSettingsWSRequest" : { - "type" : "object", - "description" : "Request object for updating SAML settings (deprecated).", - "properties" : { - "samlSettings" : { - "$ref" : "#/components/schemas/OrgSamlSettingsType" - } - } - }, - "Org_UpdateSAMLSettingsWSResponse" : { + "Internal_VerifyCanMigrateOrgFromV1JsonWSResponse" : { "type" : "object", - "description" : "Response object for updating SAML settings (deprecated).", "properties" : { "error" : { "type" : "boolean", @@ -109463,137 +112150,145 @@ "type" : "string", "nullable" : true }, + "results" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Internal_VerifyCanMigrateOrgFromV1JsonWSResponseEntry" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Org_UpdateSCIMSettingsForOrgWSRequest" : { + "Internal_VerifyCanMigrateOrgFromV1JsonWSResponseEntry" : { "type" : "object", - "description" : "Request object for updating SCIM settings for organization.", "properties" : { - "addUsersOnRoleMismatch" : { + "canMigrate" : { "type" : "boolean", - "description" : "Whether to add users on role mismatch", - "example" : false, "nullable" : true }, - "rhombusKeyAppSettings" : { - "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + "errorMessages" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true }, - "sendWelcomeEmailToNewRhombusKeyUsers" : { - "type" : "boolean", - "description" : "Whether to send welcome email to new Rhombus Key users", - "example" : true, + "licenseComparisons" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseComparisonEntry" + }, "nullable" : true }, - "sendWelcomeEmailToNewUsers" : { - "type" : "boolean", - "description" : "Whether to send welcome email to new users", - "example" : true, + "orgUuid" : { + "type" : "string", "nullable" : true } } }, - "Org_UpdateSCIMSettingsForOrgWSResponse" : { + "Internal_VerifyCanMigrateOrgFromV1WSRequest" : { "type" : "object", - "description" : "Response object for updating SCIM settings for organization.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "entries" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Internal_VerifyCanMigrateOrgFromV1WSRequestEntry" + }, "nullable" : true } } }, - "OsdpDoorReaderType" : { + "Internal_VerifyCanMigrateOrgFromV1WSRequestEntry" : { "type" : "object", "properties" : { - "allowUnencrypted" : { - "type" : "boolean", - "nullable" : true - }, - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "opportunityIds" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "disableCardReader" : { - "type" : "boolean", + "orgUuid" : { + "type" : "string", "nullable" : true }, - "disableKeypad" : { - "type" : "boolean", + "productCodeToLicensesPurchasedMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "nullable" : true - }, - "disableWaveToUnlock" : { + } + } + }, + "Internal_VerifyCanMigrateOrgFromV1WSResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "osdpAddress" : { - "type" : "integer", - "format" : "int32", + "invalidOrgsToErrorMessages" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "orgLicenseComparisons" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseComparisonEntry" + }, + "nullable" : true + }, "nullable" : true }, - "ownerDeviceUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "port" : { - "$ref" : "#/components/schemas/OsdpReaderPortType" - }, - "portImmutable" : { - "type" : "boolean", + } + } + }, + "IntuifaceSettings" : { + "type" : "object", + "properties" : { + "deviceToTriggerMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/TriggerContent" + }, "nullable" : true }, - "readerType" : { - "$ref" : "#/components/schemas/DoorReaderEnumType" - }, - "remoteUnlockAudioFeedbackEnabled" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" - }, - "updatedAtMillis" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "uuid" : { + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -109602,11 +112297,7 @@ } } }, - "OsdpPhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "RS485" ] - }, - "OsdpReaderPortType" : { + "InvalidPhysicalPortConfigType" : { "type" : "object", "properties" : { "boardNum" : { @@ -109614,60 +112305,48 @@ "format" : "int32", "nullable" : true }, + "componentUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, "portNum" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "portType" : { - "$ref" : "#/components/schemas/OsdpPhysicalPortEnumType" + "reason" : { + "$ref" : "#/components/schemas/InvalidPhysicalPortReasonEnumType" } } }, - "OutgoingShipmentInfoType" : { + "InvalidPhysicalPortReasonEnumType" : { + "type" : "string", + "enum" : [ "NON_EXISTANT_COMPONENT_BOARD_NUM", "NON_EXISTANT_COMPONENT_PORT_NUM", "CONFLICTING_COMPONENT_PORT_TYPES", "COMPONENT_PORT_TYPE_NOT_SUPPORTED_BY_PORT", "MAX_COMPONENTS_PER_PORT_TYPE_EXCEEDED" ] + }, + "InvoiceStatusEnum" : { + "type" : "string", + "enum" : [ "PAID", "UNPAID_PENDING", "UNPAID_OVERDUE", "CANCELLED" ] + }, + "InvoiceType" : { "type" : "object", - "description" : "Outgoing shipment information (deprecated)", + "description" : "Invoice details and information", "properties" : { - "buyer" : { - "$ref" : "#/components/schemas/Buyer" - }, - "consignee" : { - "$ref" : "#/components/schemas/Consignee" - }, - "depositorOrderNumber" : { - "type" : "string", - "nullable" : true - }, - "freight" : { - "$ref" : "#/components/schemas/Freight" - }, - "interchangeControlNumber" : { - "type" : "string", - "nullable" : true - }, - "product" : { + "addOnLicenseInvoices" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Product" + "$ref" : "#/components/schemas/AddOnLicenseInvoiceType" }, "nullable" : true }, - "purchaseOrderNumber" : { - "type" : "string", - "nullable" : true - }, - "shipment" : { - "$ref" : "#/components/schemas/Shipment" - }, - "shipper" : { - "$ref" : "#/components/schemas/Shipper" - } - } - }, - "PagerDutySettings" : { - "type" : "object", - "properties" : { - "allLocationIntegrationKeys" : { + "additionalEmails" : { "type" : "array", "items" : { "type" : "string", @@ -109675,135 +112354,181 @@ }, "nullable" : true }, - "enabled" : { + "attachCsv" : { "type" : "boolean", "nullable" : true }, - "enabledTimestampMs" : { + "cameraPurchaseCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "enablingUser" : { - "type" : "string", + "cameraPurchasePrice" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "enablingUserUuid" : { + "clientOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "integrationKey" : { + "companyName" : { "type" : "string", "nullable" : true }, - "locationToIntegrationKeysMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, + "customerAddress" : { + "type" : "string", "nullable" : true - } - } - }, - "PaginateRequest" : { - "type" : "object", - "description" : "Request object for retrieving a resource with optional pagination.", - "properties" : { - "lastEvaluatedKey" : { + }, + "customerEmail" : { "type" : "string", "nullable" : true }, - "maxPageSize" : { + "customerName" : { + "type" : "string", + "nullable" : true + }, + "date" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true - } - } - }, - "PanelType" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", + }, + "domePurchaseCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "name" : { - "type" : "string", + "domePurchasePrice" : { + "type" : "number", + "format" : "float", "nullable" : true - } - } - }, - "PanicButtonEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + }, + "domeSubItems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareInvoiceSubItem" }, - "newSupervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } - } - } ], - "nullable" : true, - "properties" : { - "componentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "dueDate" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "externalId" : { "type" : "string", "nullable" : true }, - "createdAtMs" : { + "installationPrice" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "license" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "licenseCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "licensePrice" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "orgUuid" : { + "licenseSubItems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseInvoiceSubItem" + }, + "nullable" : true + }, + "notes" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "partnerOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { + "r1Camera1024" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + }, + "nullable" : true + }, + "r1Camera512" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + }, + "nullable" : true + }, + "r1CameraPurchaseCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "r1CameraPurchasePrice" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "r1CameraSubItems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + }, + "nullable" : true + }, + "r1LargeCameraPurchaseCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "r1LargeCameraPurchasePrice" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "r1LargeSubItems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + }, + "nullable" : true + }, + "r1MediumSubItems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareInvoiceSubItem" + }, + "nullable" : true + }, + "salespersonName" : { + "type" : "string", + "nullable" : true + }, + "shippingPrice" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/InvoiceStatusEnum" + }, + "tax" : { + "type" : "number", + "format" : "float", + "nullable" : true }, "uuid" : { "type" : "string", @@ -109814,358 +112539,371 @@ } } }, - "ParPOSType" : { + "Invoice_InvoiceChargeV2WSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "accessToken" : { - "type" : "string", - "nullable" : true - }, - "locationTokenMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "serverUrl" : { - "type" : "string", - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "Request object for charging an invoice.", "properties" : { - "enabled" : { - "type" : "boolean", + "invoiceUuid" : { + "type" : "string", + "description" : "UUID of the invoice to charge", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "sourceToken" : { + "type" : "string", + "description" : "Payment source token for charging the invoice", + "example" : "tok_1234567890abcdef", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "Invoice_InvoiceChargeWSRequest" : { + "type" : "object", + "description" : "Request object for charging an invoice.", + "properties" : { + "invoiceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "sourceToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Payment source token for charging the invoice", + "example" : "tok_1234567890abcdef", "nullable" : true } } }, - "ParameterizedHeader" : { + "Invoice_InvoiceChargeWSResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response object for invoice charging operations.", "properties" : { - "parameters" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "chargeSucceeded" : { + "type" : "boolean", + "description" : "Whether the invoice charge was successful", + "example" : true, "nullable" : true }, - "value" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message if the charge failed", + "example" : "Insufficient funds", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "previouslyInitialized" : { + "type" : "boolean", + "description" : "Whether the invoice was previously initialized for charging", + "example" : false, + "nullable" : true + }, + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "PartnerFunctionalityEnum" : { - "type" : "string", - "enum" : [ "CREATE_CLIENT", "DELETE_CLIENT", "DEAL_ADMINISTRATION", "REMOTE_REGISTER_DEVICE", "ORG_ADMINISTRATION", "AUTH_ADMINISTRATION", "DOOR_ACCESS_ADMINISTRATION", "USER_ADMINISTRATION", "REPORT_ADMINISTRATION", "NOTIFICATION_ADMINISTRATION", "LICENSE_ADMINISTRATION", "RECEIVE_EMAILS", "API_ADMINISTRATION", "INTEGRATION_ADMINISTRATION", "DATA_EXFILTRATION", "CLIP_MANAGEMENT", "UNKNOWN" ] - }, - "PartnerNotificationClientSection" : { + "Invoice_InvoiceDetailsV1WSResponse" : { "type" : "object", + "description" : "Response object containing invoice details version 1.", "properties" : { - "clientUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true + "error" : { + "type" : "boolean", + "nullable" : true }, - "rows" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PartnerNotificationClientSectionRow" - }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "invoice" : { + "$ref" : "#/components/schemas/Invoice_InvoiceV1Type" + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "PartnerNotificationClientSectionRow" : { + "Invoice_InvoiceDetailsV2WSRequest" : { "type" : "object", "properties" : { - "activities" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "days" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RhombusDayOfWeekEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "diagnostics" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DiagnosticActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "interval" : { - "$ref" : "#/components/schemas/MinuteOfDayIntervalType" - }, - "mediums" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationEnumType" - }, - "nullable" : true, - "uniqueItems" : true + "netsuiteInvoiceUuid" : { + "type" : "string", + "nullable" : true } } }, - "PartnerNotificationSettingsType" : { + "Invoice_InvoiceDetailsV2WSResponse" : { "type" : "object", "properties" : { - "allClientsSelected" : { + "error" : { "type" : "boolean", "nullable" : true }, - "clientNotificationIntervalsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationIntervalV2Type" - }, - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "notificationIntervalsForAllClients" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationIntervalV2Type" - }, - "nullable" : true + "invoice" : { + "$ref" : "#/components/schemas/NetsuiteInvoiceDetails" }, - "orgUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Invoice_InvoiceDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving invoice details.", + "properties" : { + "invoiceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "smsPhoneNumbers" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + } + } + }, + "Invoice_InvoiceDetailsWSResponse" : { + "type" : "object", + "description" : "Response object containing invoice details.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "summaryEmailEnabled" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "userUuid" : { + "invoice" : { + "$ref" : "#/components/schemas/InvoiceType" + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "PartnerNotificationSettingsV2" : { + "Invoice_InvoiceV1LineItemType" : { "type" : "object", + "description" : "Line item information for invoice version 1.", "properties" : { - "allClientsSelected" : { - "type" : "boolean", + "description" : { + "type" : "string", + "description" : "Description of the product", + "example" : "4K Ultra HD Security Camera with Night Vision", "nullable" : true }, - "clientNotificationIntervalsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PartnerNotificationClientSection" - }, - "nullable" : true - }, + "family" : { + "type" : "string", + "description" : "Product family category", + "example" : "Cameras", "nullable" : true }, - "notificationIntervalsForAllClients" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PartnerNotificationClientSection" - }, + "name" : { + "type" : "string", + "description" : "Name of the product", + "example" : "Security Camera", "nullable" : true }, - "orgUuid" : { + "productCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Product code for the line item", + "example" : "CAM-001", "nullable" : true }, - "smsPhoneNumbers" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "quantity" : { + "type" : "number", + "format" : "float", + "description" : "Quantity of the product", + "example" : 2.0, "nullable" : true }, - "summaryEmailEnabled" : { - "type" : "boolean", + "subtotal" : { + "type" : "number", + "format" : "float", + "description" : "Subtotal for this line item (quantity × unit price)", + "example" : 199.98, "nullable" : true }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "unitPrice" : { + "type" : "number", + "format" : "float", + "description" : "Unit price of the product", + "example" : 99.99, "nullable" : true } } }, - "PartnerPermissionEnum" : { - "type" : "string", - "enum" : [ "DEFAULT", "CUSTOM" ] - }, - "PartnerPermissionType" : { + "Invoice_InvoiceV1Type" : { "type" : "object", - "description" : "List of partner permissions", + "description" : "Invoice version 1 type containing comprehensive billing and line item information.", "properties" : { - "groupUuid" : { + "billingContactEmail" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Email address of the billing contact", + "example" : "billing@company.com", "nullable" : true }, - "orgUuid" : { + "billingContactMailingCity" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Billing contact mailing city", + "example" : "Los Angeles", "nullable" : true }, - "userUuid" : { + "billingContactMailingCountry" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Billing contact mailing country", + "example" : "United States", "nullable" : true - } - } - }, - "PartnerUserPermissionGroupType" : { - "type" : "object", - "description" : "Updated partner permission group configuration", - "properties" : { - "assignablePermissionGroups" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true }, - "clientAssignablePermissionGroupsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, + "billingContactMailingPostalCode" : { + "type" : "string", + "description" : "Billing contact mailing postal code", + "example" : "90210", "nullable" : true }, - "clientFunctionalityList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/FunctionalityEnum" - }, + "billingContactMailingState" : { + "type" : "string", + "description" : "Billing contact mailing state", + "example" : "CA", "nullable" : true }, - "clientPermissionMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PartnerPermissionEnum" - }, + "billingContactMailingStreet" : { + "type" : "string", + "description" : "Billing contact mailing street address", + "example" : "456 Billing St", "nullable" : true }, - "description" : { + "billingContactName" : { "type" : "string", + "description" : "Name of the billing contact", + "example" : "Jane Doe", "nullable" : true }, - "functionalityList" : { + "companyName" : { + "type" : "string", + "description" : "Name of the company", + "example" : "Acme Corporation", + "nullable" : true + }, + "dueDate" : { + "type" : "string", + "description" : "Due date in YYYY-MM-DD format", + "example" : "2024-02-14", + "nullable" : true + }, + "grandTotal" : { + "type" : "number", + "format" : "float", + "description" : "Grand total amount including tax and shipping", + "example" : 225.98, + "nullable" : true + }, + "invoiceDate" : { + "type" : "string", + "description" : "Invoice date in YYYY-MM-DD format", + "example" : "2024-01-15", + "nullable" : true + }, + "invoiceNumber" : { + "type" : "string", + "description" : "Invoice number", + "example" : "INV-2024-001", + "nullable" : true + }, + "lineItems" : { "type" : "array", + "description" : "List of line items on the invoice", "items" : { - "$ref" : "#/components/schemas/PartnerFunctionalityEnum" + "$ref" : "#/components/schemas/Invoice_InvoiceV1LineItemType" }, "nullable" : true }, - "mutable" : { - "type" : "boolean", + "notes" : { + "type" : "string", + "description" : "Additional notes for the invoice", + "example" : "Payment due within 30 days", "nullable" : true }, - "name" : { + "partnerBillingCity" : { "type" : "string", + "description" : "Partner billing city", + "example" : "San Francisco", "nullable" : true }, - "orgUuid" : { + "partnerBillingCountry" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Partner billing country", + "example" : "United States", "nullable" : true }, - "superAdmin" : { - "type" : "boolean", + "partnerBillingPostalCode" : { + "type" : "string", + "description" : "Partner billing postal code", + "example" : "94105", + "nullable" : true + }, + "partnerBillingState" : { + "type" : "string", + "description" : "Partner billing state", + "example" : "CA", + "nullable" : true + }, + "partnerBillingStreet" : { + "type" : "string", + "description" : "Partner billing street address", + "example" : "123 Business Ave", + "nullable" : true + }, + "partnerName" : { + "type" : "string", + "description" : "Name of the partner", + "example" : "Partner Solutions Inc", + "nullable" : true + }, + "salespersonName" : { + "type" : "string", + "description" : "Name of the salesperson", + "example" : "John Smith", + "nullable" : true + }, + "shipping" : { + "type" : "number", + "format" : "float", + "description" : "Shipping cost", + "example" : 9.99, + "nullable" : true + }, + "status" : { + "type" : "string", + "description" : "Status of the invoice", + "example" : "Paid", + "nullable" : true + }, + "subtotal" : { + "type" : "number", + "format" : "float", + "description" : "Subtotal amount before tax and shipping", + "example" : 199.99, + "nullable" : true + }, + "tax" : { + "type" : "number", + "format" : "float", + "description" : "Tax amount", + "example" : 16.0, "nullable" : true }, "uuid" : { @@ -110177,162 +112915,222 @@ } } }, - "Partner_ClientCustomizationsType" : { + "JakartaFamilyEnum" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "JakartaSameSiteEnum" : { + "type" : "string", + "enum" : [ "NONE", "LAX", "STRICT" ] + }, + "JavaTimeUnitEnum" : { + "type" : "string", + "description" : "Time granularity for the uptime report", + "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] + }, + "JsonNode" : { "type" : "object", - "description" : "Client-specific customization settings for partner management.", + "description" : "A WebAuthn credential auth response" + }, + "KeypadCommandEnum" : { + "type" : "string", + "description" : "Command being executed with the current keypad.", + "enum" : [ "ALARM_RAISED", "ARM", "ARMED", "ARMING_COUNTDOWN", "CANCEL", "COUNTDOWN", "DISARM", "DISARMED", "DISARMING", "DISMISSING", "LOGS_REQUESTED", "PENDING_ARMED", "THREAT_DETECTED", "VERIFYING", "UNKNOWN" ] + }, + "KeypadConfigType" : { + "type" : "object", + "description" : "List of all registered keypads for the organization", "properties" : { - "forceLowBandwidthOnAllCameras" : { + "additionalFeaturesDisabled" : { "type" : "boolean", - "description" : "Whether to force low bandwidth on all cameras", - "example" : false, "nullable" : true }, - "inactivityTimeout" : { - "type" : "integer", - "format" : "int32", - "description" : "Inactivity timeout in minutes", - "example" : 30, + "appVersionCode" : { + "type" : "string", "nullable" : true - } - } - }, - "Partner_ClientDeviceCustomizationsType" : { - "type" : "object", - "description" : "Client device-specific customization settings for partner management.", - "properties" : { - "forceLowBandwidthOnAllCameras" : { - "type" : "boolean", - "description" : "Whether to force low bandwidth on all cameras", - "example" : false, + }, + "appVersionName" : { + "type" : "string", "nullable" : true }, - "inactivityTimeout" : { + "armCountdownSecs" : { "type" : "integer", "format" : "int32", - "description" : "Inactivity timeout in minutes", - "example" : 30, "nullable" : true - } - } - }, - "Partner_ConnectionCountType" : { - "type" : "object", - "description" : "Device connection count information for partner clients.", - "properties" : { - "connectedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of connected devices", - "example" : 45, + }, + "buildingAdminPhoneNumber" : { + "type" : "string", "nullable" : true }, - "operationalCount" : { + "connectionState" : { + "$ref" : "#/components/schemas/KeypadConnectionStateEnum" + }, + "floorNumber" : { "type" : "integer", "format" : "int32", - "description" : "Number of operational devices", - "example" : 42, "nullable" : true }, - "totalCount" : { + "ipAddress" : { + "type" : "string", + "nullable" : true + }, + "lastModified" : { "type" : "integer", - "format" : "int32", - "description" : "Total number of devices", - "example" : 50, + "format" : "int64", "nullable" : true - } - } - }, - "Partner_CreatePartnerClientWSRequest" : { - "type" : "object", - "description" : "Request object for creating a new partner client account.", - "properties" : { - "clientContactEmail" : { + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "locationName" : { "type" : "string", - "description" : "Email address of the client contact person", - "example" : "john.smith@acme.com", "nullable" : true }, - "clientContactName" : { + "locationUuid" : { "type" : "string", - "description" : "Name of the client contact person", - "example" : "John Smith", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "clientOrgName" : { + "logoUuid" : { "type" : "string", - "description" : "Name of the client organization", - "example" : "Acme Corporation", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "suppressWelcomeEmail" : { - "type" : "boolean", - "description" : "Whether to suppress sending welcome email to the client", - "example" : false, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Partner_CreatePartnerClientWSResponse" : { - "type" : "object", - "description" : "Response object containing the result of creating a partner client account.", - "properties" : { - "clientOrgUuid" : { + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { + "platform" : { + "$ref" : "#/components/schemas/KeypadPlatformEnum" + }, + "qualifiedAddress" : { + "$ref" : "#/components/schemas/QualifiedAddressType" + }, + "showCallBuildingAdmin" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "tz" : { "type" : "string", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/Partner_PartnerWebResponseStatusEnum" + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "warningMsg" : { + "videoWallUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "KeypadConnectionStateEnum" : { + "type" : "string", + "enum" : [ "ONLINE", "OFFLINE" ] + }, + "KeypadPlatformEnum" : { + "type" : "string", + "description" : "The keypad platform (IOS or ANDROID)", + "enum" : [ "ANDROID", "IOS" ] + }, + "Keypad_AuthenticatePinRequest" : { + "type" : "object", + "description" : "Request object for authenticating a keypad PIN.", + "properties" : { + "pin" : { "type" : "string", + "description" : "PIN code to authenticate", + "example" : "1234", "nullable" : true } } }, - "Partner_CustomizeClientDeviceWSRequest" : { + "Keypad_AuthenticatePinResponse" : { "type" : "object", - "description" : "Request object for customizing client device settings and configurations.", + "description" : "Response object for keypad PIN authentication.", "properties" : { - "clientDeviceUuid" : { + "authenticated" : { + "type" : "boolean", + "description" : "Whether the PIN authentication was successful", + "example" : true, + "nullable" : true + } + } + }, + "Keypad_ClaimKeypadActivationTokenRequest" : { + "type" : "object", + "description" : "Request object for claiming a keypad activation token to connect a keypad to Rhombus services.", + "properties" : { + "activationToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Activation token for claiming the keypad", + "example" : "act_token_12345", "nullable" : true }, - "clientOrgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" + "name" : { + "type" : "string", + "description" : "Name for the keypad", + "example" : "Main Entrance Keypad", + "nullable" : true }, - "customizations" : { - "$ref" : "#/components/schemas/Partner_ClientDeviceCustomizationsType" + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, - "Partner_CustomizeClientDeviceWSResponse" : { + "Keypad_ClaimKeypadActivationTokenResponse" : { "type" : "object", - "description" : "Response object containing the applied client device customization settings.", + "description" : "Response object for claiming a keypad activation token.", "properties" : { - "customizations" : { - "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" - }, "error" : { "type" : "boolean", "nullable" : true @@ -110347,29 +113145,14 @@ } } }, - "Partner_CustomizeClientWSRequest" : { + "Keypad_GetCurrentKeypadWSRequest" : { "type" : "object", - "description" : "Request object for customizing client settings and configurations.", - "properties" : { - "clientOrgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "customizations" : { - "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" - } - } + "description" : "Request object for getting the current keypad information." }, - "Partner_CustomizeClientWSResponse" : { + "Keypad_GetCurrentKeypadWSResponse" : { "type" : "object", - "description" : "Response object containing the applied client customization settings.", + "description" : "Response object containing current keypad configuration information.", "properties" : { - "customizations" : { - "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" - }, "error" : { "type" : "boolean", "nullable" : true @@ -110378,17 +113161,25 @@ "type" : "string", "nullable" : true }, + "keypad" : { + "$ref" : "#/components/schemas/KeypadConfigType" + }, + "subLocationName" : { + "type" : "string", + "description" : "Name of the sub-location where the keypad is installed", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Partner_DeleteClientWebRequest" : { + "Keypad_GetKeypadsForLocationWSRequest" : { "type" : "object", - "description" : "Request object for deleting a partner client account.", + "description" : "Request object for getting all registered keypads for a specific location.", "properties" : { - "clientOrgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -110397,262 +113188,118 @@ } } }, - "Partner_DeleteClientWebResponse" : { - "type" : "object", - "description" : "Response object for deleting a partner client account." - }, - "Partner_DeviceWithPartnerDetailsType" : { + "Keypad_GetKeypadsForLocationWSResponse" : { "type" : "object", - "description" : "Device information with partner-specific details including control and reassignment status.", + "description" : "Response object containing all registered keypads for a specific location.", "properties" : { - "device" : { - "$ref" : "#/components/schemas/DeviceTypeV2" - }, - "partnerControlledHardware" : { + "error" : { "type" : "boolean", - "description" : "Whether the hardware is controlled by the partner", - "example" : true, "nullable" : true }, - "reassignable" : { - "type" : "boolean", - "description" : "Whether the device can be reassigned to another organization", - "example" : true, + "errorMsg" : { + "type" : "string", "nullable" : true - } - } - }, - "Partner_GetClientDevicesWSRequest" : { - "type" : "object", - "description" : "Request object for getting devices for a specific client organization.", - "properties" : { - "orgUuid" : { + }, + "keypads" : { + "type" : "array", + "description" : "List of all registered keypads for the specified location", + "items" : { + "$ref" : "#/components/schemas/KeypadConfigType" + }, + "nullable" : true + }, + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Partner_GetClientDevicesWSResponse" : { + "Keypad_GetKeypadsForOrgWSRequest" : { "type" : "object", - "description" : "Response object containing devices for a specific client organization.", + "description" : "Request object for getting all registered keypads for an organization." + }, + "Keypad_GetKeypadsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing all registered keypads for an organization.", "properties" : { - "devices" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "keypads" : { "type" : "array", - "description" : "List of devices with partner-specific details", + "description" : "List of all registered keypads for the organization", "items" : { - "$ref" : "#/components/schemas/Partner_DeviceWithPartnerDetailsType" + "$ref" : "#/components/schemas/KeypadConfigType" }, "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSBaseResponse" : { + "Keypad_KeypadCheckinWSRequest" : { "type" : "object", - "description" : "Base response for getting client Rhombus organization users for partner activation token V2", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSFailureResponse" - }, { - "$ref" : "#/components/schemas/Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSSuccessResponse" - } ], + "description" : "Request object for keypad online/offline checkin processing.", "properties" : { - "type" : { - "type" : "string" - } - }, - "required" : [ "type" ] - }, - "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSFailureResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "failureReason" : { - "type" : "string", - "description" : "Reason for the failure", - "example" : "Invalid activation token", - "nullable" : true - } - } - } ], - "description" : "Failure response for getting client Rhombus organization users for partner activation token V2.", - "nullable" : true, - "properties" : { - "type" : { - "type" : "string" - } - } - }, - "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSRequest" : { - "type" : "object", - "description" : "Request object for getting client Rhombus organization users for partner activation token V2.", - "properties" : { - "token" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSSuccessResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "orgs" : { - "type" : "array", - "description" : "List of Rhombus organizations the user has access to", - "items" : { - "$ref" : "#/components/schemas/OrgV2Type" - }, - "nullable" : true - } - } - } ], - "description" : "Success response for getting client Rhombus organization users for partner activation token V2.", - "nullable" : true, - "properties" : { - "type" : { - "type" : "string" - } - } - }, - "Partner_GetClientSummaryInfoWSRequest" : { - "type" : "object", - "description" : "Request object for getting client summary information.", - "properties" : { - "clientOrgUuid" : { + "appVersionCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Partner_GetClientSummaryInfoWSResponse" : { - "type" : "object", - "description" : "Response object containing client summary information including account owner, device status, and settings.", - "properties" : { - "accountOwner" : { - "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" - }, - "clientDeviceStatusMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Partner_ConnectionCountType" - }, - "description" : "Map of device types to their connection status counts", - "nullable" : true - }, - "error" : { - "type" : "boolean", + "description" : "build number --> 34", "nullable" : true }, - "errorMsg" : { + "appVersionName" : { "type" : "string", + "description" : "human readable --> 1.0.2", "nullable" : true }, - "licenseV2Enabled" : { - "type" : "boolean", - "description" : "Whether license V2 is enabled for the client", - "example" : true, - "nullable" : true - }, - "locationCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of locations for the client", - "example" : 3, + "ipAddress" : { + "type" : "string", + "description" : "Local IP address of the keypad for discoverability", "nullable" : true }, - "manuallySendLicenseExpirationEmailEnabled" : { - "type" : "boolean", - "description" : "Whether manual license expiration email sending is enabled", - "example" : false, - "nullable" : true + "platform" : { + "$ref" : "#/components/schemas/KeypadPlatformEnum" }, - "recentPolicyAlertCount" : { + "signalStrength" : { "type" : "integer", "format" : "int32", - "description" : "Number of recent policy alerts", - "example" : 5, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Partner_GetListOfAllClientDevicesRequest" : { - "type" : "object", - "description" : "Request object for getting list of all client devices." - }, - "Partner_GetListOfAllClientDevicesResponse" : { - "type" : "object", - "description" : "Response object containing list of all client devices.", - "properties" : { - "listOfAllClientDevices" : { - "type" : "array", - "description" : "List of all client devices", - "items" : { - "$ref" : "#/components/schemas/DeviceTypeV2" - }, + "description" : "Signal strength of the keypad connection", + "example" : -45, "nullable" : true } } }, - "Partner_GetListOfControlledHardwareRequest" : { - "type" : "object", - "description" : "Request object for getting list of controlled hardware." - }, - "Partner_GetListOfControlledHardwareResponse" : { + "Keypad_KeypadCheckinWSResponse" : { "type" : "object", - "description" : "Response object containing list of controlled hardware.", - "properties" : { - "controlledHardwareList" : { - "type" : "array", - "description" : "List of controlled hardware", - "items" : { - "$ref" : "#/components/schemas/Partner_UnregisteredControlledHardwareType" - }, - "nullable" : true - } - } + "description" : "Response object for keypad checkin operations." }, - "Partner_GetPartnerClientMobileAccountAccessRequest" : { + "Keypad_PublishKeypadCommandWSRequest" : { "type" : "object", - "description" : "Request object for getting partner client mobile account access.", + "description" : "Request object for sending a STOMP containing a keypad command.", "properties" : { - "authorityUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "command" : { + "$ref" : "#/components/schemas/KeypadCommandEnum" }, - "clientOrgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "executeAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch timestamp (ms) when to execute the command if applicable.", "nullable" : true } - } + }, + "required" : [ "command" ] }, - "Partner_GetPartnerClientMobileAccountAccessResponse" : { + "Keypad_UnregisterKeypadRequest" : { "type" : "object", - "description" : "Response object containing partner client mobile account access session.", + "description" : "Request object for unregistering a keypad.", "properties" : { - "clientAccountAccessSessionId" : { + "keypadUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -110661,27 +113308,10 @@ } } }, - "Partner_GetPartnerClientsStatusMapWSRequest" : { - "type" : "object", - "description" : "Request object for getting partner clients status map." - }, - "Partner_GetPartnerClientsStatusMapWSResponse" : { + "Keypad_UnregisterKeypadResponse" : { "type" : "object", - "description" : "Response object containing partner clients status map with device connection counts.", + "description" : "Response object for unregistering a keypad.", "properties" : { - "clientDeviceStatusMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Partner_ConnectionCountType" - }, - "description" : "Map of client UUIDs to device type connection counts", - "nullable" : true - }, - "description" : "Map of client UUIDs to device type connection counts", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -110696,166 +113326,129 @@ } } }, - "Partner_GetPartnerClientsWSRequest" : { - "type" : "object", - "description" : "Request object for getting all partner clients." - }, - "Partner_GetPartnerClientsWSResponse" : { + "Keypad_UpdateKeypadRequest" : { "type" : "object", - "description" : "Response object containing list of partner clients.", + "description" : "Request object for updating keypad settings and configuration.", "properties" : { - "clients" : { - "type" : "array", - "description" : "List of partner clients", - "items" : { - "$ref" : "#/components/schemas/Partner_PartnerClientWebType" - }, - "nullable" : true - }, - "error" : { + "additionalFeaturesDisabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Partner_GetPartnerUsersInOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting partner users in organization." - }, - "Partner_GetPartnerUsersInOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing partner users in organization with notification settings and permissions.", - "properties" : { - "error" : { - "type" : "boolean", + "armCountdownSecs" : { + "type" : "integer", + "format" : "int32", + "description" : "Arm countdown seconds for the keypad", + "example" : 30, "nullable" : true }, - "errorMsg" : { + "buildingAdminPhoneNumber" : { "type" : "string", + "description" : "Phone number of the building administrator", + "example" : "+1-555-123-4567", "nullable" : true }, - "notificationSettings" : { - "type" : "array", - "description" : "List of partner notification settings", - "items" : { - "$ref" : "#/components/schemas/PartnerNotificationSettingsType" - }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the keypad is located", + "example" : 1, "nullable" : true }, - "notificationSettingsV2" : { - "type" : "array", - "description" : "List of partner notification settings V2", - "items" : { - "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" - }, + "keypadUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "partnerPermissions" : { - "type" : "array", - "description" : "List of partner permissions", - "items" : { - "$ref" : "#/components/schemas/PartnerPermissionType" - }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the keypad location", + "example" : 37.7749, "nullable" : true }, - "partnerUsers" : { - "type" : "array", - "description" : "List of partner users in the organization", - "items" : { - "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" - }, + "locationName" : { + "type" : "string", + "description" : "Name of the location where the keypad is installed", + "example" : "Main Building", "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Partner_GetShipmentsWSRequest" : { - "type" : "object", - "description" : "Request object for getting client shipments within a time range.", - "properties" : { - "clientOrgUuid" : { + }, + "logoUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "endTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "End time for shipment search (seconds since epoch)", - "example" : 1640995200, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the keypad location", + "example" : -122.4194, "nullable" : true }, - "startTimeSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time for shipment search (seconds since epoch)", - "example" : 1640908800, - "nullable" : true - } - } - }, - "Partner_GetShipmentsWSResponse" : { - "type" : "object", - "description" : "Response object containing client shipments within the specified time range.", - "properties" : { - "customerShipmentList" : { - "type" : "array", - "description" : "List of customer shipments", - "items" : { - "$ref" : "#/components/schemas/CustomerShipmentType" - }, + "name" : { + "type" : "string", + "description" : "Name of the keypad", + "example" : "Main Entrance Keypad", "nullable" : true }, - "error" : { + "qualifiedAddress" : { + "$ref" : "#/components/schemas/QualifiedAddressType" + }, + "showCallBuildingAdmin" : { "type" : "boolean", + "description" : "Whether to show the call building admin option", + "example" : true, "nullable" : true }, - "errorMsg" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, "nullable" : true }, - "warningMsg" : { + "timeZoneId" : { "type" : "string", + "description" : "Time zone ID for the keypad location", + "example" : "America/Los_Angeles", "nullable" : true - } - } - }, - "Partner_GrantSupportAccessToClientWSRequest" : { - "type" : "object", - "description" : "Request object for granting support access to a client account.", - "properties" : { - "clientOrgUuid" : { + }, + "videoWallUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "videoWallUuidUpdated" : { + "type" : "boolean", + "description" : "Whether the video wall UUID has been updated", + "example" : false, + "nullable" : true } } }, - "Partner_GrantSupportAccessToClientWSResponse" : { + "Keypad_UpdateKeypadResponse" : { "type" : "object", - "description" : "Response object for granting support access to a client account.", + "description" : "Response object for updating keypad settings.", "properties" : { - "errMessage" : { - "type" : "string", - "description" : "Error message if support access grant failed", - "example" : "Client organization not found", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -110870,304 +113463,205 @@ } } }, - "Partner_PartnerClientWebType" : { + "Kiosk" : { "type" : "object", - "description" : "Partner client information including organization details and device counts.", + "description" : "List of all registered kiosks for the organization", "properties" : { - "authorityUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "clientAccessAllowed" : { - "type" : "boolean", - "description" : "Whether client access is allowed (duplicate getter)", - "example" : true, + "batteryLevel" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "clientAccountAccessUrl" : { - "type" : "string", - "description" : "URL for accessing the client account", - "example" : "https://console.rhombussystems.com/client/access", - "nullable" : true + "connectionStatus" : { + "$ref" : "#/components/schemas/ConnectionStatusEnum" }, - "clientOrgName" : { - "type" : "string", - "description" : "Name of the client organization", - "example" : "Acme Corporation", + "deleted" : { + "type" : "boolean", "nullable" : true }, - "clientOrgUuid" : { + "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAtMillis" : { + "lastUpdateTimeMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the client was created (milliseconds since epoch)", - "example" : 1640995200000, - "nullable" : true - }, - "totalAudioGateways" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of audio gateways", - "example" : 4, "nullable" : true }, - "totalBadgeReaders" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of badge readers", - "example" : 12, + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "totalCameras" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of cameras", - "example" : 25, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "totalClimateSensors" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of climate sensors", - "example" : 10, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "totalDoorSensors" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of door sensors", - "example" : 8, + "name" : { + "type" : "string", "nullable" : true }, - "totalLocations" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of locations", - "example" : 3, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "totalOccupancySensors" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of occupancy sensors", - "example" : 6, + "printerIP" : { + "type" : "string", "nullable" : true }, - "totalProximitySensors" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of proximity sensors", - "example" : 5, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Partner_PartnerWebResponseStatusEnum" : { - "type" : "string", - "description" : "Status responses for partner web operations.", - "enum" : [ "BASIC_AUTH_FAILED", "PASSWORD_MISMATCH", "USER_EXISTS", "CLIENT_EXISTS", "USER_NOT_FOUND", "BAD_INPUT", "SUCCESS", "PASSWORD_TOO_SHORT" ] - }, - "Partner_ReassignDeviceOrgWSRequest" : { + "KioskSelectiveUpdate" : { "type" : "object", - "description" : "Request object for reassigning devices from one organization to another.", + "description" : "Selective update information for the kiosk", "properties" : { - "serialNumbers" : { + "associatedCameras" : { "type" : "array", - "description" : "Serial numbers of the devices that should be reassigned to target organization", "items" : { "type" : "string", - "description" : "Serial numbers of the devices that should be reassigned to target organization", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "sourceOrgUuid" : { + "batteryLevel" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "connectionStatus" : { + "$ref" : "#/components/schemas/ConnectionStatusEnum" + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "hostUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "targetOrgUuid" : { + "lastUpdateTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "sourceOrgUuid", "targetOrgUuid" ] - }, - "Partner_ReassignDeviceOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing the status of device reassignment operations.", - "properties" : { - "statuses" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/OperationStatus" - }, - "description" : "Map of device serial numbers to their reassignment operation status", - "nullable" : true - } - } - }, - "Partner_RegisterDealWSRequest" : { - "type" : "object", - "description" : "Request object for registering a deal with partner details.", - "properties" : { - "details" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Map of deal details with key-value pairs", - "nullable" : true - }, - "description" : "Map of deal details with key-value pairs", - "nullable" : true - } - } - }, - "Partner_RegisterDealWSResponse" : { - "type" : "object", - "description" : "Response object containing the result of registering a deal.", - "properties" : { - "clients" : { - "type" : "array", - "description" : "List of partner clients associated with the registered deal", - "items" : { - "$ref" : "#/components/schemas/Partner_PartnerClientWebType" - }, - "nullable" : true }, - "error" : { - "type" : "boolean", + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Partner_RequestAccessToClientAccountRequest" : { - "type" : "object", - "description" : "Request object for requesting access to a client account (deprecated, use V2).", - "properties" : { - "clientEmail" : { + }, + "printerIP" : { "type" : "string", - "description" : "Email address of the client to request access for", - "example" : "client@acme.com", "nullable" : true - } - } - }, - "Partner_RequestAccessToClientAccountResponse" : { - "type" : "object", - "description" : "Response object for requesting access to a client account (deprecated, use V2).", - "properties" : { - "success" : { - "type" : "boolean", - "description" : "Whether the access request was successful", - "example" : true, + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true - } - } - }, - "Partner_RequestAccessToClientAccountV2Request" : { - "type" : "object", - "description" : "Request object for requesting access to a client account V2.", - "properties" : { - "clientEmail" : { + }, + "uuid" : { "type" : "string", - "description" : "Email address of the client to request access for", - "example" : "client@acme.com", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Partner_RequestAccessToClientAccountV2Response" : { + "Kiosk_ClaimKioskActivationTokenRequest" : { "type" : "object", - "description" : "Response object for requesting access to a client account V2.", + "description" : "Request object for claiming a kiosk activation token to connect a kiosk to Rhombus services.", "properties" : { - "success" : { - "type" : "boolean", - "description" : "Whether the access request was successful", - "example" : true, + "activationToken" : { + "type" : "string", + "description" : "Activation token for claiming the kiosk", + "example" : "kiosk_token_12345", "nullable" : true - } - } - }, - "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSBaseResponse" : { - "type" : "object", - "description" : "Base response for submitting support access decision for partner activation token V2", - "discriminator" : { - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSFailureResponse" - }, { - "$ref" : "#/components/schemas/Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSSuccessResponse" - } ], - "properties" : { - "type" : { - "type" : "string" - } - }, - "required" : [ "type" ] - }, - "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSFailureResponse" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "failureReason" : { - "type" : "string", - "description" : "Reason for the failure", - "example" : "Invalid activation token", - "nullable" : true - } - } - } ], - "description" : "Failure response for submitting support access decision for partner activation token V2.", - "nullable" : true, - "properties" : { - "type" : { - "type" : "string" - } - } - }, - "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSRequest" : { - "type" : "object", - "description" : "Request object for submitting support access decision for partner activation token V2.", - "properties" : { - "accessGrantedByClient" : { - "type" : "boolean", - "description" : "Whether access was granted by the client", - "example" : true, + }, + "hostUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "token" : { + "name" : { + "type" : "string", + "description" : "Name for the kiosk", + "example" : "Lobby Guest Kiosk", + "nullable" : true + }, + "permissionGroupUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -111176,52 +113670,29 @@ } } }, - "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSSuccessResponse" : { - "type" : "object", - "allOf" : [ ], - "description" : "Success response for submitting support access decision for partner activation token V2.", - "nullable" : true, - "properties" : { - "type" : { - "type" : "string" - } - } - }, - "Partner_UnregisteredControlledHardwareType" : { + "Kiosk_ClaimKioskActivationTokenResponse" : { "type" : "object", - "description" : "Information about unregistered controlled hardware available for partner registration.", + "description" : "Response object for claiming a kiosk activation token.", "properties" : { - "deviceModel" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "error" : { + "type" : "boolean", + "nullable" : true }, - "macAddress" : { + "errorMsg" : { "type" : "string", - "description" : "MAC address of the hardware device", - "example" : "00:11:22:33:44:55", "nullable" : true }, - "serialNumber" : { + "warningMsg" : { "type" : "string", - "description" : "Serial number of the hardware device", - "example" : "RH123456789", "nullable" : true } } }, - "Partner_UpdateManuallySendLicenseExpirationEmailWSRequest" : { + "Kiosk_DeleteKioskWSRequest" : { "type" : "object", - "description" : "Request object for updating manual license expiration email settings for an organization.", + "description" : "Request object for deleting a kiosk.", "properties" : { - "manuallySendLicenseExpirationEmail" : { - "type" : "boolean", - "description" : "Whether to manually send license expiration emails", - "example" : true, - "nullable" : true - }, - "orgUuid" : { + "kioskUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -111230,9 +113701,9 @@ } } }, - "Partner_UpdateManuallySendLicenseExpirationEmailWSResponse" : { + "Kiosk_DeleteKioskWSResponse" : { "type" : "object", - "description" : "Response object for updating manual license expiration email settings.", + "description" : "Response object for deleting a kiosk.", "properties" : { "error" : { "type" : "boolean", @@ -111248,30 +113719,13 @@ } } }, - "Password_ForgotPasswordWSRequest" : { + "Kiosk_GetCurrentKioskWSRequest" : { "type" : "object", - "description" : "Request object for initiating a forgot password flow with captcha verification.", - "properties" : { - "email" : { - "type" : "string", - "description" : "Email address of the user requesting password reset", - "example" : "user@example.com", - "nullable" : true - }, - "googleCaptchaSource" : { - "$ref" : "#/components/schemas/GoogleCaptchaSourceEnum" - }, - "googlesCaptchaResponse" : { - "type" : "string", - "description" : "Google reCAPTCHA response token for verification", - "example" : "03AGdBq25...", - "nullable" : true - } - } + "description" : "Request object for getting the current kiosk information." }, - "Password_ForgotPasswordWSResponse" : { + "Kiosk_GetCurrentKioskWSResponse" : { "type" : "object", - "description" : "Response object for forgot password request containing success status and failure details.", + "description" : "Response object containing current kiosk information.", "properties" : { "error" : { "type" : "boolean", @@ -111281,17 +113735,8 @@ "type" : "string", "nullable" : true }, - "failureReason" : { - "type" : "string", - "description" : "Reason for failure if the request was unsuccessful", - "example" : "User not found", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Whether the forgot password request was successful", - "example" : true, - "nullable" : true + "kiosk" : { + "$ref" : "#/components/schemas/Kiosk_KioskWithInfo" }, "warningMsg" : { "type" : "string", @@ -111299,27 +113744,22 @@ } } }, - "Password_ResetPasswordWSRequest" : { + "Kiosk_GetKiosksForLocationWSRequest" : { "type" : "object", - "description" : "Request object for resetting user password using a reset token.", + "description" : "Request object for getting all registered kiosks for a specific location.", "properties" : { - "password" : { - "type" : "string", - "description" : "New password for the user account", - "example" : "newSecurePassword123", - "nullable" : true - }, - "token" : { + "locationUuid" : { "type" : "string", - "description" : "Password reset token received via email", - "example" : "abc123def456", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Password_ResetPasswordWSResponse" : { + "Kiosk_GetKiosksForLocationWSResponse" : { "type" : "object", - "description" : "Response object for password reset containing success status and detailed failure information.", + "description" : "Response object containing all registered kiosks for a specific location.", "properties" : { "error" : { "type" : "boolean", @@ -111329,19 +113769,12 @@ "type" : "string", "nullable" : true }, - "failureReason" : { - "type" : "string", - "description" : "Human-readable reason for failure if the reset was unsuccessful", - "example" : "Invalid or expired token", - "nullable" : true - }, - "failureReasonType" : { - "$ref" : "#/components/schemas/UpdatePasswordFailureReasonEnumType" - }, - "success" : { - "type" : "boolean", - "description" : "Whether the password reset was successful", - "example" : true, + "kiosks" : { + "type" : "array", + "description" : "List of all registered kiosks for the specified location", + "items" : { + "$ref" : "#/components/schemas/Kiosk" + }, "nullable" : true }, "warningMsg" : { @@ -111350,34 +113783,13 @@ } } }, - "Password_UserSignupWSRequest" : { + "Kiosk_GetKiosksForOrgWSRequest" : { "type" : "object", - "description" : "Request object for user signup with invitation token, password, and EULA acceptance.", - "properties" : { - "eulaAccepted" : { - "type" : "boolean", - "description" : "Whether the user has accepted the End User License Agreement", - "example" : true, - "nullable" : true - }, - "password" : { - "type" : "string", - "description" : "Password for the new user account", - "example" : "securePassword123", - "nullable" : true - }, - "token" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } + "description" : "Request object for getting all registered kiosks for an organization." }, - "Password_UserSignupWSResponse" : { + "Kiosk_GetKiosksForOrgWSResponse" : { "type" : "object", - "description" : "Response object for user signup containing success status and failure details.", + "description" : "Response object containing all registered kiosks for an organization.", "properties" : { "error" : { "type" : "boolean", @@ -111387,16 +113799,12 @@ "type" : "string", "nullable" : true }, - "failureReason" : { - "type" : "string", - "description" : "Reason for failure if the signup was unsuccessful", - "example" : "Invalid invitation token", - "nullable" : true - }, - "success" : { - "type" : "boolean", - "description" : "Whether the user signup was successful", - "example" : true, + "kiosks" : { + "type" : "array", + "description" : "List of all registered kiosks for the organization", + "items" : { + "$ref" : "#/components/schemas/Kiosk" + }, "nullable" : true }, "warningMsg" : { @@ -111405,47 +113813,81 @@ } } }, - "PeopleCountEventType" : { + "Kiosk_KioskCheckinWSRequest" : { "type" : "object", - "description" : "List of people count events", + "description" : "Request object for kiosk heartbeat and online/offline processing.", "properties" : { - "boundingBoxes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BoundingBoxType" - }, + "batteryLevel" : { + "type" : "number", + "format" : "float", + "description" : "Battery level of the kiosk device", + "example" : 0.85, "nullable" : true }, - "deviceLabels" : { + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "Signal strength of the kiosk connection", + "example" : -45, + "nullable" : true + } + } + }, + "Kiosk_KioskCheckinWSResponse" : { + "type" : "object", + "description" : "Response object for kiosk heartbeat operations." + }, + "Kiosk_KioskWithInfo" : { + "type" : "object", + "description" : "Kiosk information with additional location details.", + "properties" : { + "associatedCameras" : { "type" : "array", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "deviceUuid" : { + "batteryLevel" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "connectionStatus" : { + "$ref" : "#/components/schemas/ConnectionStatusEnum" + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "hostGroup" : { + "$ref" : "#/components/schemas/OrgGroupType" + }, + "hostUserUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "eventTimestamp" : { + "lastUpdateTimeMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "imageS3Key" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "locationLabels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "locationName" : { + "type" : "string", + "description" : "Name of the location where the kiosk is installed", + "example" : "Main Lobby", "nullable" : true }, "locationUuid" : { @@ -111455,6 +113897,15 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, "orgUuid" : { "type" : "string", "format" : "RUUID", @@ -111462,14 +113913,10 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "peopleCount" : { - "type" : "integer", - "format" : "int32", + "printerIP" : { + "type" : "string", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -111479,26 +113926,22 @@ } } }, - "PerceptionTypeEnum" : { - "type" : "string", - "enum" : [ "PEOPLE_COUNTING", "FACE_COUNTING_UNIQUE", "FACE_COUNTING_NONUNIQUE", "ENGAGMENT_COUNTING", "FACE_RECOGNITION", "LICENSEPLATE_RECOGNITION", "VEHICLE_COUNTING", "OCCUPANCY_COUNTING", "UNKNOWN" ] - }, - "PermissionEnum" : { - "type" : "string", - "enum" : [ "READONLY", "ADMIN", "LIVEONLY" ] - }, - "Permission_AssignUserPermissionWSRequest" : { + "Kiosk_UnregisterKioskRequest" : { "type" : "object", - "description" : "Request object for assigning user permissions (deprecated, use Permission Group endpoints instead).", + "description" : "Request object for unregistering a kiosk.", "properties" : { - "userPermission" : { - "$ref" : "#/components/schemas/UserPermissionType" + "kioskUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Permission_AssignUserPermissionWSResponse" : { + "Kiosk_UnregisterKioskResponse" : { "type" : "object", - "description" : "Response object for assigning user permissions (deprecated, use Permission Group endpoints instead).", + "description" : "Response object for unregistering a kiosk.", "properties" : { "error" : { "type" : "boolean", @@ -111514,18 +113957,9 @@ } } }, - "Permission_CreatePartnerPermissionGroupWSRequest" : { - "type" : "object", - "description" : "Request object for creating a new partner permission group.", - "properties" : { - "partnerPermissionGroup" : { - "$ref" : "#/components/schemas/PartnerUserPermissionGroupType" - } - } - }, - "Permission_CreatePartnerPermissionGroupWSResponse" : { + "Kiosk_UpdateKioskResponse" : { "type" : "object", - "description" : "Response object containing the UUID of the created partner permission group.", + "description" : "Response object for updating kiosk settings.", "properties" : { "error" : { "type" : "boolean", @@ -111535,615 +113969,609 @@ "type" : "string", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Permission_CreatePermissionGroupWSRequest" : { + "Kiosk_UpdateKioskSelectiveRequest" : { "type" : "object", - "description" : "Request object for creating a new permission group.", + "description" : "Request object for selectively updating kiosk settings.", "properties" : { - "userPermissionGroup" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" + "kioskUpdate" : { + "$ref" : "#/components/schemas/KioskSelectiveUpdate" } } }, - "Permission_CreatePermissionGroupWSResponse" : { + "KisiSettings" : { "type" : "object", - "description" : "Response object containing the UUID of the created permission group.", "properties" : { - "error" : { + "alertUnauthorizedFaces" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "apiSecretKey" : { "type" : "string", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "defaultOptions" : { + "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, "nullable" : true - } - } - }, - "Permission_DeletePartnerPermissionGroupWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a partner permission group.", - "properties" : { - "groupUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + }, + "doorToCameraMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, "nullable" : true - } - } - }, - "Permission_DeletePartnerPermissionGroupWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a partner permission group.", - "properties" : { - "error" : { + }, + "doorsValidated" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { "type" : "string", "nullable" : true - } - } - }, - "Permission_DeletePermissionGroupWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a permission group.", - "properties" : { - "groupUuid" : { + }, + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Permission_DeletePermissionGroupWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a permission group.", - "properties" : { - "error" : { + }, + "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "migrated" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Permission_GetPartnerPermissionGroupWSResponse" : { - "type" : "object", - "description" : "Response object containing partner permission groups and client permission group mappings.", - "properties" : { - "clientPermissionGroupMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" - }, - "description" : "Map of client UUIDs to their permission group types", + "placeId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "clientPermissionsGroupMap" : { + "placeToSettingsMap" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" + "$ref" : "#/components/schemas/BadgeIntegrationSettings" }, - "nullable" : true, - "writeOnly" : true - }, - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "rhombusToken" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "groupMembership" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of permission group UUIDs to list of user UUIDs in each group", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "description" : "Map of permission group UUIDs to list of user UUIDs in each group", - "nullable" : true - }, - "permissionGroups" : { - "type" : "array", - "description" : "List of partner permission groups", - "items" : { - "$ref" : "#/components/schemas/PartnerUserPermissionGroupType" - }, + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "webhookId" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Permission_GetPartnerPermissionGroupsWSRequest" : { - "type" : "object", - "description" : "Request object for getting partner permission groups for the organization." - }, - "Permission_GetPermissionGroupsForOrgWSRequest" : { + "KisiType" : { "type" : "object", - "description" : "Request object for getting permission groups for a specific organization.", - "properties" : { - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "apiSecretKey" : { + "type" : "string", + "nullable" : true + }, + "defaultOptions" : { + "$ref" : "#/components/schemas/BadgeIntegrationDefaultOptions" + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "placeToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationSettings" + }, + "nullable" : true + } } - } - }, - "Permission_GetPermissionGroupsForOrgWSResponse" : { - "type" : "object", - "description" : "Response object containing permission groups for a specific organization.", + } ], + "nullable" : true, "properties" : { - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "permissionGroups" : { - "type" : "array", - "description" : "List of permission groups in the organization", - "items" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" }, "nullable" : true }, - "warningMsg" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Permission_GetPermissionGroupsWSRequest" : { - "type" : "object", - "description" : "Request object for getting all permission groups in the organization." + "LEDModeEnum" : { + "type" : "string", + "enum" : [ "LED_OFF", "LED_RED_SOLID", "LED_GREEN_SOLID", "LED_ORANGE_SOLID", "LED_RED_BLINK", "LED_GREEN_BLINK", "LED_ORANGE_BLINK", "LED_NORMAL" ] }, - "Permission_GetPermissionGroupsWSResponse" : { + "LabelIdentificationActivityEventType" : { "type" : "object", - "description" : "Response object containing permission groups and membership information for the organization.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "groupMembership" : { - "type" : "object", - "additionalProperties" : { + "allOf" : [ { + "type" : "object", + "properties" : { + "alertLabelSet" : { "type" : "array", - "description" : "Map of permission group UUIDs to list of user UUIDs in each group", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "nullable" : true, + "uniqueItems" : true + }, + "alertUnidentified" : { + "type" : "boolean", "nullable" : true }, - "description" : "Map of permission group UUIDs to list of user UUIDs in each group", - "nullable" : true - }, - "partnerMembership" : { - "type" : "object", - "additionalProperties" : { + "allowedLabelSet" : { "type" : "array", - "description" : "Map of partner UUIDs to list of user UUIDs in each partner organization", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "description" : "Map of partner UUIDs to list of user UUIDs in each partner organization", - "nullable" : true - }, - "permissionGroups" : { - "type" : "array", - "description" : "List of permission groups in the organization", - "items" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "nullable" : true, + "uniqueItems" : true + } + } + } ], + "nullable" : true, + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" } } }, - "Permission_GetPermissionsForCurrentPartnerWSRequest" : { + "LastSeenInfo" : { "type" : "object", - "description" : "Request object for getting permissions for the current partner user." + "properties" : { + "lastSeenAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } }, - "Permission_GetPermissionsForCurrentPartnerWSResponse" : { + "LeakProbeType" : { "type" : "object", - "description" : "Response object containing partner permission information including functionality lists, client permissions, and group details.", "properties" : { - "assignablePermissionGroups" : { - "type" : "array", - "description" : "Set of partner permission group UUIDs the user can assign to other users", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "clientFunctionalityList" : { - "type" : "array", - "description" : "List of client functionalities the user has access to", - "items" : { - "$ref" : "#/components/schemas/FunctionalityEnum" - }, + "adcMv" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "clientPermissionMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PartnerPermissionEnum" - }, - "description" : "Map of client UUIDs to partner permission levels", + "adcRaw" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "error" : { + "leakDetected" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "functionalityList" : { - "type" : "array", - "description" : "List of partner functionalities the user has access to", - "items" : { - "$ref" : "#/components/schemas/PartnerFunctionalityEnum" - }, - "nullable" : true - }, - "permissionGroupName" : { - "type" : "string", - "description" : "Name of the partner user's permission group", - "example" : "Partner Administrator", + "moistDetected" : { + "type" : "boolean", "nullable" : true }, - "superAdmin" : { + "present" : { "type" : "boolean", - "description" : "Whether the partner user has super admin privileges", - "example" : false, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "timestampSec" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Permission_GetPermissionsForCurrentUserWSRequest" : { - "type" : "object", - "description" : "Request object for getting permissions for the current user." + "LensRoleEnum" : { + "type" : "string", + "enum" : [ "VISIBLE", "THERMAL" ] }, - "Permission_GetPermissionsForCurrentUserWSResponse" : { + "LicenseComparisonEntry" : { "type" : "object", - "description" : "Response object containing comprehensive permission information for the current user including functionality, device, location, and granular access maps.", "properties" : { - "accessControlLocationAccessMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PermissionEnum" - }, - "description" : "Map of access control location UUIDs to permission levels", + "difference" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "accessMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PermissionEnum" - }, - "description" : "Deprecated: Map of device UUIDs to permission levels (use deviceAccessMap instead)", + "existingCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "assignablePermissionGroups" : { - "type" : "array", - "description" : "Set of permission group UUIDs the user can assign to other users", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "deviceAccessMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PermissionEnum" - }, - "description" : "Map of device UUIDs to permission levels", + "licenseType" : { + "type" : "string", "nullable" : true }, - "error" : { + "purchasedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "LicenseEnum" : { + "type" : "string", + "enum" : [ "STARTER", "STANDARD", "ENTERPRISE", "LEGACY" ] + }, + "LicenseFeature" : { + "type" : "object", + "properties" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true - }, - "functionalityList" : { - "type" : "array", - "description" : "List of functionalities the user has access to", - "items" : { - "$ref" : "#/components/schemas/FunctionalityEnum" - }, + } + } + }, + "LicenseGroupStats" : { + "type" : "object", + "properties" : { + "assignedCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "installer" : { - "type" : "boolean", - "description" : "Whether the user has installer privileges", - "example" : false, - "nullable" : true + "assignedLicenseStateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" }, - "locationAccessMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PermissionEnum" - }, - "description" : "Map of location UUIDs to permission levels", + "lastEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, - "locationGranularAccessMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/PermissionEnum" - }, - "description" : "Map of location UUIDs to granular functionality permission maps", - "nullable" : true - }, - "description" : "Map of location UUIDs to granular functionality permission maps", + "nearExpirationCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, - "permissionGroupName" : { + "nextEndDate" : { "type" : "string", - "description" : "Name of the user's permission group", - "example" : "Administrator", + "format" : "date-time", + "description" : "The closest future date on which licenses belonging to the group will expire.", "nullable" : true }, - "superAdmin" : { - "type" : "boolean", - "description" : "Whether the user has super admin privileges", - "example" : false, - "nullable" : true + "stateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" }, - "warningMsg" : { - "type" : "string", + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group.", "nullable" : true } } }, - "Permission_UpdatePartnerPermissionGroupWSRequest" : { - "type" : "object", - "description" : "Request object for updating an existing partner permission group.", - "properties" : { - "partnerPermissionGroup" : { - "$ref" : "#/components/schemas/PartnerUserPermissionGroupType" - } - } - }, - "Permission_UpdatePartnerPermissionGroupWSResponse" : { + "LicenseInvoiceSubItem" : { "type" : "object", - "description" : "Response object for updating a partner permission group.", "properties" : { - "error" : { - "type" : "boolean", + "count" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { + "description" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "license" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "price" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "Permission_UpdatePermissionGroupWSRequest" : { + "LicenseStateEnum" : { + "type" : "string", + "enum" : [ "CLAIMED", "RENEWED", "PENDING_RETURN", "NOT_RENEWED", "EXPIRED", "PERMANENTLY_EXPIRED" ] + }, + "LicenseStateStats" : { "type" : "object", - "description" : "Request object for updating an existing permission group.", "properties" : { - "userPermissionGroup" : { - "$ref" : "#/components/schemas/UserPermissionGroupType" + "claimedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently in the CLAIMED state.", + "nullable" : true + }, + "expiredCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently in the EXPIRED state.", + "nullable" : true + }, + "notRenewedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently in the NOT_RENEWED state.", + "nullable" : true + }, + "pendingReturnCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently in the PENDING_RETURN state.", + "nullable" : true + }, + "permanentlyExpiredCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently in the PERMANENTLY_EXPIRED state.", + "nullable" : true + }, + "renewedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently in the RENEWED state.", + "nullable" : true } } }, - "Permission_UpdatePermissionGroupWSResponse" : { + "LicenseToUnassignEmailStateEnum" : { + "type" : "string", + "enum" : [ "INITIAL_EMAIL_SUCCEEDED", "INITIAL_EMAIL_FAILED", "FIFTEEN_DAY_WARNING_EMAIL_SUCCEEDED", "FIFTEEN_DAY_WARNING_EMAIL_FAILED", "FOURTY_EIGHT_HOUR_WARNING_EMAIL_SUCCEEDED", "FOURTY_EIGHT_HOUR_WARNING_EMAIL_FAILED", "UNKNOWN" ] + }, + "LicenseUsageCatalogItem" : { "type" : "object", - "description" : "Response object for updating a permission group.", + "allOf" : [ { + "type" : "object", + "properties" : { + "addOnLicenseType" : { + "$ref" : "#/components/schemas/AddOnLicenseEnum" + }, + "cloudArchiveDays" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "licenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "durationMonths" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { + "productCode" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" } } }, - "PermyriadRect" : { + "LicenseUsageStats" : { "type" : "object", "properties" : { - "h" : { - "type" : "integer", - "format" : "int32", + "addOnLicenseStats" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddOnLicenseStats" + }, "nullable" : true }, - "size" : { + "assignedCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "w" : { - "type" : "integer", - "format" : "int32", + "assignedLicenseStateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "lastEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest past date on which licenses belonging to the group expired.", "nullable" : true }, - "x" : { + "nearExpirationCount" : { "type" : "integer", "format" : "int32", + "description" : "The number of licenses in the group that are currently close to expiration.", "nullable" : true }, - "y" : { + "nextEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest future date on which licenses belonging to the group will expire.", + "nullable" : true + }, + "stateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "totalCount" : { "type" : "integer", "format" : "int32", + "description" : "The number of licenses in the group.", "nullable" : true } } }, - "Person" : { + "LicenseUsageType" : { "type" : "object", - "description" : "The updated person", + "description" : "List of licenses available for the client organization", "properties" : { - "createdOn" : { + "addOnLicenseType" : { + "$ref" : "#/components/schemas/AddOnLicenseEnum" + }, + "additionalPerceptionFeatures" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PerceptionTypeEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "claimKeyUuid" : { "type" : "string", - "format" : "date-time", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "email" : { - "type" : "string", + "cloudArchiveDays" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "name" : { + "createdOn" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "orgUuid" : { + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedOn" : { + "firstAssignedDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "PersonSelectiveUpdate" : { - "type" : "object", - "description" : "Selective update information for the person", - "properties" : { - "createdOn" : { + "license" : { + "$ref" : "#/components/schemas/AddOnLicenseEnum" + }, + "licenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + }, + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "maxDeleteDate" : { "type" : "string", "format" : "date-time", "nullable" : true }, - "email" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "ownerOrgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "perceptionTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PerceptionTypeEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "priorClaimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedOn" : { + "productCode" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "updatedSetMethodMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, "uuid" : { @@ -112155,109 +114583,47 @@ } } }, - "PhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "GPIO_OUTPUT", "GPIO_INPUT", "GPIO_INPUT_SUPERVISED", "RS485", "WIEGAND_INPUT", "WIEGAND_OUTPUT", "BUTTON_INPUT" ] - }, - "PhysicalPortType" : { + "License_AssignACUDoorLicenseWSRequest" : { "type" : "object", + "description" : "Request object for assigning ACU door license.", "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "componentPortTypeUsageMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true - }, - "label" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "portNum" : { - "type" : "integer", - "format" : "int32", + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "supportedPortTypes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PhysicalPortEnumType" - }, - "nullable" : true, - "uniqueItems" : true } } }, - "PimlocBaseAPIUrlEnum" : { - "type" : "string", - "enum" : [ "US", "EU" ] - }, - "PimlocType" : { + "License_AssignACUDoorLicenseWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "baseAPIUrl" : { - "$ref" : "#/components/schemas/PimlocBaseAPIUrlEnum" - }, - "clientId" : { - "type" : "string", - "nullable" : true - }, - "clientSecret" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "validCredentials" : { - "type" : "boolean", - "nullable" : true - } + "description" : "Response object for assigning ACU door license.", + "properties" : { + "acuDoorLicense" : { + "$ref" : "#/components/schemas/ACUDoorLicenseType" } - } ], - "nullable" : true, + } + }, + "License_AssignAlertMonitoringLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for assigning alert monitoring license.", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, - "nullable" : true - }, - "orgUuid" : { + "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -112266,132 +114632,134 @@ } } }, - "PinCredential" : { + "License_AssignAlertMonitoringLicenseWSResponse" : { "type" : "object", - "allOf" : [ ], - "nullable" : true, + "description" : "Response object for assigning alert monitoring license.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastUsedAccessControlledDoorUuid" : { + "alertMonitoringLicense" : { + "$ref" : "#/components/schemas/AlertMonitoringLicenseType" + } + } + }, + "License_AssignDeviceLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for assigning or unassigning a device license.", + "properties" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastUsedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastUsedLocationUuid" : { + "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "lowercaseHexValue" : { - "type" : "string", - "nullable" : true, - "readOnly" : true - }, - "managedCredUuid" : { + } + } + }, + "License_AssignDeviceLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for assigning or unassigning a device license.", + "properties" : { + "deviceLicense" : { + "$ref" : "#/components/schemas/DeviceLicenseType" + } + } + }, + "License_AssignGuestManagementLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for assigning guest management license.", + "properties" : { + "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "note" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "orgUuid" : { + } + } + }, + "License_AssignGuestManagementLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for assigning guest management license.", + "properties" : { + "guestManagementLicense" : { + "$ref" : "#/components/schemas/GuestManagementLicenseType" + } + } + }, + "License_AssignLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for assigning an add-on license to a device.", + "properties" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "userUuid" : { + "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "uuid" : { + } + } + }, + "License_AssignLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for assigning an add-on license to a device.", + "properties" : { + "licenseUsage" : { + "$ref" : "#/components/schemas/LicenseUsageType" + } + } + }, + "License_AssignPaneLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for assigning a PANE app license to a pane, or unassigning it.", + "properties" : { + "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "value" : { + "paneId" : { "type" : "string", + "description" : "Id of the pane to assign the license to (the id in the pane's hostname, .pane.rhombus.com); null unassigns the license", "nullable" : true - }, - "workflowStatus" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } } }, - "PinQueryFilter" : { + "License_AssignPaneLicenseWSResponse" : { "type" : "object", - "description" : "Applies a filter on PINs retrieved. If a filter is not provided or if filter fields are left empty, no filtering will be applied. If used with pageRequest, the paginated result will be retrieved first then the filter will be applied.", + "description" : "Response object for assigning a PANE app license.", "properties" : { - "statusFilter" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PinStatusEnum" - }, - "nullable" : true, - "uniqueItems" : true + "paneLicense" : { + "$ref" : "#/components/schemas/PaneLicenseType" } } }, - "PinStatusEnum" : { - "type" : "string", - "enum" : [ "ACTIVE", "SCHEDULED", "EXPIRED" ] - }, - "PipelineComponent" : { + "License_CalculateLicensesStatsForClientOrgWSRequest" : { "type" : "object", + "description" : "Request object for calculating license statistics for client organization.", "properties" : { - "arg_json" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "nullable" : true - }, - "nullable" : true - }, - "name" : { - "$ref" : "#/components/schemas/PipelineComponentTypeEnum" - }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -112400,182 +114768,166 @@ } } }, - "PipelineComponentTypeEnum" : { - "type" : "string", - "enum" : [ "logger", "cropper_jpg", "color_class", "crop_mem", "motion_filter", "motion_detector", "visual_tamper", "syntiant_va", "syntiant_tracker", "syntiant_lpr", "syntiant_bounding_box" ] + "License_CalculateLicensesStatsForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing license statistics for client organization.", + "properties" : { + "orgLicenseStats" : { + "$ref" : "#/components/schemas/OrgLicenseStats" + } + } }, - "PlaceOsSettings" : { + "License_CalculateLicensesStatsForOrgWSRequest" : { "type" : "object", + "description" : "Request object for calculating license statistics for organization.", "properties" : { - "alertUnauthorizedFaces" : { + "excludeTrialLicensesFromExpiredCount" : { "type" : "boolean", + "description" : "Whether to exclude trial licenses from expired count", + "example" : false, "nullable" : true - }, - "apiUrl" : { + } + } + }, + "License_CalculateLicensesStatsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing license statistics for organization.", + "properties" : { + "orgLicenseStats" : { + "$ref" : "#/components/schemas/OrgLicenseStats" + } + } + }, + "License_CreateACUDoorLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for creating ACU door license.", + "properties" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "createSeekPoints" : { + } + } + }, + "License_CreateACUDoorLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for creating ACU door license.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "enabled" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "enabledTimestampMs" : { + } + } + }, + "License_CreateAlertMonitoringLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for creating alert monitoring license.", + "properties" : { + "allowedDeviceCount" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "enablingUser" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "enablingUserUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "identifyFacesFromBadge" : { + } + } + }, + "License_CreateAlertMonitoringLicenseWSResponse" : { + "type" : "object", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "migrated" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "rhombusToken" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "License_CreateDeviceLicenseWSRequest" : { + "type" : "object", + "properties" : { + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "saveClips" : { - "type" : "boolean", - "nullable" : true + "licenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" }, - "webhookSignatureSecret" : { + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "PlaceOsType" : { + "License_CreateDeviceLicenseWSResponse" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "apiUrl" : { - "type" : "string", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, - "nullable" : true - }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "triggerNotification" : { - "type" : "boolean", - "nullable" : true - }, - "webhookSignatureSecret" : { - "type" : "string", - "nullable" : true - } - } - } ], - "nullable" : true, "properties" : { - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_CreateGuestManagementLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for creating guest management license.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -112584,851 +114936,847 @@ } } }, - "PlaceType" : { + "License_CreateGuestManagementLicenseWSResponse" : { "type" : "object", "properties" : { - "alertUnauthorizedFaces" : { + "error" : { "type" : "boolean", "nullable" : true }, - "createSeekPoints" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "id" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_CreateLicenseWSRequest" : { + "type" : "object", + "properties" : { + "cloudArchiveDays" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "name" : { - "type" : "string", - "nullable" : true + "license" : { + "$ref" : "#/components/schemas/AddOnLicenseEnum" }, - "saveClips" : { - "type" : "boolean", + "licenseFamily" : { + "$ref" : "#/components/schemas/DeviceLicenseFamilyEnum" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "PlanTypeEnum" : { - "type" : "string", - "enum" : [ "TRIAL", "STARTER", "CUSTOM" ] - }, - "PlayerViewLiveTypeEnum" : { - "type" : "string", - "enum" : [ "REALTIME", "BUFFERED" ] - }, - "PmSensorType" : { + "License_CreateLicenseWSResponse" : { "type" : "object", "properties" : { - "nc0p5" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "nc10p0" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "nc1p0" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "nc2p5" : { - "type" : "number", - "format" : "float", + "error" : { + "type" : "boolean", "nullable" : true }, - "nc4p0" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "noxIdx" : { - "type" : "number", - "format" : "float", + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pm10p0" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "pm1p0" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_CreatePaneLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for creating a PANE app license in a client organization, optionally assigned.", + "properties" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "pm2p5" : { - "type" : "number", - "format" : "float", + "paneId" : { + "type" : "string", + "description" : "Optional pane id to assign the new license to immediately", "nullable" : true - }, - "pm4p0" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_CreatePaneLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for creating a PANE app license.", + "properties" : { + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "relHumid" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_DeleteAlertMonitoringLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for deleting alert monitoring license.", + "properties" : { + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tempC" : { - "type" : "number", - "format" : "float", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "License_DeleteAlertMonitoringLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for deleting alert monitoring license.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "typPartSize" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "vocIdx" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "PointType" : { + "License_DeleteDeviceLicenseWSRequest" : { "type" : "object", + "description" : "Request object for deleting an unassigned device license from an organization.", "properties" : { - "x" : { - "type" : "integer", - "format" : "int32", + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "y" : { - "type" : "integer", - "format" : "int32", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "PolicyAlertEnumType" : { - "type" : "string", - "enum" : [ "POLICY_ALERT_V2", "ACCESS_CONTROLLED_DOOR_POLICY_ALERT" ] - }, - "PolicyAlertV2Type" : { + "License_DeleteDeviceLicenseWSResponse" : { "type" : "object", - "description" : "Policy alert V2 to report as bad", + "description" : "Response object for deleting an unassigned device license from an organization.", "properties" : { - "airQualityIndex" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "airQualityIndexThreshold" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "alertMonitoringThreatCaseUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_DeleteGuestManagementLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for deleting guest management license.", + "properties" : { + "licenseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "alertMonitoringVerified" : { - "type" : "boolean", - "nullable" : true - }, - "alertingDwellEvents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DwellEventType" - }, - "nullable" : true - }, - "alertingEventFaces" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyEventFaceType" - }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "alertingEventVehicles" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyEventVehicleType" - }, + } + } + }, + "License_DeleteGuestManagementLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for deleting guest management license.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "cd" : { + "errorMsg" : { "type" : "string", - "description" : "Custom activity display description, maximum 100 characters", "nullable" : true }, - "cdn" : { + "warningMsg" : { "type" : "string", - "description" : "Custom activity display name, maximum 32 characters", "nullable" : true - }, - "ch2oPpb" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_DeleteLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an unassigned add-on license from an organization.", + "properties" : { + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ch2oPpbThreshold" : { - "type" : "number", - "format" : "float", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "clipLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "clipLocationMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, + } + } + }, + "License_DeleteLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an unassigned add-on license from an organization.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "clipLocationMapV2" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "cllmBooleanValue" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "cllmCheckCondition" : { - "$ref" : "#/components/schemas/CheckCondition" - }, - "cllmIntegerValue" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_DeletePaneLicenseWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an unassigned PANE app license.", + "properties" : { + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "cllmPromptTypeEnum" : { - "$ref" : "#/components/schemas/PromptTypeEnum" - }, - "cllmPromptUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "co2" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_DeletePaneLicenseWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a PANE app license." + }, + "License_FindAssignedLicensesByLocationWSRequest" : { + "type" : "object", + "description" : "Request object for finding licenses assigned to a location.", + "properties" : { + "includeSubLocations" : { + "type" : "boolean", + "default" : true, + "description" : "Whether to also include licenses assigned to sub locations of the location", "nullable" : true }, - "co2Ppm" : { - "type" : "integer", - "format" : "int32", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "co2PpmThreshold" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_FindAssignedLicensesByLocationWSResponse" : { + "type" : "object", + "description" : "Response object containing licenses assigned to a location.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "co2Threshold" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "coConcentration" : { - "type" : "number", - "format" : "double", + "licenses" : { + "type" : "array", + "description" : "List of licenses assigned to the location", + "items" : { + "$ref" : "#/components/schemas/BaseLicenseType" + }, "nullable" : true }, - "coConcentrationThreshold" : { - "type" : "number", - "format" : "double", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "componentUuid" : { + } + } + }, + "License_FindLicensesByClaimKeyWSRequest" : { + "type" : "object", + "description" : "Request object for finding licenses by claim key.", + "properties" : { + "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "delayedProcessing" : { + } + } + }, + "License_FindLicensesByClaimKeyWSResponse" : { + "type" : "object", + "description" : "Response object containing licenses found by claim key.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "deleted" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "deviceType" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "licenses" : { + "type" : "array", + "description" : "List of licenses found by claim key", + "items" : { + "$ref" : "#/components/schemas/BaseLicenseType" + }, + "nullable" : true }, - "deviceUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_GetACUDoorLicensesForClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of access controlled door licenses available for a client organization.", + "properties" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_GetACUDoorLicensesForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing list of access controlled door licenses available for a client organization.", + "properties" : { + "acuDoorLicenses" : { + "type" : "array", + "description" : "List of access controlled door licenses available for the client organization", + "items" : { + "$ref" : "#/components/schemas/ACUDoorLicenseType" + }, "nullable" : true - }, - "egressBoundaryDevices" : { + } + } + }, + "License_GetACUDoorLicensesWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of access controlled door licenses available in organization." + }, + "License_GetACUDoorLicensesWSResponse" : { + "type" : "object", + "description" : "Response object containing list of access controlled door licenses available in organization.", + "properties" : { + "acuDoorLicenses" : { "type" : "array", + "description" : "List of access controlled door licenses available in the organization", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/ACUDoorLicenseType" }, "nullable" : true }, - "ethanol" : { - "type" : "number", - "format" : "float", + "error" : { + "type" : "boolean", "nullable" : true }, - "ethanolThreshold" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "finalized" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "heatIndexDegF" : { - "type" : "number", - "format" : "double", + } + } + }, + "License_GetAlertMonitoringLicensesForClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of alert monitoring licenses available for a client organization.", + "properties" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "heatIndexDegFThreshold" : { - "type" : "number", - "format" : "double", + } + } + }, + "License_GetAlertMonitoringLicensesForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing list of alert monitoring licenses available for a client organization.", + "properties" : { + "alertMonitoringLicenses" : { + "type" : "array", + "description" : "List of alert monitoring licenses available for the client organization", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringLicenseType" + }, "nullable" : true - }, - "humidityPercent1616" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_GetAlertMonitoringLicensesWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of alert monitoring licenses available in organization." + }, + "License_GetAlertMonitoringLicensesWSResponse" : { + "type" : "object", + "description" : "Response object containing list of alert monitoring licenses available in organization.", + "properties" : { + "alertMonitoringLicenses" : { + "type" : "array", + "description" : "List of alert monitoring licenses available in the organization", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringLicenseType" + }, "nullable" : true }, - "humidityPercentThreshold1616" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "humidityPermyriad" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "humidityThresholdPermyriad" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "iaq" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_GetDeviceLicensesForClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of device licenses available for a client organization.", + "properties" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "iaqThreshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_GetDeviceLicensesForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing list of device licenses available for a client organization.", + "properties" : { + "deviceLicenses" : { + "type" : "array", + "description" : "List of device licenses available for the client organization", + "items" : { + "$ref" : "#/components/schemas/DeviceLicenseType" + }, "nullable" : true - }, - "ingressBoundaryDevices" : { + } + } + }, + "License_GetDeviceLicensesWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of device licenses available in organization.", + "properties" : { + "optionalDeviceTypeFilter" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + } + } + }, + "License_GetDeviceLicensesWSResponse" : { + "type" : "object", + "description" : "Response object containing list of device licenses available in organization.", + "properties" : { + "deviceLicenses" : { "type" : "array", + "description" : "List of device licenses available in the organization", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/DeviceLicenseType" }, "nullable" : true }, - "leakDetected" : { + "error" : { "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_GetGuestManagementLicensesForClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of guest management licenses available for a client organization.", + "properties" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "maxLuf" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_GetGuestManagementLicensesForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing list of guest management licenses available for a client organization.", + "properties" : { + "guestManagementLicenses" : { + "type" : "array", + "description" : "List of guest management licenses available for the client organization", + "items" : { + "$ref" : "#/components/schemas/GuestManagementLicenseType" + }, "nullable" : true - }, - "notificationSent" : { + } + } + }, + "License_GetGuestManagementLicensesWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of guest management licenses available in organization." + }, + "License_GetGuestManagementLicensesWSResponse" : { + "type" : "object", + "description" : "Response object containing list of guest management licenses available in organization.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "noxIdx" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "noxIdxThreshold" : { - "type" : "number", - "format" : "float", + "guestManagementLicenses" : { + "type" : "array", + "description" : "List of guest management licenses available in the organization", + "items" : { + "$ref" : "#/components/schemas/GuestManagementLicenseType" + }, "nullable" : true }, - "numHumans" : { - "type" : "integer", - "format" : "int32", + "warningMsg" : { + "type" : "string", "nullable" : true - }, + } + } + }, + "License_GetLicensesForClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of licenses available for a client organization.", + "properties" : { "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "peopleCountHighThreshold" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_GetLicensesForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing list of licenses available for a client organization.", + "properties" : { + "licenses" : { + "type" : "array", + "description" : "List of licenses available for the client organization", + "items" : { + "$ref" : "#/components/schemas/LicenseUsageType" + }, "nullable" : true - }, - "peopleCountLowThreshold" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "License_GetLicensesWSRequest" : { + "type" : "object", + "description" : "Request object for getting list of add-on licenses available in organization.", + "properties" : { + "optionalDeviceTypeFilter" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + } + } + }, + "License_GetLicensesWSResponse" : { + "type" : "object", + "description" : "Response object containing list of add-on licenses available in organization.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "pm10p0" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "pm10p0Threshold" : { - "type" : "number", - "format" : "float", + "licenses" : { + "type" : "array", + "description" : "List of add-on licenses available in the organization", + "items" : { + "$ref" : "#/components/schemas/LicenseUsageType" + }, "nullable" : true }, - "pm1p0" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "pm1p0Threshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_GetPaneLicenseStatusWSRequest" : { + "type" : "object", + "description" : "Request object for checking whether the organization is licensed to use a PANE app.", + "properties" : { + "paneId" : { + "type" : "string", + "description" : "Id of the pane (the id in the pane's hostname, .pane.rhombus.com)", "nullable" : true - }, - "pm25" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_GetPaneLicenseStatusWSResponse" : { + "type" : "object", + "description" : "Whether the organization may use a PANE app right now, and why not if it may not.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "pm25Threshold" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "pm4p0" : { - "type" : "number", - "format" : "float", + "gracePeriodEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "When the current entitlement lapses; absent for a license granted without a term", "nullable" : true }, - "pm4p0Threshold" : { - "type" : "number", - "format" : "float", + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyAlertTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, + "licensed" : { + "type" : "boolean", + "description" : "True when an active pane license is assigned to the pane", "nullable" : true }, - "policyUuid" : { + "reason" : { + "$ref" : "#/components/schemas/PaneLicenseStatusReasonEnum" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_GetPaneLicensesForClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for a partner to list PANE app licenses in a client organization.", + "properties" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pressure" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_GetPaneLicensesForClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing the list of PANE app licenses in a client organization.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "pressureThreshold" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "probeTempC" : { - "type" : "number", - "format" : "float", + "paneLicenses" : { + "type" : "array", + "description" : "List of PANE app licenses in the client organization", + "items" : { + "$ref" : "#/components/schemas/PaneLicenseType" + }, "nullable" : true }, - "probeTempCThreshold" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "probeTempThreshold" : { - "type" : "number", - "format" : "float", + } + } + }, + "License_GetPaneLicensesWSRequest" : { + "type" : "object", + "description" : "Request object for getting the list of PANE app licenses in the organization." + }, + "License_GetPaneLicensesWSResponse" : { + "type" : "object", + "description" : "Response object containing the list of PANE app licenses in the organization.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "relHumid" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "relHumidThreshold" : { - "type" : "number", - "format" : "float", + "paneLicenses" : { + "type" : "array", + "description" : "List of PANE app licenses in the organization, assigned or not", + "items" : { + "$ref" : "#/components/schemas/PaneLicenseType" + }, "nullable" : true }, - "saved" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "License_catalog_FindCatalogItemsWSRequest" : { + "type" : "object", + "properties" : { + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + } + } + }, + "License_catalog_FindCatalogItemsWSResponse" : { + "type" : "object", + "properties" : { + "catalogItems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BaseCatalogItem" + }, "nullable" : true }, - "shared" : { + "error" : { "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "tamperByMovementChange" : { - "type" : "number", - "format" : "float", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "tampered" : { - "type" : "boolean", - "nullable" : true - }, - "tempC" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "tempCThreshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "tempProbePresent" : { - "type" : "boolean", - "nullable" : true - }, - "temperatureCelsius1616" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "temperatureCelsiusThreshold1616" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "temperaturePermyriad" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "temperatureThresholdPermyriad" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "textDescription" : { - "type" : "string", - "description" : "Natural language description of the alert", - "nullable" : true - }, - "thcPercent" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "thcPercentThreshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "thumbnailLocationV2" : { - "type" : "string", - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "tvoc" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "tvocThreshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/PolicyAlertEnumType" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "vapeDetected" : { - "type" : "boolean", - "nullable" : true - }, - "vapeSmokePercent" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "vapeSmokePercentThreshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "vocIdx" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "vocIdxThreshold" : { - "type" : "number", - "format" : "float", + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "PolicyAlertWithDetailsType" : { + "License_catalog_GetCatalogItemByProductCodeWSRequest" : { "type" : "object", - "description" : "Detailed information about the policy alert", - "oneOf" : [ { - "$ref" : "#/components/schemas/PolicyAlertV2Type" - }, { - "$ref" : "#/components/schemas/AccessControlledDoorPolicyAlertType" - } ], "properties" : { - "alertMonitoringThreatCaseUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "alertMonitoringVerified" : { - "type" : "boolean", - "nullable" : true - }, - "boundingBoxes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClipBoundingBoxType" - }, - "nullable" : true - }, - "boundingBoxesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClipBoundingBoxType" - }, - "nullable" : true - }, - "nullable" : true - }, - "clientType" : { - "$ref" : "#/components/schemas/ApiClientTypeEnum" - }, - "clipLocationMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "nullable" : true - }, - "clipLocationMapV2" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "componentCompositeSeekPointsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClipSeekPointV2Type" - }, - "nullable" : true - }, - "nullable" : true - }, - "delayedProcessing" : { - "type" : "boolean", - "nullable" : true - }, - "deleted" : { - "type" : "boolean", - "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "finalized" : { - "type" : "boolean", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "notificationSent" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "policyAlertTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true - }, - "policyUuid" : { + "productCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "recognizedEventFaces" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyEventFaceType" - }, - "nullable" : true - }, - "recognizedEventVehicles" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyEventVehicleType" - }, - "nullable" : true - }, - "saved" : { - "type" : "boolean", - "nullable" : true - }, - "seekPoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClipSeekPointV2Type" - }, - "nullable" : true - }, - "seekPointsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClipSeekPointV2Type" - }, - "nullable" : true - }, "nullable" : true + } + } + }, + "License_catalog_GetCatalogItemByProductCodeWSResponse" : { + "type" : "object", + "properties" : { + "catalogItem" : { + "$ref" : "#/components/schemas/BaseCatalogItem" }, - "shared" : { + "error" : { "type" : "boolean", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "textDescription" : { + "errorMsg" : { "type" : "string", - "description" : "Natural language description of the alert", "nullable" : true }, - "thirdPartyDeviceName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "thumbnailLocationV2" : { + } + } + }, + "License_claimkey_ClaimLicensesForClientOrgWSRequest" : { + "type" : "object", + "properties" : { + "claimCode" : { "type" : "string", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/PolicyAlertEnumType" - }, - "unrecognizedEventFaces" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyEventFaceType" - }, - "nullable" : true - }, - "unrecognizedEventVehicles" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyEventVehicleType" - }, - "nullable" : true - }, - "uuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -113437,39 +115785,10 @@ } } }, - "PolicyEventFaceType" : { + "License_claimkey_ClaimLicensesForClientOrgWSResponse" : { "type" : "object", "properties" : { - "faceId" : { - "type" : "string", - "nullable" : true - }, - "faceName" : { - "type" : "string", - "nullable" : true - }, - "imageS3Bucket" : { - "type" : "string", - "nullable" : true - }, - "imageS3Key" : { - "type" : "string", - "nullable" : true - }, - "imageS3Region" : { - "type" : "string", - "nullable" : true - }, - "labels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "personUuid" : { + "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -113478,85 +115797,41 @@ } } }, - "PolicyEventVehicleType" : { + "License_claimkey_ClaimLicensesFromSalesforceWSRequest" : { "type" : "object", "properties" : { - "imageS3Bucket" : { - "type" : "string", - "nullable" : true - }, - "imageS3Key" : { - "type" : "string", - "nullable" : true - }, - "imageS3Region" : { - "type" : "string", - "nullable" : true - }, - "labels" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "licensePlateNumber" : { + "claimCode" : { "type" : "string", "nullable" : true }, - "vehicleName" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_CreateAccessControlledDoorPolicyWSRequest" : { + "License_claimkey_ClaimLicensesWSRequest" : { "type" : "object", "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalAccessControlledDoorPolicyType" + "claimCode" : { + "type" : "string", + "nullable" : true } } }, - "Policy_CreateAccessControlledDoorPolicyWSResponse" : { + "License_claimkey_ClaimLicensesWSResponse" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "policyUuid" : { + "claimKeyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Policy_CreateAudioPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for creating an audio policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalAudioPolicyType" - } - } - }, - "Policy_CreateAudioPolicyWSResponse" : { - "type" : "object", - "description" : "Response object containing the UUID of the created audio policy.", - "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -113565,66 +115840,49 @@ "type" : "string", "nullable" : true }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Policy_CreateCameraPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for creating a camera policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalCameraPolicyV2Type" - } - } - }, - "Policy_CreateCameraPolicyWSResponse" : { + "License_claimkey_CreateClaimKeyWSRequest" : { "type" : "object", - "description" : "Response object containing the UUID of the created camera policy.", "properties" : { - "error" : { + "endDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "entry" : { + "$ref" : "#/components/schemas/ClaimKeyEntry" + }, + "migratedRenewal" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "requestId" : { "type" : "string", "nullable" : true }, - "policyUuid" : { + "startDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "date-time", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "trial" : { + "type" : "boolean", "nullable" : true } } }, - "Policy_CreateClimatePolicyWSRequest" : { - "type" : "object", - "description" : "Request object for creating a climate policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalClimatePolicyType" - } - } - }, - "Policy_CreateClimatePolicyWSResponse" : { + "License_claimkey_CreateClaimKeyWSResponse" : { "type" : "object", - "description" : "Response object containing the UUID of the created climate policy.", "properties" : { + "claimCode" : { + "type" : "string", + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -113633,7 +115891,7 @@ "type" : "string", "nullable" : true }, - "policyUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -113646,51 +115904,34 @@ } } }, - "Policy_CreateDoorPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for creating a door sensor policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalDoorPolicyType" - } - } - }, - "Policy_CreateDoorPolicyWSResponse" : { + "License_claimkey_CreateRenewalClaimKeyWSRequest" : { "type" : "object", - "description" : "Response object containing the UUID of the created door sensor policy.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "endDate" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "entries" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ClaimKeyEntry" + }, "nullable" : true }, - "warningMsg" : { + "requestId" : { "type" : "string", "nullable" : true } } }, - "Policy_CreateOccupancyPolicyWSRequest" : { - "type" : "object", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalOccupancyPolicyType" - } - } - }, - "Policy_CreateOccupancyPolicyWSResponse" : { + "License_claimkey_CreateRenewalClaimKeyWSResponse" : { "type" : "object", "properties" : { + "claimCode" : { + "type" : "string", + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -113699,7 +115940,7 @@ "type" : "string", "nullable" : true }, - "policyUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -113712,105 +115953,31 @@ } } }, - "Policy_CreatePolicyAddendumForLocationRequest" : { + "License_claimkey_FindClaimKeysByClientOrgWSRequest" : { "type" : "object", - "description" : "Request object for creating a policy addendum for a location.", "properties" : { - "activities" : { - "type" : "array", - "description" : "Set of activities to include in the policy addendum", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration in seconds for the policy addendum", - "example" : 3600, - "nullable" : true + "claimKeySearchFilter" : { + "$ref" : "#/components/schemas/ClaimKeySearchFilter" }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "scheduledTimestampSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Scheduled timestamp in seconds for the policy addendum", - "example" : 1640995200, - "nullable" : true - } - } - }, - "Policy_CreatePolicyAddendumForLocationResponse" : { - "type" : "object", - "description" : "Response object for creating a policy addendum for a location.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Policy_CreatePolicyAddendumsForDevicesRequest" : { + "License_claimkey_FindClaimKeysByClientOrgWSResponse" : { "type" : "object", - "description" : "Request object for creating policy addendums for multiple devices.", "properties" : { - "activities" : { - "type" : "array", - "description" : "Set of activities to include in the policy addendums", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "deviceUuids" : { + "claimKeys" : { "type" : "array", - "description" : "List of device UUIDs to create policy addendums for", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/BaseClaimKey" }, "nullable" : true }, - "durationSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration in seconds for the policy addendums", - "example" : 3600, - "nullable" : true - }, - "scheduledTimestampSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Scheduled timestamp in seconds for the policy addendums", - "example" : 1640995200, - "nullable" : true - } - } - }, - "Policy_CreatePolicyAddendumsForDevicesResponse" : { - "type" : "object", - "description" : "Response object for creating policy addendums for multiple devices.", - "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -113825,17 +115992,24 @@ } } }, - "Policy_CreateProximityPolicyWSRequest" : { + "License_claimkey_FindClaimKeysByOrgWSRequest" : { "type" : "object", "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalProximityPolicyType" + "claimKeySearchFilter" : { + "$ref" : "#/components/schemas/ClaimKeySearchFilter" } } }, - "Policy_CreateProximityPolicyWSResponse" : { + "License_claimkey_FindClaimKeysByOrgWSResponse" : { "type" : "object", "properties" : { + "claimKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BaseClaimKey" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -113844,90 +116018,57 @@ "type" : "string", "nullable" : true }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Policy_CreateScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for creating a schedule to be used for policy creation.", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - } - } - }, - "Policy_CreateScheduleWSResponse" : { + "License_claimkey_GetClaimKeyByCodeForClientOrgWSRequest" : { "type" : "object", - "description" : "Response object containing the UUID of the created schedule.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "claimCode" : { "type" : "string", "nullable" : true }, - "scheduleUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Policy_CreateVideoIntercomPolicyWSRequest" : { + "License_claimkey_GetClaimKeyByCodeForClientWSResponse" : { "type" : "object", "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalVideoIntercomPolicyType" + "claimKey" : { + "$ref" : "#/components/schemas/BaseClaimKey" } } }, - "Policy_CreateVideoIntercomPolicyWSResponse" : { + "License_claimkey_GetClaimKeyByCodeWSRequest" : { "type" : "object", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "warningMsg" : { + "claimCode" : { "type" : "string", "nullable" : true } } }, - "Policy_DeleteAccessControlledDoorPolicyWSRequest" : { + "License_claimkey_GetClaimKeyByCodeWSResponse" : { "type" : "object", - "description" : "Request object for deleting an access controlled door policy.", "properties" : { - "policyUuid" : { + "claimKey" : { + "$ref" : "#/components/schemas/BaseClaimKey" + } + } + }, + "License_claimkey_GetClaimKeyWSRequest" : { + "type" : "object", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -113936,10 +116077,12 @@ } } }, - "Policy_DeleteAccessControlledDoorPolicyWSResponse" : { + "License_claimkey_GetClaimKeyWSResponse" : { "type" : "object", - "description" : "Response object for deleting an access controlled door policy.", "properties" : { + "claimKey" : { + "$ref" : "#/components/schemas/BaseClaimKey" + }, "error" : { "type" : "boolean", "nullable" : true @@ -113954,23 +116097,22 @@ } } }, - "Policy_DeleteAudioPolicyWSRequest" : { + "License_claimkey_GetClaimKeysForPartnerOrgWSRequest" : { "type" : "object", - "description" : "Request object for deleting an audio policy.", - "properties" : { - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } + "description" : "Request object for getting the claim keys belonging to the authenticated partner organization." }, - "Policy_DeleteAudioPolicyWSResponse" : { + "License_claimkey_GetClaimKeysForPartnerOrgWSResponse" : { "type" : "object", - "description" : "Response object for deleting an audio policy.", + "description" : "Response object containing the claim keys belonging to the authenticated partner organization.", "properties" : { + "claimKeys" : { + "type" : "array", + "description" : "List of claim keys belonging to the partner organization", + "items" : { + "$ref" : "#/components/schemas/PartnerOrgClaimKey" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -113985,11 +116127,19 @@ } } }, - "Policy_DeleteCameraPolicyWSRequest" : { + "License_claimkey_ReturnClaimKeyProductQuantitiesWSRequest" : { "type" : "object", - "description" : "Request object for deleting a camera policy.", "properties" : { - "policyUuid" : { + "productQuantities" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -113998,9 +116148,8 @@ } } }, - "Policy_DeleteCameraPolicyWSResponse" : { + "License_claimkey_ReturnClaimKeyProductQuantitiesWSResponse" : { "type" : "object", - "description" : "Response object for deleting a camera policy.", "properties" : { "error" : { "type" : "boolean", @@ -114016,311 +116165,466 @@ } } }, - "Policy_DeleteClimatePolicyWSRequest" : { + "LineItems" : { "type" : "object", - "description" : "Request object for deleting a climate policy.", "properties" : { - "policyUuid" : { + "description" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Policy_DeleteClimatePolicyWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a climate policy.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "productCode" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "productcode" : { "type" : "string", "nullable" : true + }, + "quantity" : { + "type" : "number", + "nullable" : true + }, + "subtotal" : { + "type" : "number", + "nullable" : true + }, + "unitPrice" : { + "type" : "number", + "nullable" : true + }, + "unitprice" : { + "type" : "number", + "nullable" : true, + "writeOnly" : true } } }, - "Policy_DeleteDevicePolicyAddendumsWSRequest" : { + "Link" : { "type" : "object", - "description" : "Request object for deleting device policy addendums.", + "nullable" : true, "properties" : { - "uuids" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "rel" : { + "type" : "string", + "nullable" : true + }, + "rels" : { "type" : "array", - "description" : "List of device policy addendum UUIDs to delete", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - } - } - }, - "Policy_DeleteDevicePolicyAddendumsWSResponse" : { - "type" : "object", - "description" : "Response object for deleting device policy addendums.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "title" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "type" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "uri" : { "type" : "string", + "format" : "uri", "nullable" : true + }, + "uriBuilder" : { + "$ref" : "#/components/schemas/UriBuilder" } } }, - "Policy_DeleteDoorPolicyWSRequest" : { + "LiveNotificationActionRecordType" : { "type" : "object", - "description" : "Request object for deleting a door sensor policy.", "properties" : { - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "status" : { + "$ref" : "#/components/schemas/LiveNotificationActionStatusEnum" } } }, - "Policy_DeleteDoorPolicyWSResponse" : { + "LiveNotificationActionStatusEnum" : { + "type" : "string", + "enum" : [ "SUCCESS", "ERROR", "IGNORED", "MUTED", "BACKOFF", "UNKNOWN" ] + }, + "LocalDateTimeIntervalType" : { "type" : "object", - "description" : "Response object for deleting a door sensor policy.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "localEndDateTime" : { "type" : "string", + "description" : "Interval end time in 'yyyy-MM-ddTHH:mm:ss' format. Interval end time is exclusive.", "nullable" : true }, - "warningMsg" : { + "localStartDateTime" : { "type" : "string", + "description" : "Interval start time in 'yyyy-MM-ddTHH:mm:ss' format. Interval start time is inclusive.", "nullable" : true } - } + }, + "required" : [ "localEndDateTime", "localStartDateTime" ] }, - "Policy_DeleteLocationPolicyAddendumWSRequest" : { + "LocalInterval" : { "type" : "object", - "description" : "Request object for deleting a location policy addendum.", + "description" : "List of intervals each specifying door state during date range. List must contain at least one element", "properties" : { - "uuid" : { + "localEndDateTime" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Policy_DeleteLocationPolicyAddendumWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a location policy addendum.", - "properties" : { - "error" : { - "type" : "boolean", + "description" : "Interval end time in 'yyyy-MM-ddTHH:mm:ss' format. Interval end time is exclusive.", "nullable" : true }, - "errorMsg" : { + "localStartDateTime" : { "type" : "string", + "description" : "Interval start time in 'yyyy-MM-ddTHH:mm:ss' format. Interval start time is inclusive.", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "state" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" } - } + }, + "required" : [ "localEndDateTime", "localStartDateTime", "state" ] }, - "Policy_DeleteOccupancyPolicyWSRequest" : { + "LocationALMConfig" : { "type" : "object", - "description" : "Request object for deleting an occupancy policy.", + "allOf" : [ { + "type" : "object", + "properties" : { + "acceptedTermsOfService" : { + "type" : "boolean", + "description" : "Indication of whether the org accepted the terms of service for alarm monitoring at this location.\n", + "nullable" : true + }, + "defaultEmergencyContact" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, + "mode" : { + "$ref" : "#/components/schemas/MonitoringModeEnum" + }, + "talkdownEnabled" : { + "type" : "boolean", + "description" : "Indication of whether talk-down is enabled for this location.", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "policyUuid" : { + "deleted" : { + "type" : "boolean", + "description" : "Indication of whether this config was deleted.", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Policy_DeleteOccupancyPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for deleting an occupancy policy.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "type" : { + "$ref" : "#/components/schemas/TypeEnum" + }, + "versionInfo" : { + "$ref" : "#/components/schemas/ALMModificationMetadata" + }, + "zoneId" : { "type" : "string", "nullable" : true } - } + }, + "required" : [ "locationUuid" ] }, - "Policy_DeletePolicyPauseSettingWSRequest" : { + "LocationAccessControlGuestPass" : { "type" : "object", - "description" : "Request object for deleting a policy pause setting.", + "discriminator" : { + "propertyName" : "principalType" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/PlainLocationAccessControlGuestPass" + }, { + "$ref" : "#/components/schemas/RhombusGuestLocationAccessControlGuestPass" + } ], "properties" : { - "uuid" : { + "accessPeriods" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/LocationGuestPassAccessPeriod" + }, + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lifecycle" : { + "$ref" : "#/components/schemas/LocationGuestPassLifecycleEnum" + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Policy_DeletePolicyPauseSettingWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a policy pause setting.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "note" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Policy_DeleteProximityPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a proximity policy.", - "properties" : { - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Policy_DeleteProximityPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a proximity policy.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "passStartTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "principalType" : { + "$ref" : "#/components/schemas/LocationGuestPassPrincipalTypeEnum" + }, + "reconciledAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "reconciledVersion" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Policy_DeleteScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a schedule used for policy creation.", - "properties" : { - "scheduleUuid" : { + }, + "sortKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "readOnly" : true + }, + "stampVersion" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Policy_DeleteScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a schedule.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "stampedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_DeleteVideoIntercomPolicyWSRequest" : { + "LocationAccessGrantType" : { "type" : "object", - "description" : "Request object for deleting a video intercom policy.", + "description" : "The access grant to update", "properties" : { - "policyUuid" : { + "accessControlledDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "doorLabelIds" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "groupUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationGuestPassUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Policy_DeleteVideoIntercomPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a video intercom policy.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "mode" : { + "$ref" : "#/components/schemas/AccessGrantModeEnum" + }, + "name" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policyUuid" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "sortKey" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "storedInS3" : { + "type" : "boolean", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_ExternalAudioPolicyType" : { + "LocationAccessRevocationType" : { "type" : "object", - "description" : "List of audio policies in the organization", + "description" : "The access revocation to update", "properties" : { - "defaultTriggers" : { + "accessControlledDoorUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Policy_ExternalAudioTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "description" : { + "accessControlledElevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "doorLabelIds" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "groupUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { @@ -114334,12 +116638,38 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "sortKey" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "storedInS3" : { + "type" : "boolean", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Policy_ExternalAudioScheduledTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, "uuid" : { "type" : "string", @@ -114350,41 +116680,82 @@ } } }, - "Policy_ExternalAudioScheduledTriggerType" : { + "LocationFirstInSettings" : { "type" : "object", + "description" : "The updated location first-in settings.", "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "triggerSet" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "doorAuthFirstInOutOfSync" : { + "type" : "boolean", + "nullable" : true + }, + "doorAuthFirstInState" : { + "$ref" : "#/components/schemas/FirstInState" + }, + "doorAuthRequirementEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "doorScheduleFirstInOutOfSync" : { + "type" : "boolean", + "nullable" : true + }, + "doorScheduleFirstInState" : { + "$ref" : "#/components/schemas/FirstInState" + }, + "doorScheduleRequirementEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "doorUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Policy_ExternalAudioTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true - } - } - }, - "Policy_ExternalAudioTriggerType" : { - "type" : "object", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" }, - "threshold" : { - "type" : "number", - "format" : "float", - "nullable" : true - } - } - }, - "Policy_ExternalVideoIntercomPolicyType" : { - "type" : "object", - "description" : "List of video intercom policies in the organization", - "properties" : { - "description" : { + "elevatorLandingUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "groupUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "name" : { @@ -114398,257 +116769,467 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { + "resets" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomScheduledTriggerType" + "$ref" : "#/components/schemas/BaseFirstInReset" }, "nullable" : true }, - "uuid" : { + "settingsUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Policy_ExternalVideoIntercomScheduledTriggerType" : { - "type" : "object", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, - "triggerSet" : { + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, - "Policy_ExternalVideoIntercomTriggerType" : { + "LocationFunctionalityEnum" : { + "type" : "string", + "description" : "Location functionality enum for exposing to OpenAPI component schemas", + "enum" : [ "ACCESS_CONDITIONS", "ACCESS_SCHEDULES", "CCS_VISIBLE", "DOOR_SETTINGS", "FIRST_IN_SETTINGS", "GUEST_PASSES", "HARDWARE_CONFIG", "LOCKDOWN_MANAGEMENT", "REMOTE_UNLOCK", "UNKNOWN" ] + }, + "LocationGuestPassAccessPeriod" : { "type" : "object", "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" + "absoluteIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" + }, + "nullable" : true }, - "faceAlertLabelSet" : { + "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "faceAlertUnidentified" : { - "type" : "boolean", - "nullable" : true - }, - "faceAllowedLabelSet" : { + "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "lufsThreshold" : { - "type" : "number", - "format" : "float", + "intervalSource" : { + "$ref" : "#/components/schemas/GuestPassIntervalSourceEnum" + }, + "localIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LocalDateTimeIntervalType" + }, "nullable" : true }, - "peopleCountThreshold" : { - "type" : "integer", - "format" : "int32", + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "LocationGuestPassAccessPeriodUpdate" : { + "type" : "object", + "properties" : { + "absoluteIntervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbsoluteSecondsIntervalType" + }, "nullable" : true }, - "vehicleAlertLabelSet" : { + "accessControlledDoorUuids" : { "type" : "array", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "vehicleAlertUnidentified" : { - "type" : "boolean", - "nullable" : true - }, - "vehicleAllowedLabelSet" : { + "accessControlledElevatorLandingUuids" : { "type" : "array", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true, "uniqueItems" : true - } - } - }, - "Policy_FindSchedulesWSRequest" : { - "type" : "object", - "description" : "Request object for finding all schedules in the organization." - }, - "Policy_FindSchedulesWSResponse" : { - "type" : "object", - "description" : "Response object containing all schedules in the organization.", - "properties" : { - "error" : { + }, + "delete" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "intervalSource" : { + "$ref" : "#/components/schemas/GuestPassIntervalSourceEnum" }, - "schedules" : { + "localIntervals" : { "type" : "array", - "description" : "List of schedules in the organization", "items" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "$ref" : "#/components/schemas/LocalDateTimeIntervalType" }, "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_GetAccessControlledDoorPoliciesWSRequest" : { + "LocationGuestPassLifecycleEnum" : { + "type" : "string", + "enum" : [ "ACTIVE", "SUSPENDED", "EXPIRED", "ARCHIVED" ] + }, + "LocationGuestPassPrincipalTypeEnum" : { + "type" : "string", + "enum" : [ "PLAIN", "RHOMBUS_GUEST_MANAGEMENT" ] + }, + "LocationLockdownActivatedRuleTriggerType" : { "type" : "object", - "description" : "Request object for getting all access controlled door policies in the organization." + "allOf" : [ { + "type" : "object", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lockdownPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } }, - "Policy_GetAccessControlledDoorPoliciesWSResponse" : { + "LocationLockdownDeactivatedRuleTriggerType" : { "type" : "object", - "description" : "Response object containing all access controlled door policies in the organization.", + "allOf" : [ { + "type" : "object", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lockdownPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "LocationLockdownPlanType" : { + "type" : "object", + "description" : "The updated location lockdown plan.", + "properties" : { + "activationPlan" : { + "$ref" : "#/components/schemas/LockdownActivationPlanType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "deactivationPlan" : { + "$ref" : "#/components/schemas/LockdownDeactivationPlanType" + }, + "defaultLockdownState" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "doorLockdownStateMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "nullable" : true + }, + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policies" : { - "type" : "array", - "description" : "List of access controlled door policies in the organization", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorPolicyType" - }, + "name" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "physicalAccess" : { + "$ref" : "#/components/schemas/LockdownPhysicalAccessType" + }, + "scopeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "testPlan" : { + "$ref" : "#/components/schemas/LockdownTestPlanType" + }, + "type" : { + "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_GetAudioPoliciesWSRequest" : { - "type" : "object", - "description" : "Request object for getting all audio policies in the organization." + "LocationLockdownStateEnumType" : { + "type" : "string", + "enum" : [ "STANDARD_SECURITY", "LOCKED_DOWN" ] }, - "Policy_GetAudioPoliciesWSResponse" : { + "LocationLockdownStateType" : { "type" : "object", - "description" : "Response object containing all audio policies in the organization.", + "description" : "The lockdown state for the location.", "properties" : { - "error" : { + "activeLockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, + "nullable" : true, + "uniqueItems" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "followingTestPlan" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "policies" : { - "type" : "array", - "description" : "List of audio policies in the organization", - "items" : { - "$ref" : "#/components/schemas/Policy_ExternalAudioPolicyType" - }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "state" : { + "$ref" : "#/components/schemas/LocationLockdownStateEnumType" + }, + "stateChangedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Policy_GetCameraPoliciesWSRequest" : { + "LocationSettings" : { "type" : "object", - "description" : "Request object for getting all camera policies in the organization." + "nullable" : true, + "properties" : { + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "printBadge" : { + "type" : "boolean", + "nullable" : true + } + } }, - "Policy_GetCameraPoliciesWSResponse" : { + "LocationType" : { "type" : "object", - "description" : "Response object containing all camera policies in the organization.", + "description" : "Location information to update", "properties" : { - "error" : { - "type" : "boolean", + "address1" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "address2" : { "type" : "string", "nullable" : true }, - "policies" : { + "countryCode" : { + "type" : "string", + "nullable" : true + }, + "floorPlans" : { "type" : "array", - "description" : "List of camera policies in the organization", "items" : { - "$ref" : "#/components/schemas/CameraPolicyV2Type" + "$ref" : "#/components/schemas/FloorPlanType" }, "nullable" : true }, - "warningMsg" : { + "labels" : { + "type" : "array", + "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", + "items" : { + "type" : "string", + "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", + "nullable" : true + }, + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "name" : { "type" : "string", + "description" : "Name of this location", "nullable" : true - } - } - }, - "Policy_GetClimatePoliciesWSRequest" : { - "type" : "object", - "description" : "Request object for getting all climate policies in the organization." - }, - "Policy_GetClimatePoliciesWSResponse" : { - "type" : "object", - "description" : "Response object containing all climate policies in the organization.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "postalCode" : { "type" : "string", "nullable" : true }, - "policies" : { + "subLocations" : { "type" : "array", - "description" : "List of climate policies in the organization", "items" : { - "$ref" : "#/components/schemas/ClimatePolicyType" + "$ref" : "#/components/schemas/LocationType" }, + "nullable" : true, + "uniqueItems" : true + }, + "tz" : { + "type" : "string", + "description" : "Timezone for this location", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_GetDoorPoliciesWSRequest" : { + "Location_AddLocationLabelWSRequest" : { "type" : "object", - "description" : "Request object for getting all door sensor policies in the organization." + "description" : "Request object for adding a label to a location.", + "properties" : { + "label" : { + "type" : "string", + "description" : "Label to add to the location", + "nullable" : true + }, + "locationIdentifier" : { + "type" : "string", + "description" : "Location identifier (name or ID)", + "nullable" : true + } + } }, - "Policy_GetDoorPoliciesWSResponse" : { + "Location_AddLocationLabelWSResponse" : { "type" : "object", - "description" : "Response object containing all door sensor policies in the organization.", + "description" : "Response object for adding a label to a location.", "properties" : { "error" : { "type" : "boolean", @@ -114658,27 +117239,31 @@ "type" : "string", "nullable" : true }, - "policies" : { - "type" : "array", - "description" : "List of door sensor policies in the organization", - "items" : { - "$ref" : "#/components/schemas/DoorPolicyType" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Policy_GetOccupancyPoliciesWSRequest" : { + "Location_CreateLocationWSRequest" : { "type" : "object", - "description" : "Request object for getting all occupancy policies in the organization." + "description" : "Request object for creating a location.", + "properties" : { + "location" : { + "$ref" : "#/components/schemas/LocationType" + }, + "parentLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } }, - "Policy_GetOccupancyPoliciesWSResponse" : { + "Location_CreateLocationWSResponse" : { "type" : "object", - "description" : "Response object containing all occupancy policies in the organization.", + "description" : "Response object for creating a location.", "properties" : { "error" : { "type" : "boolean", @@ -114688,12 +117273,11 @@ "type" : "string", "nullable" : true }, - "policies" : { - "type" : "array", - "description" : "List of occupancy policies in the organization", - "items" : { - "$ref" : "#/components/schemas/OccupancyPolicyType" - }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "warningMsg" : { @@ -114702,11 +117286,11 @@ } } }, - "Policy_GetPoliciesUsingScheduleWSRequest" : { + "Location_DeleteLocationWSRequest" : { "type" : "object", - "description" : "Request object for getting all policies that use a specific schedule.", + "description" : "Request object for removing a location.", "properties" : { - "scheduleUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -114715,50 +117299,10 @@ } } }, - "Policy_GetPoliciesUsingScheduleWSResponse" : { + "Location_DeleteLocationWSResponse" : { "type" : "object", - "description" : "Response object containing all policies that use a specific schedule, organized by policy type.", + "description" : "Response object for removing a location.", "properties" : { - "accessControlledDoorPolicyList" : { - "type" : "array", - "description" : "List of access controlled door policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/AccessControlledDoorPolicyType" - }, - "nullable" : true - }, - "audioPolicyList" : { - "type" : "array", - "description" : "List of audio policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/AudioPolicyType" - }, - "nullable" : true - }, - "cameraPolicyList" : { - "type" : "array", - "description" : "List of camera policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/CameraPolicyV2Type" - }, - "nullable" : true - }, - "climatePolicyList" : { - "type" : "array", - "description" : "List of climate policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/ClimatePolicyType" - }, - "nullable" : true - }, - "doorPolicyList" : { - "type" : "array", - "description" : "List of door sensor policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/DoorPolicyType" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -114767,91 +117311,66 @@ "type" : "string", "nullable" : true }, - "occupancyPolicyList" : { - "type" : "array", - "description" : "List of occupancy policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/OccupancyPolicyType" - }, - "nullable" : true - }, - "proximityPolicyList" : { - "type" : "array", - "description" : "List of proximity policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/ProximityPolicyType" - }, - "nullable" : true - }, - "videoIntercomPolicyList" : { - "type" : "array", - "description" : "List of video intercom policies using the schedule", - "items" : { - "$ref" : "#/components/schemas/VideoIntercomPolicyType" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Policy_GetPolicyAddendumsWSRequest" : { - "type" : "object", - "description" : "Request object for getting policy addendums." - }, - "Policy_GetPolicyAddendumsWSResponse" : { + "Location_FloorPlanWallsWSType" : { "type" : "object", - "description" : "Response object containing policy addendums for devices and locations.", + "description" : "Walls detected in a floor plan image, as axis-aligned rectangles in image pixels.", "properties" : { - "deviceAddendumsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device UUIDs to their policy addendum scheduled intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of device UUIDs to their policy addendum scheduled intervals", + "imageHeight" : { + "type" : "integer", + "format" : "int32", + "description" : "Height in pixels of the image the walls were detected in", "nullable" : true }, - "error" : { - "type" : "boolean", + "imageWidth" : { + "type" : "integer", + "format" : "int32", + "description" : "Width in pixels of the image the walls were detected in", "nullable" : true }, - "errorMsg" : { + "model" : { "type" : "string", + "description" : "Model that detected the walls", "nullable" : true }, - "locationAddendumsMap" : { - "type" : "object", - "additionalProperties" : { + "wallRects" : { + "type" : "array", + "description" : "Wall rectangles as [x0, y0, x1, y1] image pixels, end-exclusive", + "items" : { "type" : "array", - "description" : "Map of location UUIDs to their policy addendum scheduled intervals", + "description" : "Wall rectangles as [x0, y0, x1, y1] image pixels, end-exclusive", "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" + "type" : "integer", + "format" : "int32", + "description" : "Wall rectangles as [x0, y0, x1, y1] image pixels, end-exclusive", + "nullable" : true }, "nullable" : true }, - "description" : "Map of location UUIDs to their policy addendum scheduled intervals", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", "nullable" : true } } }, - "Policy_GetPolicyPauseSettingsWSRequest" : { + "Location_GeoCodeWSRequest" : { "type" : "object", - "description" : "Request object for getting policy pause settings." + "description" : "Request object for getting the latitude and longitude of an address.", + "properties" : { + "address" : { + "type" : "string", + "description" : "Address to geocode", + "example" : "1600 Pennsylvania Avenue NW, Washington, DC", + "nullable" : true + } + } }, - "Policy_GetPolicyPauseSettingsWSResponse" : { + "Location_GeoCodeWSResponse" : { "type" : "object", - "description" : "Response object containing policy pause settings for locations, devices, and component composites.", + "description" : "Response object containing the latitude and longitude of an address.", "properties" : { "error" : { "type" : "boolean", @@ -114861,43 +117380,18 @@ "type" : "string", "nullable" : true }, - "policiesPausedForComponentCompositesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of component composite UUIDs to their paused policy scheduled intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of component composite UUIDs to their paused policy scheduled intervals", - "nullable" : true - }, - "policiesPausedForDevicesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device UUIDs to their paused policy scheduled intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of device UUIDs to their paused policy scheduled intervals", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the address", + "example" : 38.8977, "nullable" : true }, - "policiesPausedForLocationsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of location UUIDs to their paused policy scheduled intervals", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of location UUIDs to their paused policy scheduled intervals", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the address", + "example" : -77.0365, "nullable" : true }, "warningMsg" : { @@ -114906,13 +117400,23 @@ } } }, - "Policy_GetProximityPoliciesWSRequest" : { + "Location_GetFloorPlanWallsWSRequest" : { "type" : "object", - "description" : "Request object for getting all proximity policies in the organization." + "description" : "Request object for getting the detected walls of a floor plan image.", + "properties" : { + "floorPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "floorPlanUuid" ] }, - "Policy_GetProximityPoliciesWSResponse" : { + "Location_GetFloorPlanWallsWSResponse" : { "type" : "object", - "description" : "Response object containing all proximity policies in the organization.", + "description" : "Response object containing the detected walls of a floor plan image.", "properties" : { "error" : { "type" : "boolean", @@ -114922,27 +117426,29 @@ "type" : "string", "nullable" : true }, - "policies" : { - "type" : "array", - "description" : "List of proximity policies in the organization", - "items" : { - "$ref" : "#/components/schemas/ProximityPolicyType" - }, + "floorPlanUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "walls" : { + "$ref" : "#/components/schemas/Location_FloorPlanWallsWSType" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Policy_GetVideoIntercomPoliciesWSRequest" : { + "Location_GetLocationLabelsForOrgWSRequest" : { "type" : "object", - "description" : "Request object for getting all video intercom policies in the organization." + "description" : "Request object for getting all location labels for an organization." }, - "Policy_GetVideoIntercomPoliciesWSResponse" : { + "Location_GetLocationLabelsForOrgWSResponse" : { "type" : "object", - "description" : "Response object containing all video intercom policies in the organization.", + "description" : "Response object containing all location labels for an organization.", "properties" : { "error" : { "type" : "boolean", @@ -114952,12 +117458,20 @@ "type" : "string", "nullable" : true }, - "policies" : { - "type" : "array", - "description" : "List of video intercom policies in the organization", - "items" : { - "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomPolicyType" + "locationLabels" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of location name or location id to label set", + "items" : { + "type" : "string", + "description" : "Map of location name or location id to label set", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, + "description" : "Map of location name or location id to label set", "nullable" : true }, "warningMsg" : { @@ -114966,588 +117480,453 @@ } } }, - "Policy_MinimalAccessControlledDoorPolicyType" : { + "Location_GetLocationWSRequest" : { "type" : "object", - "description" : "Updated access controlled door policy configuration", + "description" : "Request object for getting location by ID.", "properties" : { - "description" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { - "type" : "string", + "subLocationsRequired" : { + "type" : "boolean", + "description" : "Whether sub-locations are required in the response", + "example" : false, + "nullable" : true + } + }, + "required" : [ "locationUuid" ] + }, + "Location_GetLocationWSResponse" : { + "type" : "object", + "description" : "Response object containing location information.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_MinimalAccessControlledDoorScheduledTriggerType" - }, - "nullable" : true + "location" : { + "$ref" : "#/components/schemas/LocationType" }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_MinimalAccessControlledDoorScheduledTriggerType" : { + "Location_GetLocationsByGeoRequest" : { "type" : "object", + "description" : "Request object for getting list of locations given latitude and longitude.", "properties" : { - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate", + "example" : 37.7749, "nullable" : true }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate", + "example" : -122.4194, + "nullable" : true } } }, - "Policy_MinimalAudioPolicyType" : { + "Location_GetLocationsByGeoResponse" : { "type" : "object", - "description" : "Updated audio policy configuration", + "description" : "Response object containing list of locations given latitude and longitude.", "properties" : { - "description" : { - "type" : "string", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "scheduledTriggers" : { + "locations" : { "type" : "array", + "description" : "Collection of locations found at the specified coordinates", "items" : { - "$ref" : "#/components/schemas/Policy_MinimalAudioScheduledTriggerType" + "$ref" : "#/components/schemas/LocationType" }, "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true } } }, - "Policy_MinimalAudioScheduledTriggerType" : { + "Location_GetLocationsBySubLocationsHierarchyKeyWSRequest" : { "type" : "object", + "description" : "Request object for getting nested locations by subLocationHierarchyKey.", "properties" : { - "scheduleUuid" : { + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_ExternalAudioTriggerType" - }, + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "uniqueItems" : true + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, - "Policy_MinimalCameraPolicyV2Type" : { + "Location_GetLocationsBySubLocationsHierarchyKeyWSResponse" : { "type" : "object", - "description" : "Updated camera policy configuration", + "description" : "Response object containing nested locations by subLocationHierarchyKey.", "properties" : { - "description" : { - "type" : "string", - "nullable" : true - }, - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_MinimalCameraScheduledTriggerType" - }, - "nullable" : true + "location" : { + "$ref" : "#/components/schemas/LocationType" }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_MinimalCameraScheduledTriggerType" : { + "Location_GetLocationsV2WSRequest" : { "type" : "object", + "description" : "Request object for getting list of locations in organization with pagination support.", "properties" : { - "scheduleUuid" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CameraTriggerType" - }, - "nullable" : true, - "uniqueItems" : true + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nameBeginsWithFilter" : { + "type" : "string", + "nullable" : true } } }, - "Policy_MinimalClimatePolicyType" : { + "Location_GetLocationsV2WSResponse" : { "type" : "object", - "description" : "Updated climate policy configuration", + "description" : "Response object containing list of locations in organization with pagination support.", "properties" : { - "backoffAlertSecs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "nullable" : true - }, - "description" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "lastEvaluatedKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { + "locations" : { "type" : "array", + "description" : "List of locations in the organization", "items" : { - "$ref" : "#/components/schemas/Policy_MinimalClimateScheduledTriggerType" + "$ref" : "#/components/schemas/LocationType" }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_MinimalClimateScheduledTriggerType" : { + "Location_GetLocationsWSRequest" : { "type" : "object", + "description" : "Request object for getting list of locations in organization.", "properties" : { - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "subLocationsIncluded" : { + "type" : "boolean", + "description" : "Whether to include sub-locations in the response", + "example" : false, "nullable" : true - }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ClimateTriggerType" - }, - "nullable" : true, - "uniqueItems" : true } } }, - "Policy_MinimalDoorPolicyType" : { + "Location_GetLocationsWSResponse" : { "type" : "object", - "description" : "Updated door sensor policy configuration", + "description" : "Response object containing list of locations in organization.", "properties" : { - "description" : { - "type" : "string", - "nullable" : true - }, - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { + "locations" : { "type" : "array", + "description" : "List of locations in the organization", "items" : { - "$ref" : "#/components/schemas/Policy_MinimalDoorScheduledTriggerType" + "$ref" : "#/components/schemas/LocationType" }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_MinimalDoorScheduledTriggerType" : { + "Location_QualifiedAddressTypeWithValidation" : { "type" : "object", + "description" : "Qualified address with validation information", "properties" : { - "ajarThresholdSec" : { - "type" : "integer", - "format" : "int32", + "addressComplete" : { + "type" : "boolean", "nullable" : true }, - "scheduleUuid" : { + "addressLine2" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "apt, suite, or unit", "nullable" : true }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Policy_MinimalOccupancyPolicyType" : { - "type" : "object", - "description" : "Updated occupancy policy configuration", - "properties" : { - "description" : { + "addressline1" : { "type" : "string", + "description" : "street address", "nullable" : true }, - "name" : { + "administrativeArea" : { "type" : "string", + "description" : "state", "nullable" : true }, - "orgUuid" : { + "locality" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "city", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_MinimalOccupancyScheduledTriggerType" - }, + "postalCode" : { + "type" : "string", + "description" : "zip code", "nullable" : true }, - "uuid" : { + "regionCode" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "country", + "nullable" : true + }, + "validatedAddressline1" : { + "type" : "boolean", + "nullable" : true + }, + "validatedAdminestrativeArea" : { + "type" : "boolean", + "nullable" : true + }, + "validatedLocality" : { + "type" : "boolean", + "nullable" : true + }, + "validatedPostalCode" : { + "type" : "boolean", + "nullable" : true + }, + "validatedRegionCode" : { + "type" : "boolean", + "nullable" : true + }, + "validatedSubpremise" : { + "type" : "boolean", "nullable" : true } } }, - "Policy_MinimalOccupancyScheduledTriggerType" : { + "Location_RefreshFloorPlanWallsWSRequest" : { "type" : "object", + "description" : "Request object for re-detecting and storing the walls of a floor plan image.", "properties" : { - "occupancyThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "scheduleUuid" : { + "floorPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "nullable" : true, - "uniqueItems" : true - }, - "vacancyThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } - } + }, + "required" : [ "floorPlanUuid" ] }, - "Policy_MinimalProximityPolicyType" : { + "Location_RefreshFloorPlanWallsWSResponse" : { "type" : "object", - "description" : "Updated proximity policy configuration", + "description" : "Response object containing the newly detected walls of a floor plan image.", "properties" : { - "description" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "name" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "floorPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_MinimalProximityScheduledTriggerType" - }, - "nullable" : true + "walls" : { + "$ref" : "#/components/schemas/Location_FloorPlanWallsWSType" }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_MinimalProximityScheduledTriggerType" : { + "Location_RemoveLocationLabelWSRequest" : { "type" : "object", + "description" : "Request object for removing a label from a location.", "properties" : { - "departureThresholdSec" : { - "type" : "integer", - "format" : "int32", + "label" : { + "type" : "string", + "description" : "Label to remove from the location", "nullable" : true }, - "scheduleUuid" : { + "locationIdentifier" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Location identifier (name or ID)", "nullable" : true - }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ProximityTriggerType" - }, - "nullable" : true, - "uniqueItems" : true } } }, - "Policy_MinimalVideoIntercomPolicyType" : { + "Location_RemoveLocationLabelWSResponse" : { "type" : "object", - "description" : "Updated video intercom policy configuration", + "description" : "Response object for removing a label from a location.", "properties" : { - "description" : { - "type" : "string", - "nullable" : true - }, - "name" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "scheduledTriggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_MinimalVideoIntercomScheduledTriggerType" - }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Policy_MinimalVideoIntercomScheduledTriggerType" : { + "Location_SelectiveUpdateLocationWSRequest" : { "type" : "object", + "description" : "Request object for selectively updating a location.", "properties" : { - "scheduleUuid" : { + "address1" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "First line of the address", "nullable" : true }, - "triggerSet" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomTriggerType" - }, - "nullable" : true, - "uniqueItems" : true - } - } - }, - "Policy_PauseAlertPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for pausing alert policies for specified locations, devices, and components.", - "properties" : { - "componentCompositeUuids" : { + "address2" : { + "type" : "string", + "description" : "Second line of the address", + "nullable" : true + }, + "countryCode" : { + "type" : "string", + "description" : "Country code of the location", + "nullable" : true + }, + "floorPlans" : { "type" : "array", - "description" : "List of component composite UUIDs to pause alert policies for", + "description" : "Floor plans for the location", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/FloorPlanType" }, "nullable" : true }, - "deviceUuids" : { + "labels" : { "type" : "array", - "description" : "List of device UUIDs to pause alert policies for", + "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Labels offer a way to perform operations across multiple locations if they have the same label", "nullable" : true }, "nullable" : true }, - "durationSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration in seconds to pause alert policies", - "example" : 3600, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the location", "nullable" : true }, - "locationUuids" : { - "type" : "array", - "description" : "List of location UUIDs to pause alert policies for", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTimestampSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Scheduled timestamp in seconds for when to pause alert policies", - "example" : 1640995200, - "nullable" : true - } - } - }, - "Policy_PauseAlertPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for pausing alert policies.", - "properties" : { - "error" : { - "type" : "boolean", + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the location", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", + "description" : "Name of this location", "nullable" : true }, - "warningMsg" : { + "policyUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Policy_UpdateAccessControlledDoorPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating an access controlled door policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalAccessControlledDoorPolicyType" - } - } - }, - "Policy_UpdateAccessControlledDoorPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for updating an access controlled door policy.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "postalCode" : { "type" : "string", + "description" : "Postal code of the location", "nullable" : true }, - "warningMsg" : { + "timezoneId" : { "type" : "string", + "description" : "Timezone identifier, e.g. America/Los_Angeles, EST, GMT+0, etc.", "nullable" : true + }, + "tz" : { + "type" : "object", + "description" : "Use timezoneId field instead", + "nullable" : true, + "properties" : { + "displayName" : { + "type" : "string", + "nullable" : true + }, + "dstsavings" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "rawOffset" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } } - } - }, - "Policy_UpdateAudioPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating an audio policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalAudioPolicyType" - } - } + }, + "required" : [ "locationUuid" ] }, - "Policy_UpdateAudioPolicyWSResponse" : { + "Location_SelectiveUpdateLocationWSResponse" : { "type" : "object", - "description" : "Response object for updating an audio policy.", + "description" : "Response object for selectively updating a location.", + "nullable" : true, "properties" : { "error" : { "type" : "boolean", @@ -115563,18 +117942,18 @@ } } }, - "Policy_UpdateCameraPolicyWSRequest" : { + "Location_UpdateLocationWSRequest" : { "type" : "object", - "description" : "Request object for updating a camera policy.", + "description" : "Request object for updating a location. NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation.", "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalCameraPolicyV2Type" + "location" : { + "$ref" : "#/components/schemas/LocationType" } } }, - "Policy_UpdateCameraPolicyWSResponse" : { + "Location_UpdateLocationWSResponse" : { "type" : "object", - "description" : "Response object for updating a camera policy.", + "description" : "Response object for updating a location.", "properties" : { "error" : { "type" : "boolean", @@ -115590,99 +117969,53 @@ } } }, - "Policy_UpdateClimatePolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating a climate policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalClimatePolicyType" - } - } - }, - "Policy_UpdateClimatePolicyWSResponse" : { + "Location_ValidateAndUpdateLocationAddressWSRequest" : { "type" : "object", - "description" : "Response object for updating a climate policy.", "properties" : { - "error" : { - "type" : "boolean", + "address1" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "address2" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "administrativeArea" : { "type" : "string", "nullable" : true - } - } - }, - "Policy_UpdateDoorPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating a door sensor policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalDoorPolicyType" - } - } - }, - "Policy_UpdateDoorPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for updating a door sensor policy.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "countryCode" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "locality" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Policy_UpdateOccupancyPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating an occupancy policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalOccupancyPolicyType" - } - } - }, - "Policy_UpdateOccupancyPolicyWSResponse" : { - "type" : "object", - "description" : "Response object for updating an occupancy policy.", - "properties" : { - "error" : { + }, + "overrideAllValidation" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "overrideMissingSubPremise" : { + "type" : "boolean", "nullable" : true }, - "warningMsg" : { + "postalCode" : { "type" : "string", "nullable" : true } } }, - "Policy_UpdateProximityPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating a proximity policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalProximityPolicyType" - } - } - }, - "Policy_UpdateProximityPolicyWSResponse" : { + "Location_ValidateAndUpdateLocationAddressWSResponse" : { "type" : "object", - "description" : "Response object for updating a proximity policy.", + "description" : "Response object for validating and updating a location address for Alarm Monitoring.", "properties" : { "error" : { "type" : "boolean", @@ -115692,32 +118025,15 @@ "type" : "string", "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", - "nullable" : true - } - } - }, - "Policy_UpdateScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for updating a schedule used for policy creation.", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - } - } - }, - "Policy_UpdateScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for updating a schedule.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "qualifiedAddress" : { + "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" }, "warningMsg" : { "type" : "string", @@ -115725,485 +118041,245 @@ } } }, - "Policy_UpdateVideoIntercomPolicyWSRequest" : { - "type" : "object", - "description" : "Request object for updating a video intercom policy.", - "properties" : { - "policy" : { - "$ref" : "#/components/schemas/Policy_MinimalVideoIntercomPolicyType" - } - } - }, - "Policy_UpdateVideoIntercomPolicyWSResponse" : { + "Location_ValidateLocationAddressV2WSRequest" : { "type" : "object", - "description" : "Response object for updating a video intercom policy.", "properties" : { - "error" : { - "type" : "boolean", + "address1" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "address2" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "administrativeArea" : { "type" : "string", "nullable" : true - } - } - }, - "PortSupervisionConfigurationType" : { - "type" : "object", - "properties" : { - "mode" : { - "$ref" : "#/components/schemas/SupervisionModeEnumType" - } - } - }, - "PosIntegrationInfoType" : { - "type" : "object", - "description" : "A HashMap of . This stores the Pos Information and assigned cameras.", - "properties" : { - "assignedCameraList" : { - "type" : "array", - "description" : "A list of camera guids from Rhombus that are assigned to the Pos device.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true }, - "posName" : { + "countryCode" : { "type" : "string", - "description" : "The name of the Pos device.", - "nullable" : true - } - } - }, - "Pose" : { - "type" : "object", - "properties" : { - "orientation" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "description" : "Serialized as [x, y, z, w]" - }, - "maxItems" : 4, - "minItems" : 4, "nullable" : true }, - "position" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "description" : "Serialized as [x, y, z]" - }, - "maxItems" : 3, - "minItems" : 3, - "nullable" : true - } - } - }, - "PressureSensorType" : { - "type" : "object", - "properties" : { - "pressure" : { - "type" : "number", - "format" : "float", + "locality" : { + "type" : "string", "nullable" : true }, - "tempC" : { - "type" : "number", - "format" : "float", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", + "postalCode" : { + "type" : "string", "nullable" : true } } }, - "PrincipalUuidEnum" : { - "type" : "string", - "enum" : [ "USER", "DEVICE", "PARTNER", "RHOMBUS_SUPPORT", "API_TOKEN", "API_OAUTH_TOKEN", "PARTNER_API_OAUTH_TOKEN", "SHARED_CLIP", "SHARED_STREAM", "SHARED_TIMELAPSE", "SHARED_VIDEOWALL", "KIOSK_CONSOLE", "UNKNOWN" ] - }, - "ProDataKeySettings" : { + "Location_ValidateLocationAddressV2WSResponse" : { "type" : "object", + "description" : "Response object for validating and updating a location address for Alarm Monitoring.", "properties" : { - "alertUnauthorizedFaces" : { + "acceptable" : { "type" : "boolean", "nullable" : true }, - "badgeAuthDisablesAlarmMonitoring" : { + "acceptableExceptingSubPremise" : { "type" : "boolean", "nullable" : true }, - "createSeekPoints" : { + "acceptableIfOverridden" : { "type" : "boolean", "nullable" : true }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "doorsValidated" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "enabled" : { + "hasChangedElements" : { "type" : "boolean", - "nullable" : true + "nullable" : true, + "writeOnly" : true }, - "enabledTimestampMs" : { - "type" : "integer", - "format" : "int64", + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "enablingUser" : { + "qualifiedAddress" : { + "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" + }, + "warningMsg" : { "type" : "string", "nullable" : true - }, - "enablingUserUuid" : { + } + } + }, + "Location_ValidateLocationWSRequest" : { + "type" : "object", + "description" : "Request object for validating a location address for Alarm Monitoring.", + "properties" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "identifyFacesFromBadge" : { + } + } + }, + "Location_ValidateLocationWSResponse" : { + "type" : "object", + "description" : "Response object for validating a location address for Alarm Monitoring.", + "properties" : { + "acceptable" : { "type" : "boolean", "nullable" : true }, - "misconfiguredDoors" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "ouId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "rhombusToken" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "webhookId" : { - "type" : "string", - "nullable" : true + "qualifiedAddress" : { + "$ref" : "#/components/schemas/Location_QualifiedAddressTypeWithValidation" }, - "webhookSignatureSecret" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "ProDataKeyType" : { + "LockdownActivatedStateEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "apiToken" : { - "type" : "string", - "nullable" : true - }, - "badgeAuthDisablesAlarmMonitoring" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "doorInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + "activatedLockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, - "doorsValidated" : { - "type" : "boolean", - "nullable" : true - }, - "identifyFacesFromBadge" : { - "type" : "boolean", - "nullable" : true - }, - "indexFaces" : { - "type" : "boolean", - "nullable" : true - }, - "misconfiguredDoors" : { + "activeLockdownPlans" : { "type" : "array", "items" : { - "type" : "string", - "nullable" : true + "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true }, - "organizationId" : { - "type" : "string", - "nullable" : true - }, - "refreshToken" : { - "type" : "string", - "nullable" : true - }, - "rhombusToken" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "saveClips" : { - "type" : "boolean", - "nullable" : true - }, - "systemId" : { - "type" : "string", - "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true - }, - "webhookId" : { - "type" : "string", - "nullable" : true - }, - "webhookSignatureSecret" : { - "type" : "string", + "deactivatedLockdownPlans" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LockdownPlanReference" + }, "nullable" : true } } } ], "nullable" : true, "properties" : { - "enabled" : { - "type" : "boolean", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "integration" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, - "integrationAuditMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationAuditEvent" - }, + "followingTestPlan" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Product" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "nullable" : true - }, - "productId" : { - "type" : "string", - "nullable" : true }, - "productIdQualifier" : { - "type" : "string", - "nullable" : true + "originator" : { + "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" }, - "quantity" : { + "stateChangedAtMillis" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, - "ProductTypeEnum" : { - "type" : "string", - "enum" : [ "DEVICE", "ALERT_MONITORING", "ACCESS_CONTROL", "LICENSE_USAGE", "UNKNOWN" ] - }, - "PromptConfigurationType" : { + "LockdownActivationPlanType" : { "type" : "object", - "description" : "Updated prompt configuration", "properties" : { - "active" : { - "type" : "boolean", - "nullable" : true - }, - "cameraConfigurations" : { + "groupUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/CameraConfiguration" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true - }, - "checkCondition" : { - "$ref" : "#/components/schemas/CheckCondition" + "nullable" : true, + "uniqueItems" : true }, - "description" : { + "rhombusKeyNotificationMessage" : { "type" : "string", "nullable" : true }, - "generateAlertForActionNewlyAddedCameras" : { - "type" : "boolean", - "nullable" : true - }, - "multiImageTimeDeltasSeconds" : { + "userUuids" : { "type" : "array", "items" : { - "type" : "integer", - "format" : "int32", + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "prompt" : { - "type" : "string", - "nullable" : true - }, - "promptType" : { - "$ref" : "#/components/schemas/PromptTypeEnum" - }, - "reportsEnabled" : { - "type" : "boolean", - "nullable" : true - }, - "scheduleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "shortName" : { - "type" : "string", - "nullable" : true - }, - "trigger" : { - "$ref" : "#/components/schemas/Trigger" - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "PromptFrequency" : { - "type" : "object", - "properties" : { - "frequency" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "unit" : { - "$ref" : "#/components/schemas/FrequencyUnitEnum" + "nullable" : true, + "uniqueItems" : true } } }, - "PromptTypeEnum" : { + "LockdownActivationResultEnumType" : { "type" : "string", - "enum" : [ "COUNT", "PERCENT", "BOOLEAN", "TEXT" ] - }, - "Providers" : { - "type" : "object", - "nullable" : true - }, - "ProximityArrivedActivityEventType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "proximityTagLocationUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" - } - } + "description" : "The result of the lockdown activation operation.", + "enum" : [ "SUCCESS", "INVALID_LOCKDOWN_PLANS", "OPTIMISTIC_CONCURRENCY" ] }, - "ProximityDepartedActivityEventType" : { + "LockdownDeactivatedStateEventType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "departureThresholdSecs" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "proximityTagLocationUuids" : { + "deactivatedLockdownPlans" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/LockdownPlanReference" }, "nullable" : true } @@ -116211,57 +118287,14 @@ } ], "nullable" : true, "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" - } - } - }, - "ProximityEventType" : { - "type" : "object", - "description" : "List of proximity events for the specified tag", - "properties" : { - "baseStationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "batteryPercentage" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "bleDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "bleRssi" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "closeBaseStations" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "endTimeMs" : { + "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "gpsLocation" : { - "$ref" : "#/components/schemas/GeodeticCoordinates" + "followingTestPlan" : { + "type" : "boolean", + "nullable" : true }, "locationUuid" : { "type" : "string", @@ -116277,346 +118310,163 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startTimeMs" : { + "originator" : { + "$ref" : "#/components/schemas/BaseLocationLockdownEventOriginator" + }, + "stateChangedAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/ProximityStatusEnum" - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : { + "$ref" : "#/components/schemas/LockdownStateEventEnumType" } } }, - "ProximityPolicyType" : { + "LockdownDeactivationPlanType" : { "type" : "object", - "description" : "List of proximity policies in the organization", "properties" : { - "defaultDepartureThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "defaultTriggers" : { + "groupUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ProximityTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "description" : { - "type" : "string", - "nullable" : true - }, - "egressThresholdMetersMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true - }, - "ingressThresholdMetersMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { + "rhombusKeyNotificationMessage" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduledTriggers" : { + "userUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ProximityScheduledTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "nullable" : true, + "uniqueItems" : true } } }, - "ProximityScheduledTriggerType" : { + "LockdownDeactivationResultEnumType" : { + "type" : "string", + "description" : "The result of the lockdown deactivation operation.", + "enum" : [ "SUCCESS", "OPTIMISTIC_CONCURRENCY" ] + }, + "LockdownEventOriginatorEnumType" : { + "type" : "string", + "enum" : [ "USER", "SUPPORT_AUTHORITY", "API_TOKEN", "RULE", "UNKNOWN" ] + }, + "LockdownPhysicalAccessType" : { "type" : "object", "properties" : { - "departureThresholdSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "egressThresholdMetersMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "nullable" : true - }, - "ingressThresholdMetersMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", + "groupUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true - }, - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "nullable" : true, + "uniqueItems" : true }, - "triggerSet" : { + "userUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ProximityTriggerType" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, "nullable" : true, "uniqueItems" : true } } }, - "ProximityStatusEnum" : { - "type" : "string", - "description" : "Filter events by proximity status", - "enum" : [ "ACTIVE", "STATIONARY", "OFFLINE" ] - }, - "ProximityTagLocomotionEventType" : { + "LockdownPlanReference" : { "type" : "object", - "description" : "List of locomotion events for the specified tag", "properties" : { - "baseStationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "gpsLocation" : { - "$ref" : "#/components/schemas/GeodeticCoordinates" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "movement" : { - "$ref" : "#/components/schemas/LocomotionMovementEnum" - }, - "orgUuid" : { + "lockdownPlanUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "scope" : { + "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" }, - "tagUuid" : { + "scopeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true } } }, - "ProximityTagTimeSeriesDataPointType" : { - "type" : "object", - "description" : "List of proximity tag time series data points", - "properties" : { - "dateLocal" : { - "type" : "string", - "nullable" : true - }, - "tagUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } + "LockdownPlanScopeEnumType" : { + "type" : "string", + "enum" : [ "ORG_LOCKDOWN", "LOCATION_LOCKDOWN" ] }, - "ProximityTriggerType" : { - "type" : "object", - "properties" : { - "activity" : { - "$ref" : "#/components/schemas/ActivityEnum" - }, - "locationUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } + "LockdownStateEventEnumType" : { + "type" : "string", + "enum" : [ "LOCKDOWN_ACTIVATED", "LOCKDOWN_DEACTIVATED" ] }, - "ProximityUnlockSettingsType" : { + "LockdownTestPlanType" : { "type" : "object", "properties" : { - "credCooldownSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "exitResetsCooldown" : { - "type" : "boolean", - "nullable" : true - }, - "holdUnlocked" : { + "doorStateOverrideEnabled" : { "type" : "boolean", "nullable" : true }, - "holdUnlockedEventIntervalSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "maxHoldUnlockedTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "minHoldUnlockedTimeSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "minRSSIThreshold" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - }, - "ProximityUnlockSettingsType_Minimal" : { - "type" : "object", - "properties" : { - "enabled" : { + "userAccessOverrideEnabled" : { "type" : "boolean", "nullable" : true - }, - "minRSSIThreshold" : { - "type" : "integer", - "format" : "int32", - "nullable" : true } } }, - "Proximity_GetLocomotionEventsForTagWSRequest" : { + "LockdownType" : { "type" : "object", - "description" : "Request object for getting locomotion events for a specified proximity tag with filtering options.", "properties" : { - "createdAfterMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter events created after this timestamp in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "createdBeforeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Filter events created before this timestamp in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "limit" : { + "id" : { "type" : "integer", "format" : "int32", - "description" : "Maximum number of events to return", - "example" : 100, "nullable" : true }, - "movementFilter" : { - "$ref" : "#/components/schemas/LocomotionMovementEnum" - }, - "tagUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Proximity_GetLocomotionEventsForTagWSResponse" : { - "type" : "object", - "description" : "Response object containing locomotion events for a specified proximity tag.", - "properties" : { - "error" : { + "isActive" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "locomotionEvents" : { - "type" : "array", - "description" : "List of locomotion events for the specified tag", - "items" : { - "$ref" : "#/components/schemas/ProximityTagLocomotionEventType" - }, - "nullable" : true - }, - "warningMsg" : { + "name" : { "type" : "string", "nullable" : true } } }, - "Proximity_GetMinimalProximityStatesWSRequest" : { + "LocomotionMovementEnum" : { + "type" : "string", + "description" : "Filter events by locomotion movement type", + "enum" : [ "ARRIVAL", "DEPARTURE", "MOVED_SIGNIFICANTLY", "UNKNOWN" ] + }, + "Logistics_GetRMAsWSRequest" : { "type" : "object", - "description" : "Request object for getting basic state information about all proximity tags in the organization." + "description" : "Request object for getting RMAs (Return Merchandise Authorizations)." }, - "Proximity_GetMinimalProximityStatesWSResponse" : { + "Logistics_GetRMAsWSResponse" : { "type" : "object", - "description" : "Response object containing basic state information about all proximity tags in the organization.", + "description" : "Response object containing RMAs (Return Merchandise Authorizations).", "properties" : { "error" : { "type" : "boolean", @@ -116626,11 +118476,11 @@ "type" : "string", "nullable" : true }, - "proximityStates" : { + "rmaList" : { "type" : "array", - "description" : "List of minimal proximity state information for all tags in the organization", + "description" : "List of RMAs (Return Merchandise Authorizations)", "items" : { - "$ref" : "#/components/schemas/Proximity_MinimalProximityStateType" + "$ref" : "#/components/schemas/RMAType" }, "nullable" : true }, @@ -116640,47 +118490,38 @@ } } }, - "Proximity_GetProximityEventsForTagWSRequest" : { + "Logistics_GetShipmentsWSRequest" : { "type" : "object", - "description" : "Request object for getting recent events for a specified proximity tag with filtering options.", + "description" : "Request object for getting shipments within a time range.", "properties" : { - "createdAfterMs" : { + "endTimeSec" : { "type" : "integer", "format" : "int64", - "description" : "Filter events created after this timestamp in milliseconds", - "example" : 1640995200000, + "description" : "End time in seconds (Unix timestamp)", + "example" : 1641081600, "nullable" : true }, - "createdBeforeMs" : { + "startTimeSec" : { "type" : "integer", "format" : "int64", - "description" : "Filter events created before this timestamp in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of events to return", - "example" : 100, - "nullable" : true - }, - "statusFilter" : { - "$ref" : "#/components/schemas/ProximityStatusEnum" - }, - "tagUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Start time in seconds (Unix timestamp)", + "example" : 1640995200, "nullable" : true } } }, - "Proximity_GetProximityEventsForTagWSResponse" : { + "Logistics_GetShipmentsWSResponse" : { "type" : "object", - "description" : "Response object containing recent events for a specified proximity tag.", + "description" : "Response object containing shipments within the specified time range.", "properties" : { + "customerShipmentList" : { + "type" : "array", + "description" : "List of customer shipments within the specified time range", + "items" : { + "$ref" : "#/components/schemas/CustomerShipmentType" + }, + "nullable" : true + }, "error" : { "type" : "boolean", "nullable" : true @@ -116689,109 +118530,83 @@ "type" : "string", "nullable" : true }, - "proximityEvents" : { - "type" : "array", - "description" : "List of proximity events for the specified tag", - "items" : { - "$ref" : "#/components/schemas/ProximityEventType" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Proximity_MinimalProximityStateType" : { + "LoiterActivityEventType" : { "type" : "object", - "description" : "Minimal proximity state information for a proximity tag.", + "allOf" : [ { + "type" : "object", + "properties" : { + "loiterDurationSecThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "batteryPercent" : { - "type" : "integer", - "format" : "int32", - "description" : "Battery percentage of the proximity tag", - "example" : 75, + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "LumeoSettings" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "createdAtMillis" : { + "enabledTimestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp when the proximity tag was created in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "firmwareVersion" : { - "type" : "string", - "description" : "Firmware version of the proximity tag", - "example" : "1.2.3", "nullable" : true }, - "gpsLocation" : { - "$ref" : "#/components/schemas/GeodeticCoordinates" - }, - "health" : { - "$ref" : "#/components/schemas/Proximity_ProximityHealthEnum" - }, - "healthDetails" : { - "$ref" : "#/components/schemas/Proximity_ProximityHealthDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "imageUrl" : { + "enablingUser" : { "type" : "string", - "description" : "URL of the image for the proximity tag", - "example" : "https://example.com/badge-image.jpg", - "nullable" : true - }, - "lastSeenSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp when the proximity tag was last seen in seconds", - "example" : 1640995200, "nullable" : true }, - "locationUuid" : { + "enablingUserUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "LumeoType" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name of the proximity tag", - "example" : "Employee Badge 001", + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "serialNumber" : { - "type" : "string", - "description" : "Serial number of the proximity tag", - "example" : "PROX-001-ABC123", - "nullable" : true - }, - "signalStrength" : { - "type" : "integer", - "format" : "int32", - "description" : "Signal strength of the proximity tag", - "example" : 85, - "nullable" : true - }, - "status" : { - "$ref" : "#/components/schemas/ProximityStatusEnum" - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "tagUuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -116800,618 +118615,793 @@ } } }, - "Proximity_ProximityHealthDetailsEnum" : { + "ManagedClientPolicyType" : { + "type" : "object", + "properties" : { + "clientSuperAdminAssignable" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "ManualAccessStateChangeEnum" : { "type" : "string", - "description" : "Detailed health information for the proximity tag", - "enum" : [ "FIRMWARE_BEHIND", "NONE" ] + "enum" : [ "DOOR_STATE_OVERRIDE", "CANCELLED_DOOR_STATE_OVERRIDE" ] }, - "Proximity_ProximityHealthEnum" : { + "ManualAccessStateChangeEnum_Minimal" : { "type" : "string", - "description" : "Health status of the proximity tag", - "enum" : [ "GREEN" ] + "enum" : [ "DOOR_STATE_OVERRIDE", "CANCELLED_DOOR_STATE_OVERRIDE" ] }, - "Proximity_UpdateProximitySensorDetailsWSRequest" : { + "ManualAlarmPolicy" : { "type" : "object", - "description" : "Request object for updating details for a proximity tag.", + "description" : "Threat-detection policy that applies when this zone is in manual monitoring mode.", + "nullable" : true, "properties" : { - "deletedUpdated" : { - "type" : "boolean", - "description" : "Whether the deleted status has been updated", - "example" : false, - "nullable" : true - }, - "description" : { - "type" : "string", - "description" : "Description of the proximity tag", - "example" : "John Doe's employee badge", - "nullable" : true - }, - "descriptionUpdated" : { - "type" : "boolean", - "description" : "Whether the description has been updated", - "example" : true, - "nullable" : true - }, - "imageUrl" : { - "type" : "string", - "description" : "URL of the image for the proximity tag", - "example" : "https://example.com/badge-image.jpg", - "nullable" : true - }, - "imageUrlUpdated" : { - "type" : "boolean", - "description" : "Whether the image URL has been updated", - "example" : false, - "nullable" : true - }, - "name" : { - "type" : "string", - "description" : "Name of the proximity tag", - "example" : "Employee Badge 001", - "nullable" : true - }, - "nameUpdated" : { - "type" : "boolean", - "description" : "Whether the name has been updated", - "example" : true, - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rules" : { + "type" : "array", + "description" : "The rules governing threat detection and subsequent actions.", + "items" : { + "$ref" : "#/components/schemas/AlarmRule" + }, "nullable" : true }, - "policyUuidUpdated" : { - "type" : "boolean", - "description" : "Whether the policy UUID has been updated", - "example" : true, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/MonitoringModeEnum" }, - "uuid" : { + "verifiedThreatSiren" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" + } + }, + "required" : [ "rules" ] + }, + "Maps_GenerateMapUrlWSRequest" : { + "type" : "object", + "description" : "Request object for generating a map URL.", + "properties" : { + "baseUrl" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Base URL for the map", + "example" : "https://maps.google.com/maps?q=", "nullable" : true } } }, - "Proximity_UpdateProximitySensorDetailsWSResponse" : { + "Maps_GenerateMapUrlWSResponse" : { "type" : "object", - "description" : "Response object for updating details for a proximity tag.", + "description" : "Response object containing the generated map URL.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { + "signedUrl" : { "type" : "string", + "description" : "Signed URL for the map", + "example" : "https://maps.google.com/maps?q=123+Main+St&key=abc123", "nullable" : true } } }, - "QualifiedAddressType" : { + "MattermostSettings" : { "type" : "object", - "description" : "Qualified address information for the keypad location", "properties" : { - "addressLine2" : { + "channel" : { "type" : "string", - "description" : "apt, suite, or unit", "nullable" : true }, - "addressline1" : { - "type" : "string", - "description" : "street address", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "administrativeArea" : { - "type" : "string", - "description" : "state", + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "locality" : { + "enablingUser" : { "type" : "string", - "description" : "city", "nullable" : true }, - "postalCode" : { + "enablingUserUuid" : { "type" : "string", - "description" : "zip code", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "regionCode" : { + "webhookUrl" : { "type" : "string", - "description" : "country", "nullable" : true } } }, - "QueryStatusEnum" : { - "type" : "string", - "enum" : [ "ANSWERED", "PARTIALLY_ANSWERED", "CLARIFICATION_REQUESTED", "REDIRECTED", "INITIATED", "QUEUED", "IN_PROGRESS", "CALLING_TOOLS", "AWAITING_TOOL_RESULTS", "GENERATING_RESPONSE", "GENERATING_REPORT_OUTLINE", "GENERATING_REPORT_SECTIONS", "GENERATING_REPORT_DRAFT", "FILLING_OUT_CHARTS", "REFINING_REPORT", "NOT_UNDERSTOOD", "INVALID_REQUEST", "UNAUTHORIZED", "UNSUPPORTED", "DENIED", "INTERRUPTED", "NO_RESPONSE", "INVALID_AUTH_DATA", "INVALID_API_TOKEN", "MIND_DISABLED", "OUT_OF_TRIAL_CREDITS", "UNKNOWN" ] - }, - "QueryTimelineEvent" : { + "MediaRegionHistoryEntryType" : { "type" : "object", "properties" : { - "status" : { - "$ref" : "#/components/schemas/QueryStatusEnum" + "region" : { + "type" : "string", + "nullable" : true }, - "timestampMs" : { + "untilMs" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, - "QueryTool" : { + "MediaType" : { "type" : "object", "properties" : { - "content" : { - "type" : "string", + "charset" : { + "type" : "object", + "nullable" : true, + "properties" : { + "registered" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "concrete" : { + "type" : "boolean", "nullable" : true }, - "contentType" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "qualityValue" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "subtype" : { "type" : "string", "nullable" : true }, - "extra" : { + "subtypeSuffix" : { "type" : "string", "nullable" : true }, - "role" : { + "type" : { "type" : "string", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", + "wildcardSubtype" : { + "type" : "boolean", "nullable" : true }, - "tool" : { - "type" : "string", + "wildcardType" : { + "type" : "boolean", "nullable" : true } } }, - "RBACSettingsType" : { + "Mediadevice_GetBulkMediaDeviceDetailsWSRequest" : { "type" : "object", + "description" : "Request object for getting media information of any video-supporting media device.", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true + "devices" : { + "type" : "array", + "description" : "Set of device facet UUIDs to get media details for", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true } } }, - "RMARequest" : { + "Mediadevice_GetBulkMediaDeviceDetailsWSResponse" : { "type" : "object", + "description" : "Response object containing media information for video-supporting media devices.", "properties" : { - "formSubmitted" : { + "error" : { "type" : "boolean", "nullable" : true }, - "requestUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "rmaOpportunityId" : { - "type" : "string", - "nullable" : true - }, - "salesforceAccountId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "salesforcePartnerContactId" : { - "type" : "string", + "mediaDeviceDetails" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Mediadevice_MediaDeviceDetailsType" + }, + "description" : "Map of device facet UUIDs to their media device details", "nullable" : true }, - "salesforcePartnerId" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "RMAStatusEnum" : { - "type" : "string", - "enum" : [ "INITIATED", "PENDING", "APPROVED", "INPROGRESS", "COMPLETE", "RETURN", "STOLEN", "OPERATIONAL", "FULFILLMENT_ERROR" ] - }, - "RMAType" : { + "Mediadevice_MediaDeviceDetailsType" : { "type" : "object", - "description" : "List of RMAs (Return Merchandise Authorizations)", + "description" : "Detailed information about a media device including streaming URLs and device characteristics.", "properties" : { - "address" : { - "type" : "string", - "nullable" : true - }, - "advancedRMAs" : { - "$ref" : "#/components/schemas/AdvancedRMAType" - }, - "briefDescription" : { - "type" : "string", - "nullable" : true - }, - "city" : { - "type" : "string", - "nullable" : true - }, - "costInDollars" : { - "type" : "number", - "format" : "float", + "audioGateways" : { + "type" : "array", + "description" : "List of audio gateway UUIDs associated with the device", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "country" : { + "deviceFacetUuid" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "customerUnresponsive" : { - "type" : "boolean", - "nullable" : true + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" }, - "deleted" : { - "type" : "boolean", - "nullable" : true + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanCheckUrls" : { + "type" : "array", + "description" : "URLs to check if the device is available on LAN", + "items" : { + "type" : "string", + "description" : "URLs to check if the device is available on LAN", + "nullable" : true + }, "nullable" : true }, - "errorCode" : { - "$ref" : "#/components/schemas/ErrorCodeOrMessageEnum" - }, - "failureDiagnostics" : { + "lanLiveH264Uris" : { "type" : "array", + "description" : "LAN live H264 streaming URIs", "items" : { "type" : "string", + "description" : "LAN live H264 streaming URIs", "nullable" : true }, "nullable" : true }, - "fedExReturnLabelSent" : { - "type" : "boolean", + "lanLiveM3u8Uris" : { + "type" : "array", + "description" : "LAN live M3U8 streaming URIs", + "items" : { + "type" : "string", + "description" : "LAN live M3U8 streaming URIs", + "nullable" : true + }, "nullable" : true }, - "finalNotes" : { - "type" : "string", + "lanLiveMpdUris" : { + "type" : "array", + "description" : "LAN live MPD streaming URIs", + "items" : { + "type" : "string", + "description" : "LAN live MPD streaming URIs", + "nullable" : true + }, "nullable" : true }, - "hardwareUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lanVodM3u8UrisTemplates" : { + "type" : "array", + "description" : "LAN VOD M3U8 URI templates", + "items" : { + "type" : "string", + "description" : "LAN VOD M3U8 URI templates", + "nullable" : true + }, "nullable" : true }, - "initialFirmwareVersion" : { - "type" : "string", + "lanVodMpdUrisTemplates" : { + "type" : "array", + "description" : "LAN VOD MPD URI templates", + "items" : { + "type" : "string", + "description" : "LAN VOD MPD URI templates", + "nullable" : true + }, "nullable" : true }, - "initiatedBy" : { + "name" : { "type" : "string", + "description" : "Name of the device", + "example" : "Front Door Camera", "nullable" : true }, - "inventoryNeeded" : { + "region" : { "type" : "string", + "description" : "Region where the device is located", + "example" : "us-west-2", "nullable" : true }, - "inventoryNeededMap" : { + "timezone" : { "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "isRefurbished" : { - "type" : "boolean", - "nullable" : true + "description" : "Timezone of the device", + "nullable" : true, + "properties" : { + "displayName" : { + "type" : "string", + "nullable" : true + }, + "dstsavings" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "rawOffset" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } }, - "knownIssue" : { - "type" : "boolean", + "uri" : { + "type" : "string", + "description" : "URI of the device", + "example" : "rtsp://device.local/stream", "nullable" : true }, - "lastRecordedFirmwareVersion" : { + "wanLiveH264Uri" : { "type" : "string", + "description" : "WAN live H264 streaming URI", + "example" : "https://stream.rhombussystems.com/live/device123.h264", "nullable" : true }, - "lastUpdatedAtSec" : { - "type" : "integer", - "format" : "int64", + "wanLiveM3u8Uri" : { + "type" : "string", + "description" : "WAN live M3U8 streaming URI", + "example" : "https://stream.rhombussystems.com/live/device123.m3u8", "nullable" : true }, - "lastUpdatedBy" : { + "wanLiveMpdUri" : { "type" : "string", + "description" : "WAN live MPD streaming URI", + "example" : "https://stream.rhombussystems.com/live/device123.mpd", "nullable" : true }, - "orgUuid" : { + "wanVodH264UriTemplate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "WAN VOD H264 URI template", + "example" : "https://vod.rhombussystems.com/{timestamp}/device123.h264", "nullable" : true }, - "postalCode" : { + "wanVodM3u8UriTemplate" : { "type" : "string", + "description" : "WAN VOD M3U8 URI template", + "example" : "https://vod.rhombussystems.com/{timestamp}/device123.m3u8", "nullable" : true }, - "prevShippingInfoUsedBy" : { + "wanVodMpdUriTemplate" : { "type" : "string", + "description" : "WAN VOD MPD URI template", + "example" : "https://vod.rhombussystems.com/{timestamp}/device123.mpd", "nullable" : true - }, - "prevShippingInfoUsedByAtSec" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "MessageBodyWorkers" : { + "type" : "object", + "nullable" : true + }, + "MetaDataLocationType" : { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", "nullable" : true - }, - "proactiveReplacement" : { + } + } + }, + "Metric_LogEventWSRequest" : { + "type" : "object", + "description" : "Request object for logging events.", + "properties" : { + "logMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Map containing log event data", + "nullable" : true + }, + "description" : "Map containing log event data", + "nullable" : true + } + } + }, + "Metric_LogEventWSResponse" : { + "type" : "object", + "description" : "Response object for logging events.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "rctpPartnerOrgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "recipientName" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "recipientPhoneNumber" : { - "type" : "string", + } + } + }, + "Metric_ReportErrorWSRequest" : { + "type" : "object", + "description" : "Request object for reporting errors.", + "properties" : { + "errorMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Map containing error information", + "nullable" : true + }, + "description" : "Map containing error information", "nullable" : true - }, - "replacementCourier" : { - "type" : "string", + } + } + }, + "Metric_ReportErrorWSResponse" : { + "type" : "object", + "description" : "Response object for reporting errors.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "replacementHardwareUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "replacementTrackingNumber" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "requesterEmailAddress" : { - "type" : "string", + } + } + }, + "Metric_ReportVideoPlaybackStatsWSRequest" : { + "type" : "object", + "description" : "Request object for reporting browser video playback stats.", + "properties" : { + "pageExit" : { + "type" : "boolean", + "description" : "True when the browser sends the request as the page closes or goes hidden. The server then admits no session to Amplitude.", "nullable" : true }, - "returnLabelRequestedUpdatedAtSec" : { - "type" : "integer", - "format" : "int64", + "records" : { + "type" : "array", + "description" : "The records to report: 1 to 25. The server drops a record that is not valid and keeps the others.", + "items" : { + "$ref" : "#/components/schemas/Metric_VideoPlaybackStatsRecordWS" + }, "nullable" : true - }, - "returnLabelSent" : { - "type" : "boolean", + } + }, + "required" : [ "records" ] + }, + "Metric_ReportVideoPlaybackStatsWSResponse" : { + "type" : "object", + "description" : "Response object for reporting browser video playback stats. It also tells the browser how to collect stats.", + "properties" : { + "amplitudeSessionIds" : { + "type" : "array", + "description" : "The playbackSessionIds of final records that the browser can also send to Amplitude. Empty when the server admits none.", + "items" : { + "type" : "string", + "description" : "The playbackSessionIds of final records that the browser can also send to Amplitude. Empty when the server admits none.", + "nullable" : true + }, "nullable" : true }, - "returnLabelSentUpdatedAtSec" : { - "type" : "integer", - "format" : "int64", + "enabled" : { + "type" : "boolean", + "description" : "False when the server does not collect playback stats. The browser must then stop sending them.", "nullable" : true }, - "returnTrackingNumber" : { - "type" : "string", + "error" : { + "type" : "boolean", "nullable" : true }, - "rmaRequest" : { - "$ref" : "#/components/schemas/RMARequest" - }, - "rmaRequestUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "sdCardReplaced" : { - "type" : "boolean", + "flushSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "How often, in seconds, the browser flushes the stats of an open playback session.", + "example" : 300, "nullable" : true }, - "shipmentMethod" : { - "$ref" : "#/components/schemas/ShipmentMethodEnum" - }, - "shipmentRequested" : { - "type" : "boolean", + "sampleRate" : { + "type" : "number", + "format" : "double", + "description" : "The fraction of users (0 to 1) that the browser samples for playback stats. Only present when an operator sets it. When it is not present, the browser uses its own default.", + "example" : 0.25, "nullable" : true }, - "shipmentRequestedBy" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "shipmentRequestedUpdatedAtSec" : { - "type" : "integer", - "format" : "int64", + } + }, + "required" : [ "amplitudeSessionIds", "enabled", "flushSeconds" ] + }, + "Metric_VideoPlaybackStatsRecordWS" : { + "type" : "object", + "description" : "One flush of the playback stats of one video playback session in the browser.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "description" : "The camera that the session played, or null. 64 characters maximum.", "nullable" : true }, - "shipmentSent" : { - "type" : "boolean", + "context" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Descriptive dimensions (browser, os, video type and more). 60 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a string (the server truncates it to 256 characters), a finite number or a boolean. The server drops other entries. \"sampled\": false marks a user that the browser did not sample: the server stores the record but never admits it to Amplitude.", + "nullable" : true + }, + "description" : "Descriptive dimensions (browser, os, video type and more). 60 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a string (the server truncates it to 256 characters), a finite number or a boolean. The server drops other entries. \"sampled\": false marks a user that the browser did not sample: the server stores the record but never admits it to Amplitude.", "nullable" : true }, - "shipmentSentUpdatedAtSec" : { + "endTs" : { "type" : "integer", "format" : "int64", + "description" : "End of the period that this flush covers, in epoch milliseconds. Must not be before startTs or more than 24 hours after it.", + "example" : 1790000300000, "nullable" : true }, - "skipAutoRegistration" : { + "final" : { "type" : "boolean", + "description" : "True for the last flush of the playback session.", "nullable" : true }, - "state" : { - "type" : "string", + "metrics" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "description" : "Numeric aggregates (playMs, stallCount, wouldShowMs and more). 120 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a finite number. The server drops other entries.", + "nullable" : true + }, + "description" : "Numeric aggregates (playMs, stallCount, wouldShowMs and more). 120 keys maximum. A key starts with a letter and has 48 letters or digits maximum. A value is a finite number. The server drops other entries.", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/RMAStatusEnum" - }, - "storageCid" : { + "playbackSessionId" : { "type" : "string", + "description" : "A UUID that identifies the playback session. All flushes of the session use the same value. 64 characters maximum.", "nullable" : true }, - "street" : { - "type" : "string", + "schemaVersion" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the record format. Currently 1.", + "example" : 1, "nullable" : true }, - "timestampSec" : { + "seq" : { + "type" : "integer", + "format" : "int32", + "description" : "The flush counter of the playback session.", + "example" : 1, + "nullable" : true + }, + "startTs" : { "type" : "integer", "format" : "int64", + "description" : "Start of the playback session in epoch milliseconds. All flushes of the session use the same value. Must be in the last 48 hours.", + "example" : 1790000000000, "nullable" : true }, - "uuid" : { + "tabSessionId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Identifies the browser tab. 64 characters maximum.", "nullable" : true - }, - "warehouseInventoryNeeded" : { + } + }, + "required" : [ "endTs", "playbackSessionId", "startTs" ] + }, + "MetricsAgentSettings" : { + "type" : "object", + "properties" : { + "batch_on" : { "type" : "boolean", + "default" : true, "nullable" : true }, - "zenDeskTicketAssigneeEmail" : { - "type" : "string", + "batch_size" : { + "type" : "integer", + "format" : "int32", + "default" : 100000, + "maximum" : 1000000, + "minimum" : 10000, "nullable" : true }, - "zenDeskTicketSubject" : { - "type" : "string", + "count_flush_interval" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "minimum" : 1, "nullable" : true }, - "zendeskTicket" : { + "level" : { + "$ref" : "#/components/schemas/MetricsLevelEnum" + }, + "log_update_interval" : { + "type" : "integer", + "format" : "int32", + "default" : 1800, + "minimum" : 1, + "nullable" : true + }, + "server_flush_interval" : { "type" : "integer", "format" : "int32", + "default" : 15, + "minimum" : 1, "nullable" : true } } }, - "Rapidsos_GetNearbyFeedsRequest" : { + "MetricsAgentSettingsSelectiveUpdate" : { "type" : "object", - "description" : "Request object for getting the closest 10 feeds by latitude and longitude.", "properties" : { - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Latitude coordinate for finding nearby feeds", - "example" : 40.7128, + "batch_on" : { + "type" : "boolean", + "default" : true, "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Longitude coordinate for finding nearby feeds", - "example" : -74.006, + "batch_size" : { + "type" : "integer", + "format" : "int32", + "default" : 100000, + "maximum" : 1000000, + "minimum" : 10000, "nullable" : true }, - "width" : { + "count_flush_interval" : { "type" : "integer", "format" : "int32", - "description" : "Width parameter for the search area", - "example" : 1000, + "default" : 1, + "minimum" : 1, "nullable" : true - } - } - }, - "Rapidsos_GetNearbyFeedsResponse" : { - "type" : "object", - "description" : "Response object containing the closest 10 feed stream URLs by latitude and longitude.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "level" : { + "$ref" : "#/components/schemas/MetricsLevelEnum" + }, + "log_update_interval" : { + "type" : "integer", + "format" : "int32", + "default" : 1800, + "minimum" : 1, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "server_flush_interval" : { + "type" : "integer", + "format" : "int32", + "default" : 15, + "minimum" : 1, "nullable" : true }, - "streamUrls" : { - "type" : "array", - "description" : "List of stream URLs for the closest 10 feeds", - "items" : { - "type" : "string", - "description" : "List of stream URLs for the closest 10 feeds", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", "nullable" : true }, "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "RaptorBuilding" : { + "MetricsLevelEnum" : { + "type" : "string", + "default" : "ESSENTIAL", + "enum" : [ "OFF", "FILE", "ESSENTIAL", "BASIC", "FULL" ] + }, + "MfaTokenTypeEnum" : { + "type" : "string", + "enum" : [ "EMAIL", "SMS", "VIRTUAL_MFA", "FIDO" ] + }, + "MicrosoftTeamsChannelSettings" : { "type" : "object", + "nullable" : true, "properties" : { - "name" : { + "botInstallationId" : { "type" : "string", "nullable" : true }, - "uid" : { + "channelId" : { "type" : "string", "nullable" : true + }, + "installingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "sendChannelNotifications" : { + "type" : "boolean", + "nullable" : true } } }, - "RaptorTemplate" : { + "MicrosoftTeamsSettings" : { "type" : "object", "properties" : { - "name" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { "type" : "string", "nullable" : true }, - "uId" : { + "enablingUserUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uid" : { + "webhookUrl" : { "type" : "string", "nullable" : true } } }, - "RaptorType" : { + "MicrosoftTeamsType" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "apiToken" : { - "type" : "string", + "adminConsent" : { + "type" : "boolean", "nullable" : true }, - "clientId" : { - "type" : "string", + "allowUserNotifications" : { + "type" : "boolean", "nullable" : true }, - "clientSecret" : { - "type" : "string", + "microsoftTeamSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MicrosoftTeamsChannelSettings" + }, "nullable" : true }, - "clientUid" : { - "type" : "string", + "microsoftTeamsUserSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MicrosoftTeamsUserSettings" + }, "nullable" : true }, - "refreshToken" : { + "tenantId" : { "type" : "string", "nullable" : true - }, - "tokenValid" : { - "type" : "boolean", - "nullable" : true } } } ], @@ -117447,260 +119437,130 @@ } } }, - "ReEnableDeviceHealthTrackingConditionEnum" : { - "type" : "string", - "description" : "Condition under which device health tracking will be re-enabled.", - "enum" : [ "MANUAL", "AUTOMATIC" ], - "example" : "MANUAL" - }, - "RealtimeRelativeSecondsScheduleType" : { + "MicrosoftTeamsUserSettings" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "pastSeconds" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - } - } - } ], "nullable" : true, "properties" : { - "mutable" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { + "botInstallationId" : { "type" : "string", "nullable" : true }, - "oneTimeUse" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { + "chatId" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "strategy" : { - "$ref" : "#/components/schemas/ScheduleStrategyEnum" - }, - "uuid" : { + "refreshToken" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "RecurringRuleTriggerType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "locationUuids" : { - "type" : "array", - "description" : "Optional list of locations to specify timezones for evaluation. Note that if not specified, then we rely on the Actions to derive timezones.", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "repeatInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "Interval of timeUnit to re-occur at. i.e. trigger every 5 minutes, repeatInerval would be 5", - "nullable" : true - }, - "timeUnit" : { - "$ref" : "#/components/schemas/RecurringTimeUnitEnum" - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" - } - } - }, - "RecurringTimeUnitEnum" : { - "type" : "string", - "description" : "Time unit of recurrence. i.e. trigger every 5 minutes, timeUnit would be MINUTES", - "enum" : [ "SECONDS", "MINUTES", "HOURS" ] - }, - "RegionConfigType" : { - "type" : "object", - "nullable" : true, - "properties" : { - "inverted" : { + }, + "sendUserNotifications" : { "type" : "boolean", "nullable" : true }, - "polygons" : { + "teamIds" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/RegionPolygonType" + "type" : "string", + "nullable" : true }, "nullable" : true - } - } - }, - "RegionCoordinateType" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "float", - "nullable" : true }, - "y" : { - "type" : "number", - "format" : "float", + "userId" : { + "type" : "string", "nullable" : true } } }, - "RegionCrossingActivityEventType" : { - "type" : "object", - "allOf" : [ ], - "nullable" : true, - "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" - } - } - }, - "RegionOfInterest" : { + "MinimalAudioGatewayStateType" : { "type" : "object", - "description" : "Regions of interest that belong to the group. Group must have at least one region specified.", + "description" : "List of minimal audio gateway state information", "properties" : { - "activities" : { + "associatedCameras" : { "type" : "array", - "description" : "Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.", "items" : { - "$ref" : "#/components/schemas/ActivityEnum" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "name" : { - "type" : "string", + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "polygon" : { - "$ref" : "#/components/schemas/RegionPolygonType" + "defaultInterface" : { + "type" : "string", + "nullable" : true }, - "uuid" : { + "defaultInterfaceMac" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "RegionOfInterestGroup" : { - "type" : "object", - "properties" : { - "inclusive" : { - "type" : "boolean", - "description" : "If true, regions in this group include specified activities. If false, regions in this group exclude specified activities.", + }, + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "regionsOfInterest" : { - "type" : "array", - "description" : "Regions of interest that belong to the group. Group must have at least one region specified.", - "items" : { - "$ref" : "#/components/schemas/RegionOfInterest" - }, + "externalIPAddress" : { + "type" : "string", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/RegionOfInterestGroupTypeEnum" - } - } - }, - "RegionOfInterestGroupTypeEnum" : { - "type" : "string", - "description" : "Represents type of activity regions in the group. Defaults to 'Activity'.", - "enum" : [ "ACTIVITY", "REPORTING", "CROSSING" ] - }, - "RegionPolygonType" : { - "type" : "object", - "properties" : { - "coordinates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RegionCoordinateType" + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true }, "nullable" : true - } - } - }, - "RelativeDateTimeIntervalsScheduleType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "intervals" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LocalDateTimeIntervalType" - }, - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "mutable" : { + }, + "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, - "name" : { + "firmwareVersion" : { "type" : "string", "nullable" : true }, - "oneTimeUse" : { - "type" : "boolean", + "floorNumber" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "strategy" : { - "$ref" : "#/components/schemas/ScheduleStrategyEnum" + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "liveStreamShared" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Relay_AssignThirdPartyCameraToNVRWSRequest" : { - "type" : "object", - "description" : "Request object for assigning a third-party camera to an NVR.", - "properties" : { - "discoveredCameraMacAddress" : { - "type" : "string", - "description" : "MAC address of the discovered camera to assign", + }, + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, "locationUuid" : { @@ -117710,395 +119570,257 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { - "type" : "string", - "description" : "Name for the third-party camera", - "example" : "Front Door Camera", + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "nvruuid" : { + "mediaRegion" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rtspUrl" : { - "type" : "string", - "description" : "RTSP URL for the camera stream", - "example" : "rtsp://192.168.1.100:554/stream1", - "nullable" : true - } - } - }, - "Relay_AssignThirdPartyCameraToNVRWSResponse" : { - "type" : "object", - "description" : "Response object for assigning a third-party camera to an NVR.", - "properties" : { - "deviceUuid" : { + "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "error" : { + "mummified" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "policyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_AssignThirdPartyCameraToRelayCameraWSRequest" : { - "type" : "object", - "description" : "Request object for assigning a third-party camera to a relay camera.", - "properties" : { - "discoveredCameraMacAddress" : { + }, + "region" : { "type" : "string", - "description" : "MAC address of the discovered camera to assign", "nullable" : true }, - "locationUuid" : { + "secondaryLanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "sensorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "serialNumber" : { "type" : "string", - "description" : "Name for the third-party camera", - "example" : "Front Door Camera", "nullable" : true }, - "rtspUrl" : { + "ssid" : { "type" : "string", - "description" : "RTSP URL for the camera stream", - "example" : "rtsp://192.168.1.100:554/stream1", "nullable" : true - } - } - }, - "Relay_AssignThirdPartyCameraToRelayCameraWSResponse" : { - "type" : "object", - "description" : "Response object for assigning a third-party camera to a relay camera.", - "properties" : { - "deviceUuid" : { + }, + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "error" : { - "type" : "boolean", - "nullable" : true + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "errorMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "wifiApMac" : { "type" : "string", "nullable" : true + }, + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "Relay_AuthenticateThirdPartyCameraWSRequest" : { + "MinimalDeviceStateType" : { "type" : "object", - "description" : "Request object for authenticating a third-party camera with RTSP URL.", + "description" : "List of minimal camera state information", "properties" : { - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" }, - "password" : { - "type" : "string", - "description" : "Password to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", - "example" : "password123", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "rtspUrl" : { + "defaultInterface" : { "type" : "string", - "description" : "The RTSP URL of the third-party camera. This RTSP URL should reference a stream that provides H.264 encoded video", - "example" : "rtsp://192.168.1.100:554/stream1", "nullable" : true }, - "thirdPartyCameraMacAddress" : { + "defaultInterfaceMac" : { "type" : "string", - "description" : "The MAC address of the third-party camera this request is operating on", "nullable" : true }, - "trySavedCredentials" : { - "type" : "boolean", - "description" : "Whether the third-party credentials saved in the account should be used when trying to validate whether the provided RTSP URL is valid", - "example" : false, + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "username" : { + "externalIPAddress" : { "type" : "string", - "description" : "Username to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", - "example" : "admin", "nullable" : true - } - } - }, - "Relay_AuthenticateThirdPartyCameraWSResponse" : { - "type" : "object", - "description" : "Response object for authenticating a third-party camera with RTSP URL.", - "properties" : { - "error" : { + }, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "firmwareVersion" : { "type" : "string", "nullable" : true }, - "result" : { - "$ref" : "#/components/schemas/DiscoveredThirdPartyCameraType" + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "rtspUrlStatus" : { - "$ref" : "#/components/schemas/UrlStatusEnum" + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_CreateThirdPartyCameraPasswordWSRequest" : { - "type" : "object", - "description" : "Request object for creating a third-party camera password.", - "properties" : { - "notes" : { - "type" : "string", - "description" : "Notes for the password entry", - "example" : "Default admin password", - "nullable" : true + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" }, - "password" : { - "type" : "string", - "description" : "Password for the third-party camera", - "example" : "password123", + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "username" : { - "type" : "string", - "description" : "Username for the third-party camera", - "example" : "admin", + "latitude" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Relay_CreateThirdPartyCameraPasswordWSResponse" : { - "type" : "object", - "description" : "Response object for creating a third-party camera password.", - "properties" : { - "error" : { + }, + "liveStreamShared" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "passwordUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Relay_DeleteThirdPartyCameraDiscoveryWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a third-party camera discovery.", - "properties" : { - "thirdPartyCameraMacAddress" : { + }, + "mediaRegion" : { "type" : "string", - "description" : "MAC address of the third-party camera to delete", "nullable" : true - } - } - }, - "Relay_DeleteThirdPartyCameraDiscoveryWSResponse" : { - "type" : "object", - "description" : "Request object for creating a third-party camera password." - }, - "Relay_DeleteThirdPartyCameraPasswordWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a third-party camera password.", - "properties" : { - "passwordUuid" : { + }, + "mediaStorageDeviceUuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - } - } - }, - "Relay_DeleteThirdPartyCameraPasswordWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a third-party camera password.", - "properties" : { - "error" : { + }, + "mummified" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_DiscoveryWithUnassignedRtspEndpoints" : { - "type" : "object", - "description" : "Discovery information with unassigned RTSP endpoints available for assignment.", - "properties" : { - "codec" : { + "policyUuid" : { "type" : "string", - "description" : "Codec of the discovered device", - "example" : "H.264", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ipAddress" : { + "region" : { "type" : "string", - "description" : "IP address of the discovered device", - "example" : "192.168.1.100", "nullable" : true }, - "macAddress" : { - "type" : "string", - "description" : "MAC address of the discovered device", + "secondaryLanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "manufacturer" : { + "serialNumber" : { "type" : "string", - "description" : "Manufacturer of the discovered device", - "example" : "Hikvision", "nullable" : true }, - "model" : { + "ssid" : { "type" : "string", - "description" : "Model of the discovered device", - "example" : "DS-2CD2142FWD-I", "nullable" : true }, - "orgUuid" : { + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "unassignedRtspEndpoints" : { - "type" : "array", - "description" : "List of unassigned RTSP endpoints that are available for assignment. Contains only endpoints with status GOOD and that are not currently assigned.", - "items" : { - "$ref" : "#/components/schemas/Relay_ExternalRtspEndpoint" - }, - "nullable" : true - } - } - }, - "Relay_ExecuteThirdPartyCameraDiscoveryWSRequest" : { - "type" : "object", - "description" : "Request object for executing third-party camera discovery.", - "properties" : { - "deviceFilter" : { - "type" : "array", - "description" : "Set of device UUIDs to filter discovery by", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "uniqueItems" : true + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "locationFilter" : { + "supportedFacets" : { "type" : "array", - "description" : "Set of location UUIDs to filter discovery by", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/DeviceFacetEnum" }, "nullable" : true, "uniqueItems" : true - } - } - }, - "Relay_ExecuteThirdPartyCameraDiscoveryWSResponse" : { - "type" : "object", - "description" : "Response object for executing third-party camera discovery.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_ExternalRtspEndpoint" : { - "type" : "object", - "description" : "External RTSP endpoint configuration for camera streams.", - "properties" : { - "lastRtspUrlStatus" : { - "$ref" : "#/components/schemas/UrlStatusEnum" - }, - "password" : { - "type" : "string", - "description" : "Password for RTSP authentication", - "example" : "password123", - "nullable" : true - }, - "rtspUrl" : { - "type" : "string", - "description" : "RTSP URL for the camera stream", - "example" : "rtsp://192.168.1.100:554/stream1", - "nullable" : true - }, - "source" : { - "$ref" : "#/components/schemas/RtspEndpointSourceEnum" - }, - "username" : { - "type" : "string", - "description" : "Username for RTSP authentication", - "example" : "admin", - "nullable" : true }, "uuid" : { "type" : "string", @@ -118106,390 +119828,224 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest" : { - "type" : "object", - "description" : "Request object for finding discoveries with unassigned RTSP endpoints." - }, - "Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse" : { - "type" : "object", - "description" : "Response object containing discoveries with unassigned RTSP endpoints.", - "properties" : { - "discoveries" : { - "type" : "array", - "description" : "List of discoveries with unassigned RTSP endpoints", - "items" : { - "$ref" : "#/components/schemas/Relay_DiscoveryWithUnassignedRtspEndpoints" - }, - "nullable" : true - } - } - }, - "Relay_GetAssignedThirdPartyCamerasWSRequest" : { - "type" : "object", - "description" : "Request object for getting third-party cameras assigned to a specific NVR.", - "properties" : { - "nvruuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Relay_GetAssignedThirdPartyCamerasWSResponse" : { - "type" : "object", - "description" : "Response object containing third-party cameras assigned to a specific NVR.", - "properties" : { - "assignedCameras" : { - "type" : "array", - "description" : "List of third-party cameras assigned to the specified NVR", - "items" : { - "$ref" : "#/components/schemas/CameraType" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "wifiApMac" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_GetFullNVRStateWSRequest" : { - "type" : "object", - "description" : "Request object for getting detailed information about the state of a specified NVR.", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "Whether to force refresh the NVR state", - "example" : false, + "wifiBars" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "nvruuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Relay_GetFullNVRStateWSResponse" : { + "MinimalNVRStateType" : { "type" : "object", - "description" : "Response object containing detailed information about the state of a specified NVR.", + "description" : "List of minimal NVR state information for all NVRs in the organization", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" }, - "errorMsg" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "fullNVRState" : { - "$ref" : "#/components/schemas/FullDeviceStateType" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_GetImportThirdPartyCamerasFormatWSResponse" : { - "type" : "object", - "description" : "Response object for getting the import format for third-party cameras.", - "properties" : { - "example" : { + "defaultInterface" : { "type" : "string", - "description" : "Example of the import format", - "example" : "CSV format example", "nullable" : true }, - "explanation" : { + "defaultInterfaceMac" : { "type" : "string", - "description" : "Explanation of the import format", - "example" : "Format explanation", "nullable" : true - } - } - }, - "Relay_GetMinimalNVRStateListWSRequest" : { - "type" : "object", - "description" : "Request object for getting basic state information about all NVRs in the organization." - }, - "Relay_GetMinimalNVRStateListWSResponse" : { - "type" : "object", - "description" : "Response object containing basic state information about all NVRs in the organization.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "errorMsg" : { + "externalIPAddress" : { "type" : "string", "nullable" : true }, - "nvrstates" : { - "type" : "array", - "description" : "List of minimal NVR state information for all NVRs in the organization", - "items" : { - "$ref" : "#/components/schemas/MinimalNVRStateType" + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true }, "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_GetMinimalThirdPartyCameraStateListWSRequest" : { - "type" : "object", - "description" : "Request object for getting basic state information about all third-party cameras in the organization." - }, - "Relay_GetMinimalThirdPartyCameraStateListWSResponse" : { - "type" : "object", - "description" : "Response object containing basic state information about all third-party cameras in the organization.", - "properties" : { - "error" : { + "firmwareUpdateInProgress" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "firmwareVersion" : { "type" : "string", "nullable" : true }, - "thirdPartyCameraStateList" : { - "type" : "array", - "description" : "List of minimal third-party camera state information for all cameras in the organization", - "items" : { - "$ref" : "#/components/schemas/Relay_MinimalThirdPartyCameraStateType" - }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Relay_GetNVRDetailsWSRequest" : { - "type" : "object", - "description" : "Request object for getting details for specified NVRs.", - "properties" : { - "nvruuids" : { + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { "type" : "array", - "description" : "List of NVR UUIDs to get details for", "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true - } - } - }, - "Relay_GetNVRDetailsWSResponse" : { - "type" : "object", - "description" : "Response object containing details for specified NVRs.", - "properties" : { - "error" : { + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "liveStreamShared" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nvrs" : { - "type" : "array", - "description" : "List of NVR details for the specified NVRs", - "items" : { - "$ref" : "#/components/schemas/Relay_NVRExternalType" - }, + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "warningMsg" : { + "mediaRegion" : { "type" : "string", "nullable" : true - } - } - }, - "Relay_GetRtspEndpointsWSRequest" : { - "type" : "object", - "description" : "Request object for getting RTSP endpoints for a device with the specified MAC address.", - "properties" : { - "discoveredCameraMacAddress" : { + }, + "mediaStorageDeviceUuid" : { "type" : "string", - "description" : "MAC address of the discovered camera to get RTSP endpoints for", - "nullable" : true - } - } - }, - "Relay_GetRtspEndpointsWSResponse" : { - "type" : "object", - "description" : "Response object containing RTSP endpoints for a device with the specified MAC address.", - "properties" : { - "rtspEndpoints" : { - "type" : "array", - "description" : "List of RTSP endpoints for the discovered camera", - "items" : { - "$ref" : "#/components/schemas/Relay_ExternalRtspEndpoint" - }, + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - } - } - }, - "Relay_GetThirdPartyCameraPasswordsWSRequest" : { - "type" : "object", - "description" : "Request object for getting third-party camera passwords." - }, - "Relay_GetThirdPartyCameraPasswordsWSResponse" : { - "type" : "object", - "description" : "Response object containing third-party camera passwords.", - "properties" : { - "error" : { + }, + "mummified" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "passwords" : { - "type" : "array", - "description" : "List of third-party camera passwords", - "items" : { - "$ref" : "#/components/schemas/ThirdPartyCameraPasswordType" - }, + "numThirdPartyCamerasAssigned" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { + "numThirdPartyCamerasSupported" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "policyUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_ImportThirdPartyCamerasWSResponse" : { - "type" : "object", - "description" : "Response object for importing third-party cameras.", - "properties" : { - "importResults" : { - "type" : "array", - "description" : "List of import results for third-party cameras", - "items" : { - "$ref" : "#/components/schemas/Relay_ThirdPartyCameraImportResult" - }, + }, + "region" : { + "type" : "string", "nullable" : true }, - "messages" : { + "secondaryLanAddresses" : { "type" : "array", - "description" : "List of messages from the import operation", "items" : { "type" : "string", - "description" : "List of messages from the import operation", "nullable" : true }, "nullable" : true - } - } - }, - "Relay_ManualDiscoverThirdPartyCameraWSRequest" : { - "type" : "object", - "description" : "Request object for manually discovering a third-party camera with RTSP URL.", - "properties" : { - "locationUuid" : { + }, + "serialNumber" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "password" : { + "ssid" : { "type" : "string", - "description" : "Password to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", - "example" : "password123", "nullable" : true }, - "rtspUrl" : { + "subLocationsHierarchyKey" : { "type" : "string", - "description" : "The RTSP URL of the third-party camera being manually added. This RTSP URL should reference a stream that provides H.264 encoded video", - "example" : "rtsp://192.168.1.100:554/stream1", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "trySavedCredentials" : { - "type" : "boolean", - "description" : "Whether the third-party credentials saved in the account should be used when trying to validate whether the provided RTSP URL is valid", - "example" : false, - "nullable" : true + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "username" : { + "uuid" : { "type" : "string", - "description" : "Username to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", - "example" : "admin", - "nullable" : true - } - } - }, - "Relay_ManualDiscoverThirdPartyCameraWSResponse" : { - "type" : "object", - "description" : "Response object for manually discovering a third-party camera with RTSP URL.", - "properties" : { - "error" : { - "type" : "boolean", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "wifiApMac" : { "type" : "string", "nullable" : true }, - "result" : { - "$ref" : "#/components/schemas/DiscoveredThirdPartyCameraType" - }, - "rtspUrlStatus" : { - "$ref" : "#/components/schemas/UrlStatusEnum" + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "warningMsg" : { - "type" : "string", + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Relay_MinimalThirdPartyCameraStateType" : { + "MinimalObservableDeviceStateType" : { "type" : "object", - "description" : "Minimal third-party camera state information.", + "description" : "List of minimal state information for doorbell cameras", "properties" : { - "assignedNVRUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "assignedRelayCameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "codec" : { - "type" : "string", - "description" : "Codec used by the third-party camera", - "example" : "H.264", + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, "connectionStatus" : { @@ -118513,13 +120069,6 @@ "format" : "float", "nullable" : true }, - "discoveredByDeviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "externalIPAddress" : { "type" : "string", "nullable" : true @@ -118562,31 +120111,6 @@ }, "nullable" : true }, - "lastRtspUrlStatus" : { - "$ref" : "#/components/schemas/UrlStatusEnum" - }, - "lastVisibleLocationMs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "description" : "Map of location UUID to last time this third-party device was known to be visible", - "nullable" : true - }, - "description" : "Map of location UUID to last time this third-party device was known to be visible", - "nullable" : true - }, - "lastVisibleMs" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "description" : "Map of device UUID to last time this third-party device was known to be visible", - "nullable" : true - }, - "description" : "Map of device UUID to last time this third-party device was known to be visible", - "nullable" : true - }, "latitude" : { "type" : "number", "format" : "double", @@ -118613,12 +120137,6 @@ "format" : "double", "nullable" : true }, - "manufacturer" : { - "type" : "string", - "description" : "Manufacturer of the third-party camera", - "example" : "Hikvision", - "nullable" : true - }, "mediaRegion" : { "type" : "string", "nullable" : true @@ -118630,12 +120148,6 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "model" : { - "type" : "string", - "description" : "Model of the third-party camera", - "example" : "DS-2CD2142FWD-I", - "nullable" : true - }, "mummified" : { "type" : "boolean", "nullable" : true @@ -118655,12 +120167,6 @@ "type" : "string", "nullable" : true }, - "rtspUrl" : { - "type" : "string", - "description" : "RTSP URL for the third-party camera stream", - "example" : "rtsp://192.168.1.100:554/stream1", - "nullable" : true - }, "secondaryLanAddresses" : { "type" : "array", "items" : { @@ -118678,7 +120184,12 @@ "nullable" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "supportedFacets" : { "type" : "array", @@ -118711,50 +120222,94 @@ } } }, - "Relay_NVRExternalType" : { + "MinimalRobotStateType" : { "type" : "object", - "description" : "External NVR type.", + "description" : "List of minimal device state information for robots", "properties" : { - "archiveRegion" : { + "activity" : { "type" : "string", "nullable" : true }, - "cameraFramerate" : { + "activityStartedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "activityUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "activityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "associatedCameras" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "batteryPercent" : { "type" : "integer", "format" : "int32", "nullable" : true }, + "charging" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "customData" : { + "defaultInterface" : { "type" : "string", "nullable" : true }, - "deleted" : { - "type" : "boolean", + "defaultInterfaceMac" : { + "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, - "deviceFacetRadians" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, + "directionRadians" : { + "type" : "number", + "format" : "float", "nullable" : true }, - "directionRadians" : { + "distanceRemaining" : { "type" : "number", "format" : "float", "nullable" : true }, + "estimatedTimeRemainingSec" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "event" : { + "type" : "string", + "nullable" : true + }, + "externalIPAddress" : { + "type" : "string", + "nullable" : true + }, "facetNameMap" : { "type" : "object", "additionalProperties" : { @@ -118763,19 +120318,64 @@ }, "nullable" : true }, + "failureReason" : { + "type" : "string", + "nullable" : true + }, + "firmwareUpdateInProgress" : { + "type" : "boolean", + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, "floorNumber" : { "type" : "integer", "format" : "int32", "nullable" : true }, + "goalPose" : { + "$ref" : "#/components/schemas/Pose" + }, + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, "hwVariation" : { "$ref" : "#/components/schemas/HardwareVariationEnum" }, + "lanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "lastEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "latitude" : { "type" : "number", "format" : "double", "nullable" : true }, + "liveStreamShared" : { + "type" : "boolean", + "nullable" : true + }, + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -118788,6 +120388,17 @@ "format" : "double", "nullable" : true }, + "mapId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "mediaRegion" : { + "type" : "string", + "nullable" : true + }, "mediaStorageDeviceUuid" : { "type" : "string", "format" : "DeviceFacetUuid", @@ -118795,6 +120406,9 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, + "mode" : { + "$ref" : "#/components/schemas/RobotOperatingModeEnum" + }, "mummified" : { "type" : "boolean", "nullable" : true @@ -118803,264 +120417,236 @@ "type" : "string", "nullable" : true }, - "pending" : { - "type" : "boolean", - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "navPath" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, "nullable" : true }, - "primaryLinkSpeedMbps" : { + "navPathTsMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "secondaryLinkSpeedMbps" : { - "type" : "integer", - "format" : "int32", + "navigationTimeSec" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "serialNumber" : { - "type" : "string", + "orientation" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "totalStreamingPixels" : { + "pathUpdatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/DeviceTypeEnum" + "phase" : { + "type" : "string", + "nullable" : true }, - "unregisteredEmailSent" : { - "type" : "boolean", + "phaseEvent" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "phaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_PTZMoveWSRequest" : { - "type" : "object", - "description" : "Request object for moving a PTZ camera.", - "properties" : { - "thirdPartyCameraUuid" : { + }, + "policyUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "xmovementPermyriad" : { + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "poseUpdatedAtMs" : { "type" : "integer", - "format" : "int32", - "description" : "X-axis movement in permyriad units", - "example" : 1000, + "format" : "int64", "nullable" : true }, - "ymovementPermyriad" : { - "type" : "integer", - "format" : "int32", - "description" : "Y-axis movement in permyriad units", - "example" : 1000, + "position" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "zmovementPermyriad" : { - "type" : "integer", - "format" : "int32", - "description" : "Z-axis movement in permyriad units", - "example" : 1000, + "preemptedBy" : { + "type" : "string", "nullable" : true - } - } - }, - "Relay_PTZMoveWSResponse" : { - "type" : "object", - "description" : "Response object for moving a PTZ camera.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "progressUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "region" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "roamingLatitude" : { + "type" : "number", + "format" : "double", "nullable" : true - } - } - }, - "Relay_PTZStatusWSRequest" : { - "type" : "object", - "description" : "Request object for getting PTZ status of a camera.", - "properties" : { - "thirdPartyCameraUuid" : { + }, + "roamingLongitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "robotPlatform" : { + "$ref" : "#/components/schemas/RobotPlatformEnum" + }, + "routeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_PTZStatusWSResponse" : { - "type" : "object", - "description" : "Response object containing PTZ status of a camera.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "secondaryLanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "errorMsg" : { + "serialNumber" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "ssid" : { "type" : "string", "nullable" : true }, - "xpositionPermyriad" : { + "stateUpdatedAtMs" : { "type" : "integer", - "format" : "int32", - "description" : "Current X-axis position in permyriad units", - "example" : 5000, + "format" : "int64", "nullable" : true }, - "ypositionPermyriad" : { - "type" : "integer", - "format" : "int32", - "description" : "Current Y-axis position in permyriad units", - "example" : 5000, - "nullable" : true + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "zpositionPermyriad" : { + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "updatedAtMs" : { "type" : "integer", - "format" : "int32", - "description" : "Current Z-axis position in permyriad units", - "example" : 5000, + "format" : "int64", "nullable" : true - } - } - }, - "Relay_RebootNVRVWSRequest" : { - "type" : "object", - "description" : "Request object for rebooting an NVR.", - "properties" : { - "nvrUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_RebootNVRVWSResponse" : { - "type" : "object", - "description" : "Response object for rebooting an NVR.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { - "type" : "string", + "waypointIndex" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "result" : { - "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse_RebootResult" + "waypointTotal" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "warningMsg" : { + "waypointUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_ThirdPartyCameraImportResult" : { - "type" : "object", - "description" : "Result of importing a third-party camera.", - "properties" : { - "discoveredThirdPartyCamera" : { - "$ref" : "#/components/schemas/DiscoveredThirdPartyCameraType" }, - "message" : { + "wifiApMac" : { "type" : "string", - "description" : "Message describing the import result", - "example" : "Successfully imported camera", "nullable" : true }, - "rtspUrl" : { - "type" : "string", - "description" : "RTSP URL that was imported", - "example" : "rtsp://192.168.1.100:554/stream1", + "wifiBars" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "urlStatus" : { - "$ref" : "#/components/schemas/UrlStatusEnum" + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "Relay_UnassignThirdPartyCameraWSRequest" : { + "MinimalThresholdEventType" : { "type" : "object", - "description" : "Request object for unassigning a third-party camera from an NVR.", + "description" : "List of threshold crossing events for the device", "properties" : { - "rtspUrl" : { - "type" : "string", - "description" : "RTSP URL of the camera to unassign", - "example" : "rtsp://192.168.1.100:554/stream1", - "nullable" : true + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" }, - "thirdPartyCameraMacAddress" : { - "type" : "string", - "description" : "MAC address of the third-party camera to unassign", + "direction" : { + "$ref" : "#/components/schemas/CrossingDirectionEnum" + }, + "objectId" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "thirdPartyCameraUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Relay_UnassignThirdPartyCameraWSResponse" : { + "MinuteOfDayIntervalType" : { "type" : "object", - "description" : "Response object for unassigning a third-party camera from an NVR.", "properties" : { - "error" : { - "type" : "boolean", + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "minuteOfDayStartInclusive" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "minuteOfDayStopExclusive" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Relay_UnregisterNVRWSRequest" : { + "MobileTokenOSEnum" : { + "type" : "string", + "enum" : [ "IOS", "ANDROID" ] + }, + "Mobile_AnswerDoorbellCallWSRequest" : { "type" : "object", - "description" : "Request object for unregistering an NVR from the system.", + "description" : "Request for the authenticated mobile session to answer (claim) a ringing doorbell call.", "properties" : { - "nvruuid" : { + "callUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -119069,152 +120655,256 @@ } } }, - "Relay_UnregisterNVRWSResponse" : { + "Mobile_AnswerDoorbellCallWSResponse" : { "type" : "object", - "description" : "Response object for unregistering an NVR from the system.", + "description" : "Outcome of a mobile session's attempt to answer a doorbell call.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "audioDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" - }, - "warningMsg" : { + "doorUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Relay_UpdateFirmwareWSStatus" : { - "type" : "string", - "description" : "Status enumeration for firmware update web service responses.", - "enum" : [ "ALREADY_ON_THE_LATEST_FIRMWARE", "DEVICE_ON_A_SPECIAL_FIRMWARE_AND_CANNOT_BE_UPDATED", "UPDATE_STARTED", "UNABLE_TO_REACH_DEVICE", "FIRMWARE_UPDATE_ALREADY_IN_PROGESS", "DEVICE_NOT_AUTHROIZED" ] - }, - "Relay_UpdateNVRFirmwareWSRequest" : { - "type" : "object", - "description" : "Request object for updating NVR firmware.", - "properties" : { - "nvruuid" : { + }, + "originatorUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "result" : { + "$ref" : "#/components/schemas/RingClaimResultEnum" } } }, - "Relay_UpdateNVRFirmwareWSResponse" : { + "Mobile_LoginToOrg2FARequiredResponse" : { "type" : "object", - "description" : "Response object for updating NVR firmware.", + "allOf" : [ { + "type" : "object", + "properties" : { + "get2FAIdentifier" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "get2FAType" : { + "$ref" : "#/components/schemas/MfaTokenTypeEnum" + }, + "numDaysSkip2FAForTrustedDevices" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days to skip 2FA for trusted devices", + "example" : 30, + "nullable" : true + } + } + } ], + "description" : "Login to organization response indicating two-factor authentication is required.", + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "status" : { - "$ref" : "#/components/schemas/Relay_UpdateFirmwareWSStatus" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "type" : "string" } } }, - "Relay_UpdateNVRWSRequest" : { + "Mobile_LoginToOrgBaseResponse" : { "type" : "object", - "description" : "Request object for updating NVR details.", - "properties" : { - "description" : { - "type" : "string", - "description" : "Description of the NVR", - "example" : "Primary NVR for main building", - "nullable" : true - }, - "descriptionUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "directionRadiansUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "floorNumberUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "latitudeUpdated" : { - "type" : "boolean", + "description" : "Base response object for login to organization operations with polymorphic response types.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Mobile_LoginToOrgSuccessResponse" + }, { + "$ref" : "#/components/schemas/Mobile_LoginToOrgSsoRequiredResponse" + }, { + "$ref" : "#/components/schemas/Mobile_LoginToOrg2FARequiredResponse" + } ], + "properties" : { + "type" : { + "type" : "string" + } + }, + "required" : [ "type" ] + }, + "Mobile_LoginToOrgRequest" : { + "type" : "object", + "description" : "Request object for allowing a multi-org user on mobile to login to a different org they are able to access.", + "properties" : { + "csr" : { + "type" : "array", + "description" : "Certificate Signing Request (CSR) data", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Certificate Signing Request (CSR) data", + "nullable" : true + }, "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "locationUuidUpdated" : { - "type" : "boolean", + } + } + }, + "Mobile_LoginToOrgSsoRequiredResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "redirectUri" : { + "type" : "string", + "description" : "Redirect URI for SSO authentication", + "example" : "https://sso.example.com/login", + "nullable" : true + } + } + } ], + "description" : "Login to organization response indicating SSO authentication is required.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Mobile_LoginToOrgSuccessResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "cert" : { + "type" : "array", + "description" : "Certificate data for the successful login session", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Certificate data for the successful login session", + "nullable" : true + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "description" : "Successful login to organization response containing session information.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Mobile_LoginVerifiedSupportAuthorityMobileRequest" : { + "type" : "object", + "description" : "Request object for mobile login of partner to client org as verified support authority.", + "properties" : { + "authorityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", + "clientType" : { + "$ref" : "#/components/schemas/SessionClientTypeEnum" + } + } + }, + "Mobile_LoginVerifiedSupportAuthorityMobileResponse" : { + "type" : "object", + "description" : "Response object for mobile login of partner to client org as verified support authority.", + "properties" : { + "supportAuthoritySessionUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitudeUpdated" : { + "valid" : { "type" : "boolean", + "description" : "Whether the support authority login is valid", + "example" : true, "nullable" : true - }, - "name" : { - "type" : "string", - "description" : "Name of the NVR", - "example" : "Main NVR", + } + } + }, + "Mobile_LogoutMobileUserRequest" : { + "type" : "object", + "description" : "Request object for logging out a mobile user." + }, + "Mobile_LogoutMobileUserResponse" : { + "type" : "object", + "description" : "Response object for logging out a mobile user." + }, + "Mobile_RefreshMobileSessionRequest" : { + "type" : "object", + "description" : "Request object for refreshing a mobile session.", + "properties" : { + "csr" : { + "type" : "array", + "description" : "Certificate Signing Request (CSR) data", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Certificate Signing Request (CSR) data", + "nullable" : true + }, "nullable" : true - }, - "nameUpdated" : { - "type" : "boolean", + } + } + }, + "Mobile_RefreshMobileSessionResponse" : { + "type" : "object", + "description" : "Response object for refreshing a mobile session.", + "properties" : { + "cert" : { + "type" : "array", + "description" : "Certificate data for the refreshed session", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "Certificate data for the refreshed session", + "nullable" : true + }, "nullable" : true }, - "policyUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "nullable" : true - }, - "uuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -119223,134 +120913,112 @@ } } }, - "Relay_UpdateNVRWSResponse" : { + "Mobile_UpdateMobileNotificationTokenRequest" : { "type" : "object", - "description" : "Response object for updating NVR details.", + "description" : "Request object for updating mobile notification token for Console app.", "properties" : { - "error" : { + "androidV2" : { "type" : "boolean", + "description" : "Flag to use the new Android app", "nullable" : true }, - "errorMsg" : { + "forceNewEndpoint" : { + "type" : "boolean", + "description" : "Forces the session to use the new SNS endpoint", + "nullable" : true + }, + "platformIOS" : { + "$ref" : "#/components/schemas/Mobile_UpdateMobileNotificationTokenRequest_PlatformIOS" + }, + "token" : { "type" : "string", + "description" : "Mobile notification token", + "example" : "abc123def456", "nullable" : true }, - "warningMsg" : { + "voipToken" : { "type" : "string", + "description" : "VoIP (PushKit) notification token for iOS doorbell ring pushes", + "example" : "abc123def456", "nullable" : true } } }, - "RemoteDoorUnlockActionType" : { + "Mobile_UpdateMobileNotificationTokenRequest_PlatformIOS" : { + "type" : "string", + "description" : "SNS endpoint to use for iOS Console app", + "enum" : [ "V1", "V2" ], + "example" : "V1" + }, + "Mobile_UpdateMobileNotificationTokenResponse" : { + "type" : "object", + "description" : "Response object for updating mobile notification token for Console app." + }, + "Mobile_UpdateRhombusKeyMobileNotificationTokenRequest" : { "type" : "object", + "description" : "Request object for updating mobile notification token for Rhombus Key app.", "properties" : { - "doorId" : { - "type" : "string", - "nullable" : true - }, - "placeId" : { + "token" : { "type" : "string", + "description" : "Rhombus Key mobile notification token", + "example" : "xyz789abc123", "nullable" : true - }, - "system" : { - "$ref" : "#/components/schemas/RemoteDoorUnlockSystemEnum" } } }, - "RemoteDoorUnlockSystemEnum" : { + "Mobile_UpdateRhombusKeyMobileNotificationTokenResponse" : { + "type" : "object", + "description" : "Response object for updating mobile notification token for Rhombus Key app." + }, + "ModelStatusEnum" : { "type" : "string", - "enum" : [ "BRIVO", "OPENPATH", "KISI", "PLACEOS", "GENEA", "PDK", "INNER_RANGE", "RHOMBUS", "UNKNOWN" ] + "enum" : [ "READY", "QUANTIZE_IN_PROGRESS", "QUANTIZE_FAILURE" ] }, - "RenewalClaimKey" : { + "ModularAIConfig" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "entries" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/ClaimKeyEntry" - }, - "nullable" : true - } - } - } ], - "nullable" : true, + "description" : "List of available modular AI models", "properties" : { - "claimEndDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", - "nullable" : true - }, - "claimStartDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date/time when claiming of licenses represented by this claim key started.", - "nullable" : true - }, - "createdOn" : { + "description" : { "type" : "string", - "format" : "date-time", "nullable" : true }, - "endDate" : { + "distributionUuid" : { "type" : "string", - "format" : "date-time", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "expirationEmailState" : { - "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" - }, - "gracePeriodEndDate" : { - "type" : "string", - "format" : "date-time", - "nullable" : true + "modelParams" : { + "$ref" : "#/components/schemas/ModularAIModelParams" }, - "maskedClaimCode" : { + "modelQuantizedBinaryContentLocator" : { "type" : "string", - "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", "nullable" : true }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "modelStatus" : { + "$ref" : "#/components/schemas/ModelStatusEnum" }, - "renewedByClaimKeyUuid" : { + "modelUploadZipContentLocator" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "requestId" : { + "name" : { "type" : "string", - "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", "nullable" : true }, - "returnHistory" : { + "pipeline" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ClaimKeyReturnEvent" + "$ref" : "#/components/schemas/PipelineComponent" }, "nullable" : true }, - "state" : { - "$ref" : "#/components/schemas/ClaimKeyStateEnum" - }, - "trial" : { - "type" : "boolean", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ClaimKeyTypeEnum" - }, - "updatedOn" : { + "restrictedOrgUuid" : { "type" : "string", - "format" : "date-time", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { @@ -119362,117 +121030,89 @@ } } }, - "ReportBucketSizeEnum" : { - "type" : "string", - "description" : "Size of the report buckets", - "enum" : [ "QUARTER_HOUR", "HOUR", "DAY", "WEEK", "MONTH" ] - }, - "ReportIntervalEnum" : { - "type" : "string", - "description" : "Report interval for filtering face events", - "enum" : [ "MINUTELY", "QUARTERHOURLY", "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ] - }, - "ReportScopeEnum" : { - "type" : "string", - "description" : "Scope of the report to reset", - "enum" : [ "REGION", "DEVICE", "LOCATION", "ORG" ] - }, - "ReportTypeEnum" : { - "type" : "string", - "description" : "Type of report to receive", - "enum" : [ "CROWD", "PEOPLE", "FACES", "MOTION", "BANDWIDTH", "VEHICLES", "LICENSEPLATES", "ALERTS", "AM_VERIFICATION", "DWELL" ] - }, - "Report_AuditEventWeb" : { + "ModularAIConfigSelectiveUpdate" : { "type" : "object", - "description" : "Web representation of an audit event.", + "description" : "Selective update configuration for the modular AI model", "properties" : { - "FOOBAR" : { + "description" : { "type" : "string", "nullable" : true }, - "action" : { - "$ref" : "#/components/schemas/AuditActionEnum" - }, - "asi" : { + "distributionUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "clientType" : { - "$ref" : "#/components/schemas/ClientEnum" + "modelParams" : { + "$ref" : "#/components/schemas/ModularAIModelParams" }, - "displayText" : { + "modelQuantizedBinaryContentLocator" : { "type" : "string", - "description" : "Display text for the audit event", - "example" : "User login successful", "nullable" : true }, - "failure" : { - "type" : "boolean", - "description" : "Whether the audit event represents a failure", - "example" : false, - "nullable" : true + "modelStatus" : { + "$ref" : "#/components/schemas/ModelStatusEnum" }, - "orgUuid" : { + "modelUploadZipContentLocator" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "principalName" : { + "name" : { "type" : "string", "nullable" : true }, - "principalType" : { - "$ref" : "#/components/schemas/PrincipalUuidEnum" + "pipeline" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PipelineComponent" + }, + "nullable" : true }, - "principalUuid" : { + "restrictedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "selectiveUpdateStr" : { - "type" : "string", - "nullable" : true - }, - "sourceCity" : { - "type" : "string", - "nullable" : true - }, - "sourceCountry" : { - "type" : "string", + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true }, - "sourceIp" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "sourceState" : { + } + } + }, + "ModularAIDistribution" : { + "type" : "object", + "description" : "List of available modular AI distributions", + "properties" : { + "description" : { "type" : "string", "nullable" : true }, - "targetName" : { + "name" : { "type" : "string", "nullable" : true }, - "targetUuid" : { + "restrictedOrgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestamp" : { - "type" : "string", - "format" : "date-time", - "nullable" : true - }, - "userAgent" : { - "type" : "string", - "nullable" : true - }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -119482,38 +121122,53 @@ } } }, - "Report_GetAuditFeedForPrincipalWSRequest" : { + "ModularAIModelParams" : { "type" : "object", - "description" : "Request object for getting audit feed for a specific principal.", "properties" : { - "maxResults" : { + "classOutputMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "inputHeight" : { "type" : "integer", "format" : "int32", - "description" : "Max number of audit records to retrieve", "nullable" : true }, - "principalUuid" : { + "inputWidth" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Modularai_AddModelToDeviceWSRequest" : { + "type" : "object", + "description" : "Request object for adding a modular AI model to a device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "modelUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "principalUuid" ] + } }, - "Report_GetAuditFeedForPrincipalWSResponse" : { + "Modularai_AddModelToDeviceWSResponse" : { "type" : "object", - "description" : "Response object for getting audit feed for a specific principal.", + "description" : "Response object for adding a modular AI model to a device.", "properties" : { - "auditEvents" : { - "type" : "array", - "description" : "List of audit events for the principal", - "items" : { - "$ref" : "#/components/schemas/Report_AuditEventWeb" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -119528,38 +121183,26 @@ } } }, - "Report_GetAuditFeedForTargetWSRequest" : { + "Modularai_CreateModularAIDistributionWSRequest" : { "type" : "object", - "description" : "Request object for getting audit feed for a specific target.", + "description" : "Request object for creating a modular AI distribution.", "properties" : { - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "Max number of audit records to retrieve", + "description" : { + "type" : "string", + "description" : "Description of the created model.", "nullable" : true }, - "targetUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Name of the created model.", "nullable" : true } - }, - "required" : [ "targetUuid" ] + } }, - "Report_GetAuditFeedForTargetWSResponse" : { + "Modularai_CreateModularAIDistributionWSResponse" : { "type" : "object", - "description" : "Response object for getting audit feed for a specific target.", + "description" : "Response object for creating a modular AI distribution.", "properties" : { - "auditEvents" : { - "type" : "array", - "description" : "List of audit events for the target", - "items" : { - "$ref" : "#/components/schemas/Report_AuditEventWeb" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -119568,62 +121211,54 @@ "type" : "string", "nullable" : true }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Report_GetAuditFeedWSRequest" : { + "Modularai_CreateModularAIPipelineConfigWSRequest" : { "type" : "object", - "description" : "Request object for getting audit feed.", + "description" : "Request object for creating a modular AI pipeline config.", "properties" : { - "excludeActions" : { - "type" : "array", - "description" : "If not empty, events with actions specified in the list are filtered out. If both include and exclude actions are specified, exclude actions are ignored.", - "items" : { - "$ref" : "#/components/schemas/AuditActionEnum" - }, - "maxItems" : 50, + "description" : { + "type" : "string", + "description" : "Description of the created model.", "nullable" : true }, - "includeActions" : { - "type" : "array", - "description" : "If not empty, only events with actions specified in the list are returned. If both include and exclude actions are specified, exclude actions are ignored. ", - "items" : { - "$ref" : "#/components/schemas/AuditActionEnum" - }, - "maxItems" : 50, + "distributionUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMsAfter" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds after which to get audit events", - "example" : 1640995200000, + "name" : { + "type" : "string", + "description" : "Name of the created model.", "nullable" : true }, - "timestampMsBefore" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds before which to get audit events", - "example" : 1640998800000, + "pipeline" : { + "type" : "array", + "description" : "List of pipeline components describing the behavior of the modular ai config.", + "items" : { + "$ref" : "#/components/schemas/PipelineComponent" + }, "nullable" : true } } }, - "Report_GetAuditFeedWSResponse" : { + "Modularai_CreateModularAIPipelineConfigWSResponse" : { "type" : "object", - "description" : "Response object for getting audit feed.", + "description" : "Response object for creating a modular AI pipeline config.", "properties" : { - "auditEvents" : { - "type" : "array", - "description" : "List of audit events", - "items" : { - "$ref" : "#/components/schemas/Report_AuditEventWeb" - }, - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -119632,38 +121267,24 @@ "type" : "string", "nullable" : true }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Report_GetAverageReportWSRequest" : { + "Modularai_GetDevicesForModelWSRequest" : { "type" : "object", - "description" : "Request object for getting average reports.", + "description" : "Request object for getting devices running a modular AI model.", "properties" : { - "endDate" : { - "type" : "string", - "description" : "End date for the report", - "example" : "2024-01-31", - "nullable" : true - }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" - }, - "startDate" : { - "type" : "string", - "description" : "Start date for the report", - "example" : "2024-01-01", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" - }, - "uuid" : { + "modelUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -119672,15 +121293,20 @@ } } }, - "Report_GetAverageReportWSResponse" : { + "Modularai_GetDevicesForModelWSResponse" : { "type" : "object", - "description" : "Response object for getting average reports.", + "description" : "Response object containing devices running a modular AI model.", "properties" : { - "average" : { - "type" : "number", - "format" : "double", - "description" : "Overall average value", - "example" : 15.5, + "devices" : { + "type" : "array", + "description" : "List of device facet UUIDs running the modular AI model", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, "nullable" : true }, "error" : { @@ -119691,65 +121317,29 @@ "type" : "string", "nullable" : true }, - "groupAverageMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", - "description" : "Map of group IDs to their average values", - "nullable" : true - }, - "description" : "Map of group IDs to their average values", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Report_GetAverageReportsWSRequest" : { + "Modularai_GetModelsAddedToDeviceWSRequest" : { "type" : "object", - "description" : "Request object for getting average reports.", + "description" : "Request object for getting modular AI models added to a device.", "properties" : { - "endDate" : { - "type" : "string", - "description" : "End date for the report", - "example" : "2024-01-31", - "nullable" : true - }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" - }, - "startDate" : { + "deviceUuid" : { "type" : "string", - "description" : "Start date for the report", - "example" : "2024-01-01", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" } } }, - "Report_GetAverageReportsWSResponse" : { + "Modularai_GetModelsAddedToDeviceWSResponse" : { "type" : "object", - "description" : "Response object for getting average reports.", + "description" : "Response object containing modular AI models added to a device.", "properties" : { - "averageMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", - "description" : "Map of UUIDs to their average values", - "nullable" : true - }, - "description" : "Map of UUIDs to their average values", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -119758,20 +121348,12 @@ "type" : "string", "nullable" : true }, - "groupAverageMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "double", - "description" : "Map of UUIDs to their group average maps", - "nullable" : true - }, - "description" : "Map of UUIDs to their group average maps", - "nullable" : true + "models" : { + "type" : "array", + "description" : "List of modular AI models added to the device", + "items" : { + "$ref" : "#/components/schemas/ModularAIConfig" }, - "description" : "Map of UUIDs to their group average maps", "nullable" : true }, "warningMsg" : { @@ -119780,142 +121362,117 @@ } } }, - "Report_GetBatchThresholdCrossingCountReportWSRequest" : { + "Modularai_GetModelsForDistributionWSRequest" : { "type" : "object", - "description" : "Request object for getting batch threshold crossing count reports.", + "description" : "Request object for getting modular AI models for a given distribution.", "properties" : { - "bucketSize" : { - "$ref" : "#/components/schemas/ReportBucketSizeEnum" - }, - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" - }, - "dedupe" : { + "distributionUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Modularai_GetModelsForDistributionWSResponse" : { + "type" : "object", + "description" : "Response object containing available modular AI models for a given distribution.", + "properties" : { + "error" : { "type" : "boolean", - "description" : "Whether to deduplicate the results", - "example" : true, "nullable" : true }, - "deviceUuids" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "models" : { "type" : "array", - "description" : "UUID of devices to get threshold crossing count report for", + "description" : "List of available modular AI models", "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "$ref" : "#/components/schemas/ModularAIConfig" }, "nullable" : true }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds", - "example" : 1640998800000, - "nullable" : true - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds", - "example" : 1640995200000, - "nullable" : true - }, - "timeZone" : { + "warningMsg" : { "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", "nullable" : true } } }, - "Report_GetCountReportV2WSRequest" : { + "Modularai_GetModelsWSRequest" : { "type" : "object", - "description" : "Request object for getting count reports V2.", + "description" : "Request object for getting available modular AI models." + }, + "Modularai_GetModelsWSResponse" : { + "type" : "object", + "description" : "Response object containing available modular AI models.", "properties" : { - "endDate" : { - "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use endTimeMs instead", - "nullable" : true - }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, - "nullable" : true - }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" - }, - "startDate" : { - "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use startTimeMs instead", - "nullable" : true - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "error" : { + "type" : "boolean", "nullable" : true }, - "timeZone" : { + "errorMsg" : { "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", "nullable" : true }, - "types" : { + "models" : { "type" : "array", - "description" : "Types of reports to receive", + "description" : "List of available modular AI models", "items" : { - "$ref" : "#/components/schemas/ReportTypeEnum" + "$ref" : "#/components/schemas/ModularAIConfig" }, "nullable" : true }, - "uuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - }, - "required" : [ "interval", "scope", "types" ] + } }, - "Report_GetCountReportWSRequest" : { + "Modularai_ListModularAIDistributionsWSRequest" : { "type" : "object", - "description" : "Request object for getting count reports.", + "description" : "Request object for getting available modular AI distributions." + }, + "Modularai_ListModularAIDistributionsWSResponse" : { + "type" : "object", + "description" : "Response object containing available modular AI distributions.", "properties" : { - "endDate" : { - "type" : "string", - "description" : "End date for the report", - "example" : "2024-01-31", + "distributions" : { + "type" : "array", + "description" : "List of available modular AI distributions", + "items" : { + "$ref" : "#/components/schemas/ModularAIDistribution" + }, "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" + "error" : { + "type" : "boolean", + "nullable" : true }, - "startDate" : { + "errorMsg" : { "type" : "string", - "description" : "Start date for the report", - "example" : "2024-01-01", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Modularai_RemoveModelFromDeviceWSRequest" : { + "type" : "object", + "description" : "Request object for removing a modular AI model from a device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, - "uuid" : { + "modelUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -119924,9 +121481,9 @@ } } }, - "Report_GetCountReportWSResponse" : { + "Modularai_RemoveModelFromDeviceWSResponse" : { "type" : "object", - "description" : "Response object for getting count reports.", + "description" : "Response object for removing a modular AI model from a device.", "properties" : { "error" : { "type" : "boolean", @@ -119936,1063 +121493,1231 @@ "type" : "string", "nullable" : true }, - "timeSeriesDataPoints" : { - "type" : "array", - "description" : "List of time series data points for count report", - "items" : { - "$ref" : "#/components/schemas/TimeSeriesDataPointV2Type" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Report_GetCountReportsForDevicesAtLocationWSRequest" : { + "Modularai_UpdateModelWSRequest" : { "type" : "object", - "description" : "Request object for getting count reports for devices at a specific location.", + "description" : "Request object for updating modular AI model configuration.", "properties" : { - "endTimeMs" : { + "update" : { + "$ref" : "#/components/schemas/ModularAIConfigSelectiveUpdate" + } + } + }, + "Modularai_UpdateModelWSResponse" : { + "type" : "object", + "description" : "Response object for updating modular AI model configuration." + }, + "MonitoringEnableStatus" : { + "type" : "object", + "description" : "Map of location UUIDs to their monitoring enable status", + "properties" : { + "devicesWithActiveSirens" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true + }, + "disabledOnMs" : { "type" : "integer", "format" : "int64", - "description" : "End timestamp in epoch milliseconds.", - "minimum" : 0, "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "startTimeMs" : { + "enabledOnMs" : { "type" : "integer", "format" : "int64", - "description" : "Start timestamp in epoch milliseconds.", - "minimum" : 0, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" + "noNextTimestampReason" : { + "type" : "string", + "nullable" : true + }, + "notEnabledReason" : { + "type" : "string", + "nullable" : true + }, + "recentlyActivatedSirensTimestampMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true } - }, - "required" : [ "endTimeMs", "interval", "locationUuid", "startTimeMs", "type" ] + } }, - "Report_GetCountReportsWSRequest" : { + "MonitoringModeEnum" : { + "type" : "string", + "enum" : [ "MANUAL", "SCHEDULED", "UNKNOWN" ] + }, + "MspApproval" : { "type" : "object", - "description" : "Request object for getting count reports.", + "nullable" : true, "properties" : { - "endDate" : { + "adminUser" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use endTimeMs instead", "nullable" : true }, - "endTimeMs" : { + "timestampMillis" : { "type" : "integer", "format" : "int64", - "description" : "End datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "nullable" : true + } + } + }, + "MspDesignationStatusEnum" : { + "type" : "string", + "enum" : [ "PENDING_APPROVAL", "ACTIVE", "REVOKED", "UNKNOWN" ] + }, + "MspDesignationType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "agreementRef" : { + "type" : "string", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" + "approvals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MspApproval" + }, + "nullable" : true }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" + "contractSignedDate" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "startDate" : { + "keyId" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use startTimeMs instead", "nullable" : true }, - "startTimeMs" : { + "proposedAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Start datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, "nullable" : true }, - "timeZone" : { + "salesforceAccountId" : { "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" - } - }, - "required" : [ "interval", "scope", "type" ] - }, - "Report_GetCountReportsWSResponse" : { - "type" : "object", - "description" : "Response object for getting count reports.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "signature" : { "type" : "string", + "description" : "Base64 ECDSA (P-256, SHA-256) signature over the canonical designation payload.", "nullable" : true }, - "timeSeriesDataPointsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of UUIDs to their time series data points", - "items" : { - "$ref" : "#/components/schemas/TimeSeriesDataPointV2Type" - }, - "nullable" : true - }, - "description" : "Map of UUIDs to their time series data points", + "signedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "source" : { "type" : "string", + "description" : "How the designation landed: SALESFORCE_PULL or ADMIN_SYNC.", "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/MspDesignationStatusEnum" } } }, - "Report_GetCustomLLMNumericWSResponse" : { + "MultiPart" : { "type" : "object", - "description" : "Response object for custom LLM numeric reports.", + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "bodyParts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BodyPart" + }, "nullable" : true }, - "errorMsg" : { - "type" : "string", + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" + }, + "entity" : { + "type" : "object", "nullable" : true }, - "reports" : { + "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", - "description" : "Map of numeric count reports", "items" : { - "$ref" : "#/components/schemas/NumericAggregationValue" + "type" : "string", + "nullable" : true }, "nullable" : true }, - "description" : "Map of numeric count reports", - "nullable" : true + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Report_GetCustomLLMReportWSRequest" : { - "type" : "object", - "description" : "Request object for custom LLM reports.", - "properties" : { - "deviceFacetUuids" : { - "type" : "array", - "description" : "Uuids of the selected devices", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "mediaType" : { + "$ref" : "#/components/schemas/MediaType" + }, + "messageBodyWorkers" : { + "$ref" : "#/components/schemas/MessageBodyWorkers" + }, + "parameterizedHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterizedHeader" + }, "nullable" : true }, "nullable" : true, - "uniqueItems" : true + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The end timestamp (in Unix epoch milliseconds) of the selected interval", - "example" : 1640998800000, + "providers" : { + "$ref" : "#/components/schemas/Providers" + } + } + }, + "MultivaluedMapStringObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object", "nullable" : true }, - "extendedResponse" : { + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { "type" : "boolean", "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "promptUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The start timestamp (in Unix epoch milliseconds) of the selected interval", - "example" : 1640995200000, - "nullable" : true } } }, - "Report_GetCustomLLMReportWSResponse" : { + "MultivaluedMapStringParameterizedHeader" : { "type" : "object", - "description" : "Response object for custom LLM reports.", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterizedHeader" + }, + "nullable" : true + }, + "nullable" : true, "properties" : { - "error" : { + "empty" : { "type" : "boolean", "nullable" : true - }, - "errorMsg" : { + } + } + }, + "MultivaluedMapStringString" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { "type" : "string", "nullable" : true }, - "timeSeriesDataPoints" : { - "type" : "array", - "description" : "List of time series data points", - "items" : { - "$ref" : "#/components/schemas/SceneQueryReport" - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", "nullable" : true } } }, - "Report_GetCustomLLMWBinaryWSResponse" : { + "NavigationTypeEnum" : { + "type" : "string", + "enum" : [ "ROUTE", "PATROL", "WAYPOINT", "POSE" ] + }, + "NetsuiteInvoiceDetails" : { "type" : "object", - "description" : "Response object for custom LLM binary reports.", "properties" : { - "error" : { - "type" : "boolean", + "billingContactEmail" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "billingContactName" : { "type" : "string", "nullable" : true }, - "reports" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of binary count reports", - "items" : { - "$ref" : "#/components/schemas/BinaryAggregationValue" - }, - "nullable" : true - }, - "description" : "Map of binary count reports", + "billingcontactemail" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "billingcontactname" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "clientOrgName" : { "type" : "string", "nullable" : true - } - } - }, - "Report_GetCustomLLMWSRequest" : { - "type" : "object", - "description" : "Request object for custom LLM reports.", - "properties" : { - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The end timestamp (in Unix epoch milliseconds) of the selected interval", - "example" : 1640998800000, + }, + "clientorgname" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "dueDate" : { + "type" : "string", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" + "duedate" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true }, - "promptUuid" : { + "invoiceDate" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The start timestamp (in Unix epoch milliseconds) of the selected interval", - "example" : 1640995200000, + "invoiceUuid" : { + "type" : "string", "nullable" : true - } - } - }, - "Report_GetDiagnosticFeedWSRequest" : { - "type" : "object", - "description" : "Request object for getting diagnostic feed.", - "properties" : { - "timestampMsAfter" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds after which to get diagnostic events", - "example" : 1640995200000, + }, + "invoicedate" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "invoiceinternalid" : { + "type" : "string", "nullable" : true }, - "timestampMsBefore" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds before which to get diagnostic events", - "example" : 1640998800000, + "invoiceuuid" : { + "type" : "string", "nullable" : true - } - } - }, - "Report_GetDiagnosticFeedWSResponse" : { - "type" : "object", - "description" : "Response object for getting diagnostic feed.", - "properties" : { - "diagnosticEvents" : { + }, + "lineItems" : { "type" : "array", - "description" : "List of diagnostic events", "items" : { - "$ref" : "#/components/schemas/DiagnosticEventType" + "$ref" : "#/components/schemas/LineItems" }, "nullable" : true }, - "error" : { - "type" : "boolean", + "lineitems" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LineItems" + }, "nullable" : true }, - "errorMsg" : { + "partnerOrgName" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "partnerorgname" : { "type" : "string", - "nullable" : true - } - } - }, - "Report_GetLicensePlatesByDeviceWSRequest" : { - "type" : "object", - "description" : "Request object for getting license plates by device.", - "properties" : { - "dateLocal" : { + "nullable" : true, + "writeOnly" : true + }, + "paymentid" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use timestampMs instead", "nullable" : true }, - "deviceUuid" : { + "status" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, - "nullable" : true - } - }, - "required" : [ "deviceUuid", "interval" ] - }, - "Report_GetLicensePlatesByDeviceWSResponse" : { - "type" : "object", - "description" : "Response object for getting license plates by device.", - "properties" : { - "error" : { - "type" : "boolean", + "totalBalance" : { + "type" : "number", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "totalbalance" : { + "type" : "number", "nullable" : true }, - "licensePlateEvents" : { - "type" : "array", - "description" : "List of license plate events", - "items" : { - "$ref" : "#/components/schemas/VehicleEventIndexType" - }, + "transactionId" : { + "type" : "string", "nullable" : true }, - "warningMsg" : { + "transactionid" : { "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "unpaidBalance" : { + "type" : "number", "nullable" : true + }, + "unpaidbalance" : { + "type" : "number", + "nullable" : true, + "writeOnly" : true } } }, - "Report_GetMostRecentPeopleCountWSRequest" : { + "Network_GetDeviceNetworkConfigurationWSRequest" : { "type" : "object", - "description" : "Request object for getting most recent people count.", "properties" : { "deviceUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "numMostRecent" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of most recent people counts to retrieve", - "example" : 10, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Report_GetMostRecentPeopleCountWSResponse" : { + "Network_GetDeviceNetworkConfigurationWSResponse" : { "type" : "object", - "description" : "Response object for getting most recent people count.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "events" : { + "ipConfigurations" : { "type" : "array", - "description" : "List of people count events", "items" : { - "$ref" : "#/components/schemas/PeopleCountEventType" + "$ref" : "#/components/schemas/Network_IpConfiguration" }, "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Report_GetOccupancyCountWSRequest" : { + "Network_IpConfiguration" : { "type" : "object", - "description" : "Request object for getting occupancy count from a device.", "properties" : { - "deviceUuid" : { + "dnsServer1" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "endMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds", - "example" : 1640998800000, + "description" : "Primary DNS server. Will only be set if mode is STATIC.", "nullable" : true }, - "startMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds", - "example" : 1640995200000, - "nullable" : true - } - } - }, - "Report_GetOccupancyCountWSResponse" : { - "type" : "object", - "description" : "Response object for getting occupancy count from a device.", - "properties" : { - "approximateTimestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Approximate timestamp in milliseconds when the count was estimated", - "example" : 1640995200000, + "dnsServer2" : { + "type" : "string", + "description" : "Secondary DNS server. Will only be set if mode is STATIC.", "nullable" : true }, - "error" : { - "type" : "boolean", + "gateway" : { + "type" : "string", + "description" : "Gateway address. Will only be set if mode is STATIC.", "nullable" : true }, - "errorMsg" : { + "ipAddress" : { "type" : "string", + "description" : "IP address. Will only be set if mode is STATIC.", "nullable" : true }, - "estimatedCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Estimated occupancy count", - "example" : 15, + "isSecondary" : { + "type" : "boolean", + "description" : "Indicates whether this IP configuration is secondary. Default is false (primary).", "nullable" : true }, - "warningMsg" : { + "mode" : { + "$ref" : "#/components/schemas/Network_NetworkConfigurationModeEnum" + }, + "netmask" : { "type" : "string", + "description" : "Subnet mask. Will only be set if mode is STATIC.", "nullable" : true } } }, - "Report_GetOccupancyCountsWSRequest" : { + "Network_NetworkConfigurationModeEnum" : { + "type" : "string", + "description" : "Network configuration mode for devices.", + "enum" : [ "DHCP", "STATIC" ] + }, + "Network_UpdateDeviceIpConfigurationWSRequest" : { "type" : "object", - "description" : "Request object for getting occupancy counts from a device.", "properties" : { "deviceUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The end timestamp (in Unix epoch milliseconds) of the selected interval", - "example" : 1640998800000, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The start timestamp (in Unix epoch milliseconds) of the selected interval", - "example" : 1640995200000, - "nullable" : true + "ipConfiguration" : { + "$ref" : "#/components/schemas/Network_IpConfiguration" } } }, - "Report_GetOccupancyCountsWSResponse" : { + "Network_UpdateDeviceIpConfigurationWSResponse" : { "type" : "object", - "description" : "Response object for getting occupancy counts from a device.", "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "timeSeriesDataPoints" : { - "type" : "array", - "description" : "List of time series data points with occupancy counts", - "items" : { - "$ref" : "#/components/schemas/Report_TimeSeriesDataPointV2ExtendedType" - }, - "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true + "ipConfiguration" : { + "$ref" : "#/components/schemas/Network_IpConfiguration" } } }, - "Report_GetProximityTagLocationsByDateWSRequest" : { + "NewCookie" : { "type" : "object", - "description" : "Request object for getting proximity tag locations by date.", + "nullable" : true, "properties" : { - "endDateStr" : { + "comment" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use endTimeMs instead", "nullable" : true }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "domain" : { + "type" : "string", "nullable" : true }, - "startDateStr" : { + "expiry" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use startTimeMs instead", + "format" : "date-time", "nullable" : true }, - "startTimeMs" : { + "httpOnly" : { + "type" : "boolean", + "nullable" : true + }, + "maxAge" : { "type" : "integer", - "format" : "int64", - "description" : "Start datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "format" : "int32", "nullable" : true }, - "tagUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - }, - "required" : [ "tagUuid" ] - }, - "Report_GetProximityTagLocationsByDateWSResponse" : { - "type" : "object", - "description" : "Response object for getting proximity tag locations by date.", - "properties" : { - "dataPoints" : { - "type" : "array", - "description" : "List of proximity tag time series data points", - "items" : { - "$ref" : "#/components/schemas/ProximityTagTimeSeriesDataPointType" - }, + }, + "path" : { + "type" : "string", "nullable" : true }, - "error" : { + "sameSite" : { + "$ref" : "#/components/schemas/JakartaSameSiteEnum" + }, + "secure" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "value" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "version" : { + "type" : "integer", + "format" : "int32", "nullable" : true } } }, - "Report_GetRunningAverageWSRequest" : { + "NewGuestPassCredentialSpec" : { "type" : "object", - "description" : "Request object for getting running average statistics.", + "description" : "Polymorphic credential creation spec. Discriminated on the AccessControlCredentialEnumType value in the 'type' field. PIN_CODE and QR_CODE_STATIC are currently supported.", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/PinCodeNewGuestPassCredentialSpec" + }, { + "$ref" : "#/components/schemas/QrCodeStaticNewGuestPassCredentialSpec" + } ], "properties" : { - "endDate" : { + "type" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use endTimeMs instead", + "description" : "Discriminator for the credential type to create.", "nullable" : true - }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + } + }, + "required" : [ "type" ] + }, + "NineOneOneCellularType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "bearerToken" : { + "type" : "string", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "securityZoneMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SecurityZoneInfoType" + }, + "nullable" : true + }, + "triggerNotification" : { + "type" : "boolean", + "nullable" : true + }, + "webhookToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "zonesValidated" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" - }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" }, - "startDate" : { - "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use startTimeMs instead", + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timeZone" : { + "userUuid" : { "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "uuid" : { + } + } + }, + "NoOpAction" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/RobotActionTypeEnum" } - }, - "required" : [ "interval", "scope" ] + } }, - "Report_GetRunningAverageWSResponse" : { + "NoonlightPromptSelection" : { "type" : "object", - "description" : "Response object for getting running average statistics.", + "description" : "The threat qualification prompt to update.", "properties" : { - "error" : { + "mutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "statsDataPoints" : { + "reasons" : { "type" : "array", - "description" : "List of weekly statistics data points", "items" : { - "$ref" : "#/components/schemas/WeeklyStatisticsDataPoint" + "$ref" : "#/components/schemas/NoonlightReasonEnum" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { + "title" : { "type" : "string", "nullable" : true } } }, - "Report_GetSummaryCountReportWSRequest" : { + "NoonlightPromptThemeEnum" : { + "type" : "string", + "enum" : [ "THREAT", "HUMAN" ] + }, + "NoonlightReasonEnum" : { + "type" : "string", + "enum" : [ "NO_PERSON", "ROUTINE_EMPLOYEE", "PERSON_OUTSIDE", "PERSON_INSIDE", "OTHER", "SERVICES_ONSITE", "MOVING_VEHICLE", "CAMERA_OBSTRUCTED", "VIDEO_ISSUE", "PERSON_OTHER", "NO_PERSON_OTHER", "LOAD_FAILURE", "ACTIVE_CRIME", "UNKNOWN_PERSON_INSIDE", "UNKNOWN_SUSPECT_OUTSIDE", "UNKNOWN_SUSPECT_INSIDE", "UNKNOWN_PERSON_OUTSIDE", "OTHER_CONCLUSIVE_RESULT", "TIMEOUT" ] + }, + "NoonlightScheduleType" : { "type" : "object", - "description" : "Request object for getting summary count reports.", "properties" : { - "endDate" : { - "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use endTimeMs instead", - "nullable" : true + "audioGateways" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "endTimeMs" : { + "escalationDelayMinutes" : { "type" : "integer", - "format" : "int64", - "description" : "End datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "format" : "int32", "nullable" : true }, - "interval" : { - "$ref" : "#/components/schemas/ReportIntervalEnum" + "monitoredDevices" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" + "promptTheme" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" }, - "startDate" : { + "promptTitle" : { "type" : "string", - "deprecated" : true, - "description" : "Deprecated input, use startTimeMs instead", "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start datetime provided as a UNIX timestamp in milliseconds", - "minimum" : 0, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timeZone" : { + "sirenSettings" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" + }, + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "tripwire" : { + "$ref" : "#/components/schemas/TripwireSettings" + }, + "uuid" : { "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ReportTypeEnum" + "verifiedThreatSiren" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" } - }, - "required" : [ "interval", "scope", "type" ] + } }, - "Report_GetSummaryCountReportWSResponse" : { + "NoonlightSettings" : { "type" : "object", - "description" : "Response object for getting summary count reports.", "properties" : { - "error" : { + "acceptedTermsOfService" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "defaultContactsByLocationMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/EmergencyContact" + }, "nullable" : true }, - "timeSeriesDataPoints" : { - "type" : "array", - "description" : "List of summary count time series data points", - "items" : { - "$ref" : "#/components/schemas/SummaryCountTimeSeriesDataPointType" + "defaultDelayByLocationsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, "nullable" : true }, - "warningMsg" : { - "type" : "string", + "defaultPromptByLocationsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + }, "nullable" : true - } - } - }, - "Report_GetThresholdCrossingCountReportForOrgWSRequest" : { - "type" : "object", - "description" : "Request object for getting org wide threshold crossing count reports.", - "properties" : { - "bucketSize" : { - "$ref" : "#/components/schemas/ReportBucketSizeEnum" }, - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" + "emergencyContactsByLocationsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EmergencyResponseContactsIntervalType" + }, + "nullable" : true + }, + "nullable" : true }, - "dedupe" : { + "enabled" : { "type" : "boolean", - "description" : "Whether to deduplicate the results", - "example" : true, "nullable" : true }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds", - "example" : 1640998800000, + "escalationSettingsByLocationsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringSubmissionDelayIntervalType" + }, + "nullable" : true + }, "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds", - "example" : 1640995200000, + "locationEntryInstructionsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "timeZone" : { + "pinsByLocationMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringPinType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "nullable" : true + }, + "verificationPrompt" : { "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", "nullable" : true } } }, - "Report_GetThresholdCrossingCountReportWSRequest" : { + "NoonlightVersionedSettingsType" : { "type" : "object", - "description" : "Request object for getting threshold crossing count reports.", + "description" : "Updated alert monitoring settings configuration for the location", "properties" : { - "bucketSize" : { - "$ref" : "#/components/schemas/ReportBucketSizeEnum" - }, - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" - }, - "dedupe" : { + "acceptedTermsOfService" : { "type" : "boolean", - "description" : "Whether to deduplicate the results", - "example" : true, "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "badgeAuthDisablesMonitoring" : { + "type" : "boolean", "nullable" : true }, - "endTimeMs" : { + "defaultDelay" : { "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds", - "example" : 1640998800000, + "format" : "int32", "nullable" : true }, - "startTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds", - "example" : 1640995200000, - "nullable" : true + "defaultEmergencyContact" : { + "$ref" : "#/components/schemas/EmergencyContact" }, - "timeZone" : { - "type" : "string", - "description" : "String of timezone for bucketing", - "example" : "America/Los_Angeles", + "defaultPromptTheme" : { + "$ref" : "#/components/schemas/NoonlightPromptThemeEnum" + }, + "deleted" : { + "type" : "boolean", "nullable" : true - } - } - }, - "Report_GetThresholdCrossingCountReportWSResponse" : { - "type" : "object", - "description" : "Response object for getting threshold crossing count reports.", - "properties" : { - "crossingCounts" : { + }, + "emergencyContacts" : { "type" : "array", - "description" : "List of crossing counts", "items" : { - "$ref" : "#/components/schemas/CrossingCountsType" + "$ref" : "#/components/schemas/EmergencyResponseContactsScheduleType" }, "nullable" : true }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "entryInstructions" : { "type" : "string", "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Report_GetThresholdCrossingCountsWSRequest" : { - "type" : "object", - "description" : "Request object for getting threshold crossing counts.", - "properties" : { - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" }, - "dailyResetTimeMinute" : { - "type" : "integer", - "format" : "int32", - "description" : "Daily reset time in minutes", - "example" : 0, + "manualEscalationSettings" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, + "modifiedByEmail" : { + "type" : "string", "nullable" : true }, - "devices" : { - "type" : "array", - "description" : "List of device UUIDs to get threshold crossing counts for", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "modifiedByIntegration" : { + "type" : "boolean", "nullable" : true }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End time in milliseconds", - "example" : 1640998800000, + "modifiedByMetadata" : { + "type" : "string", "nullable" : true }, - "startTimeMs" : { + "modifiedByUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "modifiedTimeMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time in milliseconds", - "example" : 1640995200000, "nullable" : true - } - } - }, - "Report_GetThresholdCrossingCountsWSResponse" : { - "type" : "object", - "description" : "Response object for getting threshold crossing counts.", - "properties" : { - "counts" : { + }, + "monitoringMode" : { + "$ref" : "#/components/schemas/MonitoringModeEnum" + }, + "oneTimePauses" : { "type" : "array", - "description" : "List of threshold crossing counts", "items" : { - "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSResponse_ThresholdCrossingCountType" + "$ref" : "#/components/schemas/NoonlightScheduleType" }, "nullable" : true }, - "error" : { - "type" : "boolean", + "oneTimeSchedules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "pins" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringPinType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "rules" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "schedules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NoonlightScheduleType" + }, + "nullable" : true + }, + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "talkdownEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "Report_GetThresholdCrossingCountsWSResponse_ThresholdCrossingCountType" : { + "NormalStateEnumType" : { + "type" : "string", + "enum" : [ "NO", "NC" ] + }, + "NotificationEnumType" : { + "type" : "string", + "enum" : [ "SMS", "EMAIL", "APP", "SLACK", "MICROSOFT_TEAMS", "BROWSER", "UNKNOWN" ] + }, + "NotificationFollowUp" : { "type" : "object", - "description" : "Threshold crossing count data point.", + "allOf" : [ { + "type" : "object", + "properties" : { + "userUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + } ], + "nullable" : true, "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Count of threshold crossings", - "example" : 5, - "nullable" : true - }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds", - "example" : 1640995200000, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ChatFollowUpActionEnum" } } }, - "Report_GetThresholdCrossingEventsForDeviceWSRequest" : { + "NotificationIntervalV2Type" : { "type" : "object", - "description" : "Request object for getting threshold crossing events for a specific device.", "properties" : { - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" + "activityTriggerMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "deviceFilterSet" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "diagnosticTriggerMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + }, "nullable" : true }, - "endTimeMs" : { - "type" : "integer", - "format" : "int64", - "description" : "End timestamp of query period in epoch MS", - "example" : 1640998800000, + "locationActivityTriggerMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + }, "nullable" : true }, - "lastEvaluatedKey" : { - "type" : "string", - "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", + "locationDiagnosticTriggerMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + }, "nullable" : true }, - "maxPageSize" : { + "locationFilterSet" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationOnlyFilterSet" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "minuteOfWeekStart" : { "type" : "integer", "format" : "int32", - "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", - "example" : 100, "nullable" : true }, - "startTimeMs" : { + "minuteOfWeekStop" : { "type" : "integer", - "format" : "int64", - "description" : "Start timestamp of query period in epoch MS", - "example" : 1640995200000, + "format" : "int32", "nullable" : true } } }, - "Report_GetThresholdCrossingEventsForDeviceWSResponse" : { + "NotificationSettingsType" : { "type" : "object", - "description" : "Response object for getting threshold crossing events for a specific device.", "properties" : { - "error" : { - "type" : "boolean", + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "slackChannel" : { "type" : "string", "nullable" : true }, - "lastEvaluatedKey" : { + "slackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "slackWebhookUrl" : { "type" : "string", - "description" : "If a max page size was specified and there are additional results that can be retrieved this will be non-null and should be supplied in the next request to retrieve the next page of results", "nullable" : true + } + } + }, + "NotificationTimeFrame" : { + "type" : "object", + "properties" : { + "days" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RhombusDayOfWeekEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "thresholdCrossingEvents" : { + "interval" : { + "$ref" : "#/components/schemas/MinuteOfDayIntervalType" + }, + "mediums" : { "type" : "array", - "description" : "List of threshold crossing events for the device", "items" : { - "$ref" : "#/components/schemas/MinimalThresholdEventType" + "$ref" : "#/components/schemas/NotificationEnumType" }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "warningMsg" : { - "type" : "string", + "rows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationTimeFrameRow" + }, "nullable" : true } } }, - "Report_GetThresholdCrossingEventsWSRequest" : { + "NotificationTimeFrameRow" : { "type" : "object", - "description" : "Request object for getting threshold crossing events.", "properties" : { - "crossingObject" : { - "$ref" : "#/components/schemas/CrossingObjectEnum" + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true }, "devices" : { "type" : "array", - "description" : "List of device UUIDs to get threshold crossing events for", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "diagnostics" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiagnosticActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationOnly" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationOnlyActivities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationOnlyDiagnostics" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiagnosticActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "locations" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "promptUuids" : { + "type" : "array", "items" : { "type" : "string", "format" : "RUUID", @@ -121000,41 +122725,125 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "NumericAggregationValue" : { + "type" : "object", + "description" : "Map of numeric count reports", + "properties" : { + "average" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "endTimeMs" : { + "eventCount" : { "type" : "integer", "format" : "int64", - "description" : "End time in milliseconds", - "example" : 1640998800000, "nullable" : true }, - "startTimeMs" : { + "localDate" : { + "type" : "string", + "nullable" : true + }, + "max" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "maxValueTimestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time in milliseconds", - "example" : 1640995200000, + "nullable" : true + }, + "min" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "minValueTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "sum" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "utcDate" : { + "type" : "string", "nullable" : true } } }, - "Report_GetThresholdCrossingEventsWSResponse" : { + "OAuthApplication" : { "type" : "object", - "description" : "Response object for getting threshold crossing events.", + "description" : "OAuth application details", "properties" : { - "deviceToThresholdCrossingEventMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of device UUIDs to their threshold crossing events", - "items" : { - "$ref" : "#/components/schemas/MinimalThresholdEventType" - }, - "nullable" : true - }, - "description" : "Map of device UUIDs to their threshold crossing events", + "clientId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "clientSecretHash" : { + "type" : "string", + "nullable" : true + }, + "contactEmail" : { + "type" : "string", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "publicClient" : { + "type" : "boolean", "nullable" : true }, + "redirectUri" : { + "type" : "string", + "nullable" : true + }, + "tokenEndpointAuthMethod" : { + "type" : "string", + "nullable" : true + } + } + }, + "OPERATOREnum" : { + "type" : "string", + "enum" : [ "GT", "LT", "LTE", "GTE", "EQ", "CONTAINS" ] + }, + "Oauth_GetAllApplicationsForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting all OAuth applications for an organization." + }, + "Oauth_GetAllApplicationsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing all OAuth applications for an organization.", + "properties" : { "error" : { "type" : "boolean", "nullable" : true @@ -121043,20 +122852,25 @@ "type" : "string", "nullable" : true }, + "oauthApplications" : { + "type" : "array", + "description" : "List of OAuth applications for the organization", + "items" : { + "$ref" : "#/components/schemas/OAuthApplication" + }, + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Report_ResetRunningAverageWSRequest" : { + "Oauth_GetApplicationByClientIdWSRequest" : { "type" : "object", - "description" : "Request object for resetting running average.", + "description" : "Request object for getting OAuth application by client ID.", "properties" : { - "scope" : { - "$ref" : "#/components/schemas/ReportScopeEnum" - }, - "uuid" : { + "clientId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -121065,10 +122879,13 @@ } } }, - "Report_ResetRunningAverageWSResponse" : { + "Oauth_GetApplicationByClientIdWSResponse" : { "type" : "object", - "description" : "Response object for resetting running average.", + "description" : "Response object containing OAuth application details.", "properties" : { + "application" : { + "$ref" : "#/components/schemas/OAuthApplication" + }, "error" : { "type" : "boolean", "nullable" : true @@ -121083,219 +122900,343 @@ } } }, - "Report_TimeSeriesDataPointV2ExtendedType" : { + "Oauth_OAuthApplicationWSRequest" : { "type" : "object", - "description" : "Extended time series data point with additional timestamp information.", + "description" : "Request object for OAuth application management.", "properties" : { - "approximateTimestampMsMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "description" : "A mapping of timestamps (in Unix epoch milliseconds) that indicate, for each type and interval, the point in time where the aggregated occupancy count is closest to the occupancy observed in the corresponding video segment", - "nullable" : true - }, - "description" : "A mapping of timestamps (in Unix epoch milliseconds) that indicate, for each type and interval, the point in time where the aggregated occupancy count is closest to the occupancy observed in the corresponding video segment", + "clientId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dateLocal" : { + "contactEmail" : { "type" : "string", + "description" : "Contact email for the OAuth application", + "example" : "admin@myapp.com", "nullable" : true }, - "dateUtc" : { + "description" : { "type" : "string", + "description" : "Description of the OAuth application", + "example" : "Integration app for accessing Rhombus API", "nullable" : true }, - "eventCountMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, + "name" : { + "type" : "string", + "description" : "Name of the OAuth application", + "example" : "My Integration App", "nullable" : true }, - "reportingDevicesMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "nullable" : true - }, + "redirectUri" : { + "type" : "string", + "description" : "OAuth redirect URI", + "example" : "https://myapp.com/oauth/callback", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "The representative timestamp (in Unix epoch milliseconds) for the interval", - "example" : 1640995200000, + "tokenEndpointAuthMethod" : { + "type" : "string", + "description" : "OAuth token endpoint auth method. 'none' registers a PUBLIC (PKCE-only) client with no secret; omit or 'client_secret_basic'/'client_secret_post' for a confidential client.", + "example" : "none", "nullable" : true } } }, - "RequestToExitEnumType" : { - "type" : "string", - "enum" : [ "integrated", "remote" ] - }, - "RequestToExitPhysicalPortEnumType" : { - "type" : "string", - "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] - }, - "RequestToExitPortType" : { + "Oauth_OAuthApplicationWSResponse" : { "type" : "object", + "description" : "Response object containing OAuth application credentials.", "properties" : { - "boardNum" : { - "type" : "integer", - "format" : "int32", + "clientId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "portNum" : { - "type" : "integer", - "format" : "int32", + "clientSecret" : { + "type" : "string", + "description" : "OAuth client secret", "nullable" : true }, - "portType" : { - "$ref" : "#/components/schemas/RequestToExitPhysicalPortEnumType" + "error" : { + "type" : "boolean", + "nullable" : true }, - "supervisionConfiguration" : { - "$ref" : "#/components/schemas/PortSupervisionConfigurationType" + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "RequestToExitShadowType" : { + "ObjectSearchModelEnum" : { + "type" : "string", + "description" : "Model used for embeddings. The streaming variant of this search accepts only \"CHARON\".", + "enum" : [ "CLIP_512", "CHARON" ] + }, + "ObjectSearchQuery" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "state" : { - "$ref" : "#/components/schemas/RequestToExitStateEnumType" - }, - "stateUpdateEventTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "supervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } - } - } ], - "nullable" : true, "properties" : { - "componentUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "query" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "ownerDeviceUuid" : { + } + } + }, + "Objectsearchtracking_CreateObjectSearchQueryWSRequest" : { + "type" : "object", + "description" : "Request to save a Custom Detection.", + "properties" : { + "query" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Search text to save; a Custom Detection is named by its text", + "nullable" : true + } + } + }, + "Objectsearchtracking_CreateObjectSearchQueryWSResponse" : { + "type" : "object", + "description" : "The saved Custom Detection.", + "properties" : { + "moderationReason" : { + "type" : "string", + "description" : "Why moderation rejected the text", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentShadowEnumType" + "objectSearchQuery" : { + "$ref" : "#/components/schemas/ObjectSearchQuery" }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "queryAllowed" : { + "type" : "boolean", + "description" : "False when the text was rejected by moderation", "nullable" : true } } }, - "RequestToExitStateChangeEventType" : { + "Objectsearchtracking_CreateTrackedObjectSearchWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "componentCompositeUuid" : { + "description" : "Request to save a Custom Detection search.", + "properties" : { + "deviceFacetUuids" : { + "type" : "array", + "description" : "Cameras to record sightings on; required and must name at least one", + "items" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "intentOnly" : { - "type" : "boolean", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "newState" : { - "$ref" : "#/components/schemas/RequestToExitStateEnumType" - }, - "newSupervisionState" : { - "$ref" : "#/components/schemas/SupervisionStateEnumType" - } + "nullable" : true, + "uniqueItems" : true + }, + "query" : { + "type" : "string", + "description" : "CHARON text query to record sightings for", + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Objectsearchtracking_CreateTrackedObjectSearchWSResponse" : { + "type" : "object", + "description" : "The saved Custom Detection search.", "properties" : { - "componentUuid" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "correlationId" : { + "moderationReason" : { "type" : "string", + "description" : "Why moderation rejected the query", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "queryAllowed" : { + "type" : "boolean", + "description" : "False when the query was rejected by moderation", "nullable" : true }, - "locationUuid" : { + "trackedObjectSearch" : { + "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Objectsearchtracking_DeleteTrackedObjectSearchWSRequest" : { + "type" : "object", + "description" : "Request to stop a saved Custom Detection search.", + "properties" : { + "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Objectsearchtracking_DeleteTrackedObjectSearchWSResponse" : { + "type" : "object", + "description" : "Result of stopping a saved Custom Detection search.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "orgUuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerDeviceUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Objectsearchtracking_GetTrackedObjectSearchWSRequest" : { + "type" : "object", + "description" : "Request for one saved Custom Detection search.", + "properties" : { + "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Objectsearchtracking_GetTrackedObjectSearchWSResponse" : { + "type" : "object", + "description" : "One saved Custom Detection search.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "timestampMs" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "trackedObjectSearch" : { + "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Objectsearchtracking_ListObjectSearchQueriesWSRequest" : { + "type" : "object", + "description" : "Request for the org's saved Custom Detections.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "nullable" : true + }, + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Objectsearchtracking_ListObjectSearchQueriesWSResponse" : { + "type" : "object", + "description" : "The org's saved Custom Detections.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Opaque continuation key; absent on the last page", + "nullable" : true + }, + "objectSearchQueries" : { + "type" : "array", + "description" : "Saved Custom Detections, one per query", + "items" : { + "$ref" : "#/components/schemas/ObjectSearchQuery" + }, + "nullable" : true + } + } + }, + "Objectsearchtracking_ListTrackedObjectSearchesWSRequest" : { + "type" : "object", + "description" : "Request for the org's saved Custom Detection searches." + }, + "Objectsearchtracking_ListTrackedObjectSearchesWSResponse" : { + "type" : "object", + "description" : "The org's saved Custom Detection searches.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "trackedObjectSearches" : { + "type" : "array", + "description" : "Saved Custom Detection searches with their queries", + "items" : { + "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Objectsearchtracking_SearchTrackedObjectSearchMatchesWSRequest" : { + "type" : "object", + "description" : "Request for recorded Custom Detection sightings.", + "properties" : { + "endTimestampMs" : { "type" : "integer", "format" : "int64", + "description" : "Inclusive end of the sighting window", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/ComponentEventEnumType" + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Page token from a previous response", + "nullable" : true }, - "uuid" : { + "startTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Inclusive start of the sighting window", + "nullable" : true + }, + "trackedObjectSearchUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -121304,1366 +123245,26055 @@ } } }, - "RequestToExitStateEnumType" : { - "type" : "string", - "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] - }, - "Resolution" : { + "Objectsearchtracking_SearchTrackedObjectSearchMatchesWSResponse" : { "type" : "object", + "description" : "Recorded Custom Detection sightings.", "properties" : { - "height" : { - "type" : "integer", - "format" : "int32", + "error" : { + "type" : "boolean", "nullable" : true }, - "width" : { - "type" : "integer", - "format" : "int32", + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Page token to fetch the next page, absent on the last page", + "nullable" : true + }, + "matches" : { + "type" : "array", + "description" : "Sightings, newest first", + "items" : { + "$ref" : "#/components/schemas/TrackedObjectSearchMatch" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Response" : { + "Objectsearchtracking_UpdateTrackedObjectSearchWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request to change a saved Custom Detection search's camera scope or state.", "properties" : { - "allowedMethods" : { + "deviceFacetUuids" : { "type" : "array", + "description" : "Replacement camera scope; required and must name at least one", "items" : { "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, "nullable" : true, "uniqueItems" : true }, - "closed" : { + "isArchived" : { "type" : "boolean", + "description" : "Archive or restore; omit to leave unchanged", "nullable" : true }, - "cookies" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/NewCookie" - }, + "isPaused" : { + "type" : "boolean", + "description" : "Stop or resume recording new sightings; omit to leave unchanged", "nullable" : true }, - "date" : { + "trackedObjectSearchUuid" : { "type" : "string", - "format" : "date-time", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Objectsearchtracking_UpdateTrackedObjectSearchWSResponse" : { + "type" : "object", + "description" : "The updated saved Custom Detection search.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "entity" : { - "type" : "object", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "entityTag" : { - "$ref" : "#/components/schemas/EntityTag" + "trackedObjectSearch" : { + "$ref" : "#/components/schemas/HydratedTrackedObjectSearch" }, - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "OccupancyEventType" : { + "type" : "object", + "description" : "List of occupancy events for the sensor", + "properties" : { + "baseStationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "language" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } + "batteryPercentage" : { + "type" : "integer", + "format" : "int32", + "nullable" : true }, - "lastModified" : { + "bleDeviceUuid" : { "type" : "string", - "format" : "date-time", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "length" : { + "bleRssi" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "links" : { + "closeBaseStations" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "location" : { + "locationUuid" : { "type" : "string", - "format" : "uri", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "metadata" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true - }, - "nullable" : true - }, - "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "status" : { + "lux" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "statusInfo" : { - "$ref" : "#/components/schemas/StatusType" + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "stringHeaders" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, + "state" : { + "$ref" : "#/components/schemas/OccupancyStateEnum" + }, + "stateChanged" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "properties" : { - "empty" : { - "type" : "boolean", - "nullable" : true - } - } + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "tampered" : { + "type" : "boolean", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true } } }, - "ResponseEntity" : { + "OccupancyPolicyType" : { "type" : "object", + "description" : "List of occupancy policies using the schedule", "properties" : { - "body" : { - "type" : "object", + "description" : { + "type" : "string", "nullable" : true }, - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OccupancyScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OccupancyScheduledTriggerType" : { + "type" : "object", + "properties" : { + "occupancyThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "vacancyThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "OccupancyStateEnum" : { + "type" : "string", + "enum" : [ "VACANT", "MOVEMENT", "OCCUPIED" ] + }, + "OccupancyStatusEnum" : { + "type" : "string", + "description" : "Current occupancy status of the sensor", + "enum" : [ "VACANT", "MOVEMENT", "OCCUPIED" ] + }, + "Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" : { + "type" : "object", + "description" : "Request object for getting minimal occupancy sensor states for all sensors in organization." + }, + "Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" : { + "type" : "object", + "description" : "Response object containing minimal occupancy sensor states for all sensors in organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "occupancySensorStates" : { + "type" : "array", + "description" : "List of minimal occupancy sensor states", + "items" : { + "$ref" : "#/components/schemas/Occupancysensor_MinimalOccupancySensorStateType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Occupancysensor_GetOccupancyEventsForSensorWSRequest" : { + "type" : "object", + "description" : "Request object for getting occupancy events for a specific sensor.", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter events created after this timestamp (milliseconds since epoch)", + "example" : 1640908800000, + "nullable" : true + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter events created before this timestamp (milliseconds since epoch)", + "example" : 1640995200000, + "nullable" : true + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of events to return", + "example" : 100, + "nullable" : true + }, + "sensorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Occupancysensor_GetOccupancyEventsForSensorWSResponse" : { + "type" : "object", + "description" : "Response object containing occupancy events for a specific sensor.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "events" : { + "type" : "array", + "description" : "List of occupancy events for the sensor", + "items" : { + "$ref" : "#/components/schemas/OccupancyEventType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Occupancysensor_MinimalOccupancySensorStateType" : { + "type" : "object", + "description" : "Minimal state information for occupancy sensors including health, location, and sensor data.", + "properties" : { + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device facet UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, + "nullable" : true + }, + "batteryPercent" : { + "type" : "integer", + "format" : "int32", + "description" : "Battery percentage of the sensor", + "example" : 85, + "nullable" : true + }, + "closestBaseStation" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "description" : "Firmware version of the sensor", + "example" : "1.2.3", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "Floor number where the sensor is located", + "example" : 2, + "nullable" : true + }, + "health" : { + "$ref" : "#/components/schemas/Occupancysensor_MotionSensorHealthEnum" + }, + "healthDetails" : { + "$ref" : "#/components/schemas/Occupancysensor_MotionSensorHealthDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lastSeenSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the sensor was last seen (seconds since epoch)", + "example" : 1640995200, + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the sensor location", + "example" : 37.7749, + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the sensor location", + "example" : -122.4194, + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the occupancy sensor", + "example" : "Conference Room Sensor", + "nullable" : true + }, + "normalizedLux" : { + "type" : "number", + "format" : "float", + "description" : "Normalized lux value (0-1) matching human perception of lighting transitions", + "example" : 0.75, + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rawLux" : { + "type" : "integer", + "format" : "int32", + "description" : "Raw lux value from the sensor", + "example" : 500, + "nullable" : true + }, + "sensorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the occupancy sensor", + "example" : "RH123456789", + "nullable" : true + }, + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "Signal strength of the sensor", + "example" : -45, + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/OccupancyStatusEnum" + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true, - "properties" : { - "accept" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/MediaType" - }, - "nullable" : true - }, - "acceptCharset" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "registered" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "nullable" : true - }, - "acceptLanguage" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "range" : { - "type" : "string", - "nullable" : true - }, - "weight" : { - "type" : "number", - "format" : "double", - "nullable" : true - } - } - }, - "nullable" : true - }, - "acceptLanguageAsLocales" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } - }, - "nullable" : true - }, - "acceptPatch" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/MediaType" - }, - "nullable" : true - }, - "accessControlAllowCredentials" : { - "type" : "boolean", - "nullable" : true - }, - "accessControlAllowHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "accessControlAllowMethods" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "nullable" : true - }, - "accessControlAllowOrigin" : { - "type" : "string", - "nullable" : true - }, - "accessControlExposeHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "accessControlMaxAge" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "accessControlRequestHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "accessControlRequestMethod" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "all" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "writeOnly" : true - }, - "allow" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "nullable" : true, - "uniqueItems" : true - }, - "basicAuth" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true - }, - "bearerAuth" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true - }, - "cacheControl" : { - "type" : "string", - "nullable" : true - }, - "connection" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" - }, - "contentLanguage" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } - }, - "contentLength" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "contentType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "date" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "empty" : { - "type" : "boolean", - "nullable" : true - }, - "etag" : { - "type" : "string", - "nullable" : true - }, - "expires" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "host" : { - "type" : "object", - "nullable" : true, - "properties" : { - "address" : { - "type" : "object", - "nullable" : true, - "properties" : { - "address" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "anyLocalAddress" : { - "type" : "boolean", - "nullable" : true - }, - "canonicalHostName" : { - "type" : "string", - "nullable" : true - }, - "hostAddress" : { - "type" : "string", - "nullable" : true - }, - "hostName" : { - "type" : "string", - "nullable" : true - }, - "linkLocalAddress" : { - "type" : "boolean", - "nullable" : true - }, - "loopbackAddress" : { - "type" : "boolean", - "nullable" : true - }, - "mcglobal" : { - "type" : "boolean", - "nullable" : true - }, - "mclinkLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcnodeLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcorgLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcsiteLocal" : { - "type" : "boolean", - "nullable" : true - }, - "multicastAddress" : { - "type" : "boolean", - "nullable" : true - }, - "siteLocalAddress" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "hostName" : { - "type" : "string", - "nullable" : true - }, - "hostString" : { - "type" : "string", - "nullable" : true - }, - "port" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "unresolved" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "ifMatch" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "ifModifiedSince" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "ifNoneMatch" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "ifUnmodifiedSince" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastModified" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "location" : { - "type" : "string", - "format" : "uri", - "nullable" : true - }, - "origin" : { - "type" : "string", - "nullable" : true - }, - "pragma" : { - "type" : "string", - "nullable" : true - }, - "range" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpRange" - }, - "nullable" : true - }, - "upgrade" : { - "type" : "string", - "nullable" : true - }, - "vary" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - } - } + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + } + }, + "Occupancysensor_MotionSensorHealthDetailsEnum" : { + "type" : "string", + "description" : "Detailed motion sensor health status.", + "enum" : [ "NO_HEARTBEAT", "FIRMWARE_BEHIND", "NONE" ] + }, + "Occupancysensor_MotionSensorHealthEnum" : { + "type" : "string", + "description" : "Motion sensor health status.", + "enum" : [ "RED", "GREEN" ] + }, + "Occupancysensor_UpdateOccupancySensorDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for updating occupancy sensor details with selective update flags.", + "properties" : { + "associatedCameras" : { + "type" : "array", + "description" : "List of associated camera device facet UUIDs", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true }, - "statusCode" : { - "$ref" : "#/components/schemas/HttpStatusCode" + "associatedCamerasUpdated" : { + "type" : "boolean", + "description" : "Whether the associated cameras should be updated", + "example" : false, + "nullable" : true }, - "statusCodeValue" : { + "deleted" : { + "type" : "boolean", + "description" : "Whether the sensor is marked as deleted", + "example" : false, + "nullable" : true + }, + "deletedUpdated" : { + "type" : "boolean", + "description" : "Whether the deleted status should be updated", + "example" : false, + "nullable" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the occupancy sensor", + "example" : "Motion sensor for conference room A", + "nullable" : true + }, + "descriptionUpdated" : { + "type" : "boolean", + "description" : "Whether the description should be updated", + "example" : false, + "nullable" : true + }, + "floorNumber" : { "type" : "integer", "format" : "int32", + "description" : "Floor number where the sensor is located", + "example" : 2, + "nullable" : true + }, + "floorNumberUpdated" : { + "type" : "boolean", + "description" : "Whether the floor number should be updated", + "example" : false, + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate of the sensor location", + "example" : 37.7749, + "nullable" : true + }, + "latitudeUpdated" : { + "type" : "boolean", + "description" : "Whether the latitude should be updated", + "example" : false, + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationUuidUpdated" : { + "type" : "boolean", + "description" : "Whether the location UUID should be updated", + "example" : false, + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate of the sensor location", + "example" : -122.4194, + "nullable" : true + }, + "longitudeUpdated" : { + "type" : "boolean", + "description" : "Whether the longitude should be updated", + "example" : false, + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the occupancy sensor", + "example" : "Conference Room Sensor", + "nullable" : true + }, + "nameUpdated" : { + "type" : "boolean", + "description" : "Whether the name should be updated", + "example" : false, + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyUuidUpdated" : { + "type" : "boolean", + "description" : "Whether the policy UUID should be updated", + "example" : false, + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key should be updated", + "example" : false, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "ResponseEntityString" : { + "Occupancysensor_UpdateOccupancySensorDetailsWSResponse" : { "type" : "object", + "description" : "Response object for updating occupancy sensor details.", "properties" : { - "body" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "headers" : { - "type" : "object", - "additionalProperties" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "OccupiedActivityEventType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "occupancyThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "Office365Settings" : { + "type" : "object", + "description" : "Office 365 integration settings to update", + "properties" : { + "driveId" : { + "type" : "string", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "tenantId" : { + "type" : "string", + "nullable" : true + } + } + }, + "OmnialertType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "associatedCameras" : { "type" : "array", "items" : { "type" : "string", - "nullable" : true + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, + "nullable" : true, + "uniqueItems" : true + }, + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "nullable" : true, - "properties" : { - "accept" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/MediaType" - }, - "nullable" : true - }, - "acceptCharset" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "registered" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "nullable" : true - }, - "acceptLanguage" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "range" : { - "type" : "string", - "nullable" : true - }, - "weight" : { - "type" : "number", - "format" : "double", - "nullable" : true - } - } - }, - "nullable" : true - }, - "acceptLanguageAsLocales" : { - "type" : "array", - "items" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } - }, - "nullable" : true - }, - "acceptPatch" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/MediaType" - }, - "nullable" : true - }, - "accessControlAllowCredentials" : { - "type" : "boolean", - "nullable" : true - }, - "accessControlAllowHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "accessControlAllowMethods" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "nullable" : true - }, - "accessControlAllowOrigin" : { - "type" : "string", - "nullable" : true - }, - "accessControlExposeHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "accessControlMaxAge" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "accessControlRequestHeaders" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "accessControlRequestMethod" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "all" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "writeOnly" : true - }, - "allow" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpMethod" - }, - "nullable" : true, - "uniqueItems" : true - }, - "basicAuth" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true - }, - "bearerAuth" : { - "type" : "string", - "nullable" : true, - "writeOnly" : true - }, - "cacheControl" : { - "type" : "string", - "nullable" : true - }, - "connection" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "contentDisposition" : { - "$ref" : "#/components/schemas/ContentDisposition" - }, - "contentLanguage" : { - "type" : "object", - "nullable" : true, - "properties" : { - "country" : { - "type" : "string", - "nullable" : true - }, - "displayCountry" : { - "type" : "string", - "nullable" : true - }, - "displayLanguage" : { - "type" : "string", - "nullable" : true - }, - "displayName" : { - "type" : "string", - "nullable" : true - }, - "displayScript" : { - "type" : "string", - "nullable" : true - }, - "displayVariant" : { - "type" : "string", - "nullable" : true - }, - "extensionKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "iso3Country" : { - "type" : "string", - "nullable" : true - }, - "iso3Language" : { - "type" : "string", - "nullable" : true - }, - "language" : { - "type" : "string", - "nullable" : true - }, - "script" : { - "type" : "string", - "nullable" : true - }, - "unicodeLocaleAttributes" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "unicodeLocaleKeys" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "variant" : { - "type" : "string", - "nullable" : true - } - } - }, - "contentLength" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "contentType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "date" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "empty" : { - "type" : "boolean", - "nullable" : true - }, - "etag" : { - "type" : "string", - "nullable" : true - }, - "expires" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "host" : { - "type" : "object", - "nullable" : true, - "properties" : { - "address" : { - "type" : "object", - "nullable" : true, - "properties" : { - "address" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte", - "nullable" : true - }, - "nullable" : true - }, - "anyLocalAddress" : { - "type" : "boolean", - "nullable" : true - }, - "canonicalHostName" : { - "type" : "string", - "nullable" : true - }, - "hostAddress" : { - "type" : "string", - "nullable" : true - }, - "hostName" : { - "type" : "string", - "nullable" : true - }, - "linkLocalAddress" : { - "type" : "boolean", - "nullable" : true - }, - "loopbackAddress" : { - "type" : "boolean", - "nullable" : true - }, - "mcglobal" : { - "type" : "boolean", - "nullable" : true - }, - "mclinkLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcnodeLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcorgLocal" : { - "type" : "boolean", - "nullable" : true - }, - "mcsiteLocal" : { - "type" : "boolean", - "nullable" : true - }, - "multicastAddress" : { - "type" : "boolean", - "nullable" : true - }, - "siteLocalAddress" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "hostName" : { - "type" : "string", - "nullable" : true - }, - "hostString" : { - "type" : "string", - "nullable" : true - }, - "port" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "unresolved" : { - "type" : "boolean", - "nullable" : true - } - } - }, - "ifMatch" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "ifModifiedSince" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "ifNoneMatch" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - }, - "ifUnmodifiedSince" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastModified" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "location" : { - "type" : "string", - "format" : "uri", - "nullable" : true - }, - "origin" : { - "type" : "string", - "nullable" : true - }, - "pragma" : { + "triggerNotification" : { + "type" : "boolean", + "nullable" : true + }, + "webhookToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OnGuardDeploymentSettings" : { + "type" : "object", + "nullable" : true, + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "presharedSecret" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "OpStatusEnum" : { + "type" : "string", + "description" : "Why it failed. ERROR_DUPLICATE means a door already sits at that address.", + "enum" : [ "SUCCESS", "ERROR_DUPLICATE", "ERROR_GENERIC", "ERROR_GENERIC_RETRY" ] + }, + "OpenAIModel" : { + "type" : "object", + "description" : "List of available OpenAI models", + "properties" : { + "created" : { + "type" : "string", + "nullable" : true + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "object" : { + "type" : "string", + "nullable" : true + }, + "ownedBy" : { + "type" : "string", + "nullable" : true + }, + "owned_by" : { + "type" : "string", + "nullable" : true + } + } + }, + "OpenAIType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "baseUrl" : { + "type" : "string", + "description" : "The base url for any OpenAI Chat Completions compliant API. For example, to use Gemini models, set this to 'https://generativelanguage.googleapis.com/v1beta/openai/'. If left blank, we will try to use OpenAI models.", + "nullable" : true + }, + "defaultModel" : { + "type" : "string", + "description" : "The model identifier to use as a default model. This is provider specific and typically found on model card pages. For example, set to 'gemini-2.0-flash' to use the Gemini 2.0 Flash model. Currently we require a model with vision capabilities for this integration.", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Openapi_GetOpenApiComponentSchemasWSRequest" : { + "type" : "object", + "description" : "Request object for exposing custom objects and enums to OpenAPI component schemas.", + "properties" : { + "changeType" : { + "$ref" : "#/components/schemas/ChangeTypeEnum" + }, + "entity" : { + "$ref" : "#/components/schemas/EntityEnum" + }, + "locationFunctionality" : { + "$ref" : "#/components/schemas/LocationFunctionalityEnum" + } + } + }, + "OpenpathSettings" : { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorToCameraMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "range" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/HttpRange" - }, - "nullable" : true - }, - "upgrade" : { - "type" : "string", - "nullable" : true + "nullable" : true + }, + "nullable" : true + }, + "email" : { + "type" : "string", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "eventToWebhookIdMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "eventToWebhookMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/WebhookMapEntry" + }, + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "migrated" : { + "type" : "boolean", + "nullable" : true + }, + "password" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "webhookId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "OpentechAllianceActionGroupType" : { + "type" : "object", + "properties" : { + "actionGroupId" : { + "type" : "string", + "nullable" : true + }, + "deviceId" : { + "type" : "string", + "nullable" : true + }, + "locationName" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + } + } + }, + "OpentechAllianceDoorInfoType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "actionGroupId" : { + "type" : "string", + "nullable" : true + }, + "assignedCameraList" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "clipDuration" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorName" : { + "type" : "string", + "nullable" : true + }, + "leadingSeconds" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "remoteUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + } + }, + "OpentechAllianceFacilitySettings" : { + "type" : "object", + "nullable" : true, + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OpentechAllianceDoorInfoType" + }, + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "OpentechAllianceFacilityType" : { + "type" : "object", + "properties" : { + "actionGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OpentechAllianceActionGroupType" + }, + "nullable" : true + }, + "deviceList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DoorType" + }, + "nullable" : true + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + } + } + }, + "OpentechAllianceSettings" : { + "type" : "object", + "properties" : { + "apiKey" : { + "type" : "string", + "nullable" : true + }, + "apiSecret" : { + "type" : "string", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "facilityToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" + }, + "nullable" : true + }, + "migrated" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "OpentechAllianceType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "apiKey" : { + "type" : "string", + "nullable" : true + }, + "apiSecret" : { + "type" : "string", + "nullable" : true + }, + "facilityToSettingsMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OpentechAllianceFacilitySettings" }, - "vary" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true - } + "nullable" : true } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OperationStatus" : { + "type" : "object", + "description" : "Map of device serial numbers to their reassignment operation status", + "properties" : { + "message" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/StatusTypeEnum" + } + } + }, + "OrgGroupEnumType" : { + "type" : "string", + "enum" : [ "RHOMBUS_ACCESS_CONTROL", "GUEST_MANAGEMENT_HOST" ] + }, + "OrgGroupMemberType" : { + "type" : "object", + "description" : "List of user group memberships", + "properties" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/OrgGroupEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OrgGroupType" : { + "type" : "object", + "description" : "Guest management host group", + "properties" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/OrgGroupEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OrgIntegrationsType" : { + "type" : "object", + "description" : "Organization integrations configuration and settings", + "properties" : { + "amtSettings" : { + "$ref" : "#/components/schemas/AmtSettings" + }, + "awsSettings" : { + "$ref" : "#/components/schemas/AwsSettings" + }, + "backblazeSettings" : { + "$ref" : "#/components/schemas/BackblazeSettings" + }, + "boxSettings" : { + "$ref" : "#/components/schemas/BoxSettings" + }, + "brivoSettings" : { + "$ref" : "#/components/schemas/BrivoSettings" + }, + "butterflymxSettings" : { + "$ref" : "#/components/schemas/ButterflyMXSettings" + }, + "diceSettings" : { + "$ref" : "#/components/schemas/DiceSettings" + }, + "dropboxSettingsV2" : { + "$ref" : "#/components/schemas/DropboxSettingsV2" + }, + "emailSettings" : { + "$ref" : "#/components/schemas/EmailSettings" + }, + "envoySettings" : { + "$ref" : "#/components/schemas/EnvoySettings" + }, + "geneaSettings" : { + "$ref" : "#/components/schemas/GeneaSettings" + }, + "googleSettings" : { + "$ref" : "#/components/schemas/GoogleSettings" + }, + "googleSettingsV2" : { + "$ref" : "#/components/schemas/GoogleSettingsV2" + }, + "haloSettings" : { + "$ref" : "#/components/schemas/HaloSettings" + }, + "immixSettings" : { + "$ref" : "#/components/schemas/ImmixSettings" + }, + "intuifaceSettings" : { + "$ref" : "#/components/schemas/IntuifaceSettings" + }, + "kisiSettings" : { + "$ref" : "#/components/schemas/KisiSettings" + }, + "lumeoSettings" : { + "$ref" : "#/components/schemas/LumeoSettings" + }, + "mattermostSettings" : { + "$ref" : "#/components/schemas/MattermostSettings" + }, + "microsoftTeamsSettings" : { + "$ref" : "#/components/schemas/MicrosoftTeamsSettings" + }, + "noonlightSettings" : { + "$ref" : "#/components/schemas/NoonlightSettings" + }, + "office365Settings" : { + "$ref" : "#/components/schemas/Office365Settings" + }, + "openpathSettings" : { + "$ref" : "#/components/schemas/OpenpathSettings" + }, + "opentechAllianceSettings" : { + "$ref" : "#/components/schemas/OpentechAllianceSettings" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pagerDutySettings" : { + "$ref" : "#/components/schemas/PagerDutySettings" + }, + "placeOsSettings" : { + "$ref" : "#/components/schemas/PlaceOsSettings" + }, + "proDataKeySettings" : { + "$ref" : "#/components/schemas/ProDataKeySettings" + }, + "saltoSettings" : { + "$ref" : "#/components/schemas/SaltoSettings" + }, + "serviceNowSettings" : { + "$ref" : "#/components/schemas/ServiceNowSettings" + }, + "slackSettings" : { + "$ref" : "#/components/schemas/SlackSettings" + }, + "slackSettingsV2" : { + "$ref" : "#/components/schemas/SlackSettingsV2" + }, + "squareSettings" : { + "$ref" : "#/components/schemas/SquareSettings" + }, + "toastSettings" : { + "$ref" : "#/components/schemas/ToastSettings" + }, + "tpLinkSettings" : { + "$ref" : "#/components/schemas/TPLinkSettings" + }, + "tritonSettings" : { + "$ref" : "#/components/schemas/TritonSettings" + }, + "twilioSettings" : { + "$ref" : "#/components/schemas/TwilioSettings" + }, + "webhookSettings" : { + "$ref" : "#/components/schemas/WebhookSettings" + } + } + }, + "OrgLicenseStats" : { + "type" : "object", + "description" : "License statistics for the organization", + "properties" : { + "acuDoorLicenseStats" : { + "$ref" : "#/components/schemas/LicenseGroupStats" + }, + "alertMonitoringLicenseStats" : { + "$ref" : "#/components/schemas/LicenseGroupStats" + }, + "assignedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "assignedLicenseStateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "deviceLicenseStats" : { + "$ref" : "#/components/schemas/DeviceAssignableLicenseGroupStats" + }, + "guestManagementLicenseStats" : { + "$ref" : "#/components/schemas/LicenseGroupStats" + }, + "lastEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest past date on which licenses belonging to the group expired.", + "nullable" : true + }, + "licenseUsageStats" : { + "$ref" : "#/components/schemas/LicenseUsageStats" + }, + "nearExpirationCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group that are currently close to expiration.", + "nullable" : true + }, + "nextEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "The closest future date on which licenses belonging to the group will expire.", + "nullable" : true + }, + "paneLicenseStats" : { + "$ref" : "#/components/schemas/LicenseGroupStats" + }, + "stateStats" : { + "$ref" : "#/components/schemas/LicenseStateStats" + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of licenses in the group.", + "nullable" : true + } + } + }, + "OrgLockdownPlanType" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "activationPlan" : { + "$ref" : "#/components/schemas/LockdownActivationPlanType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deactivationPlan" : { + "$ref" : "#/components/schemas/LockdownDeactivationPlanType" + }, + "defaultLockdownState" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "doorLockdownStateMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/DoorLockdownStateEnumType" + }, + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "physicalAccess" : { + "$ref" : "#/components/schemas/LockdownPhysicalAccessType" + }, + "scopeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "testPlan" : { + "$ref" : "#/components/schemas/LockdownTestPlanType" + }, + "type" : { + "$ref" : "#/components/schemas/LockdownPlanScopeEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OrgPaneLinkType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "label" : { + "type" : "string", + "nullable" : true + }, + "paneId" : { + "type" : "string", + "nullable" : true + }, + "permissionGroupUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "tier" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "userUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + } + } + }, + "OrgSamlSettingsType" : { + "type" : "object", + "description" : "List of SAML settings to update", + "properties" : { + "addUsersOnRoleMismatch" : { + "type" : "boolean", + "nullable" : true + }, + "allowIdpSessionReuse" : { + "type" : "boolean", + "nullable" : true + }, + "domain" : { + "$ref" : "#/components/schemas/RhombusSamlDomainEnum" + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledForRhombusKey" : { + "type" : "boolean", + "nullable" : true + }, + "idpMetaDataXml" : { + "type" : "string", + "nullable" : true + }, + "justInTimeAccountProvisioningEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "registrationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rhombusKeyAppSettings" : { + "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + }, + "teamName" : { + "type" : "string", + "nullable" : true + } + } + }, + "OrgType" : { + "type" : "object", + "description" : "Organization information to update", + "properties" : { + "accountOwnerEmail" : { + "type" : "string", + "nullable" : true + }, + "address1" : { + "type" : "string", + "nullable" : true + }, + "address2" : { + "type" : "string", + "nullable" : true + }, + "countryCode" : { + "type" : "string", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "firmwareUpdateSettings" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" + }, + "itemizedInvoice" : { + "type" : "boolean", + "nullable" : true + }, + "mfaEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "newCameraFramerateMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraResolutionMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraSegmentMaxBytesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraVideoTargetQualityMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "notificationSettings" : { + "$ref" : "#/components/schemas/NotificationSettingsType" + }, + "partnerAccessAllowedUntil" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "planType" : { + "$ref" : "#/components/schemas/PlanTypeEnum" + }, + "postalCode" : { + "type" : "string", + "nullable" : true + }, + "rbacSettings" : { + "$ref" : "#/components/schemas/RBACSettingsType" + }, + "samlSettings" : { + "$ref" : "#/components/schemas/SAMLSettingsType" + }, + "subscriptionEndDate" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "subscriptionStatus" : { + "$ref" : "#/components/schemas/SubscriptionStatusEnum" + }, + "subscriptionType" : { + "$ref" : "#/components/schemas/SubscriptionTypeEnum" + }, + "supportAccessAllowedUntil" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/OrgTypeEnum" + }, + "uapSettings" : { + "$ref" : "#/components/schemas/UAPSettingsType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OrgTypeEnum" : { + "type" : "string", + "enum" : [ "PARTNER", "CUSTOMER", "UNKNOWN" ] + }, + "OrgV2Type" : { + "type" : "object", + "description" : "List of Rhombus organizations the user has access to", + "nullable" : true, + "properties" : { + "accountBillingContactEmail" : { + "type" : "string", + "nullable" : true + }, + "accountOwnerEmail" : { + "type" : "string", + "nullable" : true + }, + "accountTechnicalContactEmail" : { + "type" : "string", + "nullable" : true + }, + "accountTechnicalContacts" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "address1" : { + "type" : "string", + "nullable" : true + }, + "address2" : { + "type" : "string", + "nullable" : true + }, + "allowedLoginIpRanges" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "applyMobileSessionLimit" : { + "type" : "boolean", + "nullable" : true + }, + "audioAnalysisEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "audioRecordingEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "bandwidthReportsDisabled" : { + "type" : "boolean", + "nullable" : true + }, + "companyLogoUrl" : { + "type" : "string", + "nullable" : true + }, + "companyLogoUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "connectivityBatchWindowSecs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "countryCode" : { + "type" : "string", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "criticalStatusEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "dataRetentionSettings" : { + "$ref" : "#/components/schemas/DataRetentionSettingsType" + }, + "defaultPlayerViewLiveType" : { + "$ref" : "#/components/schemas/PlayerViewLiveTypeEnum" + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "deletedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "developmentPartnerOrg" : { + "type" : "boolean", + "nullable" : true + }, + "firmwareUpdateSettings" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" + }, + "firmwareUpdateSettingsOverrides" : { + "type" : "array", + "description" : "Overrides default firmware update settings.", + "items" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsOverrideType" + }, + "nullable" : true + }, + "inactivityTimeout" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "itemizedInvoice" : { + "type" : "boolean", + "nullable" : true + }, + "keypadLogoUrl" : { + "type" : "string", + "nullable" : true + }, + "keypadLogoUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "llmUsageEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "managedClientPolicy" : { + "$ref" : "#/components/schemas/ManagedClientPolicyType" + }, + "managingPartnerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "maxAllowedSegmentMaxBytesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "mfaEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "mobileSessionLimitInDays" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "motionGridDisabled" : { + "type" : "boolean", + "nullable" : true + }, + "motionLightweightDisabled" : { + "type" : "boolean", + "nullable" : true + }, + "mspDesignation" : { + "$ref" : "#/components/schemas/MspDesignationType" + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "newCameraFramerateMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraResolutionMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraSegmentMaxBytesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraVideoTargetQualityMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "newCameraZeroMotionVideoQualityMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "notifyForHardwareFailureTickets" : { + "type" : "boolean", + "nullable" : true + }, + "paneLinks" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrgPaneLinkType" + }, + "nullable" : true + }, + "partnerAccessAllowedUntil" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "nullable" : true + }, + "rhombusKeyLogoUrl" : { + "type" : "string", + "nullable" : true + }, + "rhombusKeyLogoUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "salesforceAccountId" : { + "type" : "string", + "nullable" : true + }, + "shareAiTrainingMediaWithRhombus" : { + "type" : "boolean", + "nullable" : true + }, + "subscriptionEndDate" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "subscriptionStatus" : { + "$ref" : "#/components/schemas/SubscriptionStatusEnum" + }, + "subscriptionType" : { + "$ref" : "#/components/schemas/SubscriptionTypeEnum" + }, + "supportAccessAllowedUntil" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "tenantUrl" : { + "type" : "string", + "nullable" : true + }, + "thumbstripDisabled" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/OrgTypeEnum" + }, + "uapSettings" : { + "$ref" : "#/components/schemas/UAPSettingsType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "v3AuthNumDaysSkip2FAForTrustedDevices" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Org_ClaimActivationTokenWSRequest" : { + "type" : "object", + "properties" : { + "activationToken" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "permissionGroupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_ClaimActivationTokenWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_ClaimShipmentRegistrationTokenWSRequest" : { + "type" : "object", + "properties" : { + "claimList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Org_DeviceRegistrationClaimType" + }, + "nullable" : true + }, + "tokenUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_ClaimShipmentRegistrationTokenWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_CreateOrUpdateHealthNotificationRuleWSRequest" : { + "type" : "object", + "description" : "Request object for creating or updating a health notification rule.", + "properties" : { + "rule" : { + "$ref" : "#/components/schemas/HealthNotificationRuleType" + } + } + }, + "Org_CreateOrUpdateHealthNotificationRuleWSResponse" : { + "type" : "object", + "description" : "Response object for creating or updating a health notification rule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "rule" : { + "$ref" : "#/components/schemas/HealthNotificationRuleType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_CreatePendingRegistrationRequest" : { + "type" : "object", + "description" : "Request object for creating pending hardware registration.", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the hardware device", + "example" : "RH123456789", + "nullable" : true + }, + "wifiPsk" : { + "type" : "array", + "description" : "WiFi pre-shared key for the device", + "items" : { + "type" : "string", + "format" : "byte", + "description" : "WiFi pre-shared key for the device", + "nullable" : true + }, + "nullable" : true + }, + "wifiSsid" : { + "type" : "string", + "description" : "WiFi SSID for the device", + "example" : "Office_WiFi", + "nullable" : true + } + } + }, + "Org_CreatePendingRegistrationResponse" : { + "type" : "object", + "description" : "Response object for creating pending hardware registration.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_DeleteCloudArchivingConfigWSRequest" : { + "type" : "object", + "description" : "Request object for deleting cloud archiving configuration.", + "properties" : { + "scope" : { + "$ref" : "#/components/schemas/DeviceTargetScopeEnum" + }, + "targetUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_DeleteCloudArchivingConfigWSResponse" : { + "type" : "object", + "description" : "Response object for deleting cloud archiving configuration.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_DeleteHealthNotificationRuleWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a health notification rule.", + "properties" : { + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_DeleteHealthNotificationRuleWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a health notification rule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_DeleteKeypadLogoWSRequest" : { + "type" : "object", + "description" : "Request object for deleting keypad logo." + }, + "Org_DeleteKeypadLogoWSResponse" : { + "type" : "object", + "description" : "Response object for deleting keypad logo.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_DeleteRhombusKeyLogoWSRequest" : { + "type" : "object", + "description" : "Request object for deleting Rhombus Key logo.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_DeleteRhombusKeyLogoWSResponse" : { + "type" : "object", + "description" : "Response object for deleting Rhombus Key logo.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_DeviceRegistrationClaimType" : { + "type" : "object", + "properties" : { + "deviceName" : { + "type" : "string", + "nullable" : true + }, + "hardwareUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_FindAllHardwareWithPendingRegistrationRequest" : { + "type" : "object" + }, + "Org_FindAllHardwareWithPendingRegistrationResponse" : { + "type" : "object", + "properties" : { + "hardwareList" : { + "type" : "array", + "deprecated" : true, + "description" : "Use hardwareWithPendingRegistrationInfoList instead", + "items" : { + "$ref" : "#/components/schemas/HardwareType" + }, + "nullable" : true + }, + "hardwareWithPendingRegistrationInfoList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Org_HardwareWithPendingRegistrationInfoType" + }, + "nullable" : true + } + } + }, + "Org_FindHardwareAvailableForPendingRegistrationRequest" : { + "type" : "object" + }, + "Org_FindHardwareAvailableForPendingRegistrationResponse" : { + "type" : "object", + "properties" : { + "hardwareList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HardwareType" + }, + "nullable" : true + } + } + }, + "Org_FindIfTeamNameAvailableRequest" : { + "type" : "object", + "description" : "Request object for checking if a team name is available.", + "properties" : { + "teamName" : { + "type" : "string", + "description" : "Team name to check availability for", + "example" : "Engineering Team", + "nullable" : true + } + } + }, + "Org_FindIfTeamNameAvailableResponse" : { + "type" : "object", + "description" : "Response object indicating if a team name is available.", + "properties" : { + "available" : { + "type" : "boolean", + "description" : "Whether the team name is available", + "example" : true, + "nullable" : true + } + } + }, + "Org_FindSCIMSettingsForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding SCIM settings for organization." + }, + "Org_FindSCIMSettingsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing SCIM settings for organization.", + "properties" : { + "scimSettings" : { + "$ref" : "#/components/schemas/SCIMSettingsType" + } + } + }, + "Org_GenerateFederatedSessionTokenRequest" : { + "type" : "object", + "description" : "Request object for generating a federated session token.", + "properties" : { + "deviceUUid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "domain" : { + "type" : "string", + "description" : "Optional. The origin that is allowed to use the federated token, specified as a fully qualified URL (scheme and host, plus a port if non-default). On the browser API the value is applied as a CORS allowed-origin, and must match the browser's Origin exactly. For media requests, which are not governed by CORS, the request's Referer is parsed and compared against this value on origin (scheme, host and port) — so the Referer may carry a path and query and still match. Omit the field to leave the token unrestricted, which is required for clients that cannot send a Referer, such as native and on-prem players. This restricts where a token can be used from a browser; it is not a substitute for treating the token as a bearer credential. Both Origin and Referer are supplied by the client, so a non-browser caller holding the token can send either value at will. Use a short durationSec, and deviceUUid where the token only needs one camera's media, to limit a token that has been extracted.", + "example" : "https://app.example.com", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration of the federated session token in seconds", + "example" : 3600, + "nullable" : true + } + } + }, + "Org_GenerateFederatedSessionTokenResponse" : { + "type" : "object", + "description" : "Response object containing the generated federated session token.", + "properties" : { + "federatedSessionToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_GetAwsIntCloudformationFileRequest" : { + "type" : "object", + "description" : "Request object for getting AWS CloudFormation file." + }, + "Org_GetAwsIntCloudformationFileResponse" : { + "type" : "object", + "description" : "Response object containing AWS CloudFormation file.", + "properties" : { + "fileBase64" : { + "type" : "string", + "description" : "Base64 encoded CloudFormation file content", + "example" : "UEsDBBQAAAAIAA...", + "nullable" : true + } + } + }, + "Org_GetClientOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting client organization details.", + "properties" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_GetClientOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing client organization details.", + "properties" : { + "featureFlags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of feature flags for the client organization", + "nullable" : true + }, + "description" : "Map of feature flags for the client organization", + "nullable" : true + }, + "org" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, + "partnerOrgPermissionGroup" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + } + } + }, + "Org_GetCloudArchivingConfigsWSRequest" : { + "type" : "object", + "description" : "Request object for getting cloud archiving configurations." + }, + "Org_GetCloudArchivingConfigsWSResponse" : { + "type" : "object", + "description" : "Response object containing cloud archiving configurations.", + "properties" : { + "archivingConfigs" : { + "type" : "array", + "description" : "List of cloud archiving configurations", + "items" : { + "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetDeviceFlagsWSRequest" : { + "type" : "object", + "description" : "Request object for getting device flags.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_GetDeviceFlagsWSResponse" : { + "type" : "object", + "description" : "Response object containing device flags.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "flags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of device flags", + "nullable" : true + }, + "description" : "Map of device flags", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetFeaturesWSRequest" : { + "type" : "object", + "description" : "Request object for getting organization features." + }, + "Org_GetFeaturesWSResponse" : { + "type" : "object", + "description" : "Response object containing organization feature flags.", + "properties" : { + "behaviorDetection" : { + "type" : "boolean", + "description" : "Whether behavior detection is enabled", + "example" : false, + "nullable" : true + }, + "cloudArchiving" : { + "type" : "boolean", + "description" : "Whether cloud archiving is enabled", + "example" : false, + "nullable" : true + }, + "engagementCounting" : { + "type" : "boolean", + "description" : "Whether engagement counting is enabled", + "example" : false, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "faceCounting" : { + "type" : "boolean", + "description" : "Whether face counting is enabled", + "example" : false, + "nullable" : true + }, + "faceCountingNonUnique" : { + "type" : "boolean", + "description" : "Whether non-unique face counting is enabled", + "example" : false, + "nullable" : true + }, + "faceRecognition" : { + "type" : "boolean", + "description" : "Whether face recognition is enabled", + "example" : false, + "nullable" : true + }, + "licensePlateRecognition" : { + "type" : "boolean", + "description" : "Whether license plate recognition is enabled", + "example" : false, + "nullable" : true + }, + "peopleCounting" : { + "type" : "boolean", + "description" : "Whether people counting is enabled", + "example" : false, + "nullable" : true + }, + "ppeDetection" : { + "type" : "boolean", + "description" : "Whether PPE detection is enabled", + "example" : false, + "nullable" : true + }, + "rulesEngine" : { + "type" : "boolean", + "description" : "Whether rules engine is enabled (deprecated)", + "example" : false, + "nullable" : true + }, + "vehicleCounting" : { + "type" : "boolean", + "description" : "Whether vehicle counting is enabled", + "example" : false, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetHealthNotificationRulesWSRequest" : { + "type" : "object", + "description" : "Request object for getting health notification rules." + }, + "Org_GetHealthNotificationRulesWSResponse" : { + "type" : "object", + "description" : "Response object containing health notification rules for the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "rules" : { + "type" : "array", + "description" : "List of health notification rules", + "items" : { + "$ref" : "#/components/schemas/HealthNotificationRuleType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetLocationFlagsWSRequest" : { + "type" : "object", + "description" : "Request object for getting location flags." + }, + "Org_GetLocationFlagsWSResponse" : { + "type" : "object", + "description" : "Response object containing location flags for all locations.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "flagsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of location UUIDs to their flags", + "nullable" : true + }, + "description" : "Map of location UUIDs to their flags", + "nullable" : true + }, + "description" : "Map of location UUIDs to their flags", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetOrgIntegrationsWSRequest" : { + "type" : "object", + "description" : "Request object for getting organization integrations (deprecated, use integration package)." + }, + "Org_GetOrgIntegrationsWSResponse" : { + "type" : "object", + "description" : "Response object containing organization integrations (deprecated, use integration package).", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "orgIntegrations" : { + "$ref" : "#/components/schemas/OrgIntegrationsType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetOrgNotificationTemplateV2WSResponse" : { + "type" : "object", + "description" : "Response object containing organization notification template V2.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "notificationSettings" : { + "$ref" : "#/components/schemas/UserNotificationSettingsV4Type" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetOrgNotificationTemplateWSRequest" : { + "type" : "object", + "description" : "Request object for getting organization notification template." + }, + "Org_GetOrgNotificationTemplateWSResponse" : { + "type" : "object", + "description" : "Response object containing organization notification template.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "notificationSettings" : { + "$ref" : "#/components/schemas/UserNotificationSettingsV3Type" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetOrgV2WSRequest" : { + "type" : "object", + "description" : "Request object for getting organization details V2." + }, + "Org_GetOrgV2WSResponse" : { + "type" : "object", + "description" : "Response object containing organization details V2 with camera configuration options.", + "properties" : { + "cameraConfigDefaults" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Device_config_settings_VideoConfigurationDefault" + }, + "description" : "Map of hardware variations to default video configurations", + "nullable" : true + }, + "cameraConfigOptions" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of hardware variations to available video configuration options", + "items" : { + "$ref" : "#/components/schemas/Device_config_settings_VideoConfigurationOption" + }, + "nullable" : true + }, + "description" : "Map of hardware variations to available video configuration options", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "featureFlags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of feature flags for the organization", + "nullable" : true + }, + "description" : "Map of feature flags for the organization", + "nullable" : true + }, + "managingPartnerName" : { + "type" : "string", + "description" : "MSP initiative: name of the MSP that manages this org (org.managingPartnerOrgUuid), when managed.", + "nullable" : true + }, + "org" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting organization details (deprecated)." + }, + "Org_GetOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing organization details (deprecated).", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "featureFlags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of feature flags for the organization", + "nullable" : true + }, + "description" : "Map of feature flags for the organization", + "nullable" : true + }, + "org" : { + "$ref" : "#/components/schemas/OrgType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetSAMLSettingsV2WSRequest" : { + "type" : "object", + "description" : "Request object for getting SAML settings V2." + }, + "Org_GetSAMLSettingsV2WSResponse" : { + "type" : "object", + "description" : "Response object containing SAML settings V2.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "samlSettings" : { + "type" : "array", + "description" : "List of SAML settings for the organization", + "items" : { + "$ref" : "#/components/schemas/OrgSamlSettingsType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetSAMLSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for getting SAML settings (deprecated)." + }, + "Org_GetSAMLSettingsWSResponse" : { + "type" : "object", + "description" : "Response object containing SAML settings (deprecated).", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "samlSettings" : { + "$ref" : "#/components/schemas/OrgSamlSettingsType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_GetScimDisplayInfoResponse" : { + "type" : "object", + "description" : "Response object containing SCIM display information.", + "properties" : { + "azureScimEndpointUrl" : { + "type" : "string", + "description" : "Azure SCIM endpoint URL", + "example" : "https://api.rhombussystems.com/scim/v2/azure", + "nullable" : true + }, + "scimEndpointUrl" : { + "type" : "string", + "description" : "SCIM endpoint URL", + "example" : "https://api.rhombussystems.com/scim/v2", + "nullable" : true + } + } + }, + "Org_GetTemporaryOrgTokenWSRequest" : { + "type" : "object", + "description" : "Request object for getting temporary organization token." + }, + "Org_HardwareWithPendingRegistrationInfoType" : { + "type" : "object", + "properties" : { + "hardware" : { + "$ref" : "#/components/schemas/HardwareType" + }, + "hwUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pendingRegistrationInfo" : { + "$ref" : "#/components/schemas/Org_PendingRegistrationInfoType" + } + } + }, + "Org_PeekShipmentRegistrationTokenWSRequest" : { + "type" : "object", + "properties" : { + "tokenUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_PeekShipmentRegistrationTokenWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "hardwareUuidList" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_PendingRegistrationInfoType" : { + "type" : "object", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_RemovePendingRegistrationRequest" : { + "type" : "object", + "properties" : { + "serialNumber" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_RemovePendingRegistrationResponse" : { + "type" : "object" + }, + "Org_RevokeSCIMAccessForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for revoking SCIM access for organization." + }, + "Org_RevokeSCIMAccessForOrgWSResponse" : { + "type" : "object", + "description" : "Response object for revoking SCIM access for organization." + }, + "Org_SetFlagWSRequest" : { + "type" : "object", + "description" : "Request object for setting organization flags.", + "properties" : { + "flagName" : { + "type" : "string", + "description" : "Name of the flag to set", + "example" : "feature_enabled", + "nullable" : true + }, + "flagValue" : { + "type" : "string", + "description" : "Value of the flag to set", + "example" : "true", + "nullable" : true + } + } + }, + "Org_SetFlagWSResponse" : { + "type" : "object", + "description" : "Response object for setting organization flags.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_SetupSCIMAccessForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for setting up SCIM access for organization.", + "properties" : { + "addUsersOnRoleMismatch" : { + "type" : "boolean", + "description" : "Whether to add users on role mismatch", + "example" : false, + "nullable" : true + }, + "rhombusKeyAppSettings" : { + "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + }, + "sendWelcomeEmailToNewRhombusKeyUsers" : { + "type" : "boolean", + "description" : "Whether to send welcome email to new Rhombus Key users", + "example" : true, + "nullable" : true + }, + "sendWelcomeEmailToNewUsers" : { + "type" : "boolean", + "description" : "Whether to send welcome email to new users", + "example" : true, + "nullable" : true + } + } + }, + "Org_SetupSCIMAccessForOrgWSResponse" : { + "type" : "object", + "description" : "Response object for setting up SCIM access for organization.", + "properties" : { + "scimAccessAlreadySetupFailure" : { + "type" : "boolean", + "nullable" : true + }, + "token" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateAiTrainingSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for updating AI training settings.", + "properties" : { + "shareAiTrainingMediaWithRhombus" : { + "type" : "boolean", + "description" : "Whether to share AI training media with Rhombus", + "example" : false, + "nullable" : true + } + } + }, + "Org_UpdateAiTrainingSettingsWSResponse" : { + "type" : "object", + "description" : "Response object for updating AI training settings.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateCloudArchivingConfigWSRequest" : { + "type" : "object", + "description" : "Request object for updating cloud archiving configuration.", + "properties" : { + "archivingConfig" : { + "$ref" : "#/components/schemas/ScopedCloudArchivingConfig" + } + } + }, + "Org_UpdateCloudArchivingConfigWSResponse" : { + "type" : "object", + "description" : "Response object for updating cloud archiving configuration.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateDataRetentionSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for updating org data retention settings for face and license plate events.", + "properties" : { + "dataRetentionSettings" : { + "$ref" : "#/components/schemas/DataRetentionSettingsType" + } + } + }, + "Org_UpdateDataRetentionSettingsWSResponse" : { + "type" : "object", + "description" : "Response object for updating org data retention settings.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "org" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateFirmwareSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for updating firmware settings.", + "properties" : { + "firmwareSettings" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" + }, + "firmwareUpdateSettings" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsType" + }, + "firmwareUpdateSettingsOverrides" : { + "type" : "array", + "description" : "Overrides default firmware update settings.", + "items" : { + "$ref" : "#/components/schemas/FirmwareUpdateSettingsOverrideType" + }, + "nullable" : true + } + } + }, + "Org_UpdateFirmwareSettingsWSResponse" : { + "type" : "object", + "description" : "Response object for updating firmware settings.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateGeneralSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for updating general organization settings.", + "properties" : { + "accountBillingContactEmail" : { + "type" : "string", + "description" : "Email of the account billing contact", + "example" : "billing@acme.com", + "nullable" : true + }, + "accountOwnerEmail" : { + "type" : "string", + "description" : "Email of the account owner", + "example" : "owner@acme.com", + "nullable" : true + }, + "accountTechnicalContactEmail" : { + "type" : "string", + "description" : "Email of the account technical contact", + "example" : "tech@acme.com", + "nullable" : true + }, + "accountTechnicalContacts" : { + "type" : "array", + "description" : "List of account technical contact emails", + "items" : { + "type" : "string", + "description" : "List of account technical contact emails", + "nullable" : true + }, + "nullable" : true + }, + "connectivityBatchWindowSecs" : { + "type" : "integer", + "format" : "int32", + "description" : "Window in seconds over which device connectivity notifications are batched into a single digest; null or 0 disables batching", + "example" : 300, + "nullable" : true + }, + "defaultPlayerViewLiveType" : { + "$ref" : "#/components/schemas/PlayerViewLiveTypeEnum" + }, + "inactivityTimeout" : { + "type" : "integer", + "format" : "int32", + "description" : "Inactivity timeout in minutes", + "example" : 30, + "nullable" : true + }, + "mobileSessionLimitInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Mobile session length in days (1-365); sessions older than this are invalidated and the mobile apps re-authenticate", + "example" : 30, + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the organization", + "example" : "Acme Corporation", + "nullable" : true + }, + "uapSettings" : { + "$ref" : "#/components/schemas/UAPSettingsType" + } + } + }, + "Org_UpdateGeneralSettingsWSResponse" : { + "type" : "object", + "description" : "Response object for updating general organization settings.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateLoginIpAllowlistWSRequest" : { + "type" : "object", + "description" : "Request object for updating the org-wide login IP allowlist.", + "properties" : { + "allowedLoginIpRanges" : { + "type" : "array", + "description" : "IP addresses / CIDR ranges that users flagged with restrictToAllowedLoginIps may use the web console from. An empty list clears the allowlist (and lifts the restriction until ranges are configured again).", + "example" : [ "203.0.113.5", "198.51.100.0/24" ], + "items" : { + "type" : "string", + "description" : "IP addresses / CIDR ranges that users flagged with restrictToAllowedLoginIps may use the web console from. An empty list clears the allowlist (and lifts the restriction until ranges are configured again).", + "example" : "[\"203.0.113.5\",\"198.51.100.0/24\"]", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Org_UpdateLoginIpAllowlistWSResponse" : { + "type" : "object", + "description" : "Response object for updating the org-wide login IP allowlist.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "org" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateMFASettingsWSRequest" : { + "type" : "object", + "description" : "Request object for updating MFA settings.", + "properties" : { + "mfaEnabled" : { + "type" : "boolean", + "description" : "Whether MFA is enabled for the organization", + "example" : true, + "nullable" : true + }, + "v3AuthNumDaysSkip2FAForTrustedDevices" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days to skip 2FA for trusted devices (< 0 = forever, 0 = always require 2FA, > 0 = days to skip)", + "example" : 30, + "nullable" : true + } + } + }, + "Org_UpdateMFASettingsWSResponse" : { + "type" : "object", + "description" : "Response object for updating MFA settings.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "org" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgAudioAnalysisPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating organization audio analysis policy.", + "properties" : { + "audioAnalysisEnabled" : { + "type" : "boolean", + "description" : "Whether audio analysis is enabled for the organization", + "example" : true, + "nullable" : true + } + } + }, + "Org_UpdateOrgAudioAnalysisPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization audio analysis policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgAudioRecordingPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating organization audio recording policy.", + "properties" : { + "audioRecordingEnabled" : { + "type" : "boolean", + "description" : "Whether audio recording is enabled for the organization", + "example" : true, + "nullable" : true + } + } + }, + "Org_UpdateOrgAudioRecordingPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization audio recording policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgIntegrationsWSRequest" : { + "type" : "object", + "description" : "Request object for updating organization integrations (deprecated, use integration package).", + "properties" : { + "orgIntegrations" : { + "$ref" : "#/components/schemas/OrgIntegrationsType" + } + } + }, + "Org_UpdateOrgIntegrationsWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization integrations (deprecated, use integration package).", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgLLMUsagePolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating organization LLM usage opt-in policy.", + "properties" : { + "llmUsageEnabled" : { + "type" : "boolean", + "description" : "Whether the org is opting in to use LLMs", + "example" : true, + "nullable" : true + } + } + }, + "Org_UpdateOrgLLMUsagePolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization LLM usage opt-in policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgNotificationTemplateV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating organization notification template V2.", + "properties" : { + "summaryEmailEnabled" : { + "type" : "boolean", + "description" : "Whether summary email is enabled", + "example" : true, + "nullable" : true + }, + "templateUpdate" : { + "$ref" : "#/components/schemas/UserNotificationSelectiveUpdateV2" + } + } + }, + "Org_UpdateOrgNotificationTemplateV2WSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgNotificationTemplateWSRequest" : { + "type" : "object", + "description" : "Request object for updating organization notification template.", + "properties" : { + "notificationIntervalsV2" : { + "type" : "array", + "description" : "List of notification intervals V2", + "items" : { + "$ref" : "#/components/schemas/NotificationIntervalV2Type" + }, + "nullable" : true + }, + "summaryEmailEnabled" : { + "type" : "boolean", + "description" : "Whether summary email is enabled", + "example" : true, + "nullable" : true + } + } + }, + "Org_UpdateOrgNotificationTemplateWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization notification template.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateOrgWSRequest" : { + "type" : "object", + "description" : "Request object for updating organization details (deprecated).", + "properties" : { + "org" : { + "$ref" : "#/components/schemas/OrgType" + } + } + }, + "Org_UpdateOrgWSResponse" : { + "type" : "object", + "description" : "Response object for updating organization details (deprecated).", + "properties" : { + "samlEntityIdUniquenessConstraintFailure" : { + "type" : "boolean", + "nullable" : true + }, + "teamNameNotAssignedFailure" : { + "type" : "boolean", + "nullable" : true + }, + "teamNameUniquenessConstraintFailure" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "Org_UpdatePaneLinksWSRequest" : { + "type" : "object", + "description" : "Request object for setting which PANE apps this organization links.", + "properties" : { + "paneLinks" : { + "type" : "array", + "description" : "The complete set of PANE apps this organization links, replacing any current set. An empty list removes them all.", + "items" : { + "$ref" : "#/components/schemas/OrgPaneLinkType" + }, + "nullable" : true + } + } + }, + "Org_UpdatePaneLinksWSResponse" : { + "type" : "object", + "description" : "Response object for setting which PANE apps this organization links.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdatePendingRegistrationRequest" : { + "type" : "object", + "properties" : { + "hardwareUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Org_UpdatePendingRegistrationResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateSAMLSettingsV2WSRequest" : { + "type" : "object", + "description" : "Request object for updating SAML settings V2.", + "properties" : { + "samlSettings" : { + "type" : "array", + "description" : "List of SAML settings to update", + "items" : { + "$ref" : "#/components/schemas/OrgSamlSettingsType" + }, + "nullable" : true + } + } + }, + "Org_UpdateSAMLSettingsV2WSResponse" : { + "type" : "object", + "description" : "Response object for updating SAML settings V2.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateSAMLSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for updating SAML settings (deprecated).", + "properties" : { + "samlSettings" : { + "$ref" : "#/components/schemas/OrgSamlSettingsType" + } + } + }, + "Org_UpdateSAMLSettingsWSResponse" : { + "type" : "object", + "description" : "Response object for updating SAML settings (deprecated).", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Org_UpdateSCIMSettingsForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for updating SCIM settings for organization.", + "properties" : { + "addUsersOnRoleMismatch" : { + "type" : "boolean", + "description" : "Whether to add users on role mismatch", + "example" : false, + "nullable" : true + }, + "rhombusKeyAppSettings" : { + "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + }, + "sendWelcomeEmailToNewRhombusKeyUsers" : { + "type" : "boolean", + "description" : "Whether to send welcome email to new Rhombus Key users", + "example" : true, + "nullable" : true + }, + "sendWelcomeEmailToNewUsers" : { + "type" : "boolean", + "description" : "Whether to send welcome email to new users", + "example" : true, + "nullable" : true + } + } + }, + "Org_UpdateSCIMSettingsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object for updating SCIM settings for organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "OsdpDoorReaderType" : { + "type" : "object", + "properties" : { + "allowUnencrypted" : { + "type" : "boolean", + "nullable" : true + }, + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "disableCardReader" : { + "type" : "boolean", + "nullable" : true + }, + "disableKeypad" : { + "type" : "boolean", + "nullable" : true + }, + "disableWaveToUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "disposition" : { + "$ref" : "#/components/schemas/ReaderDispositionEnum" + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "osdpAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/OsdpReaderPortType" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "readerType" : { + "$ref" : "#/components/schemas/DoorReaderEnumType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "OsdpPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "RS485" ] + }, + "OsdpReaderPortType" : { + "type" : "object", + "properties" : { + "boardNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "portNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "portType" : { + "$ref" : "#/components/schemas/OsdpPhysicalPortEnumType" + } + } + }, + "OutgoingShipmentInfoType" : { + "type" : "object", + "description" : "Outgoing shipment information (deprecated)", + "properties" : { + "buyer" : { + "$ref" : "#/components/schemas/Buyer" + }, + "consignee" : { + "$ref" : "#/components/schemas/Consignee" + }, + "depositorOrderNumber" : { + "type" : "string", + "nullable" : true + }, + "freight" : { + "$ref" : "#/components/schemas/Freight" + }, + "interchangeControlNumber" : { + "type" : "string", + "nullable" : true + }, + "product" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Product" + }, + "nullable" : true + }, + "purchaseOrderNumber" : { + "type" : "string", + "nullable" : true + }, + "shipment" : { + "$ref" : "#/components/schemas/Shipment" + }, + "shipper" : { + "$ref" : "#/components/schemas/Shipper" + } + } + }, + "PagerDutySettings" : { + "type" : "object", + "properties" : { + "allLocationIntegrationKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "integrationKey" : { + "type" : "string", + "nullable" : true + }, + "locationToIntegrationKeysMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + } + } + }, + "PaginateRequest" : { + "type" : "object", + "description" : "Request object for retrieving a resource with optional pagination.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "nullable" : true + }, + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "PaneCatalogItem" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" + } + } + } ], + "nullable" : true, + "properties" : { + "durationMonths" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "nullable" : true + }, + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + } + } + }, + "PaneLicenseStatusReasonEnum" : { + "type" : "string", + "description" : "LICENSED, or why the pane is not licensed: NO_LICENSE, EXPIRED, INVALID_STATE", + "enum" : [ "LICENSED", "NO_LICENSE", "EXPIRED", "INVALID_STATE" ] + }, + "PaneLicenseType" : { + "type" : "object", + "description" : "List of PANE app licenses in the client organization", + "properties" : { + "claimKeyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "firstAssignedDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "licenseToUnassignEmailState" : { + "$ref" : "#/components/schemas/LicenseToUnassignEmailStateEnum" + }, + "licenseType" : { + "$ref" : "#/components/schemas/LicenseEnum" + }, + "maxDeleteDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "paneId" : { + "type" : "string", + "nullable" : true + }, + "priorClaimKeyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "nullable" : true + }, + "productType" : { + "$ref" : "#/components/schemas/ProductTypeEnum" + }, + "state" : { + "$ref" : "#/components/schemas/LicenseStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PanelType" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + } + } + }, + "PanicButtonEventType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "newSupervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "correlationId" : { + "type" : "string", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ParPOSType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "accessToken" : { + "type" : "string", + "nullable" : true + }, + "locationTokenMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "serverUrl" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ParameterizedHeader" : { + "type" : "object", + "nullable" : true, + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + } + } + }, + "ParseRulePromptRequest" : { + "type" : "object", + "properties" : { + "catalog" : { + "$ref" : "#/components/schemas/RulePromptCatalog" + }, + "orgUuid" : { + "type" : "string", + "nullable" : true + }, + "source" : { + "type" : "string", + "nullable" : true + }, + "timezone" : { + "type" : "string", + "nullable" : true + }, + "turns" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PromptTurn" + }, + "nullable" : true + } + } + }, + "ParseRulePromptResponse" : { + "type" : "object", + "properties" : { + "assistantText" : { + "type" : "string", + "nullable" : true + }, + "draft" : { + "$ref" : "#/components/schemas/RulePromptDraft" + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "options" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RulePromptClarificationOption" + }, + "nullable" : true + }, + "question" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "type" : "string", + "nullable" : true + } + } + }, + "PartnerFunctionalityEnum" : { + "type" : "string", + "enum" : [ "CREATE_CLIENT", "DELETE_CLIENT", "DEAL_ADMINISTRATION", "REMOTE_REGISTER_DEVICE", "ORG_ADMINISTRATION", "AUTH_ADMINISTRATION", "DOOR_ACCESS_ADMINISTRATION", "USER_ADMINISTRATION", "REPORT_ADMINISTRATION", "NOTIFICATION_ADMINISTRATION", "LICENSE_ADMINISTRATION", "RECEIVE_EMAILS", "API_ADMINISTRATION", "INTEGRATION_ADMINISTRATION", "DATA_EXFILTRATION", "MSP_ADMINISTRATION", "CLIP_MANAGEMENT", "UNKNOWN" ] + }, + "PartnerNotificationClientSection" : { + "type" : "object", + "properties" : { + "clientUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "rows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PartnerNotificationClientSectionRow" + }, + "nullable" : true + } + } + }, + "PartnerNotificationClientSectionRow" : { + "type" : "object", + "properties" : { + "activities" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "days" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RhombusDayOfWeekEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "diagnostics" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiagnosticActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "interval" : { + "$ref" : "#/components/schemas/MinuteOfDayIntervalType" + }, + "mediums" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEnumType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "PartnerNotificationSettingsV2" : { + "type" : "object", + "properties" : { + "allClientsSelected" : { + "type" : "boolean", + "nullable" : true + }, + "clientNotificationIntervalsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PartnerNotificationClientSection" + }, + "nullable" : true + }, + "nullable" : true + }, + "notificationIntervalsForAllClients" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PartnerNotificationClientSection" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "smsNotificationIncludesLinks" : { + "type" : "boolean", + "nullable" : true + }, + "smsPhoneNumbers" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "summaryEmailEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PartnerOrgClaimKey" : { + "type" : "object", + "description" : "CREATED (not yet claimed) keys for the partner, as getClaimKeysForPartnerOrg returns them.", + "properties" : { + "accountAdminId" : { + "type" : "string", + "nullable" : true + }, + "accountName" : { + "type" : "string", + "nullable" : true + }, + "claimKeyUuid" : { + "type" : "string", + "nullable" : true + }, + "contractEndDate" : { + "type" : "string", + "nullable" : true + }, + "contractStartDate" : { + "type" : "string", + "nullable" : true + }, + "createdDate" : { + "type" : "string", + "nullable" : true + }, + "externalUuid" : { + "type" : "string", + "nullable" : true + }, + "poNumber" : { + "type" : "string", + "nullable" : true + } + } + }, + "PartnerPermissionEnum" : { + "type" : "string", + "enum" : [ "DEFAULT", "CUSTOM" ] + }, + "PartnerPermissionType" : { + "type" : "object", + "description" : "List of partner permissions", + "properties" : { + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PartnerUserPermissionGroupType" : { + "type" : "object", + "description" : "Updated partner permission group configuration", + "properties" : { + "assignablePermissionGroups" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "clientAssignablePermissionGroupsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "nullable" : true + }, + "clientFunctionalityList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FunctionalityEnum" + }, + "nullable" : true + }, + "clientPermissionMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PartnerPermissionEnum" + }, + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "functionalityList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PartnerFunctionalityEnum" + }, + "nullable" : true + }, + "mutable" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "superAdmin" : { + "type" : "boolean", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_ClientCustomizationsType" : { + "type" : "object", + "description" : "Client-specific customization settings for partner management.", + "properties" : { + "forceLowBandwidthOnAllCameras" : { + "type" : "boolean", + "description" : "Whether to force low bandwidth on all cameras", + "example" : false, + "nullable" : true + }, + "inactivityTimeout" : { + "type" : "integer", + "format" : "int32", + "description" : "Inactivity timeout in minutes", + "example" : 30, + "nullable" : true + } + } + }, + "Partner_ClientDeviceCustomizationsType" : { + "type" : "object", + "description" : "Client device-specific customization settings for partner management.", + "properties" : { + "forceLowBandwidthOnAllCameras" : { + "type" : "boolean", + "description" : "Whether to force low bandwidth on all cameras", + "example" : false, + "nullable" : true + }, + "inactivityTimeout" : { + "type" : "integer", + "format" : "int32", + "description" : "Inactivity timeout in minutes", + "example" : 30, + "nullable" : true + } + } + }, + "Partner_ConnectionCountType" : { + "type" : "object", + "description" : "Device connection count information for partner clients.", + "properties" : { + "connectedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of connected devices", + "example" : 45, + "nullable" : true + }, + "operationalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of operational devices", + "example" : 42, + "nullable" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of devices", + "example" : 50, + "nullable" : true + } + } + }, + "Partner_CreatePartnerClientWSRequest" : { + "type" : "object", + "description" : "Request object for creating a new partner client account.", + "properties" : { + "allowDuplicateName" : { + "type" : "boolean", + "description" : "MSP initiative (D8): create even if this MSP already manages an org with the same name (case-insensitive). Default false.", + "nullable" : true + }, + "clientContactEmail" : { + "type" : "string", + "description" : "Email address of the client contact person", + "example" : "john.smith@acme.com", + "nullable" : true + }, + "clientContactName" : { + "type" : "string", + "description" : "Name of the client contact person", + "example" : "John Smith", + "nullable" : true + }, + "clientOrgName" : { + "type" : "string", + "description" : "Name of the client organization", + "example" : "Acme Corporation", + "nullable" : true + }, + "suppressWelcomeEmail" : { + "type" : "boolean", + "description" : "Whether to suppress sending welcome email to the client", + "example" : false, + "nullable" : true + } + } + }, + "Partner_CreatePartnerClientWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of creating a partner client account.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "responseStatus" : { + "$ref" : "#/components/schemas/Partner_PartnerWebResponseStatusEnum" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_CustomizeClientDeviceWSRequest" : { + "type" : "object", + "description" : "Request object for customizing client device settings and configurations.", + "properties" : { + "clientDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_IExternalUpdateableAudioVideoUserConfig" + }, + "customizations" : { + "$ref" : "#/components/schemas/Partner_ClientDeviceCustomizationsType" + } + } + }, + "Partner_CustomizeClientDeviceWSResponse" : { + "type" : "object", + "description" : "Response object containing the applied client device customization settings.", + "properties" : { + "customizations" : { + "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_CustomizeClientWSRequest" : { + "type" : "object", + "description" : "Request object for customizing client settings and configurations.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "customizations" : { + "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" + } + } + }, + "Partner_CustomizeClientWSResponse" : { + "type" : "object", + "description" : "Response object containing the applied client customization settings.", + "properties" : { + "customizations" : { + "$ref" : "#/components/schemas/Partner_ClientCustomizationsType" + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_DeleteClientWebRequest" : { + "type" : "object", + "description" : "Request object for deleting a partner client account.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_DeleteClientWebResponse" : { + "type" : "object", + "description" : "Response object for deleting a partner client account." + }, + "Partner_DeviceWithPartnerDetailsType" : { + "type" : "object", + "description" : "Device information with partner-specific details including control and reassignment status.", + "properties" : { + "device" : { + "$ref" : "#/components/schemas/DeviceTypeV2" + }, + "partnerControlledHardware" : { + "type" : "boolean", + "description" : "Whether the hardware is controlled by the partner", + "example" : true, + "nullable" : true + }, + "reassignable" : { + "type" : "boolean", + "description" : "Whether the device can be reassigned to another organization", + "example" : true, + "nullable" : true + } + } + }, + "Partner_GetClientDevicesWSRequest" : { + "type" : "object", + "description" : "Request object for getting devices for a specific client organization.", + "properties" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GetClientDevicesWSResponse" : { + "type" : "object", + "description" : "Response object containing devices for a specific client organization.", + "properties" : { + "devices" : { + "type" : "array", + "description" : "List of devices with partner-specific details", + "items" : { + "$ref" : "#/components/schemas/Partner_DeviceWithPartnerDetailsType" + }, + "nullable" : true + } + } + }, + "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSBaseResponse" : { + "type" : "object", + "description" : "Base response for getting client Rhombus organization users for partner activation token V2", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSFailureResponse" + }, { + "$ref" : "#/components/schemas/Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSSuccessResponse" + } ], + "properties" : { + "type" : { + "type" : "string" + } + }, + "required" : [ "type" ] + }, + "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSFailureResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "failureReason" : { + "type" : "string", + "description" : "Reason for the failure", + "example" : "Invalid activation token", + "nullable" : true + } + } + } ], + "description" : "Failure response for getting client Rhombus organization users for partner activation token V2.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSRequest" : { + "type" : "object", + "description" : "Request object for getting client Rhombus organization users for partner activation token V2.", + "properties" : { + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GetClientRhombusOrgUsersForPartnerActivationTokenV2WSSuccessResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "orgs" : { + "type" : "array", + "description" : "List of Rhombus organizations the user has access to", + "items" : { + "$ref" : "#/components/schemas/OrgV2Type" + }, + "nullable" : true + } + } + } ], + "description" : "Success response for getting client Rhombus organization users for partner activation token V2.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_GetClientSummaryInfoWSRequest" : { + "type" : "object", + "description" : "Request object for getting client summary information.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GetClientSummaryInfoWSResponse" : { + "type" : "object", + "description" : "Response object containing client summary information including account owner, device status, and settings.", + "properties" : { + "accountOwner" : { + "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" + }, + "clientDeviceStatusMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Partner_ConnectionCountType" + }, + "description" : "Map of device types to their connection status counts", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "licenseV2Enabled" : { + "type" : "boolean", + "description" : "Whether license V2 is enabled for the client", + "example" : true, + "nullable" : true + }, + "locationCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of locations for the client", + "example" : 3, + "nullable" : true + }, + "manuallySendLicenseExpirationEmailEnabled" : { + "type" : "boolean", + "description" : "Whether manual license expiration email sending is enabled", + "example" : false, + "nullable" : true + }, + "recentPolicyAlertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of recent policy alerts", + "example" : 5, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_GetListOfAllClientDevicesRequest" : { + "type" : "object", + "description" : "Request object for getting list of all client devices." + }, + "Partner_GetListOfAllClientDevicesResponse" : { + "type" : "object", + "description" : "Response object containing list of all client devices.", + "properties" : { + "listOfAllClientDevices" : { + "type" : "array", + "description" : "List of all client devices", + "items" : { + "$ref" : "#/components/schemas/DeviceTypeV2" + }, + "nullable" : true + } + } + }, + "Partner_GetListOfControlledHardwareRequest" : { + "type" : "object", + "description" : "Request object for getting list of controlled hardware." + }, + "Partner_GetListOfControlledHardwareResponse" : { + "type" : "object", + "description" : "Response object containing list of controlled hardware.", + "properties" : { + "controlledHardwareList" : { + "type" : "array", + "description" : "List of controlled hardware", + "items" : { + "$ref" : "#/components/schemas/Partner_UnregisteredControlledHardwareType" + }, + "nullable" : true + } + } + }, + "Partner_GetPartnerAccessRequestSummaryV3WSBaseResponse" : { + "type" : "object", + "description" : "Base response for fetching pending partner access request summary (V3).", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Partner_GetPartnerAccessRequestSummaryV3WSFailureResponse" + }, { + "$ref" : "#/components/schemas/Partner_GetPartnerAccessRequestSummaryV3WSSuccessResponse" + } ], + "properties" : { + "type" : { + "type" : "string" + } + }, + "required" : [ "type" ] + }, + "Partner_GetPartnerAccessRequestSummaryV3WSFailureResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "failureReason" : { + "type" : "string", + "description" : "Reason for the failure", + "example" : "Session expired", + "nullable" : true + } + } + } ], + "description" : "Failure response for fetching pending partner access request summary (V3).", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_GetPartnerAccessRequestSummaryV3WSRequest" : { + "type" : "object", + "description" : "Request object for fetching summary info for a pending partner access request (V3, session-authenticated).", + "properties" : { + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GetPartnerAccessRequestSummaryV3WSSuccessResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "partnerName" : { + "type" : "string", + "description" : "Display name of the partner requesting access", + "nullable" : true + } + } + } ], + "description" : "Success response for fetching a pending partner access request summary (V3). The request is scoped to a single org, so this returns just the partner identity for display; the approving user is already in that org's tenant.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_GetPartnerClientMobileAccountAccessRequest" : { + "type" : "object", + "description" : "Request object for getting partner client mobile account access.", + "properties" : { + "authorityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GetPartnerClientMobileAccountAccessResponse" : { + "type" : "object", + "description" : "Response object containing partner client mobile account access session.", + "properties" : { + "clientAccountAccessSessionId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GetPartnerClientsStatusMapWSRequest" : { + "type" : "object", + "description" : "Request object for getting partner clients status map." + }, + "Partner_GetPartnerClientsStatusMapWSResponse" : { + "type" : "object", + "description" : "Response object containing partner clients status map with device connection counts.", + "properties" : { + "clientDeviceStatusMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Partner_ConnectionCountType" + }, + "description" : "Map of client UUIDs to device type connection counts", + "nullable" : true + }, + "description" : "Map of client UUIDs to device type connection counts", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_GetPartnerClientsWSRequest" : { + "type" : "object", + "description" : "Request object for getting all partner clients.", + "properties" : { + "includeDeactivated" : { + "type" : "boolean", + "description" : "MSP initiative: also return soft-deleted (deactivated) client orgs still inside the restore window. Default false.", + "nullable" : true + } + } + }, + "Partner_GetPartnerClientsWSResponse" : { + "type" : "object", + "description" : "Response object containing list of partner clients.", + "properties" : { + "clients" : { + "type" : "array", + "description" : "List of partner clients", + "items" : { + "$ref" : "#/components/schemas/Partner_PartnerClientWebType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_GetPartnerUsersInOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting partner users in organization." + }, + "Partner_GetPartnerUsersInOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing partner users in organization with notification settings and permissions.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "notificationSettingsV2" : { + "type" : "array", + "description" : "List of partner notification settings V2", + "items" : { + "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" + }, + "nullable" : true + }, + "partnerPermissions" : { + "type" : "array", + "description" : "List of partner permissions", + "items" : { + "$ref" : "#/components/schemas/PartnerPermissionType" + }, + "nullable" : true + }, + "partnerUsers" : { + "type" : "array", + "description" : "List of partner users in the organization", + "items" : { + "$ref" : "#/components/schemas/WrappedRhombusOrgUserType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_GetShipmentsWSRequest" : { + "type" : "object", + "description" : "Request object for getting client shipments within a time range.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "endTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "End time for shipment search (seconds since epoch)", + "example" : 1640995200, + "nullable" : true + }, + "startTimeSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time for shipment search (seconds since epoch)", + "example" : 1640908800, + "nullable" : true + } + } + }, + "Partner_GetShipmentsWSResponse" : { + "type" : "object", + "description" : "Response object containing client shipments within the specified time range.", + "properties" : { + "customerShipmentList" : { + "type" : "array", + "description" : "List of customer shipments", + "items" : { + "$ref" : "#/components/schemas/CustomerShipmentType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_GrantSupportAccessToClientWSRequest" : { + "type" : "object", + "description" : "Request object for granting support access to a client account.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_GrantSupportAccessToClientWSResponse" : { + "type" : "object", + "description" : "Response object for granting support access to a client account.", + "properties" : { + "errMessage" : { + "type" : "string", + "description" : "Error message if support access grant failed", + "example" : "Client organization not found", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_PartnerClientWebType" : { + "type" : "object", + "description" : "Partner client information including organization details and device counts.", + "properties" : { + "authorityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "clientAccessAllowed" : { + "type" : "boolean", + "description" : "Whether client access is allowed (duplicate getter)", + "example" : true, + "nullable" : true + }, + "clientAccountAccessUrl" : { + "type" : "string", + "description" : "URL for accessing the client account", + "example" : "https://console.rhombussystems.com/client/access", + "nullable" : true + }, + "clientOrgName" : { + "type" : "string", + "description" : "Name of the client organization", + "example" : "Acme Corporation", + "nullable" : true + }, + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "clientSuperAdminAssignable" : { + "type" : "boolean", + "description" : "MSP initiative (D3): false when the MSP has restricted the client org's Super Admin role.", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the client was created (milliseconds since epoch)", + "example" : 1640995200000, + "nullable" : true + }, + "deactivated" : { + "type" : "boolean", + "description" : "MSP initiative: true when the client org is soft-deleted (only returned with includeDeactivated=true).", + "nullable" : true + }, + "deactivatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "MSP initiative: when the client org was deactivated, if it is.", + "nullable" : true + }, + "managedByMsp" : { + "type" : "boolean", + "description" : "MSP initiative: true when this client is a managed org owned by the calling MSP (permanent authority).", + "nullable" : true + }, + "totalAudioGateways" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of audio gateways", + "example" : 4, + "nullable" : true + }, + "totalBadgeReaders" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of badge readers", + "example" : 12, + "nullable" : true + }, + "totalCameras" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of cameras", + "example" : 25, + "nullable" : true + }, + "totalClimateSensors" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of climate sensors", + "example" : 10, + "nullable" : true + }, + "totalDoorSensors" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of door sensors", + "example" : 8, + "nullable" : true + }, + "totalLocations" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of locations", + "example" : 3, + "nullable" : true + }, + "totalOccupancySensors" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of occupancy sensors", + "example" : 6, + "nullable" : true + }, + "totalProximitySensors" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of proximity sensors", + "example" : 5, + "nullable" : true + } + } + }, + "Partner_PartnerWebResponseStatusEnum" : { + "type" : "string", + "description" : "Status responses for partner web operations.", + "enum" : [ "BASIC_AUTH_FAILED", "PASSWORD_MISMATCH", "USER_EXISTS", "CLIENT_EXISTS", "USER_NOT_FOUND", "BAD_INPUT", "SUCCESS", "PASSWORD_TOO_SHORT" ] + }, + "Partner_ReassignDeviceOrgWSRequest" : { + "type" : "object", + "description" : "Request object for reassigning devices from one organization to another.", + "properties" : { + "serialNumbers" : { + "type" : "array", + "description" : "Serial numbers of the devices that should be reassigned to target organization", + "items" : { + "type" : "string", + "description" : "Serial numbers of the devices that should be reassigned to target organization", + "nullable" : true + }, + "nullable" : true + }, + "sourceOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "targetOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "sourceOrgUuid", "targetOrgUuid" ] + }, + "Partner_ReassignDeviceOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing the status of device reassignment operations.", + "properties" : { + "statuses" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationStatus" + }, + "description" : "Map of device serial numbers to their reassignment operation status", + "nullable" : true + } + } + }, + "Partner_RegisterDealWSRequest" : { + "type" : "object", + "description" : "Request object for registering a deal with partner details.", + "properties" : { + "details" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Map of deal details with key-value pairs", + "nullable" : true + }, + "description" : "Map of deal details with key-value pairs", + "nullable" : true + } + } + }, + "Partner_RegisterDealWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of registering a deal.", + "properties" : { + "clients" : { + "type" : "array", + "description" : "List of partner clients associated with the registered deal", + "items" : { + "$ref" : "#/components/schemas/Partner_PartnerClientWebType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_RequestAccessToClientAccountRequest" : { + "type" : "object", + "description" : "Request object for requesting access to a client account (deprecated, use V2).", + "properties" : { + "clientEmail" : { + "type" : "string", + "description" : "Email address of the client to request access for", + "example" : "client@acme.com", + "nullable" : true + } + } + }, + "Partner_RequestAccessToClientAccountResponse" : { + "type" : "object", + "description" : "Response object for requesting access to a client account (deprecated, use V2).", + "properties" : { + "success" : { + "type" : "boolean", + "description" : "Whether the access request was successful", + "example" : true, + "nullable" : true + } + } + }, + "Partner_RequestAccessToClientAccountV2Request" : { + "type" : "object", + "description" : "Request object for requesting access to a client account V2.", + "properties" : { + "clientEmail" : { + "type" : "string", + "description" : "Email address of the client to request access for", + "example" : "client@acme.com", + "nullable" : true + } + } + }, + "Partner_RequestAccessToClientAccountV2Response" : { + "type" : "object", + "description" : "Response object for requesting access to a client account V2.", + "properties" : { + "success" : { + "type" : "boolean", + "description" : "Whether the access request was successful", + "example" : true, + "nullable" : true + } + } + }, + "Partner_RequestAccessToClientAccountV3Request" : { + "type" : "object", + "description" : "Request object for requesting access to a client account V3. V3 differs from V2 in that the request is scoped to a specific client org (the partner initiates it from that client's row), and the email links to an authenticated in-Console approval page (instead of an anonymous token-auth landing page) deep-linked to that org, enabling explicit role selection at approval time.", + "properties" : { + "clientEmail" : { + "type" : "string", + "description" : "Email address of the client to request access for", + "example" : "client@acme.com", + "nullable" : true + }, + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_RequestAccessToClientAccountV3Response" : { + "type" : "object", + "description" : "Response object for requesting access to a client account V3.", + "properties" : { + "success" : { + "type" : "boolean", + "description" : "Whether the access request was successful", + "example" : true, + "nullable" : true + } + } + }, + "Partner_SubmitPartnerAccessRequestDecisionV3WSBaseResponse" : { + "type" : "object", + "description" : "Base response for submitting partner access request decision (V3).", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Partner_SubmitPartnerAccessRequestDecisionV3WSFailureResponse" + }, { + "$ref" : "#/components/schemas/Partner_SubmitPartnerAccessRequestDecisionV3WSSuccessResponse" + } ], + "properties" : { + "type" : { + "type" : "string" + } + }, + "required" : [ "type" ] + }, + "Partner_SubmitPartnerAccessRequestDecisionV3WSFailureResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "failureReason" : { + "type" : "string", + "description" : "Reason for the failure", + "example" : "Invalid role for selected org", + "nullable" : true + } + } + } ], + "description" : "Failure response for submitting partner access request decision (V3).", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_SubmitPartnerAccessRequestDecisionV3WSRequest" : { + "type" : "object", + "description" : "Request object for the customer's decision on a pending partner access request (V3, session-authenticated). Caller's session identifies the customer; clientRoleUuid is the explicit role the customer chose for the partner.", + "properties" : { + "accessGrantedByClient" : { + "type" : "boolean", + "description" : "Whether access was granted by the client", + "example" : true, + "nullable" : true + }, + "clientRoleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_SubmitPartnerAccessRequestDecisionV3WSSuccessResponse" : { + "type" : "object", + "allOf" : [ ], + "description" : "Success response for submitting partner access request decision (V3).", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSBaseResponse" : { + "type" : "object", + "description" : "Base response for submitting support access decision for partner activation token V2", + "discriminator" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSFailureResponse" + }, { + "$ref" : "#/components/schemas/Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSSuccessResponse" + } ], + "properties" : { + "type" : { + "type" : "string" + } + }, + "required" : [ "type" ] + }, + "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSFailureResponse" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "failureReason" : { + "type" : "string", + "description" : "Reason for the failure", + "example" : "Invalid activation token", + "nullable" : true + } + } + } ], + "description" : "Failure response for submitting support access decision for partner activation token V2.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSRequest" : { + "type" : "object", + "description" : "Request object for submitting support access decision for partner activation token V2.", + "properties" : { + "accessGrantedByClient" : { + "type" : "boolean", + "description" : "Whether access was granted by the client", + "example" : true, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_SubmitSupportAccessDecisionForPartnerActivationTokenV2WSSuccessResponse" : { + "type" : "object", + "allOf" : [ ], + "description" : "Success response for submitting support access decision for partner activation token V2.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "Partner_UnregisteredControlledHardwareType" : { + "type" : "object", + "description" : "Information about unregistered controlled hardware available for partner registration.", + "properties" : { + "deviceModel" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "macAddress" : { + "type" : "string", + "description" : "MAC address of the hardware device", + "example" : "00:11:22:33:44:55", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the hardware device", + "example" : "RH123456789", + "nullable" : true + } + } + }, + "Partner_UpdateManuallySendLicenseExpirationEmailWSRequest" : { + "type" : "object", + "description" : "Request object for updating manual license expiration email settings for an organization.", + "properties" : { + "manuallySendLicenseExpirationEmail" : { + "type" : "boolean", + "description" : "Whether to manually send license expiration emails", + "example" : true, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_UpdateManuallySendLicenseExpirationEmailWSResponse" : { + "type" : "object", + "description" : "Response object for updating manual license expiration email settings.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_AssignLicensesToClientWSRequest" : { + "type" : "object", + "description" : "Move unassigned pool licenses to a managed client.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "nullable" : true + }, + "quantity" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "requestId" : { + "type" : "string", + "description" : "Idempotency key; retries with the same id are safe.", + "nullable" : true + } + } + }, + "Partner_msp_AssignLicensesToClientWSResponse" : { + "type" : "object", + "description" : "Per-license outcome of an assignment.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "failed" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_LicenseOperationFailureWSType" + }, + "nullable" : true + }, + "moved" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_BlockingDeviceWSType" : { + "type" : "object", + "description" : "A registered device that blocks deactivation.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "serial" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_BlockingLicenseWSType" : { + "type" : "object", + "description" : "A pooled license still assigned to a device that blocks deactivation.", + "properties" : { + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_ClaimLicensesToPoolWSRequest" : { + "type" : "object", + "description" : "Claim a key into the MSP's own pool.", + "properties" : { + "claimCode" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_ClaimLicensesToPoolWSResponse" : { + "type" : "object", + "description" : "Result of claiming a key into the pool.", + "properties" : { + "claimKeyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_DeactivateClientWSRequest" : { + "type" : "object", + "description" : "Deactivate (soft delete) a managed client org.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "confirmName" : { + "type" : "string", + "description" : "Typed confirmation; must match the client org name.", + "nullable" : true + } + } + }, + "Partner_msp_DeactivateClientWSResponse" : { + "type" : "object", + "description" : "Outcome of a client deactivation.", + "properties" : { + "blockedByDevices" : { + "type" : "array", + "description" : "Devices still registered in the client org.", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_BlockingDeviceWSType" + }, + "nullable" : true + }, + "blockedByLicenses" : { + "type" : "array", + "description" : "Pooled licenses still assigned to devices in the client org.", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_BlockingLicenseWSType" + }, + "nullable" : true + }, + "deactivated" : { + "type" : "boolean", + "description" : "True when the org was soft-deleted by this call (or already was).", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorCode" : { + "type" : "string", + "description" : "DEVICES_STILL_REGISTERED or LICENSES_STILL_ASSIGNED when deactivated is false.", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "reclaimedLicenses" : { + "type" : "integer", + "format" : "int32", + "description" : "Pooled licenses moved back to the MSP by this call.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_DoorBindingWSType" : { + "type" : "object", + "description" : "An access-control binding that prevents a hardware move.", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "DOOR", + "nullable" : true + } + } + }, + "Partner_msp_GetHardwareInventoryWSRequest" : { + "type" : "object", + "description" : "Request for the MSP's controlled hardware (no fields)." + }, + "Partner_msp_GetHardwareInventoryWSResponse" : { + "type" : "object", + "description" : "The MSP's controlled hardware across all clients.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "units" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_HardwareInventoryUnitWSType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_GetLicensePoolWSRequest" : { + "type" : "object", + "description" : "Request for the MSP's license pool (no fields)." + }, + "Partner_msp_GetLicensePoolWSResponse" : { + "type" : "object", + "description" : "The MSP's license pool.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "products" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_LicensePoolProductWSType" + }, + "nullable" : true + }, + "unclaimedKeys" : { + "type" : "array", + "description" : "CREATED (not yet claimed) keys for the partner, as getClaimKeysForPartnerOrg returns them.", + "items" : { + "$ref" : "#/components/schemas/PartnerOrgClaimKey" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_GetPartnerOrgProfileWSRequest" : { + "type" : "object", + "description" : "Request for the calling partner org's MSP profile (no fields)." + }, + "Partner_msp_GetPartnerOrgProfileWSResponse" : { + "type" : "object", + "description" : "The calling partner org's MSP profile.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "functionalityList" : { + "type" : "array", + "description" : "Partner functionalities of the calling role.", + "items" : { + "$ref" : "#/components/schemas/PartnerFunctionalityEnum" + }, + "nullable" : true + }, + "msp" : { + "type" : "boolean", + "description" : "True only when the partner's MSP designation is ACTIVE and its signature verifies.", + "nullable" : true + }, + "mspSince" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch millis the designation was signed, when msp is true.", + "nullable" : true + }, + "mspStatus" : { + "type" : "string", + "description" : "NONE, PENDING_APPROVAL, ACTIVE or REVOKED (never trusted alone; see msp).", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_HardwareInventoryUnitWSType" : { + "type" : "object", + "description" : "One hardware unit under the MSP's PARTNER control.", + "properties" : { + "currentOrgName" : { + "type" : "string", + "nullable" : true + }, + "currentOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "doorBound" : { + "type" : "boolean", + "description" : "True when a DC20 / DR40 / DR20 unit is bound to an access-controlled door.", + "nullable" : true + }, + "hardwareType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "hwUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "licenseState" : { + "type" : "string", + "description" : "Device license state (CLAIMED, RENEWED, ...) or UNLICENSED; null when unregistered.", + "nullable" : true + }, + "model" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "registered" : { + "type" : "boolean", + "nullable" : true + }, + "serial" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_HardwareMoveBlockedWSType" : { + "type" : "object", + "description" : "A device refused because of access-control bindings.", + "properties" : { + "bindings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_DoorBindingWSType" + }, + "nullable" : true + }, + "reason" : { + "type" : "string", + "nullable" : true + }, + "serial" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_HardwareMoveFailureWSType" : { + "type" : "object", + "description" : "A device that could not be moved and why.", + "properties" : { + "reason" : { + "type" : "string", + "nullable" : true + }, + "serial" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_LicenseOperationFailureWSType" : { + "type" : "object", + "description" : "A license that could not be moved and why.", + "properties" : { + "licenseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reason" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_LicensePoolClientHoldingWSType" : { + "type" : "object", + "description" : "Pooled licenses of one product held by one managed client.", + "properties" : { + "assignedToDevices" : { + "type" : "integer", + "format" : "int32", + "description" : "Of those, how many are assigned to a device.", + "nullable" : true + }, + "clientOrgName" : { + "type" : "string", + "nullable" : true + }, + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Licenses of this product held by the client.", + "nullable" : true + } + } + }, + "Partner_msp_LicensePoolProductWSType" : { + "type" : "object", + "description" : "Pool summary for one product code.", + "properties" : { + "displayName" : { + "type" : "string", + "nullable" : true + }, + "expiringWithin90d" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "heldByClients" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_LicensePoolClientHoldingWSType" + }, + "nullable" : true + }, + "heldByPool" : { + "type" : "integer", + "format" : "int32", + "description" : "Unassigned licenses held by the MSP org itself.", + "nullable" : true + }, + "owned" : { + "type" : "integer", + "format" : "int32", + "description" : "Every license owned by the MSP, wherever held.", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_MoveHardwareToClientWSRequest" : { + "type" : "object", + "description" : "Move controlled devices from one managed client to another.", + "properties" : { + "fromClientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "moveLicense" : { + "type" : "boolean", + "description" : "When true, an MSP-owned device license follows the device to the target org.", + "nullable" : true + }, + "serials" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "toClientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partner_msp_MoveHardwareToClientWSResponse" : { + "type" : "object", + "description" : "Per-serial outcome of a hardware move.", + "properties" : { + "blocked" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_HardwareMoveBlockedWSType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "failed" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_HardwareMoveFailureWSType" + }, + "nullable" : true + }, + "moved" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_ReclaimLicensesFromClientWSRequest" : { + "type" : "object", + "description" : "Move pooled licenses held by a managed client back to the MSP.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "forceUnassign" : { + "type" : "boolean", + "description" : "When true, device-assigned licenses are unassigned first (config downgrade included).", + "nullable" : true + }, + "licenseUuids" : { + "type" : "array", + "description" : "Explicit licenses; or use productCode + quantity.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "productCode" : { + "type" : "string", + "nullable" : true + }, + "quantity" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "requestId" : { + "type" : "string", + "description" : "Idempotency key; retries with the same id are safe.", + "nullable" : true + } + } + }, + "Partner_msp_ReclaimLicensesFromClientWSResponse" : { + "type" : "object", + "description" : "Per-license outcome of a reclaim.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "reclaimed" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "skipped" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Partner_msp_LicenseOperationFailureWSType" + }, + "nullable" : true + }, + "unassignedDevices" : { + "type" : "array", + "description" : "Devices whose license was force-unassigned by this call.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partner_msp_UpdateManagedClientPolicyWSRequest" : { + "type" : "object", + "description" : "Update the per-client policy the MSP sets on a managed org.", + "properties" : { + "clientOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "clientSuperAdminAssignable" : { + "type" : "boolean", + "description" : "When false, client-org users cannot assign the Super Admin role.", + "nullable" : true + } + } + }, + "Partner_msp_UpdateManagedClientPolicyWSResponse" : { + "type" : "object", + "description" : "The stored managed-client policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policy" : { + "$ref" : "#/components/schemas/ManagedClientPolicyType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_CreatePartnerDealRegistrationWSRequest" : { + "type" : "object", + "description" : "Request object for registering a new deal on behalf of the authenticated partner organization.", + "properties" : { + "additionalInformation" : { + "type" : "string", + "description" : "Additional information about the deal", + "nullable" : true + }, + "city" : { + "type" : "string", + "description" : "City of the end customer", + "nullable" : true + }, + "comfortableWithRhombusEUDemo" : { + "type" : "string", + "description" : "Whether the end customer is comfortable with a Rhombus end user demo", + "nullable" : true + }, + "company" : { + "type" : "string", + "description" : "Name of the end customer company", + "nullable" : true + }, + "countryCode" : { + "type" : "string", + "description" : "ISO country code of the end customer", + "example" : "US", + "nullable" : true + }, + "dealRegProductInterest" : { + "type" : "array", + "description" : "Rhombus products the end customer is interested in", + "items" : { + "type" : "string", + "description" : "Rhombus products the end customer is interested in", + "nullable" : true + }, + "nullable" : true + }, + "email" : { + "type" : "string", + "description" : "Email address of the end customer contact. This is the end customer's email, not the submitting partner's email.", + "nullable" : true + }, + "estimatedNumberOfCameras" : { + "type" : "number", + "description" : "Estimated number of cameras for the deal", + "nullable" : true + }, + "firstName" : { + "type" : "string", + "description" : "First name of the end customer contact", + "nullable" : true + }, + "governmentOwnedOrOperatedAccount" : { + "type" : "string", + "description" : "Whether the end customer account is government owned or operated", + "nullable" : true + }, + "governmentType" : { + "type" : "string", + "description" : "Type of government entity, for public sector deals", + "nullable" : true + }, + "hubspotNoOfEmployees" : { + "type" : "string", + "description" : "Number of employees at the end customer company", + "nullable" : true + }, + "industry" : { + "type" : "string", + "description" : "Industry of the end customer", + "nullable" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name of the end customer contact", + "nullable" : true + }, + "otherDidntAgreeToEndUserDemo" : { + "type" : "string", + "description" : "Reason the end customer did not agree to an end user demo", + "nullable" : true + }, + "partOfRFP" : { + "type" : "boolean", + "description" : "Whether this deal is part of an RFP", + "nullable" : true + }, + "phone" : { + "type" : "string", + "description" : "Phone number of the end customer contact", + "nullable" : true + }, + "population" : { + "type" : "string", + "description" : "Population served by the end customer, for public sector deals", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "description" : "Postal code of the end customer", + "nullable" : true + }, + "stateCode" : { + "type" : "string", + "description" : "ISO state or province code of the end customer", + "example" : "CA", + "nullable" : true + }, + "street" : { + "type" : "string", + "description" : "Street address of the end customer", + "nullable" : true + }, + "studentCount" : { + "type" : "string", + "description" : "Number of students at the end customer, for education deals", + "nullable" : true + }, + "timeframe" : { + "type" : "string", + "description" : "Expected purchasing timeframe for the deal", + "nullable" : true + }, + "title" : { + "type" : "string", + "description" : "Job title of the end customer contact", + "nullable" : true + }, + "website" : { + "type" : "string", + "description" : "Website of the end customer company", + "nullable" : true + } + }, + "required" : [ "company", "email", "lastName" ] + }, + "Partnerportal_CreatePartnerDealRegistrationWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of registering a new deal.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "salesforceLeadId" : { + "type" : "string", + "description" : "Identifier of the Salesforce lead created for the registered deal", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_CreatePartnerPortalMdfClaimWSRequest" : { + "type" : "object", + "description" : "Request object for filing a claim against a market development funds request on behalf of the authenticated partner organization.", + "properties" : { + "claimAmount" : { + "type" : "number", + "description" : "Amount being claimed; must be greater than zero", + "nullable" : true + }, + "claimNotes" : { + "type" : "string", + "description" : "Notes supporting the claim", + "nullable" : true + }, + "claimTitle" : { + "type" : "string", + "description" : "Title of the claim; at most 120 characters", + "maxLength" : 120, + "nullable" : true + }, + "mdfRequestId" : { + "type" : "string", + "description" : "Identifier of the approved Salesforce MDF request being claimed against", + "nullable" : true + } + }, + "required" : [ "claimAmount", "claimTitle", "mdfRequestId" ] + }, + "Partnerportal_CreatePartnerPortalMdfClaimWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of filing a market development funds claim.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "mdfClaimId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF claim that was created", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_CreatePartnerPortalMdfRequestWSRequest" : { + "type" : "object", + "description" : "Request object for filing a market development funds request on behalf of the authenticated partner organization.", + "properties" : { + "activityCost" : { + "type" : "number", + "description" : "Total cost of the marketing activity; must be greater than zero when present", + "nullable" : true + }, + "activityDescription" : { + "type" : "string", + "description" : "Description of the marketing activity the funds are requested for", + "nullable" : true + }, + "activityEndDate" : { + "type" : "string", + "description" : "Last day of the marketing activity, in yyyy-MM-dd format; not before activityStartDate", + "nullable" : true + }, + "activityStartDate" : { + "type" : "string", + "description" : "First day of the marketing activity, in yyyy-MM-dd format", + "nullable" : true + }, + "activityType" : { + "type" : "string", + "description" : "Type of the marketing activity", + "nullable" : true + }, + "amountRequested" : { + "type" : "number", + "description" : "Amount of funding requested; must be greater than zero", + "nullable" : true + }, + "city" : { + "type" : "string", + "description" : "City where the marketing activity takes place", + "nullable" : true + }, + "countryCode" : { + "type" : "string", + "description" : "ISO 3166-1 alpha-2 code of the country where the marketing activity takes place (for example US)", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "description" : "Postal code where the marketing activity takes place", + "nullable" : true + }, + "requestTitle" : { + "type" : "string", + "description" : "Title of the request", + "nullable" : true + }, + "stateCode" : { + "type" : "string", + "description" : "ISO code of the state or province where the marketing activity takes place (for example CA); requires countryCode, since Salesforce rejects a state without a country", + "nullable" : true + }, + "street" : { + "type" : "string", + "description" : "Street address where the marketing activity takes place", + "nullable" : true + } + }, + "required" : [ "activityEndDate", "activityStartDate", "activityType", "amountRequested", "requestTitle" ] + }, + "Partnerportal_CreatePartnerPortalMdfRequestWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of filing a market development funds request.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "mdfRequestId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF request that was created", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_CreatePartnerPortalQuoteWSRequest" : { + "type" : "object", + "description" : "Request object for creating a new primary quote on an opportunity belonging to the authenticated partner organization.", + "properties" : { + "expirationDate" : { + "type" : "string", + "description" : "Expiration date of the quote in yyyy-MM-dd format", + "nullable" : true + }, + "notes" : { + "type" : "string", + "description" : "Notes on the quote", + "nullable" : true + }, + "opportunityId" : { + "type" : "string", + "description" : "Identifier of the Salesforce opportunity", + "nullable" : true + }, + "primaryContactId" : { + "type" : "string", + "description" : "Identifier of the Salesforce contact to set as the quote's primary contact", + "nullable" : true + }, + "quoteName" : { + "type" : "string", + "description" : "Display name of the quote; defaults to the opportunity name", + "nullable" : true + }, + "shippingMethod" : { + "type" : "string", + "description" : "Shipping method", + "nullable" : true + } + }, + "required" : [ "opportunityId" ] + }, + "Partnerportal_CreatePartnerPortalQuoteWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of creating a quote.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "quoteId" : { + "type" : "string", + "description" : "Identifier of the created Salesforce quote", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerMetricsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the Salesforce scorecard belonging to the authenticated partner organization." + }, + "Partnerportal_GetPartnerMetricsWSResponse" : { + "type" : "object", + "description" : "Response object containing the Salesforce scorecard belonging to the authenticated partner organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "metrics" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerMetricsType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalAcademyLoginUrlWSRequest" : { + "type" : "object", + "description" : "Request object for obtaining a one-time Rhombus Academy login URL for the authenticated caller. This request carries no fields: the partner organization and the caller's identity are resolved from the authenticated session." + }, + "Partnerportal_GetPartnerPortalAcademyLoginUrlWSResponse" : { + "type" : "object", + "description" : "Response object carrying a one-time, short-lived Rhombus Academy login URL for the authenticated caller.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "loginUrl" : { + "type" : "string", + "description" : "One-time URL that logs the caller into Rhombus Academy. The client should redirect to it immediately and never store it. Null when the request failed.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalAssetDownloadUrlWSRequest" : { + "type" : "object", + "description" : "Request object for minting a short-lived presigned download URL for one piece of Partner Portal collateral. Carries the asset uuid only: there is no organization field, because the partner organization is always resolved from the authenticated principal and is never read from the request body, and there is no version field, because the download is always of the currently published version.", + "properties" : { + "assetUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalAssetDownloadUrlWSResponse" : { + "type" : "object", + "description" : "Response object carrying a short-lived presigned download URL for one piece of Partner Portal collateral, and the epoch millisecond at which that URL stops working.", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "Short-lived presigned URL the client may GET to fetch the asset's bytes. Null when the request failed or the partner is not entitled to the asset.", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "expiresAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch milliseconds at which the presigned URL expires. Null when the request failed or the partner is not entitled to the asset.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalAssetPreviewUrlWSRequest" : { + "type" : "object", + "description" : "Request object for minting a short-lived presigned URL for the thumbnail of one piece of Partner Portal collateral. Carries the asset uuid only: there is no organization field, because the partner organization is always resolved from the authenticated principal and is never read from the request body, and there is no version field, because the preview is always of the currently published version.", + "properties" : { + "assetUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalAssetPreviewUrlWSResponse" : { + "type" : "object", + "description" : "Response object carrying a short-lived presigned URL for the thumbnail of one piece of Partner Portal collateral, and the epoch millisecond at which that URL stops working. A null previewUrl on a successful response means the asset type has no thumbnail, not that the request failed.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "expiresAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch milliseconds at which the presigned URL expires. Accompanies a minted previewUrl and is absent when no URL was minted.", + "nullable" : true + }, + "previewUrl" : { + "type" : "string", + "description" : "Short-lived presigned URL the client may GET to fetch the asset's thumbnail. Null when the asset has no thumbnail, when the request failed, or when the partner is not entitled to the asset.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalCompanyInfoWSRequest" : { + "type" : "object", + "description" : "Request object for reading the company profile of the authenticated partner organization. This request carries no fields: the partner organization is resolved from the authenticated session." + }, + "Partnerportal_GetPartnerPortalCompanyInfoWSResponse" : { + "type" : "object", + "description" : "Response object containing the company profile of the authenticated partner organization.", + "properties" : { + "companyInfo" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalCompanyInfoWebType" + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalDealDashboardOppsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the deal dashboard opportunities belonging to the authenticated partner organization." + }, + "Partnerportal_GetPartnerPortalDealDashboardOppsWSResponse" : { + "type" : "object", + "description" : "Response object containing the deal dashboard opportunities belonging to the authenticated partner organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "opportunities" : { + "type" : "array", + "description" : "List of opportunities registered under the partner organization, newest first", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalDealDashboardOppType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalLeadDashboardLeadsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the lead dashboard leads belonging to the authenticated partner organization." + }, + "Partnerportal_GetPartnerPortalLeadDashboardLeadsWSResponse" : { + "type" : "object", + "description" : "Response object containing the lead dashboard leads belonging to the authenticated partner organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "leads" : { + "type" : "array", + "description" : "List of leads registered under the partner organization, newest first", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalLeadDashboardLeadType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalLoggedInUserInfoWSRequest" : { + "type" : "object", + "description" : "Request object for reading the Partner Portal profile of the authenticated caller. This request carries no fields: the partner organization and the caller's identity are resolved from the authenticated session." + }, + "Partnerportal_GetPartnerPortalLoggedInUserInfoWSResponse" : { + "type" : "object", + "description" : "Response object containing the Partner Portal profile of the authenticated caller.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "loggedInUser" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalLoggedInUserWebType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalMdfAllocationsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the market development funds allocations belonging to the authenticated partner organization." + }, + "Partnerportal_GetPartnerPortalMdfAllocationsWSResponse" : { + "type" : "object", + "description" : "Response object containing the market development funds allocations belonging to the authenticated partner organization.", + "properties" : { + "allocations" : { + "type" : "array", + "description" : "List of allocations held by the partner organization, newest budget period first", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalMdfAllocationType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalMdfClaimsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the market development funds claims belonging to the authenticated partner organization." + }, + "Partnerportal_GetPartnerPortalMdfClaimsWSResponse" : { + "type" : "object", + "description" : "Response object containing the market development funds claims belonging to the authenticated partner organization.", + "properties" : { + "claims" : { + "type" : "array", + "description" : "List of claims filed under the partner organization, newest first", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalMdfClaimType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalMdfRequestsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the market development funds requests belonging to the authenticated partner organization." + }, + "Partnerportal_GetPartnerPortalMdfRequestsWSResponse" : { + "type" : "object", + "description" : "Response object containing the market development funds requests belonging to the authenticated partner organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "requests" : { + "type" : "array", + "description" : "List of requests filed under the partner organization, newest first", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalMdfRequestType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalOpportunityQuotesWSRequest" : { + "type" : "object", + "description" : "Request object for listing the quotes on an opportunity belonging to the authenticated partner organization.", + "properties" : { + "opportunityId" : { + "type" : "string", + "description" : "Identifier of the Salesforce opportunity", + "nullable" : true + } + }, + "required" : [ "opportunityId" ] + }, + "Partnerportal_GetPartnerPortalOpportunityQuotesWSResponse" : { + "type" : "object", + "description" : "Response object containing the quotes on an opportunity.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "quotes" : { + "type" : "array", + "description" : "Quotes on the opportunity", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteSummaryType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalQuoteProductsWSRequest" : { + "type" : "object", + "description" : "Request object for getting the products a partner can add to a quote." + }, + "Partnerportal_GetPartnerPortalQuoteProductsWSResponse" : { + "type" : "object", + "description" : "Response object containing the active products on the Standard Price Book.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "products" : { + "type" : "array", + "description" : "Active products that can be added to a quote", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteProductType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_GetPartnerPortalQuoteWSRequest" : { + "type" : "object", + "description" : "Request object for getting a quote and its lines belonging to the authenticated partner organization.", + "properties" : { + "quoteId" : { + "type" : "string", + "description" : "Identifier of the Salesforce quote", + "nullable" : true + } + }, + "required" : [ "quoteId" ] + }, + "Partnerportal_GetPartnerPortalQuoteWSResponse" : { + "type" : "object", + "description" : "Response object containing a quote header and its lines.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "lines" : { + "type" : "array", + "description" : "Quote lines, ordered by line number", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteLineType" + }, + "nullable" : true + }, + "quote" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteHeaderType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_ListPartnerPortalAssetsWSRequest" : { + "type" : "object", + "description" : "Request object for listing the Partner Portal collateral the authenticated partner organization is entitled to view. This request intentionally carries no fields: in particular there is no organization field, because the partner organization is always resolved from the authenticated principal and is never read from the request body. Adding an org field here would let a caller re-scope the entitlement lookup to an organization they choose." + }, + "Partnerportal_ListPartnerPortalAssetsWSResponse" : { + "type" : "object", + "description" : "Response object containing the Partner Portal collateral the authenticated partner organization is entitled to view.", + "properties" : { + "assets" : { + "type" : "array", + "description" : "List of Partner Portal assets the authenticated partner organization is entitled to view. Empty, never null, when the partner is entitled to nothing or the request failed.", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalAssetWebType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_ListPartnerPortalNewsWSRequest" : { + "type" : "object", + "description" : "Request object for listing the active Partner Portal news items. This request intentionally carries no fields: the list is the same for every partner, and only active items are ever returned." + }, + "Partnerportal_ListPartnerPortalNewsWSResponse" : { + "type" : "object", + "description" : "Response object containing the active Partner Portal news items, newest first.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "newsItems" : { + "type" : "array", + "description" : "List of active Partner Portal news items, newest first. Empty, never null, when there is no news or the request failed.", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalNewsItemWebType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_PartnerMetricsType" : { + "type" : "object", + "description" : "Salesforce scorecard for a partner organization: active certifications, eligible billings, new logos won and deal registration activity for the current and prior fiscal year.", + "properties" : { + "activeRcdpCertifications" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of reps at the partner who currently hold an active RCDP (Rhombus Certified Design Professional) certification", + "nullable" : true + }, + "activeRcspCertifications" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of reps at the partner who currently hold an active RCSP (Rhombus Certified Sales Professional) certification", + "nullable" : true + }, + "activeRctpCertifications" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of reps at the partner who currently hold an active RCTP (Rhombus Certified Technical Professional) certification", + "nullable" : true + }, + "lastFyDealRegistrationSubmissions" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of deal registrations submitted by the partner over the whole of the prior fiscal year. Sourced from a Last_YTD_* Salesforce field, but the value covers the last fiscal year rather than a trailing twelve month window", + "nullable" : true + }, + "lastFyEligibleBillings" : { + "type" : "number", + "description" : "Last FY Eligible Billings: eligible billings for the partner over the whole of the prior fiscal year. Sourced from the Salesforce field Last_YTD_Revenue__c, whose API name is misleading on two counts - its label is \"Last FY Eligible Billings\", so it is billings rather than revenue, and it covers the last fiscal year rather than a trailing twelve month window", + "nullable" : true + }, + "lastFyNewBizConvertedDealRegistrations" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of the partner's new business deal registrations converted over the whole of the prior fiscal year. Sourced from a Last_YTD_* Salesforce field, but the value covers the last fiscal year rather than a trailing twelve month window", + "nullable" : true + }, + "lastFyNewBizDrEligibleBillings" : { + "type" : "number", + "description" : "Last FY NL DR Eligible Billings: the portion of the prior fiscal year's eligible billings attributable to new business deal registrations. Sourced from the Salesforce field Last_YTD_NL_DR_Revenue__c, whose API name is misleading on two counts - its label is \"Last FY NL DR Eligible Billings\", so it is billings rather than revenue, and it covers the last fiscal year rather than a trailing twelve month window", + "nullable" : true + }, + "lastFyNewLogosWon" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of new logos won by the partner over the whole of the prior fiscal year. Sourced from a Last_YTD_* Salesforce field, but the value covers the last fiscal year rather than a trailing twelve month window", + "nullable" : true + }, + "ytdDealRegistrationSubmissions" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of deal registrations submitted by the partner so far this fiscal year", + "nullable" : true + }, + "ytdEligibleBillings" : { + "type" : "number", + "description" : "YTD Eligible Billings: eligible billings for the partner so far this fiscal year. Sourced from the Salesforce field YTD_Revenue__c, whose API name is misleading - its label is \"YTD Eligible Billings\" and it is billings, not revenue", + "nullable" : true + }, + "ytdNewBizConvertedDealRegistrations" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of the partner's new business deal registrations converted so far this fiscal year", + "nullable" : true + }, + "ytdNewBizDrEligibleBillings" : { + "type" : "number", + "description" : "YTD New Biz DR Eligible Billings: the portion of this fiscal year's eligible billings attributable to new business deal registrations. Sourced from the Salesforce field YTD_NL_DR_Revenue__c, whose API name is misleading - its label is \"YTD New Biz DR Eligible Billings\" and it is billings, not revenue", + "nullable" : true + }, + "ytdNewLogosWon" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of new logos won by the partner so far this fiscal year", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalAssetWebType" : { + "type" : "object", + "description" : "A single piece of Partner Portal collateral, projected down to the fields a partner may see.", + "properties" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch milliseconds at which the asset was created", + "nullable" : true + }, + "currentVersionSeq" : { + "type" : "integer", + "format" : "int32", + "description" : "Sequence number of the version currently published, or null if no version has been published yet", + "nullable" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the asset", + "nullable" : true + }, + "tags" : { + "type" : "array", + "description" : "Taxonomy tags carried by the asset, as tag names (for example PDF, HEALTHCARE)", + "items" : { + "type" : "string", + "description" : "Taxonomy tags carried by the asset, as tag names (for example PDF, HEALTHCARE)", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "title" : { + "type" : "string", + "description" : "Title of the asset", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch milliseconds at which the asset was last updated", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalCompanyInfoWebType" : { + "type" : "object", + "description" : "The company profile of a partner organization, projected down to the fields a partner may see.", + "properties" : { + "accessControl" : { + "type" : "array", + "description" : "Access control platforms the organization works with, as Salesforce multi-select picklist values. Empty, never null.", + "items" : { + "type" : "string", + "description" : "Access control platforms the organization works with, as Salesforce multi-select picklist values. Empty, never null.", + "nullable" : true + }, + "nullable" : true + }, + "accountType" : { + "type" : "string", + "description" : "Salesforce account type of the partner organization. Read only.", + "nullable" : true + }, + "alarmMonitoringApproved" : { + "type" : "boolean", + "description" : "Whether the partner organization is approved for alarm monitoring", + "nullable" : true + }, + "billingCity" : { + "type" : "string", + "description" : "Billing city of the partner organization", + "nullable" : true + }, + "billingCountry" : { + "type" : "string", + "description" : "Billing country as a display name (for example United States). Provided for display only: the update endpoint accepts only the ISO code, billingCountryCode.", + "nullable" : true + }, + "billingCountryCode" : { + "type" : "string", + "description" : "Billing country as an ISO code (for example US). This is the form the update endpoint accepts.", + "nullable" : true + }, + "billingPostalCode" : { + "type" : "string", + "description" : "Billing postal code of the partner organization", + "nullable" : true + }, + "billingState" : { + "type" : "string", + "description" : "Billing state as a display name (for example California). Provided for display only: the update endpoint accepts only the ISO code, billingStateCode.", + "nullable" : true + }, + "billingStateCode" : { + "type" : "string", + "description" : "Billing state as an ISO code (for example CA). This is the form the update endpoint accepts.", + "nullable" : true + }, + "billingStreet" : { + "type" : "string", + "description" : "Billing street of the partner organization", + "nullable" : true + }, + "competitorsResellerOffers" : { + "type" : "array", + "description" : "Competitor offerings the organization also resells, as Salesforce multi-select picklist values. Empty, never null.", + "items" : { + "type" : "string", + "description" : "Competitor offerings the organization also resells, as Salesforce multi-select picklist values. Empty, never null.", + "nullable" : true + }, + "nullable" : true + }, + "confirmedAccessControlQualifications" : { + "type" : "boolean", + "description" : "Whether the partner organization has confirmed its access control qualifications", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the partner organization. Read only; the update endpoint rejects it.", + "nullable" : true + }, + "offeredServices" : { + "type" : "array", + "description" : "Services the organization offers, as Salesforce multi-select picklist values. Empty, never null.", + "items" : { + "type" : "string", + "description" : "Services the organization offers, as Salesforce multi-select picklist values. Empty, never null.", + "nullable" : true + }, + "nullable" : true + }, + "partnerType" : { + "type" : "array", + "description" : "Partner types the organization operates as, as Salesforce multi-select picklist values. Empty, never null.", + "items" : { + "type" : "string", + "description" : "Partner types the organization operates as, as Salesforce multi-select picklist values. Empty, never null.", + "nullable" : true + }, + "nullable" : true + }, + "phone" : { + "type" : "string", + "description" : "Primary phone number of the partner organization", + "nullable" : true + }, + "resellerStatus" : { + "type" : "string", + "description" : "Reseller status of the partner organization. Read only. One of Pending, Denied, Approved, Credit Hold, Terminated, Approved - Monitoring, Unknown.", + "nullable" : true + }, + "resellerTier" : { + "type" : "string", + "description" : "Reseller tier of the partner organization. Read only; the update endpoint rejects it.", + "nullable" : true + }, + "servicesGeographicCoverage" : { + "type" : "string", + "description" : "Geographic coverage of the services the partner organization offers", + "nullable" : true + }, + "website" : { + "type" : "string", + "description" : "Website of the partner organization", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalDealDashboardOppType" : { + "type" : "object", + "description" : "Information about a single opportunity displayed on the partner portal deal dashboard.", + "properties" : { + "accountName" : { + "type" : "string", + "description" : "Name of the account associated with the opportunity", + "nullable" : true + }, + "amount" : { + "type" : "number", + "description" : "Monetary amount of the opportunity", + "nullable" : true + }, + "clientOrgUuid" : { + "type" : "string", + "description" : "UUID of the Rhombus org of the client account associated with the opportunity", + "nullable" : true + }, + "closeDate" : { + "type" : "string", + "description" : "Close date of the opportunity", + "nullable" : true + }, + "createdDate" : { + "type" : "string", + "description" : "Date the opportunity was created, in MM/DD/YYYY format based on the UTC calendar date (for example 01/15/2026)", + "nullable" : true + }, + "leadSource" : { + "type" : "string", + "description" : "Lead Source of the opportunity", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the opportunity", + "nullable" : true + }, + "netsuiteInvoiceNumber" : { + "type" : "string", + "description" : "Netsuite Invoice Number of the opportunity", + "nullable" : true + }, + "opportunityId" : { + "type" : "string", + "description" : "Identifier of the Salesforce opportunity", + "nullable" : true + }, + "ownerName" : { + "type" : "string", + "description" : "Name of the owner of the opportunity", + "nullable" : true + }, + "partnerAccountName" : { + "type" : "string", + "description" : "Name of the partner account associated with the opportunity", + "nullable" : true + }, + "partnerContactName" : { + "type" : "string", + "description" : "Name of the partner contact associated with the opportunity", + "nullable" : true + }, + "stageName" : { + "type" : "string", + "description" : "Current stage of the opportunity", + "nullable" : true + }, + "trackingNumber" : { + "type" : "string", + "description" : "Shipment tracking number of the opportunity", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the opportunity", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalLeadDashboardLeadType" : { + "type" : "object", + "description" : "Information about a single lead displayed on the partner portal lead dashboard.", + "properties" : { + "aeDeniedReason" : { + "type" : "string", + "description" : "Reason the account executive denied the lead", + "nullable" : true + }, + "city" : { + "type" : "string", + "description" : "City of the lead", + "nullable" : true + }, + "company" : { + "type" : "string", + "description" : "Company the lead belongs to", + "nullable" : true + }, + "country" : { + "type" : "string", + "description" : "Country of the lead", + "nullable" : true + }, + "createdDate" : { + "type" : "string", + "description" : "Date the lead was created, in MM/DD/YYYY format based on the UTC calendar date (for example 01/15/2026)", + "nullable" : true + }, + "email" : { + "type" : "string", + "description" : "Email address of the lead", + "nullable" : true + }, + "firstName" : { + "type" : "string", + "description" : "First name of the lead", + "nullable" : true + }, + "formSubmissionType" : { + "type" : "string", + "description" : "Type of the form the lead was submitted through", + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Salesforce record id of the lead", + "nullable" : true + }, + "impartnerLeadOwnerText" : { + "type" : "string", + "description" : "Name of the Impartner lead owner", + "nullable" : true + }, + "isConverted" : { + "type" : "boolean", + "description" : "Whether the lead has been converted to an opportunity", + "nullable" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name of the lead", + "nullable" : true + }, + "leadSource" : { + "type" : "string", + "description" : "Lead source of the lead", + "nullable" : true + }, + "leadSourceSecondary" : { + "type" : "string", + "description" : "Secondary lead source of the lead", + "nullable" : true + }, + "ownerName" : { + "type" : "string", + "description" : "Name of the owner of the lead", + "nullable" : true + }, + "partnerAccountName" : { + "type" : "string", + "description" : "Name of the partner account associated with the lead", + "nullable" : true + }, + "partnerContactId" : { + "type" : "string", + "description" : "Salesforce record id of the partner contact associated with the lead", + "nullable" : true + }, + "partnerContactName" : { + "type" : "string", + "description" : "Name of the partner contact associated with the lead", + "nullable" : true + }, + "phone" : { + "type" : "string", + "description" : "Phone number of the lead", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "description" : "Postal code of the lead", + "nullable" : true + }, + "state" : { + "type" : "string", + "description" : "State or province of the lead", + "nullable" : true + }, + "status" : { + "type" : "string", + "description" : "Current status of the lead", + "nullable" : true + }, + "street" : { + "type" : "string", + "description" : "Street address of the lead", + "nullable" : true + }, + "title" : { + "type" : "string", + "description" : "Job title of the lead", + "nullable" : true + }, + "website" : { + "type" : "string", + "description" : "Website of the lead's company", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalLoggedInUserWebType" : { + "type" : "object", + "description" : "The Partner Portal profile of the authenticated caller, projected down to the fields a partner may see.", + "properties" : { + "camOwnerName" : { + "type" : "string", + "description" : "Name of the Channel Account Manager who owns the caller's partner organization, or null if none is assigned", + "nullable" : true + }, + "firstName" : { + "type" : "string", + "description" : "First name of the caller", + "nullable" : true + }, + "grantPortalAccess" : { + "type" : "boolean", + "description" : "Whether the caller has been granted Partner Portal access. Every other partner portal endpoint denies with 403 when this is not true; clients should hide the portal UI when it is false or absent.", + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Salesforce Contact id of the caller", + "nullable" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name of the caller", + "nullable" : true + }, + "partnerLevel" : { + "type" : "string", + "description" : "Partner level of the caller's partner organization", + "nullable" : true + }, + "purchasingVehicle" : { + "type" : "string", + "description" : "Purchasing vehicle of the caller's partner organization", + "nullable" : true + }, + "resellerTier" : { + "type" : "string", + "description" : "Reseller tier of the caller's partner organization", + "nullable" : true + }, + "responsibilities" : { + "type" : "array", + "description" : "Responsibilities held by the caller on their partner account, as Salesforce multi-select picklist values (for example Account Profile Administrator). Empty, never null, when the caller holds none.", + "items" : { + "type" : "string", + "description" : "Responsibilities held by the caller on their partner account, as Salesforce multi-select picklist values (for example Account Profile Administrator). Empty, never null, when the caller holds none.", + "nullable" : true + }, + "nullable" : true + }, + "rhombusCertifiedTechnicalProfessional" : { + "type" : "boolean", + "description" : "Whether the caller is a Rhombus Certified Technical Professional, or null if unknown", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalMdfAllocationType" : { + "type" : "object", + "description" : "A partner organization's share of one market development funds budget period.", + "properties" : { + "allocatedAmount" : { + "type" : "number", + "description" : "Amount allocated to the partner organization for the budget period", + "nullable" : true + }, + "budgetAvailable" : { + "type" : "number", + "description" : "Amount of the allocation still available to request", + "nullable" : true + }, + "budgetEndDate" : { + "type" : "string", + "description" : "Last day of the budget period, in yyyy-MM-dd format", + "nullable" : true + }, + "budgetName" : { + "type" : "string", + "description" : "Name of the budget the allocation is drawn from", + "nullable" : true + }, + "budgetPeriodType" : { + "type" : "string", + "description" : "Period type of the budget, for example Quarterly or Annual", + "nullable" : true + }, + "budgetStartDate" : { + "type" : "string", + "description" : "First day of the budget period, in yyyy-MM-dd format", + "nullable" : true + }, + "budgetStatus" : { + "type" : "string", + "description" : "Status of the budget; new requests are only accepted against an Open budget", + "nullable" : true + }, + "claimed" : { + "type" : "number", + "description" : "Percentage of the allocation that has been claimed", + "nullable" : true + }, + "claimsApproved" : { + "type" : "number", + "description" : "Total amount of the approved claims", + "nullable" : true + }, + "claimsPending" : { + "type" : "number", + "description" : "Total amount of the claims awaiting review", + "nullable" : true + }, + "mdfAllocationId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF allocation", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the allocation", + "nullable" : true + }, + "requestApproved" : { + "type" : "number", + "description" : "Total amount of the approved requests", + "nullable" : true + }, + "requestsPending" : { + "type" : "number", + "description" : "Total amount of the requests awaiting review", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalMdfClaimType" : { + "type" : "object", + "description" : "A single claim filed by a partner organization against a market development funds request.", + "properties" : { + "amountPaid" : { + "type" : "number", + "description" : "Amount paid out against the claim", + "nullable" : true + }, + "approvedAmount" : { + "type" : "number", + "description" : "Amount of the claim that was approved", + "nullable" : true + }, + "claimAmount" : { + "type" : "number", + "description" : "Amount claimed", + "nullable" : true + }, + "claimApproverName" : { + "type" : "string", + "description" : "Name of the Rhombus approver of the claim", + "nullable" : true + }, + "claimNotes" : { + "type" : "string", + "description" : "Notes supporting the claim", + "nullable" : true + }, + "claimSubmittedDate" : { + "type" : "string", + "description" : "Date and time the claim was submitted, as the raw Salesforce datetime (for example 2026-01-15T18:30:00.000+0000)", + "nullable" : true + }, + "claimTitle" : { + "type" : "string", + "description" : "Title of the claim", + "nullable" : true + }, + "createdDate" : { + "type" : "string", + "description" : "Date and time the claim was created, as the raw Salesforce datetime (for example 2026-01-15T18:30:00.000+0000)", + "nullable" : true + }, + "mdfClaimId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF claim", + "nullable" : true + }, + "mdfRequestId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF request the claim is filed against", + "nullable" : true + }, + "mdfRequestName" : { + "type" : "string", + "description" : "Salesforce generated number of the request the claim is filed against", + "nullable" : true + }, + "mdfRequestTitle" : { + "type" : "string", + "description" : "Title of the request the claim is filed against", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Salesforce generated number of the claim", + "nullable" : true + }, + "paymentDate" : { + "type" : "string", + "description" : "When the claim was paid, as the raw Salesforce value", + "nullable" : true + }, + "rejectionDetail" : { + "type" : "string", + "description" : "Further detail on why the claim was rejected", + "nullable" : true + }, + "rejectionReason" : { + "type" : "string", + "description" : "Reason the claim was rejected", + "nullable" : true + }, + "status" : { + "type" : "string", + "description" : "Current status of the claim", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalMdfRequestType" : { + "type" : "object", + "description" : "A single market development funds request filed by a partner organization.", + "properties" : { + "activityCost" : { + "type" : "number", + "description" : "Total cost of the marketing activity", + "nullable" : true + }, + "activityDescription" : { + "type" : "string", + "description" : "Description of the marketing activity the funds are requested for", + "nullable" : true + }, + "activityEndDate" : { + "type" : "string", + "description" : "Last day of the marketing activity, in yyyy-MM-dd format", + "nullable" : true + }, + "activityStartDate" : { + "type" : "string", + "description" : "First day of the marketing activity, in yyyy-MM-dd format", + "nullable" : true + }, + "activityType" : { + "type" : "string", + "description" : "Type of the marketing activity", + "nullable" : true + }, + "amountRequested" : { + "type" : "number", + "description" : "Amount of funding requested", + "nullable" : true + }, + "assignedReviewerName" : { + "type" : "string", + "description" : "Name of the Rhombus reviewer assigned to the request", + "nullable" : true + }, + "budgetEndDate" : { + "type" : "string", + "description" : "Last day of the budget period the request draws on, in yyyy-MM-dd format", + "nullable" : true + }, + "budgetName" : { + "type" : "string", + "description" : "Name of the budget the request draws on", + "nullable" : true + }, + "budgetStartDate" : { + "type" : "string", + "description" : "First day of the budget period the request draws on, in yyyy-MM-dd format", + "nullable" : true + }, + "city" : { + "type" : "string", + "description" : "City where the marketing activity takes place", + "nullable" : true + }, + "countryCode" : { + "type" : "string", + "description" : "ISO 3166-1 alpha-2 code of the country where the marketing activity takes place", + "nullable" : true + }, + "createdDate" : { + "type" : "string", + "description" : "Date and time the request was created, as the raw Salesforce datetime (for example 2026-01-15T18:30:00.000+0000)", + "nullable" : true + }, + "mdfAllocationId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF allocation the request draws on", + "nullable" : true + }, + "mdfRequestId" : { + "type" : "string", + "description" : "Identifier of the Salesforce MDF request", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Salesforce generated number of the request", + "nullable" : true + }, + "partnerContactName" : { + "type" : "string", + "description" : "Name of the partner contact who filed the request", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "description" : "Postal code where the marketing activity takes place", + "nullable" : true + }, + "rejectionDetail" : { + "type" : "string", + "description" : "Further detail on why the request was rejected", + "nullable" : true + }, + "rejectionReason" : { + "type" : "string", + "description" : "Reason the request was rejected", + "nullable" : true + }, + "requestApprovalDate" : { + "type" : "string", + "description" : "When the request was approved, as the raw Salesforce value", + "nullable" : true + }, + "requestSubmittedDate" : { + "type" : "string", + "description" : "Date and time the request was submitted, as the raw Salesforce datetime (for example 2026-01-15T18:30:00.000+0000)", + "nullable" : true + }, + "requestTitle" : { + "type" : "string", + "description" : "Title of the request", + "nullable" : true + }, + "stage" : { + "type" : "string", + "description" : "Current stage of the request; claims can only be filed against an Approved request", + "nullable" : true + }, + "stateCode" : { + "type" : "string", + "description" : "ISO code of the state or province where the marketing activity takes place", + "nullable" : true + }, + "street" : { + "type" : "string", + "description" : "Street address where the marketing activity takes place", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalNewsItemWebType" : { + "type" : "object", + "description" : "A single Partner Portal news item: a dated headline linking to a url.", + "properties" : { + "headline" : { + "type" : "string", + "description" : "Headline of the news item", + "nullable" : true + }, + "publishedAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch milliseconds at 12:00 UTC of the calendar day the news item was published; format it in UTC to display the date", + "nullable" : true + }, + "url" : { + "type" : "string", + "description" : "Url the headline links to", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalQuoteHeaderType" : { + "type" : "object", + "description" : "Header fields of a partner quote. Prices are recalculated asynchronously after a save and are pending until lastCalculatedOn is at or after lastSavedOn.", + "properties" : { + "additionalDiscountOverride" : { + "type" : "boolean", + "description" : "Whether the additional discount is overridden", + "nullable" : true + }, + "additionalDiscountPercent" : { + "type" : "number", + "description" : "Quote-level additional discount percent", + "nullable" : true + }, + "approvalStatus" : { + "type" : "string", + "description" : "Approval status of the quote", + "nullable" : true + }, + "billAttentionTo" : { + "type" : "string", + "description" : "Bill-to attention", + "nullable" : true + }, + "billingCity" : { + "type" : "string", + "description" : "Bill-to city", + "nullable" : true + }, + "billingCountry" : { + "type" : "string", + "description" : "Bill-to country", + "nullable" : true + }, + "billingName" : { + "type" : "string", + "description" : "Bill-to name", + "nullable" : true + }, + "billingPostalCode" : { + "type" : "string", + "description" : "Bill-to postal code", + "nullable" : true + }, + "billingState" : { + "type" : "string", + "description" : "Bill-to state", + "nullable" : true + }, + "billingStreet" : { + "type" : "string", + "description" : "Bill-to street", + "nullable" : true + }, + "channel" : { + "type" : "string", + "description" : "Sales channel of the quote", + "nullable" : true + }, + "discountOffMsrpOverride" : { + "type" : "boolean", + "description" : "Whether the discount off MSRP is overridden", + "nullable" : true + }, + "groupByBillOnlyOnPdf" : { + "type" : "boolean", + "description" : "Whether bill-only lines are grouped on the quote PDF", + "nullable" : true + }, + "lastCalculatedOn" : { + "type" : "string", + "description" : "Date and time prices were last calculated, as returned by Salesforce", + "nullable" : true + }, + "lastModifiedDate" : { + "type" : "string", + "description" : "Date and time the quote was last modified; send as expectedLastModifiedDate on updateQuote", + "nullable" : true + }, + "lastSavedOn" : { + "type" : "string", + "description" : "Date and time of the last partner portal save; prices are pending while lastCalculatedOn is earlier than this value", + "nullable" : true + }, + "netAmount" : { + "type" : "number", + "description" : "Net amount of the quote", + "nullable" : true + }, + "opportunityId" : { + "type" : "string", + "description" : "Identifier of the Salesforce opportunity the quote belongs to", + "nullable" : true + }, + "opportunityType" : { + "type" : "string", + "description" : "Type of the opportunity; subscription term is only editable on Renewal opportunities", + "nullable" : true + }, + "pricebookId" : { + "type" : "string", + "description" : "Identifier of the price book the quote is priced from", + "nullable" : true + }, + "primary" : { + "type" : "boolean", + "description" : "Whether this is the primary quote on the opportunity", + "nullable" : true + }, + "quoteId" : { + "type" : "string", + "description" : "Identifier of the Salesforce quote", + "nullable" : true + }, + "quoteName" : { + "type" : "string", + "description" : "Display name of the quote", + "nullable" : true + }, + "quoteNumber" : { + "type" : "string", + "description" : "Salesforce quote record name", + "nullable" : true + }, + "shipAttentionTo" : { + "type" : "string", + "description" : "Ship-to attention", + "nullable" : true + }, + "shipping" : { + "type" : "number", + "description" : "Shipping amount", + "nullable" : true + }, + "shippingCity" : { + "type" : "string", + "description" : "Ship-to city", + "nullable" : true + }, + "shippingCountry" : { + "type" : "string", + "description" : "Ship-to country", + "nullable" : true + }, + "shippingMethod" : { + "type" : "string", + "description" : "Shipping method", + "nullable" : true + }, + "shippingName" : { + "type" : "string", + "description" : "Ship-to name", + "nullable" : true + }, + "shippingPostalCode" : { + "type" : "string", + "description" : "Ship-to postal code", + "nullable" : true + }, + "shippingPriceOverride" : { + "type" : "boolean", + "description" : "Whether the shipping price is overridden", + "nullable" : true + }, + "shippingState" : { + "type" : "string", + "description" : "Ship-to state", + "nullable" : true + }, + "shippingStreet" : { + "type" : "string", + "description" : "Ship-to street", + "nullable" : true + }, + "status" : { + "type" : "string", + "description" : "Status of the quote", + "nullable" : true + }, + "tax" : { + "type" : "number", + "description" : "Tax amount", + "nullable" : true + }, + "uncalculated" : { + "type" : "boolean", + "description" : "Whether prices are pending recalculation after the last save", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalQuoteHeaderUpdateType" : { + "type" : "object", + "description" : "Quote header edits. Omitted fields, and blank address fields, are left unchanged.", + "properties" : { + "billAttentionTo" : { + "type" : "string", + "description" : "Bill-to attention", + "nullable" : true + }, + "billingCity" : { + "type" : "string", + "description" : "Bill-to city", + "nullable" : true + }, + "billingCountry" : { + "type" : "string", + "description" : "Bill-to country; must be a valid Salesforce Billing Country picklist value, e.g. \"United States\"", + "nullable" : true + }, + "billingName" : { + "type" : "string", + "description" : "Bill-to name", + "nullable" : true + }, + "billingPostalCode" : { + "type" : "string", + "description" : "Bill-to postal code", + "nullable" : true + }, + "billingState" : { + "type" : "string", + "description" : "Bill-to state; must be a valid Salesforce Billing State picklist value for the quote's billing country, e.g. \"California\". Required when billingCountry changes to a country that has states.", + "nullable" : true + }, + "billingStreet" : { + "type" : "string", + "description" : "Bill-to street", + "nullable" : true + }, + "shipAttentionTo" : { + "type" : "string", + "description" : "Ship-to attention", + "nullable" : true + }, + "shippingCity" : { + "type" : "string", + "description" : "Ship-to city", + "nullable" : true + }, + "shippingCountry" : { + "type" : "string", + "description" : "Ship-to country", + "nullable" : true + }, + "shippingMethod" : { + "type" : "string", + "description" : "Shipping method", + "nullable" : true + }, + "shippingName" : { + "type" : "string", + "description" : "Ship-to name", + "nullable" : true + }, + "shippingPostalCode" : { + "type" : "string", + "description" : "Ship-to postal code", + "nullable" : true + }, + "shippingPriceOverride" : { + "type" : "boolean", + "description" : "Whether the shipping price is overridden", + "nullable" : true + }, + "shippingState" : { + "type" : "string", + "description" : "Ship-to state", + "nullable" : true + }, + "shippingStreet" : { + "type" : "string", + "description" : "Ship-to street", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalQuoteLineAddType" : { + "type" : "object", + "description" : "A line to add to a quote.", + "properties" : { + "contractStartDate" : { + "type" : "string", + "description" : "Contract start date in yyyy-MM-dd format; only accepted for term products or trial quotes", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "description" : "Product code (SKU) of an active Standard Price Book product", + "nullable" : true + }, + "quantity" : { + "type" : "number", + "description" : "Quantity", + "nullable" : true + }, + "shippingPrice" : { + "type" : "number", + "description" : "Line shipping price. Only allowed when the quote's Shipping Price Override is checked.", + "nullable" : true + }, + "subscriptionTerm" : { + "type" : "integer", + "format" : "int32", + "description" : "Subscription term in months; only accepted on Renewal opportunities", + "nullable" : true + } + }, + "required" : [ "productCode", "quantity" ] + }, + "Partnerportal_PartnerPortalQuoteLineType" : { + "type" : "object", + "description" : "A single line on a partner quote.", + "properties" : { + "additionalDiscountAmount" : { + "type" : "number", + "description" : "Additional discount amount", + "nullable" : true + }, + "additionalDiscountPercent" : { + "type" : "number", + "description" : "Additional discount percent", + "nullable" : true + }, + "contractEndDateTime" : { + "type" : "string", + "description" : "Contract end date and time, as returned by Salesforce", + "nullable" : true + }, + "contractStartDateTime" : { + "type" : "string", + "description" : "Contract start date and time, as returned by Salesforce", + "nullable" : true + }, + "creatorEntity" : { + "type" : "string", + "description" : "System that created the line; lines with a value cannot be updated or deleted", + "nullable" : true + }, + "discountFromMsrp" : { + "type" : "number", + "description" : "Discount from MSRP", + "nullable" : true + }, + "listPrice" : { + "type" : "number", + "description" : "List price (MSRP)", + "nullable" : true + }, + "netTotal" : { + "type" : "number", + "description" : "Net total of the line", + "nullable" : true + }, + "netUnitPrice" : { + "type" : "number", + "description" : "Net unit price", + "nullable" : true + }, + "number" : { + "type" : "integer", + "format" : "int32", + "description" : "Line number on the quote", + "nullable" : true + }, + "partnerDiscount" : { + "type" : "number", + "description" : "Partner discount", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "description" : "Product code (SKU)", + "nullable" : true + }, + "productId" : { + "type" : "string", + "description" : "Identifier of the Salesforce product", + "nullable" : true + }, + "productName" : { + "type" : "string", + "description" : "Name of the product", + "nullable" : true + }, + "quantity" : { + "type" : "number", + "description" : "Quantity", + "nullable" : true + }, + "quoteLineId" : { + "type" : "string", + "description" : "Identifier of the Salesforce quote line", + "nullable" : true + }, + "shippingNeeded" : { + "type" : "string", + "description" : "Whether the line needs shipping", + "nullable" : true + }, + "shippingPrice" : { + "type" : "number", + "description" : "Shipping price", + "nullable" : true + }, + "subscriptionTerm" : { + "type" : "integer", + "format" : "int32", + "description" : "Subscription term in months", + "nullable" : true + }, + "tariffSurcharge" : { + "type" : "number", + "description" : "Tariff surcharge", + "nullable" : true + }, + "tax" : { + "type" : "number", + "description" : "Tax amount", + "nullable" : true + }, + "taxRate" : { + "type" : "number", + "description" : "Tax rate", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalQuoteLineUpdateType" : { + "type" : "object", + "description" : "Edits to an existing quote line. Omitted fields are left unchanged.", + "properties" : { + "contractStartDate" : { + "type" : "string", + "description" : "Contract start date in yyyy-MM-dd format; only accepted for term products or trial quotes", + "nullable" : true + }, + "quantity" : { + "type" : "number", + "description" : "Quantity", + "nullable" : true + }, + "quoteLineId" : { + "type" : "string", + "description" : "Identifier of the Salesforce quote line to update", + "nullable" : true + }, + "shippingPrice" : { + "type" : "number", + "description" : "Line shipping price. Only allowed when the quote's Shipping Price Override is checked.", + "nullable" : true + }, + "subscriptionTerm" : { + "type" : "integer", + "format" : "int32", + "description" : "Subscription term in months; only accepted on Renewal opportunities", + "nullable" : true + } + }, + "required" : [ "quoteLineId" ] + }, + "Partnerportal_PartnerPortalQuoteProductType" : { + "type" : "object", + "description" : "A product on the Standard Price Book that can be added to a partner quote.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description of the product", + "nullable" : true + }, + "family" : { + "type" : "string", + "description" : "Product family", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the product", + "nullable" : true + }, + "nonDiscountable" : { + "type" : "boolean", + "description" : "Whether discounts cannot be applied to the product", + "nullable" : true + }, + "pricebookEntryId" : { + "type" : "string", + "description" : "Identifier of the Standard Price Book entry", + "nullable" : true + }, + "productCode" : { + "type" : "string", + "description" : "Product code (SKU), used to add the product to a quote", + "nullable" : true + }, + "productId" : { + "type" : "string", + "description" : "Identifier of the Salesforce product", + "nullable" : true + }, + "subscriptionPricing" : { + "type" : "string", + "description" : "CPQ subscription pricing method, if the product is a subscription", + "nullable" : true + }, + "subscriptionTerm" : { + "type" : "integer", + "format" : "int32", + "description" : "Default subscription term in months, if the product is a subscription", + "nullable" : true + }, + "unitPrice" : { + "type" : "number", + "description" : "List price (MSRP) on the Standard Price Book", + "nullable" : true + } + } + }, + "Partnerportal_PartnerPortalQuoteSummaryType" : { + "type" : "object", + "description" : "Summary of a single quote on an opportunity.", + "properties" : { + "approvalStatus" : { + "type" : "string", + "description" : "Approval status of the quote", + "nullable" : true + }, + "lastModifiedDate" : { + "type" : "string", + "description" : "Date and time the quote was last modified, as returned by Salesforce", + "nullable" : true + }, + "netAmount" : { + "type" : "number", + "description" : "Net amount of the quote", + "nullable" : true + }, + "primary" : { + "type" : "boolean", + "description" : "Whether this is the primary quote on the opportunity", + "nullable" : true + }, + "quoteId" : { + "type" : "string", + "description" : "Identifier of the Salesforce quote", + "nullable" : true + }, + "quoteName" : { + "type" : "string", + "description" : "Display name of the quote", + "nullable" : true + }, + "quoteNumber" : { + "type" : "string", + "description" : "Salesforce quote record name", + "nullable" : true + }, + "status" : { + "type" : "string", + "description" : "Status of the quote", + "nullable" : true + }, + "uncalculated" : { + "type" : "boolean", + "description" : "Whether prices are pending recalculation after the last save", + "nullable" : true + } + } + }, + "Partnerportal_UpdatePartnerPortalCompanyInfoWSRequest" : { + "type" : "object", + "description" : "Request object for updating the company profile of the authenticated partner organization. Only the updatable fields appear here: there is deliberately no email and no organization field, because both are resolved from the authenticated principal, and accepting either from the body would let a caller write another partner's Account. Every field is optional, and a null value, a blank string or an empty list all leave the current value alone. Nothing can be cleared through this endpoint.", + "properties" : { + "accessControl" : { + "type" : "array", + "description" : "Access control platforms the organization works with, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.", + "items" : { + "type" : "string", + "description" : "Access control platforms the organization works with, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.", + "nullable" : true + }, + "nullable" : true + }, + "alarmMonitoringApproved" : { + "type" : "boolean", + "description" : "Whether the partner organization is approved for alarm monitoring", + "nullable" : true + }, + "billingCity" : { + "type" : "string", + "description" : "Billing city of the partner organization. Null or blank leaves the current value alone.", + "nullable" : true + }, + "billingCountryCode" : { + "type" : "string", + "description" : "Billing country as an ISO code (for example US). Only the ISO code is accepted, not the display name. Null or blank leaves the current value alone.", + "nullable" : true + }, + "billingPostalCode" : { + "type" : "string", + "description" : "Billing postal code of the partner organization. Null or blank leaves the current value alone.", + "nullable" : true + }, + "billingStateCode" : { + "type" : "string", + "description" : "Billing state as an ISO code (for example CA). Only the ISO code is accepted, not the display name, and it must be valid for the billing country. Null or blank leaves the current value alone.", + "nullable" : true + }, + "billingStreet" : { + "type" : "string", + "description" : "Billing street of the partner organization. Null or blank leaves the current value alone.", + "nullable" : true + }, + "competitorsResellerOffers" : { + "type" : "array", + "description" : "Competitor offerings the organization also resells, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.", + "items" : { + "type" : "string", + "description" : "Competitor offerings the organization also resells, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.", + "nullable" : true + }, + "nullable" : true + }, + "confirmedAccessControlQualifications" : { + "type" : "boolean", + "description" : "Whether the partner organization has confirmed its access control qualifications", + "nullable" : true + }, + "offeredServices" : { + "type" : "array", + "description" : "Services the organization offers, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.", + "items" : { + "type" : "string", + "description" : "Services the organization offers, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.", + "nullable" : true + }, + "nullable" : true + }, + "partnerType" : { + "type" : "array", + "description" : "Partner types of the organization, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here. The Managed Service Provider (MSP) value is set by Rhombus, and a list containing it is rejected.", + "items" : { + "type" : "string", + "description" : "Partner types of the organization, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here. The Managed Service Provider (MSP) value is set by Rhombus, and a list containing it is rejected.", + "nullable" : true + }, + "nullable" : true + }, + "phone" : { + "type" : "string", + "description" : "Primary phone number of the partner organization. Null or blank leaves the current value alone; it cannot be cleared here.", + "nullable" : true + }, + "servicesGeographicCoverage" : { + "type" : "string", + "description" : "Geographic coverage of the services the partner organization offers. Null or blank leaves the current value alone.", + "nullable" : true + }, + "website" : { + "type" : "string", + "description" : "Website of the partner organization. Null or blank leaves the current value alone.", + "nullable" : true + } + } + }, + "Partnerportal_UpdatePartnerPortalCompanyInfoWSResponse" : { + "type" : "object", + "description" : "Response object for updating the company profile of the authenticated partner organization. Carries success or failure only; re-read getCompanyInfo for the saved values.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_UpdatePartnerPortalQuoteWSRequest" : { + "type" : "object", + "description" : "Request object for saving header edits and line adds, updates and deletes to a quote belonging to the authenticated partner organization, applied in one transaction. At least one change is required, and at most 200 line operations are allowed per save. Prices are recalculated asynchronously afterwards.", + "properties" : { + "addLines" : { + "type" : "array", + "description" : "Lines to add", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteLineAddType" + }, + "nullable" : true + }, + "deleteLineIds" : { + "type" : "array", + "description" : "Identifiers of existing lines to delete", + "items" : { + "type" : "string", + "description" : "Identifiers of existing lines to delete", + "nullable" : true + }, + "nullable" : true + }, + "expectedLastModifiedDate" : { + "type" : "string", + "description" : "The quote's lastModifiedDate from the most recent getQuote; the save is rejected if the quote has changed since", + "nullable" : true + }, + "quote" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteHeaderUpdateType" + }, + "quoteId" : { + "type" : "string", + "description" : "Identifier of the Salesforce quote", + "nullable" : true + }, + "updateLines" : { + "type" : "array", + "description" : "Existing lines to update", + "items" : { + "$ref" : "#/components/schemas/Partnerportal_PartnerPortalQuoteLineUpdateType" + }, + "nullable" : true + } + }, + "required" : [ "expectedLastModifiedDate", "quoteId" ] + }, + "Partnerportal_UpdatePartnerPortalQuoteWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of saving changes to a quote.", + "properties" : { + "addedLineIds" : { + "type" : "array", + "description" : "Identifiers of the lines that were added, in request order", + "items" : { + "type" : "string", + "description" : "Identifiers of the lines that were added, in request order", + "nullable" : true + }, + "nullable" : true + }, + "deletedLineIds" : { + "type" : "array", + "description" : "Identifiers of the lines that were deleted", + "items" : { + "type" : "string", + "description" : "Identifiers of the lines that were deleted", + "nullable" : true + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "quoteId" : { + "type" : "string", + "description" : "Identifier of the updated Salesforce quote", + "nullable" : true + }, + "recalcQueued" : { + "type" : "boolean", + "description" : "Whether a price recalculation was queued for the save", + "nullable" : true + }, + "savedAt" : { + "type" : "string", + "description" : "Date and time the save was recorded; prices are current once getQuote returns a lastCalculatedOn at or after this value", + "nullable" : true + }, + "updatedLineIds" : { + "type" : "array", + "description" : "Identifiers of the lines that were updated", + "items" : { + "type" : "string", + "description" : "Identifiers of the lines that were updated", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Partnerportal_UploadPartnerPortalMdfClaimFileWSResponse" : { + "type" : "object", + "description" : "Response object containing the result of attaching a supporting file to a market development funds claim.", + "properties" : { + "contentVersionId" : { + "type" : "string", + "description" : "Identifier of the Salesforce ContentVersion holding the uploaded file", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Password_ForgotPasswordWSRequest" : { + "type" : "object", + "description" : "Request object for initiating a forgot password flow with captcha verification.", + "properties" : { + "email" : { + "type" : "string", + "description" : "Email address of the user requesting password reset", + "example" : "user@example.com", + "nullable" : true + }, + "googleCaptchaSource" : { + "$ref" : "#/components/schemas/GoogleCaptchaSourceEnum" + }, + "googlesCaptchaResponse" : { + "type" : "string", + "description" : "Google reCAPTCHA response token for verification", + "example" : "03AGdBq25...", + "nullable" : true + } + } + }, + "Password_ForgotPasswordWSResponse" : { + "type" : "object", + "description" : "Response object for forgot password request containing success status and failure details.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason for failure if the request was unsuccessful", + "example" : "User not found", + "nullable" : true + }, + "success" : { + "type" : "boolean", + "description" : "Whether the forgot password request was successful", + "example" : true, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Password_ResetPasswordWSRequest" : { + "type" : "object", + "description" : "Request object for resetting user password using a reset token.", + "properties" : { + "password" : { + "type" : "string", + "description" : "New password for the user account", + "example" : "newSecurePassword123", + "nullable" : true + }, + "token" : { + "type" : "string", + "description" : "Password reset token received via email", + "example" : "abc123def456", + "nullable" : true + } + } + }, + "Password_ResetPasswordWSResponse" : { + "type" : "object", + "description" : "Response object for password reset containing success status and detailed failure information.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Human-readable reason for failure if the reset was unsuccessful", + "example" : "Invalid or expired token", + "nullable" : true + }, + "failureReasonType" : { + "$ref" : "#/components/schemas/UpdatePasswordFailureReasonEnumType" + }, + "success" : { + "type" : "boolean", + "description" : "Whether the password reset was successful", + "example" : true, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Password_UserSignupWSRequest" : { + "type" : "object", + "description" : "Request object for user signup with invitation token, password, and EULA acceptance.", + "properties" : { + "eulaAccepted" : { + "type" : "boolean", + "description" : "Whether the user has accepted the End User License Agreement", + "example" : true, + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password for the new user account", + "example" : "securePassword123", + "nullable" : true + }, + "token" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Password_UserSignupWSResponse" : { + "type" : "object", + "description" : "Response object for user signup containing success status and failure details.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason for failure if the signup was unsuccessful", + "example" : "Invalid invitation token", + "nullable" : true + }, + "success" : { + "type" : "boolean", + "description" : "Whether the user signup was successful", + "example" : true, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "PeerAddressModeEnum" : { + "type" : "string", + "enum" : [ "STRICT", "HINT" ] + }, + "PeerChannelModeEnum" : { + "type" : "string", + "enum" : [ "DISABLED", "PASSIVE", "ENABLED" ] + }, + "PerceptionTypeEnum" : { + "type" : "string", + "enum" : [ "PEOPLE_COUNTING", "FACE_COUNTING_UNIQUE", "FACE_COUNTING_NONUNIQUE", "ENGAGMENT_COUNTING", "FACE_RECOGNITION", "LICENSEPLATE_RECOGNITION", "VEHICLE_COUNTING", "OCCUPANCY_COUNTING", "UNKNOWN" ] + }, + "PermissionEnum" : { + "type" : "string", + "enum" : [ "READONLY", "ADMIN", "LIVEONLY" ] + }, + "Permission_AssignUserPermissionWSRequest" : { + "type" : "object", + "description" : "Request object for assigning user permissions (deprecated, use Permission Group endpoints instead).", + "properties" : { + "userPermission" : { + "$ref" : "#/components/schemas/UserPermissionType" + } + } + }, + "Permission_AssignUserPermissionWSResponse" : { + "type" : "object", + "description" : "Response object for assigning user permissions (deprecated, use Permission Group endpoints instead).", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_CreatePartnerPermissionGroupWSRequest" : { + "type" : "object", + "description" : "Request object for creating a new partner permission group.", + "properties" : { + "partnerPermissionGroup" : { + "$ref" : "#/components/schemas/PartnerUserPermissionGroupType" + } + } + }, + "Permission_CreatePartnerPermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created partner permission group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_CreatePermissionGroupWSRequest" : { + "type" : "object", + "description" : "Request object for creating a new permission group.", + "properties" : { + "userPermissionGroup" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + } + } + }, + "Permission_CreatePermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created permission group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_DeletePartnerPermissionGroupWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a partner permission group.", + "properties" : { + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Permission_DeletePartnerPermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a partner permission group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_DeletePermissionGroupWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a permission group.", + "properties" : { + "groupUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Permission_DeletePermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a permission group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_GetPartnerPermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object containing partner permission groups and client permission group mappings.", + "properties" : { + "clientPermissionGroupMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + }, + "description" : "Map of client UUIDs to their permission group types", + "nullable" : true + }, + "clientPermissionsGroupMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + }, + "nullable" : true, + "writeOnly" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "groupMembership" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of permission group UUIDs to list of user UUIDs in each group", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "description" : "Map of permission group UUIDs to list of user UUIDs in each group", + "nullable" : true + }, + "permissionGroups" : { + "type" : "array", + "description" : "List of partner permission groups", + "items" : { + "$ref" : "#/components/schemas/PartnerUserPermissionGroupType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_GetPartnerPermissionGroupsWSRequest" : { + "type" : "object", + "description" : "Request object for getting partner permission groups for the organization." + }, + "Permission_GetPermissionGroupsForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting permission groups for a specific organization.", + "properties" : { + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Permission_GetPermissionGroupsForOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing permission groups for a specific organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "permissionGroups" : { + "type" : "array", + "description" : "List of permission groups in the organization", + "items" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_GetPermissionGroupsWSRequest" : { + "type" : "object", + "description" : "Request object for getting all permission groups in the organization." + }, + "Permission_GetPermissionGroupsWSResponse" : { + "type" : "object", + "description" : "Response object containing permission groups and membership information for the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "groupMembership" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of permission group UUIDs to list of user UUIDs in each group", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "description" : "Map of permission group UUIDs to list of user UUIDs in each group", + "nullable" : true + }, + "partnerMembership" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of partner UUIDs to list of user UUIDs in each partner organization", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "description" : "Map of partner UUIDs to list of user UUIDs in each partner organization", + "nullable" : true + }, + "permissionGroups" : { + "type" : "array", + "description" : "List of permission groups in the organization", + "items" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_GetPermissionsForCurrentPartnerWSRequest" : { + "type" : "object", + "description" : "Request object for getting permissions for the current partner user." + }, + "Permission_GetPermissionsForCurrentPartnerWSResponse" : { + "type" : "object", + "description" : "Response object containing partner permission information including functionality lists, client permissions, and group details.", + "properties" : { + "assignablePermissionGroups" : { + "type" : "array", + "description" : "Set of partner permission group UUIDs the user can assign to other users", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "clientFunctionalityList" : { + "type" : "array", + "description" : "List of client functionalities the user has access to", + "items" : { + "$ref" : "#/components/schemas/FunctionalityEnum" + }, + "nullable" : true + }, + "clientPermissionMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PartnerPermissionEnum" + }, + "description" : "Map of client UUIDs to partner permission levels", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "functionalityList" : { + "type" : "array", + "description" : "List of partner functionalities the user has access to", + "items" : { + "$ref" : "#/components/schemas/PartnerFunctionalityEnum" + }, + "nullable" : true + }, + "permissionGroupName" : { + "type" : "string", + "description" : "Name of the partner user's permission group", + "example" : "Partner Administrator", + "nullable" : true + }, + "superAdmin" : { + "type" : "boolean", + "description" : "Whether the partner user has super admin privileges", + "example" : false, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_GetPermissionsForCurrentUserWSRequest" : { + "type" : "object", + "description" : "Request object for getting permissions for the current user." + }, + "Permission_GetPermissionsForCurrentUserWSResponse" : { + "type" : "object", + "description" : "Response object containing comprehensive permission information for the current user including functionality, device, location, and granular access maps.", + "properties" : { + "accessControlLocationAccessMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "description" : "Map of access control location UUIDs to permission levels", + "nullable" : true + }, + "accessMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "description" : "Deprecated: Map of device UUIDs to permission levels (use deviceAccessMap instead)", + "nullable" : true + }, + "assignablePermissionGroups" : { + "type" : "array", + "description" : "Set of permission group UUIDs the user can assign to other users", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "componentCompositeGranularAccessMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "description" : "Map of component composite UUIDs to granular functionality permission maps. Functionality keys are LocationFunctionality values (normalized from ComponentCompositeFunctionality via ComponentCompositeFunctionality#getLocationFunctionality).", + "nullable" : true + }, + "description" : "Map of component composite UUIDs to granular functionality permission maps. Functionality keys are LocationFunctionality values (normalized from ComponentCompositeFunctionality via ComponentCompositeFunctionality#getLocationFunctionality).", + "nullable" : true + }, + "deviceAccessMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "description" : "Map of device UUIDs to permission levels", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "functionalityList" : { + "type" : "array", + "description" : "List of functionalities the user has access to", + "items" : { + "$ref" : "#/components/schemas/FunctionalityEnum" + }, + "nullable" : true + }, + "installer" : { + "type" : "boolean", + "description" : "Whether the user has installer privileges", + "example" : false, + "nullable" : true + }, + "locationAccessMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "description" : "Map of location UUIDs to permission levels", + "nullable" : true + }, + "locationGranularAccessMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "description" : "Map of location UUIDs to granular functionality permission maps", + "nullable" : true + }, + "description" : "Map of location UUIDs to granular functionality permission maps", + "nullable" : true + }, + "permissionGroupName" : { + "type" : "string", + "description" : "Name of the user's permission group", + "example" : "Administrator", + "nullable" : true + }, + "superAdmin" : { + "type" : "boolean", + "description" : "Whether the user has super admin privileges", + "example" : false, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_UpdatePartnerPermissionGroupWSRequest" : { + "type" : "object", + "description" : "Request object for updating an existing partner permission group.", + "properties" : { + "partnerPermissionGroup" : { + "$ref" : "#/components/schemas/PartnerUserPermissionGroupType" + } + } + }, + "Permission_UpdatePartnerPermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object for updating a partner permission group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Permission_UpdatePermissionGroupWSRequest" : { + "type" : "object", + "description" : "Request object for updating an existing permission group.", + "properties" : { + "userPermissionGroup" : { + "$ref" : "#/components/schemas/UserPermissionGroupType" + } + } + }, + "Permission_UpdatePermissionGroupWSResponse" : { + "type" : "object", + "description" : "Response object for updating a permission group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "PermyriadRect" : { + "type" : "object", + "properties" : { + "h" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "size" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "w" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "x" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "y" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Person" : { + "type" : "object", + "description" : "The updated person", + "properties" : { + "createdOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "email" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PersonSelectiveUpdate" : { + "type" : "object", + "description" : "Selective update information for the person", + "properties" : { + "createdOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "email" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_OUTPUT", "GPIO_INPUT", "GPIO_INPUT_SUPERVISED", "RS485", "WIEGAND_INPUT", "WIEGAND_OUTPUT", "BUTTON_INPUT" ] + }, + "PhysicalPortType" : { + "type" : "object", + "properties" : { + "boardNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "componentPortTypeUsageMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "label" : { + "type" : "string", + "nullable" : true + }, + "portNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "supportedPortTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PhysicalPortEnumType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "PimlocBaseAPIUrlEnum" : { + "type" : "string", + "enum" : [ "US", "EU" ] + }, + "PimlocType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "baseAPIUrl" : { + "$ref" : "#/components/schemas/PimlocBaseAPIUrlEnum" + }, + "clientId" : { + "type" : "string", + "nullable" : true + }, + "clientSecret" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "validCredentials" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PinCodeNewGuestPassCredentialSpec" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "pinCode" : { + "type" : "string", + "description" : "PIN code (4 to 16 digits). When omitted, the server generates one that does not collide with any non-revoked PIN already issued in the org. Either pinCode or pinLength must be set.", + "example" : "12345", + "maxLength" : 16, + "minLength" : 4, + "nullable" : true + }, + "pinLength" : { + "type" : "integer", + "format" : "int32", + "default" : 5, + "description" : "Length of the PIN to generate when pinCode is null. Default 5. Ignored if pinCode is set.", + "example" : 5, + "maximum" : 16, + "minimum" : 4, + "nullable" : true + } + } + } ], + "description" : "Spec for a PIN_CODE credential to be created and bound to the new guest pass. Mirrors the relevant subset of CreatePinCredentialWSRequest.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string", + "description" : "Discriminator for the credential type to create.", + "nullable" : true + } + }, + "required" : [ "type" ] + }, + "PinCredential" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastUsedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "managedCredUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "PinQueryFilter" : { + "type" : "object", + "description" : "Applies a filter on PINs retrieved. If a filter is not provided or if filter fields are left empty, no filtering will be applied. If used with pageRequest, the paginated result will be retrieved first then the filter will be applied.", + "properties" : { + "statusFilter" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PinStatusEnum" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "PinStatusEnum" : { + "type" : "string", + "enum" : [ "ACTIVE", "SCHEDULED", "EXPIRED" ] + }, + "PipelineComponent" : { + "type" : "object", + "properties" : { + "arg_json" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true + }, + "nullable" : true + }, + "modelQuantizedBinaryContentLocator" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "$ref" : "#/components/schemas/PipelineComponentTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PipelineComponentTypeEnum" : { + "type" : "string", + "enum" : [ "logger", "cropper_jpg", "color_class", "crop_mem", "motion_filter", "motion_detector", "visual_tamper", "syntiant_va", "syntiant_tracker", "syntiant_lpr", "syntiant_bounding_box", "cavalry_detector", "iou_tracker", "plumerai", "person_vit", "detector_pose" ] + }, + "Place" : { + "type" : "object", + "properties" : { + "behavior" : { + "type" : "string", + "nullable" : true + }, + "box_count" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "capture_as" : { + "type" : "string", + "nullable" : true + }, + "date_format" : { + "type" : "string", + "nullable" : true + }, + "default" : { + "type" : "string", + "nullable" : true + }, + "font_color" : { + "type" : "string", + "nullable" : true + }, + "font_size" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "format" : { + "type" : "string", + "nullable" : true + }, + "format_message" : { + "type" : "string", + "nullable" : true + }, + "height" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "hint" : { + "type" : "string", + "nullable" : true + }, + "key" : { + "type" : "string", + "nullable" : true + }, + "line_count" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "line_height" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "options" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "prompt" : { + "type" : "string", + "nullable" : true + }, + "recipient_key" : { + "type" : "string", + "nullable" : true + }, + "requirement" : { + "type" : "string", + "nullable" : true + }, + "symbol" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/PlaceTypeEnum" + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "width" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "PlaceOsSettings" : { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiUrl" : { + "type" : "string", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "migrated" : { + "type" : "boolean", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + } + } + }, + "PlaceOsType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "apiUrl" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "triggerNotification" : { + "type" : "boolean", + "nullable" : true + }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PlaceType" : { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "id" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "PlaceTypeEnum" : { + "type" : "string", + "enum" : [ "signature", "initials", "text", "text_input", "boxed_text_input", "multiline_text_input", "checkbox", "dropdown", "recipient_completed_date", "envelope_completed_date", "recipient_name", "recipient_email" ] + }, + "PlainLocationAccessControlGuestPass" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "guestEmail" : { + "type" : "string", + "nullable" : true + }, + "guestName" : { + "type" : "string", + "nullable" : true + }, + "profileImageUrl" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "accessPeriods" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/LocationGuestPassAccessPeriod" + }, + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lifecycle" : { + "$ref" : "#/components/schemas/LocationGuestPassLifecycleEnum" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "passStartTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "principalType" : { + "$ref" : "#/components/schemas/LocationGuestPassPrincipalTypeEnum" + }, + "reconciledAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "reconciledVersion" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "sortKey" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "stampVersion" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "stampedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PlanTypeEnum" : { + "type" : "string", + "enum" : [ "TRIAL", "STARTER", "CUSTOM" ] + }, + "PlayerViewLiveTypeEnum" : { + "type" : "string", + "enum" : [ "REALTIME", "BUFFERED" ] + }, + "PmSensorType" : { + "type" : "object", + "properties" : { + "nc0p5" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nc10p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nc1p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nc2p5" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nc4p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "noxIdx" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm10p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm1p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm2p5" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm4p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "relHumid" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tempC" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "timestampSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "typPartSize" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vocIdx" : { + "type" : "number", + "format" : "float", + "nullable" : true + } + } + }, + "PointType" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "y" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "PolicyAlertComponentCompositeTypeEnum" : { + "type" : "string", + "description" : "Type of component composite associated with an archived policy alert. Access controlled doors are the only composite that can raise policy alerts today.", + "enum" : [ "ACCESS_CONTROLLED_DOOR", "UNKNOWN" ] + }, + "PolicyAlertEnumType" : { + "type" : "string", + "enum" : [ "POLICY_ALERT_V2", "ACCESS_CONTROLLED_DOOR_POLICY_ALERT" ] + }, + "PolicyAlertHistory" : { + "type" : "object", + "description" : "A policy alert history record containing information about the archived policy alert. Either the device fields or the component composite fields are populated, never both, and the type indicates which group to read.", + "properties" : { + "alertCreatedAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the policy alert was created, in milliseconds since the epoch.", + "nullable" : true + }, + "alertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "associatedCameras" : { + "type" : "array", + "description" : "Cameras associated with the entity that raised the alert, captured at the time the alert was archived.", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "componentCompositeName" : { + "type" : "string", + "description" : "Component composite name at the time the alert was archived, or null when no name was captured. It may differ from the current component composite name.", + "nullable" : true + }, + "componentCompositeType" : { + "$ref" : "#/components/schemas/PolicyAlertComponentCompositeTypeEnum" + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the policy alert was archived, in milliseconds since the epoch.", + "nullable" : true + }, + "deviceName" : { + "type" : "string", + "description" : "Device name at the time the alert was archived, or null when no device name was captured. It may differ from the current device name.", + "nullable" : true + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "historyState" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryStateEnum" + }, + "locationName" : { + "type" : "string", + "description" : "Location name at the time the alert was archived, or null when no location name was captured. It may differ from the current location name.", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reviewedByName" : { + "type" : "string", + "description" : "Name of the reviewer, captured when the alert was archived, so it may differ from the current name. Read reviewedByType to know what it names, such as the PIN itself for SHARED_PIN. It is null when nobody reviewed the alert.", + "nullable" : true + }, + "reviewedByType" : { + "$ref" : "#/components/schemas/ThreatCaseReviewerTypeEnum" + }, + "reviewedByUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationName" : { + "type" : "string", + "description" : "Sub-location name at the time the alert was archived, or null when the alert was raised at the location itself. It may differ from the current sub-location name.", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "threatCaseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggers" : { + "type" : "array", + "description" : "Activities that triggered the policy alert.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/PolicyAlertEnumType" + } + } + }, + "PolicyAlertHistoryComponentCompositeStats" : { + "type" : "object", + "description" : "Aggregate policy alert history counts for a single component composite, such as an access controlled door.", + "properties" : { + "componentCompositeType" : { + "$ref" : "#/components/schemas/PolicyAlertComponentCompositeTypeEnum" + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of policy alert histories attributed to this entity.", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Entity name captured when the policy alert was archived. The value may no longer match the current entity name, or be null if no name was captured. If the entity was renamed during the reported date range, the name captured by the most recently created alert is returned.", + "nullable" : true + } + } + }, + "PolicyAlertHistoryDeviceStats" : { + "type" : "object", + "description" : "Policy alert history stats for a single device.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of policy alert histories attributed to this entity.", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Entity name captured when the policy alert was archived. The value may no longer match the current entity name, or be null if no name was captured. If the entity was renamed during the reported date range, the name captured by the most recently created alert is returned.", + "nullable" : true + } + } + }, + "PolicyAlertHistoryFilter" : { + "type" : "object", + "description" : "Filtering criteria for policy alert histories.", + "properties" : { + "alertCreatedAtFilter" : { + "$ref" : "#/components/schemas/EventTimestampFilter" + }, + "anyNameContains" : { + "type" : "string", + "description" : "Filters policy alert histories by any name captured at archive time, ignoring case. Histories where at least one name contains the value match. A value shorter than 3 characters after trimming applies no filter.", + "nullable" : true + }, + "componentCompositeNameContains" : { + "type" : "string", + "description" : "Filters policy alert histories by the component composite name captured at archive time, ignoring case. A value shorter than 3 characters after trimming applies no filter.", + "nullable" : true + }, + "componentCompositeUuids" : { + "type" : "array", + "description" : "Filters policy alert histories by component composite. Histories raised by any of the specified composites match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "deviceNameContains" : { + "type" : "string", + "description" : "Filters policy alert histories by the device name captured at archive time, ignoring case. A value shorter than 3 characters after trimming applies no filter.", + "nullable" : true + }, + "deviceUuids" : { + "type" : "array", + "description" : "Filters policy alert histories by device. Histories raised by any of the specified devices match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "historyStates" : { + "type" : "array", + "description" : "Filters policy alert histories by state. Histories in any of the specified states match.", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryStateEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationNameContains" : { + "type" : "string", + "description" : "Filters policy alert histories by the location name captured at archive time, ignoring case. A value shorter than 3 characters after trimming applies no filter.", + "nullable" : true + }, + "locationUuids" : { + "type" : "array", + "description" : "Filters policy alert histories by location. Histories at any of the specified locations match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "reviewedByNameContains" : { + "type" : "string", + "description" : "Filters policy alert histories by the reviewer name captured at archive time, ignoring case. A value shorter than 3 characters after trimming applies no filter.", + "nullable" : true + }, + "reviewedByUuids" : { + "type" : "array", + "description" : "Filters policy alert histories by reviewer. Histories reviewed by any of the specified users match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "subLocationNameContains" : { + "type" : "string", + "description" : "Filters policy alert histories by the sub-location name captured at archive time, ignoring case. A value shorter than 3 characters after trimming applies no filter.", + "nullable" : true + }, + "subLocationsHierarchyKeys" : { + "type" : "array", + "description" : "Filters policy alert histories by sub-location. Each key also matches every sub-location beneath it.", + "items" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "nullable" : true, + "uniqueItems" : true + }, + "triggers" : { + "type" : "array", + "description" : "Filters policy alert histories by trigger. Histories with any of the specified triggers match.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "PolicyAlertHistoryLocationStats" : { + "type" : "object", + "description" : "Policy alert history stats for a single location.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of policy alert histories attributed to this entity.", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Entity name captured when the policy alert was archived. The value may no longer match the current entity name, or be null if no name was captured. If the entity was renamed during the reported date range, the name captured by the most recently created alert is returned.", + "nullable" : true + } + } + }, + "PolicyAlertHistoryReportIntervalEnum" : { + "type" : "string", + "description" : "Interval the policy alert history stats are bucketed by.", + "enum" : [ "HOURLY", "DAILY" ] + }, + "PolicyAlertHistoryReviewerStats" : { + "type" : "object", + "description" : "Aggregate policy alert history counts for a single reviewer.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of policy alert histories attributed to this entity.", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Entity name captured when the policy alert was archived. The value may no longer match the current entity name, or be null if no name was captured. If the entity was renamed during the reported date range, the name captured by the most recently created alert is returned.", + "nullable" : true + }, + "reviewerType" : { + "$ref" : "#/components/schemas/ThreatCaseReviewerTypeEnum" + }, + "reviewerUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PolicyAlertHistoryStateEnum" : { + "type" : "string", + "description" : "State of a policy alert history record.", + "enum" : [ "EXPIRED", "DISMISSED", "ESCALATED", "DELAYED", "UNKNOWN" ] + }, + "PolicyAlertTimelineEntry" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "activities" : { + "type" : "array", + "description" : "Activities that triggered the alert.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true + }, + "alertType" : { + "$ref" : "#/components/schemas/PolicyAlertEnumType" + }, + "alertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "componentComposite" : { + "$ref" : "#/components/schemas/TimelineEntryComponentComposite" + }, + "device" : { + "$ref" : "#/components/schemas/TimelineEntryDevice" + } + } + } ], + "description" : "A timeline entry recording a policy alert associated with the report.", + "nullable" : true, + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", + "nullable" : true + }, + "createdBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "imageKey" : { + "type" : "string", + "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", + "nullable" : true + }, + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "systemGenerated" : { + "type" : "boolean", + "description" : "Whether the entry was generated by the system rather than created by a user.", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/TimelineEntryTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PolicyAlertV2Type" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "airQualityIndex" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "airQualityIndexThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "alertingDwellEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DwellEventType" + }, + "nullable" : true + }, + "alertingEventFaces" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyEventFaceType" + }, + "nullable" : true + }, + "alertingEventVehicles" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyEventVehicleType" + }, + "nullable" : true + }, + "alertingTrackIds" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "cd" : { + "type" : "string", + "description" : "Custom activity display description, maximum 100 characters", + "nullable" : true + }, + "cdn" : { + "type" : "string", + "description" : "Custom activity display name, maximum 32 characters", + "nullable" : true + }, + "ch2oPpb" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "ch2oPpbThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "clipLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "cllmBooleanValue" : { + "type" : "boolean", + "nullable" : true + }, + "cllmCheckCondition" : { + "$ref" : "#/components/schemas/CheckCondition" + }, + "cllmIntegerValue" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "cllmPromptTypeEnum" : { + "$ref" : "#/components/schemas/PromptTypeEnum" + }, + "cllmPromptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "co2" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "co2Ppm" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "co2PpmThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "co2Threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "coConcentration" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "coConcentrationThreshold" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "egressBoundaryDevices" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "ethanol" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "ethanolThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "heatIndexDegF" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "heatIndexDegFThreshold" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "humidityPercent1616" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "humidityPercentThreshold1616" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "humidityPermyriad" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "humidityThresholdPermyriad" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "iaq" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "iaqThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "inactivityThresholdMs" : { + "type" : "integer", + "format" : "int64", + "description" : "For INACTIVITY_* alerts, the inactivity threshold configured on the region that fired, in milliseconds. This is the configured threshold, not the elapsed length of the inactivity window.", + "nullable" : true + }, + "ingressBoundaryDevices" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "leakDetected" : { + "type" : "boolean", + "nullable" : true + }, + "maxLuf" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "noxIdx" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "noxIdxThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "numHumans" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "peopleCountHighThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "peopleCountLowThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "pm10p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm10p0Threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm1p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm1p0Threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm25" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm25Threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm4p0" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pm4p0Threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pressure" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "pressureThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "probeTempC" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "probeTempCThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "probeTempThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "relHumid" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "relHumidThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tamperByMovementChange" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tampered" : { + "type" : "boolean", + "nullable" : true + }, + "tempC" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tempCThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tempProbePresent" : { + "type" : "boolean", + "nullable" : true + }, + "temperatureCelsius1616" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "temperatureCelsiusThreshold1616" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "temperaturePermyriad" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "temperatureThresholdPermyriad" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "thcPercent" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "thcPercentThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tvoc" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tvocThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vapeDetected" : { + "type" : "boolean", + "nullable" : true + }, + "vapeSmokePercent" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vapeSmokePercentThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vocIdx" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "vocIdxThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "alertMonitoringThreatCaseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "alertMonitoringVerified" : { + "type" : "boolean", + "nullable" : true + }, + "archived" : { + "type" : "boolean", + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" + }, + "clipLocationMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "nullable" : true + }, + "clipLocationMapV2" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "delayedProcessing" : { + "type" : "boolean", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "finalized" : { + "type" : "boolean", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "notificationSent" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyAlertTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saved" : { + "type" : "boolean", + "nullable" : true + }, + "serverReceivedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "shared" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "textDescription" : { + "type" : "string", + "description" : "Natural language description of the alert", + "nullable" : true + }, + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/PolicyAlertEnumType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PolicyAlertWithDetailsType" : { + "type" : "object", + "description" : "Detailed information about the policy alert", + "oneOf" : [ { + "$ref" : "#/components/schemas/PolicyAlertV2Type" + }, { + "$ref" : "#/components/schemas/AccessControlledDoorPolicyAlertType" + } ], + "properties" : { + "alertMonitoringThreatCaseUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "alertMonitoringVerified" : { + "type" : "boolean", + "nullable" : true + }, + "archived" : { + "type" : "boolean", + "nullable" : true + }, + "boundingBoxes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipBoundingBoxType" + }, + "nullable" : true + }, + "boundingBoxesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipBoundingBoxType" + }, + "nullable" : true + }, + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/ApiClientTypeEnum" + }, + "clipLocationMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "nullable" : true + }, + "clipLocationMapV2" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "componentCompositeSeekPointsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipSeekPointV2Type" + }, + "nullable" : true + }, + "nullable" : true + }, + "delayedProcessing" : { + "type" : "boolean", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "finalized" : { + "type" : "boolean", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "notificationSent" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyAlertTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "recognizedEventFaces" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyEventFaceType" + }, + "nullable" : true + }, + "recognizedEventVehicles" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyEventVehicleType" + }, + "nullable" : true + }, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saved" : { + "type" : "boolean", + "nullable" : true + }, + "seekPoints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipSeekPointV2Type" + }, + "nullable" : true + }, + "seekPointsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClipSeekPointV2Type" + }, + "nullable" : true + }, + "nullable" : true + }, + "serverReceivedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "shared" : { + "type" : "boolean", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "textDescription" : { + "type" : "string", + "description" : "Natural language description of the alert", + "nullable" : true + }, + "thirdPartyDeviceName" : { + "type" : "string", + "nullable" : true + }, + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/PolicyAlertEnumType" + }, + "unrecognizedEventFaces" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyEventFaceType" + }, + "nullable" : true + }, + "unrecognizedEventVehicles" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyEventVehicleType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PolicyEventFaceType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "faceId" : { + "type" : "string", + "nullable" : true + }, + "faceName" : { + "type" : "string", + "nullable" : true + }, + "imageS3Bucket" : { + "type" : "string", + "nullable" : true + }, + "imageS3Key" : { + "type" : "string", + "nullable" : true + }, + "imageS3Region" : { + "type" : "string", + "nullable" : true + }, + "labels" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "personUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PolicyEventPipelineEnum" : { + "type" : "string", + "enum" : [ "DEFAULT", "POLICY_ALERT_PUBLISHER" ] + }, + "PolicyEventVehicleType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "imageS3Bucket" : { + "type" : "string", + "nullable" : true + }, + "imageS3Key" : { + "type" : "string", + "nullable" : true + }, + "imageS3Region" : { + "type" : "string", + "nullable" : true + }, + "labels" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "licensePlateNumber" : { + "type" : "string", + "nullable" : true + }, + "vehicleName" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateAccessControlledDoorPolicyWSRequest" : { + "type" : "object", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalAccessControlledDoorPolicyType" + } + } + }, + "Policy_CreateAccessControlledDoorPolicyWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateAudioPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for creating an audio policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalAudioPolicyType" + } + } + }, + "Policy_CreateAudioPolicyWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created audio policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateCameraPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for creating a camera policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalCameraPolicyV2Type" + } + } + }, + "Policy_CreateCameraPolicyWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created camera policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateClimatePolicyWSRequest" : { + "type" : "object", + "description" : "Request object for creating a climate policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalClimatePolicyType" + } + } + }, + "Policy_CreateClimatePolicyWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created climate policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateDoorPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for creating a door sensor policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalDoorPolicyType" + } + } + }, + "Policy_CreateDoorPolicyWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created door sensor policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateOccupancyPolicyWSRequest" : { + "type" : "object", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalOccupancyPolicyType" + } + } + }, + "Policy_CreateOccupancyPolicyWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreatePolicyAddendumForLocationRequest" : { + "type" : "object", + "description" : "Request object for creating a policy addendum for a location.", + "properties" : { + "activities" : { + "type" : "array", + "description" : "Set of activities to include in the policy addendum", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds for the policy addendum", + "example" : 3600, + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds for the policy addendum", + "example" : 1640995200, + "nullable" : true + } + } + }, + "Policy_CreatePolicyAddendumForLocationResponse" : { + "type" : "object", + "description" : "Response object for creating a policy addendum for a location.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreatePolicyAddendumsForDevicesRequest" : { + "type" : "object", + "description" : "Request object for creating policy addendums for multiple devices.", + "properties" : { + "activities" : { + "type" : "array", + "description" : "Set of activities to include in the policy addendums", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "deviceUuids" : { + "type" : "array", + "description" : "List of device UUIDs to create policy addendums for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds for the policy addendums", + "example" : 3600, + "nullable" : true + }, + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds for the policy addendums", + "example" : 1640995200, + "nullable" : true + } + } + }, + "Policy_CreatePolicyAddendumsForDevicesResponse" : { + "type" : "object", + "description" : "Response object for creating policy addendums for multiple devices.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateProximityPolicyWSRequest" : { + "type" : "object", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalProximityPolicyType" + } + } + }, + "Policy_CreateProximityPolicyWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for creating a schedule to be used for policy creation.", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + } + } + }, + "Policy_CreateScheduleWSResponse" : { + "type" : "object", + "description" : "Response object containing the UUID of the created schedule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_CreateVideoIntercomPolicyWSRequest" : { + "type" : "object", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalVideoIntercomPolicyType" + } + } + }, + "Policy_CreateVideoIntercomPolicyWSResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteAccessControlledDoorPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an access controlled door policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteAccessControlledDoorPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an access controlled door policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteAudioPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an audio policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteAudioPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an audio policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteCameraPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a camera policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteCameraPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a camera policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteClimatePolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a climate policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteClimatePolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a climate policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteDevicePolicyAddendumsWSRequest" : { + "type" : "object", + "description" : "Request object for deleting device policy addendums.", + "properties" : { + "uuids" : { + "type" : "array", + "description" : "List of device policy addendum UUIDs to delete", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Policy_DeleteDevicePolicyAddendumsWSResponse" : { + "type" : "object", + "description" : "Response object for deleting device policy addendums.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteDoorPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a door sensor policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteDoorPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a door sensor policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteLocationPolicyAddendumWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a location policy addendum.", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteLocationPolicyAddendumWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a location policy addendum.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteOccupancyPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting an occupancy policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteOccupancyPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting an occupancy policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeletePolicyPauseSettingWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a policy pause setting.", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeletePolicyPauseSettingWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a policy pause setting.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteProximityPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a proximity policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteProximityPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a proximity policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a schedule used for policy creation.", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a schedule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_DeleteVideoIntercomPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a video intercom policy.", + "properties" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_DeleteVideoIntercomPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a video intercom policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_ExternalAudioPolicyType" : { + "type" : "object", + "description" : "List of audio policies in the organization", + "properties" : { + "defaultTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalAudioTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalAudioScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_ExternalAudioScheduledTriggerType" : { + "type" : "object", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalAudioTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_ExternalAudioTriggerType" : { + "type" : "object", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "threshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + } + } + }, + "Policy_ExternalVideoIntercomPolicyType" : { + "type" : "object", + "description" : "List of video intercom policies in the organization", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_ExternalVideoIntercomScheduledTriggerType" : { + "type" : "object", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_ExternalVideoIntercomTriggerType" : { + "type" : "object", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "faceAlertLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "faceAlertUnidentified" : { + "type" : "boolean", + "nullable" : true + }, + "faceAllowedLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "lufsThreshold" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "peopleCountThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "vehicleAlertLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "vehicleAlertUnidentified" : { + "type" : "boolean", + "nullable" : true + }, + "vehicleAllowedLabelSet" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_FindSchedulesWSRequest" : { + "type" : "object", + "description" : "Request object for finding all schedules in the organization." + }, + "Policy_FindSchedulesWSResponse" : { + "type" : "object", + "description" : "Response object containing all schedules in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "schedules" : { + "type" : "array", + "description" : "List of schedules in the organization", + "items" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetAccessControlledDoorPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all access controlled door policies in the organization." + }, + "Policy_GetAccessControlledDoorPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all access controlled door policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of access controlled door policies in the organization", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetAudioPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all audio policies in the organization." + }, + "Policy_GetAudioPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all audio policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of audio policies in the organization", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalAudioPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetCameraPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all camera policies in the organization." + }, + "Policy_GetCameraPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all camera policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of camera policies in the organization", + "items" : { + "$ref" : "#/components/schemas/CameraPolicyV2Type" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetClimatePoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all climate policies in the organization." + }, + "Policy_GetClimatePoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all climate policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of climate policies in the organization", + "items" : { + "$ref" : "#/components/schemas/ClimatePolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetDoorPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all door sensor policies in the organization." + }, + "Policy_GetDoorPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all door sensor policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of door sensor policies in the organization", + "items" : { + "$ref" : "#/components/schemas/DoorPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetOccupancyPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all occupancy policies in the organization." + }, + "Policy_GetOccupancyPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all occupancy policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of occupancy policies in the organization", + "items" : { + "$ref" : "#/components/schemas/OccupancyPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetPoliciesUsingScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for getting all policies that use a specific schedule.", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_GetPoliciesUsingScheduleWSResponse" : { + "type" : "object", + "description" : "Response object containing all policies that use a specific schedule, organized by policy type.", + "properties" : { + "accessControlledDoorPolicyList" : { + "type" : "array", + "description" : "List of access controlled door policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/AccessControlledDoorPolicyType" + }, + "nullable" : true + }, + "audioPolicyList" : { + "type" : "array", + "description" : "List of audio policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/AudioPolicyType" + }, + "nullable" : true + }, + "cameraPolicyList" : { + "type" : "array", + "description" : "List of camera policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/CameraPolicyV2Type" + }, + "nullable" : true + }, + "climatePolicyList" : { + "type" : "array", + "description" : "List of climate policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/ClimatePolicyType" + }, + "nullable" : true + }, + "doorPolicyList" : { + "type" : "array", + "description" : "List of door sensor policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/DoorPolicyType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "occupancyPolicyList" : { + "type" : "array", + "description" : "List of occupancy policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/OccupancyPolicyType" + }, + "nullable" : true + }, + "proximityPolicyList" : { + "type" : "array", + "description" : "List of proximity policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/ProximityPolicyType" + }, + "nullable" : true + }, + "videoIntercomPolicyList" : { + "type" : "array", + "description" : "List of video intercom policies using the schedule", + "items" : { + "$ref" : "#/components/schemas/VideoIntercomPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetPolicyAddendumsWSRequest" : { + "type" : "object", + "description" : "Request object for getting policy addendums." + }, + "Policy_GetPolicyAddendumsWSResponse" : { + "type" : "object", + "description" : "Response object containing policy addendums for devices and locations.", + "properties" : { + "deviceAddendumsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device UUIDs to their policy addendum scheduled intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of device UUIDs to their policy addendum scheduled intervals", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "locationAddendumsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of location UUIDs to their policy addendum scheduled intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of location UUIDs to their policy addendum scheduled intervals", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetPolicyPauseSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for getting policy pause settings." + }, + "Policy_GetPolicyPauseSettingsWSResponse" : { + "type" : "object", + "description" : "Response object containing policy pause settings for locations, devices, and component composites.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policiesPausedForComponentCompositesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of component composite UUIDs to their paused policy scheduled intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of component composite UUIDs to their paused policy scheduled intervals", + "nullable" : true + }, + "policiesPausedForDevicesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device UUIDs to their paused policy scheduled intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of device UUIDs to their paused policy scheduled intervals", + "nullable" : true + }, + "policiesPausedForLocationsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of location UUIDs to their paused policy scheduled intervals", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true + }, + "description" : "Map of location UUIDs to their paused policy scheduled intervals", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetProximityPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all proximity policies in the organization." + }, + "Policy_GetProximityPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all proximity policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of proximity policies in the organization", + "items" : { + "$ref" : "#/components/schemas/ProximityPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetTrackPauseSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for listing active per-track alert snoozes. Org is resolved from the principal." + }, + "Policy_GetTrackPauseSettingsWSResponse" : { + "type" : "object", + "description" : "Response object listing active and scheduled per-track alert snoozes across devices and locations.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "trackPauses" : { + "type" : "array", + "description" : "All active or scheduled per-track snoozes for the org, across device and location scope", + "items" : { + "$ref" : "#/components/schemas/Policy_TrackPauseEntry" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_GetVideoIntercomPoliciesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all video intercom policies in the organization." + }, + "Policy_GetVideoIntercomPoliciesWSResponse" : { + "type" : "object", + "description" : "Response object containing all video intercom policies in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policies" : { + "type" : "array", + "description" : "List of video intercom policies in the organization", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomPolicyType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_MinimalAccessControlledDoorPolicyType" : { + "type" : "object", + "description" : "Updated access controlled door policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalAccessControlledDoorScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalAccessControlledDoorScheduledTriggerType" : { + "type" : "object", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_MinimalAudioPolicyType" : { + "type" : "object", + "description" : "Updated audio policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalAudioScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalAudioScheduledTriggerType" : { + "type" : "object", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalAudioTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_MinimalCameraPolicyV2Type" : { + "type" : "object", + "description" : "Updated camera policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalCameraScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalCameraScheduledTriggerType" : { + "type" : "object", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CameraTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_MinimalClimatePolicyType" : { + "type" : "object", + "description" : "Updated climate policy configuration", + "properties" : { + "backoffAlertSecs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalClimateScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalClimateScheduledTriggerType" : { + "type" : "object", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClimateTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_MinimalDoorPolicyType" : { + "type" : "object", + "description" : "Updated door sensor policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalDoorScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalDoorScheduledTriggerType" : { + "type" : "object", + "properties" : { + "ajarThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_MinimalOccupancyPolicyType" : { + "type" : "object", + "description" : "Updated occupancy policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalOccupancyScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalOccupancyScheduledTriggerType" : { + "type" : "object", + "properties" : { + "occupancyThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "vacancyThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Policy_MinimalProximityPolicyType" : { + "type" : "object", + "description" : "Updated proximity policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalProximityScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalProximityScheduledTriggerType" : { + "type" : "object", + "properties" : { + "departureThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProximityTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_MinimalVideoIntercomPolicyType" : { + "type" : "object", + "description" : "Updated video intercom policy configuration", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_MinimalVideoIntercomScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_MinimalVideoIntercomScheduledTriggerType" : { + "type" : "object", + "properties" : { + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Policy_ExternalVideoIntercomTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Policy_PauseAlertPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for pausing alert policies for specified locations, devices, and components.", + "properties" : { + "componentCompositeUuids" : { + "type" : "array", + "description" : "List of component composite UUIDs to pause alert policies for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "deviceUuids" : { + "type" : "array", + "description" : "List of device UUIDs to pause alert policies for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds to pause alert policies", + "example" : 3600, + "nullable" : true + }, + "locationUuids" : { + "type" : "array", + "description" : "List of location UUIDs to pause alert policies for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds for when to pause alert policies", + "example" : 1640995200, + "nullable" : true + } + } + }, + "Policy_PauseAlertPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for pausing alert policies.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_PauseTrackAlertsForLocationWSRequest" : { + "type" : "object", + "description" : "Request object for pausing/resuming track alerts for a single reID stableTrackId across a location.", + "properties" : { + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds to pause track alerts", + "example" : 3600, + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds for when to begin the pause", + "example" : 1640995200, + "nullable" : true + }, + "trackId" : { + "type" : "integer", + "format" : "int32", + "description" : "reID stableTrackId to pause track alerts for", + "nullable" : true + } + } + }, + "Policy_PauseTrackAlertsWSRequest" : { + "type" : "object", + "description" : "Request object for pausing/resuming track alerts for a single reID stableTrackId on a device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds to pause track alerts", + "example" : 3600, + "nullable" : true + }, + "policyAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds for when to begin the pause", + "example" : 1640995200, + "nullable" : true + }, + "trackId" : { + "type" : "integer", + "format" : "int32", + "description" : "reID stableTrackId to pause track alerts for", + "nullable" : true + } + } + }, + "Policy_TrackPauseEntry" : { + "type" : "object", + "description" : "A single active or scheduled per-track alert snooze.", + "properties" : { + "activeAfterTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch seconds after which the snooze is active", + "nullable" : true + }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration in seconds the snooze remains active", + "nullable" : true + }, + "policyAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scope" : { + "$ref" : "#/components/schemas/TrackPauseScopeEnum" + }, + "targetUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "thumbnailLocation" : { + "type" : "string", + "description" : "Thumbnail crop locator, copied from the policy alert this snooze was created from; null if no source alert was supplied or its thumbnail could not be resolved", + "nullable" : true + }, + "trackId" : { + "type" : "integer", + "format" : "int32", + "description" : "reID stableTrackId that is snoozed", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Policy_UpdateAccessControlledDoorPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating an access controlled door policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalAccessControlledDoorPolicyType" + } + } + }, + "Policy_UpdateAccessControlledDoorPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating an access controlled door policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateAudioPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating an audio policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalAudioPolicyType" + } + } + }, + "Policy_UpdateAudioPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating an audio policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateCameraPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating a camera policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalCameraPolicyV2Type" + } + } + }, + "Policy_UpdateCameraPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating a camera policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateClimatePolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating a climate policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalClimatePolicyType" + } + } + }, + "Policy_UpdateClimatePolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating a climate policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateDoorPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating a door sensor policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalDoorPolicyType" + } + } + }, + "Policy_UpdateDoorPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating a door sensor policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateOccupancyPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating an occupancy policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalOccupancyPolicyType" + } + } + }, + "Policy_UpdateOccupancyPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating an occupancy policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateProximityPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating a proximity policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalProximityPolicyType" + } + } + }, + "Policy_UpdateProximityPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating a proximity policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for updating a schedule used for policy creation.", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + } + } + }, + "Policy_UpdateScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for updating a schedule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policy_UpdateVideoIntercomPolicyWSRequest" : { + "type" : "object", + "description" : "Request object for updating a video intercom policy.", + "properties" : { + "policy" : { + "$ref" : "#/components/schemas/Policy_MinimalVideoIntercomPolicyType" + } + } + }, + "Policy_UpdateVideoIntercomPolicyWSResponse" : { + "type" : "object", + "description" : "Response object for updating a video intercom policy.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policyalert_FindLegacyPolicyAlertsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving legacy policy alerts.", + "properties" : { + "afterTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Enter starting timestamp interval in UNIX ms", + "example" : 1640995200000, + "nullable" : true + }, + "beforeTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Enter ending timestamp interval in UNIX ms", + "example" : 1641081600000, + "nullable" : true + }, + "deviceFilter" : { + "type" : "array", + "description" : "Filter including chosen Devices", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "lastTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Search with last known TimestampMs (Required for Pagination)", + "example" : 1640995200000, + "nullable" : true + }, + "lastUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationFilter" : { + "type" : "array", + "description" : "Filter any locations you would like to include", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Set a max result limit", + "example" : 100, + "nullable" : true + } + } + }, + "Policyalert_FindLegacyPolicyAlertsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing a list of legacy policy alerts.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "policyAlerts" : { + "type" : "array", + "description" : "List of legacy policy alerts matching the request criteria", + "items" : { + "$ref" : "#/components/schemas/BasePolicyAlertType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Policyalert_FindPolicyAlertsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding recent unarchived policy alerts by organization with filtering.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/UnarchivedPolicyAlertFilter" + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + } + }, + "Policyalert_FindPolicyAlertsByOrgWSResponse" : { + "type" : "object", + "description" : "Response containing the org's unarchived policy alerts.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Last evaluated key for pagination", + "nullable" : true + }, + "policyAlerts" : { + "type" : "array", + "description" : "List of unarchived policy alerts matching the filter criteria", + "items" : { + "$ref" : "#/components/schemas/BasePolicyAlertType" + }, + "nullable" : true + } + } + }, + "Policyalert_GetPolicyAlertStatsWSRequest" : { + "type" : "object", + "description" : "Request object for getting unarchived policy alert stats for an organization." + }, + "Policyalert_GetPolicyAlertStatsWSResponse" : { + "type" : "object", + "description" : "Response containing the count of unarchived policy alerts.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of unarchived policy alerts the caller can read, up to 100. If more alerts exist, hasMoreAlerts is true.", + "maximum" : 100, + "nullable" : true + }, + "hasMoreAlerts" : { + "type" : "boolean", + "description" : "Whether more unarchived policy alerts exist beyond alertCount.", + "nullable" : true + } + } + }, + "Policyalert_history_CalculatePolicyAlertHistoryStatsByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for calculating policy alert history stats by organization.", + "properties" : { + "alertCreatedAtFilter" : { + "$ref" : "#/components/schemas/EventTimestampFilter" + }, + "locationUuids" : { + "type" : "array", + "description" : "List of locations to filter policy alert histories.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "reportInterval" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryReportIntervalEnum" + }, + "timeZone" : { + "type" : "object", + "description" : "Time zone the interval buckets are aligned to, defaults to UTC", + "nullable" : true, + "properties" : { + "displayName" : { + "type" : "string", + "nullable" : true + }, + "dstsavings" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "id" : { + "type" : "string", + "nullable" : true + }, + "rawOffset" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } + } + }, + "Policyalert_history_CalculatePolicyAlertHistoryStatsByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing aggregate policy alert history stats for an organization.", + "properties" : { + "componentCompositeStats" : { + "type" : "array", + "description" : "Stats for each component composite, such as an access controlled door.", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryComponentCompositeStats" + }, + "nullable" : true + }, + "countByIntervalStartMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "Counts keyed by the start of each interval", + "nullable" : true + }, + "description" : "Counts keyed by the start of each interval", + "nullable" : true + }, + "countByState" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "Counts keyed by history state", + "nullable" : true + }, + "description" : "Counts keyed by history state", + "nullable" : true + }, + "countByTrigger" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "Counts keyed by trigger", + "nullable" : true + }, + "description" : "Counts keyed by trigger", + "nullable" : true + }, + "deviceStats" : { + "type" : "array", + "description" : "Stats for each device.", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryDeviceStats" + }, + "nullable" : true + }, + "locationStats" : { + "type" : "array", + "description" : "Stats for each location.", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryLocationStats" + }, + "nullable" : true + }, + "reviewerStats" : { + "type" : "array", + "description" : "Stats for each reviewer.", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryReviewerStats" + }, + "nullable" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of policy alert histories matching the filter", + "nullable" : true + } + } + }, + "Policyalert_history_FindPolicyAlertHistoriesByOrgWSRequest" : { + "type" : "object", + "description" : "Request object for finding policy alert histories by organization with search filtering and pagination.", + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/PolicyAlertHistoryFilter" + }, + "pageRequest" : { + "$ref" : "#/components/schemas/DynamoPageRequest" + } + } + }, + "Policyalert_history_FindPolicyAlertHistoriesByOrgWSResponse" : { + "type" : "object", + "description" : "Response object containing policy alert histories for an organization with pagination information.", + "properties" : { + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Pagination key for retrieving the next page of results", + "example" : "next_page_key_123", + "nullable" : true + }, + "policyAlertHistories" : { + "type" : "array", + "description" : "List of policy alert histories matching the search criteria", + "items" : { + "$ref" : "#/components/schemas/PolicyAlertHistory" + }, + "nullable" : true + } + } + }, + "Policyalert_history_GetPolicyAlertHistoryWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving a specific policy alert history by alert UUID.", + "properties" : { + "alertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "alertUuid" ] + }, + "Policyalert_history_GetPolicyAlertHistoryWSResponse" : { + "type" : "object", + "description" : "Response object containing a specific policy alert history.", + "properties" : { + "policyAlertHistory" : { + "$ref" : "#/components/schemas/PolicyAlertHistory" + } + } + }, + "PortSupervisionConfigurationType" : { + "type" : "object", + "properties" : { + "mode" : { + "$ref" : "#/components/schemas/SupervisionModeEnumType" + } + } + }, + "PosIntegrationInfoType" : { + "type" : "object", + "description" : "A HashMap of . This stores the Pos Information and assigned cameras.", + "properties" : { + "assignedCameraList" : { + "type" : "array", + "description" : "A list of camera guids from Rhombus that are assigned to the Pos device.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "posName" : { + "type" : "string", + "description" : "The name of the Pos device.", + "nullable" : true + } + } + }, + "Pose" : { + "type" : "object", + "properties" : { + "orientation" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "description" : "Serialized as [x, y, z, w]" + }, + "maxItems" : 4, + "minItems" : 4, + "nullable" : true + }, + "position" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "description" : "Serialized as [x, y, z]" + }, + "maxItems" : 3, + "minItems" : 3, + "nullable" : true + } + } + }, + "PreemptedBy" : { + "type" : "object", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/RobotActivityEnum" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "PressureSensorType" : { + "type" : "object", + "properties" : { + "pressure" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "tempC" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "timestampSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "PrincipalUuidEnum" : { + "type" : "string", + "enum" : [ "USER", "DEVICE", "PARTNER", "RHOMBUS_SUPPORT", "API_TOKEN", "API_OAUTH_TOKEN", "PARTNER_API_OAUTH_TOKEN", "SHARED_CLIP", "SHARED_STREAM", "SHARED_TIMELAPSE", "SHARED_VIDEOWALL", "KIOSK_CONSOLE", "UNKNOWN" ] + }, + "ProDataKeySettings" : { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "ouId" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "webhookId" : { + "type" : "string", + "nullable" : true + }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + } + } + }, + "ProDataKeyType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "alertUnauthorizedFaces" : { + "type" : "boolean", + "nullable" : true + }, + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "badgeAuthDisablesAlarmMonitoring" : { + "type" : "boolean", + "nullable" : true + }, + "badgeFaceVerificationMode" : { + "$ref" : "#/components/schemas/BadgeFaceVerificationModeEnum" + }, + "createAccessAnomalyAlerts" : { + "type" : "boolean", + "nullable" : true + }, + "createSeekPoints" : { + "type" : "boolean", + "nullable" : true + }, + "doorInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/BadgeIntegrationDoorInfoType" + }, + "nullable" : true + }, + "doorsValidated" : { + "type" : "boolean", + "nullable" : true + }, + "identifyFacesFromBadge" : { + "type" : "boolean", + "nullable" : true + }, + "indexFaces" : { + "type" : "boolean", + "nullable" : true + }, + "misconfiguredDoors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "organizationId" : { + "type" : "string", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "rhombusToken" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "systemId" : { + "type" : "string", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + }, + "webhookId" : { + "type" : "string", + "nullable" : true + }, + "webhookSignatureSecret" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Product" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "nullable" : true + }, + "productId" : { + "type" : "string", + "nullable" : true + }, + "productIdQualifier" : { + "type" : "string", + "nullable" : true + }, + "quantity" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "ProductTypeEnum" : { + "type" : "string", + "enum" : [ "DEVICE", "ALERT_MONITORING", "ACCESS_CONTROL", "GUEST_MANAGEMENT", "LICENSE_USAGE", "PANE", "UNKNOWN" ] + }, + "PromptConfigurationType" : { + "type" : "object", + "description" : "Updated prompt configuration", + "properties" : { + "active" : { + "type" : "boolean", + "nullable" : true + }, + "cameraConfigurations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CameraConfiguration" + }, + "nullable" : true + }, + "checkCondition" : { + "$ref" : "#/components/schemas/CheckCondition" + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "generateAlertForActionNewlyAddedCameras" : { + "type" : "boolean", + "nullable" : true + }, + "multiImageTimeDeltasSeconds" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "prompt" : { + "type" : "string", + "nullable" : true + }, + "promptType" : { + "$ref" : "#/components/schemas/PromptTypeEnum" + }, + "reportsEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "shortName" : { + "type" : "string", + "nullable" : true + }, + "trigger" : { + "$ref" : "#/components/schemas/Trigger" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "PromptFrequency" : { + "type" : "object", + "properties" : { + "frequency" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "unit" : { + "$ref" : "#/components/schemas/FrequencyUnitEnum" + } + } + }, + "PromptTurn" : { + "type" : "object", + "properties" : { + "role" : { + "type" : "string", + "nullable" : true + }, + "text" : { + "type" : "string", + "nullable" : true + } + } + }, + "PromptTypeEnum" : { + "type" : "string", + "enum" : [ "COUNT", "PERCENT", "BOOLEAN", "TEXT" ] + }, + "ProposedSchedule" : { + "type" : "object", + "properties" : { + "days" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "endMinuteOfDay" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "startMinuteOfDay" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Providers" : { + "type" : "object", + "nullable" : true + }, + "ProximityArrivedActivityEventType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "proximityTagLocationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "ProximityDepartedActivityEventType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "departureThresholdSecs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "proximityTagLocationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "ProximityEventType" : { + "type" : "object", + "description" : "List of proximity events for the specified tag", + "properties" : { + "baseStationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "batteryPercentage" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "bleDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "bleRssi" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "closeBaseStations" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "gpsLocation" : { + "$ref" : "#/components/schemas/GeodeticCoordinates" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/ProximityStatusEnum" + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + } + }, + "ProximityPolicyType" : { + "type" : "object", + "description" : "List of proximity policies in the organization", + "properties" : { + "defaultDepartureThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "defaultTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProximityTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "egressThresholdMetersMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, + "ingressThresholdMetersMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduledTriggers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProximityScheduledTriggerType" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ProximityScheduledTriggerType" : { + "type" : "object", + "properties" : { + "departureThresholdSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "egressThresholdMetersMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, + "ingressThresholdMetersMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "triggerSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProximityTriggerType" + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "ProximityStatusEnum" : { + "type" : "string", + "description" : "Filter events by proximity status", + "enum" : [ "ACTIVE", "STATIONARY", "OFFLINE" ] + }, + "ProximityTagLocomotionEventType" : { + "type" : "object", + "description" : "List of locomotion events for the specified tag", + "properties" : { + "baseStationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "gpsLocation" : { + "$ref" : "#/components/schemas/GeodeticCoordinates" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "movement" : { + "$ref" : "#/components/schemas/LocomotionMovementEnum" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "tagUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "ProximityTagTimeSeriesDataPointType" : { + "type" : "object", + "description" : "List of proximity tag time series data points", + "properties" : { + "dateLocal" : { + "type" : "string", + "nullable" : true + }, + "tagUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ProximityTriggerType" : { + "type" : "object", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "locationUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + }, + "ProximityUnlockSettingsType" : { + "type" : "object", + "properties" : { + "credCooldownSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "exitResetsCooldown" : { + "type" : "boolean", + "nullable" : true + }, + "holdUnlocked" : { + "type" : "boolean", + "nullable" : true + }, + "holdUnlockedEventIntervalSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "maxHoldUnlockedTimeSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "minHoldUnlockedTimeSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "minRSSIThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "ProximityUnlockSettingsType_Minimal" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "minRSSIThreshold" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Proximity_GetLocomotionEventsForTagWSRequest" : { + "type" : "object", + "description" : "Request object for getting locomotion events for a specified proximity tag with filtering options.", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter events created after this timestamp in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter events created before this timestamp in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of events to return", + "example" : 100, + "nullable" : true + }, + "movementFilter" : { + "$ref" : "#/components/schemas/LocomotionMovementEnum" + }, + "tagUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Proximity_GetLocomotionEventsForTagWSResponse" : { + "type" : "object", + "description" : "Response object containing locomotion events for a specified proximity tag.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "locomotionEvents" : { + "type" : "array", + "description" : "List of locomotion events for the specified tag", + "items" : { + "$ref" : "#/components/schemas/ProximityTagLocomotionEventType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Proximity_GetMinimalProximityStatesWSRequest" : { + "type" : "object", + "description" : "Request object for getting basic state information about all proximity tags in the organization." + }, + "Proximity_GetMinimalProximityStatesWSResponse" : { + "type" : "object", + "description" : "Response object containing basic state information about all proximity tags in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "proximityStates" : { + "type" : "array", + "description" : "List of minimal proximity state information for all tags in the organization", + "items" : { + "$ref" : "#/components/schemas/Proximity_MinimalProximityStateType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Proximity_GetProximityEventsForTagWSRequest" : { + "type" : "object", + "description" : "Request object for getting recent events for a specified proximity tag with filtering options.", + "properties" : { + "createdAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter events created after this timestamp in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "createdBeforeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Filter events created before this timestamp in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum number of events to return", + "example" : 100, + "nullable" : true + }, + "statusFilter" : { + "$ref" : "#/components/schemas/ProximityStatusEnum" + }, + "tagUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Proximity_GetProximityEventsForTagWSResponse" : { + "type" : "object", + "description" : "Response object containing recent events for a specified proximity tag.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "proximityEvents" : { + "type" : "array", + "description" : "List of proximity events for the specified tag", + "items" : { + "$ref" : "#/components/schemas/ProximityEventType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Proximity_MinimalProximityStateType" : { + "type" : "object", + "description" : "Minimal proximity state information for a proximity tag.", + "properties" : { + "batteryPercent" : { + "type" : "integer", + "format" : "int32", + "description" : "Battery percentage of the proximity tag", + "example" : 75, + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the proximity tag was created in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "description" : "Firmware version of the proximity tag", + "example" : "1.2.3", + "nullable" : true + }, + "gpsLocation" : { + "$ref" : "#/components/schemas/GeodeticCoordinates" + }, + "health" : { + "$ref" : "#/components/schemas/Proximity_ProximityHealthEnum" + }, + "healthDetails" : { + "$ref" : "#/components/schemas/Proximity_ProximityHealthDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "imageUrl" : { + "type" : "string", + "description" : "URL of the image for the proximity tag", + "example" : "https://example.com/badge-image.jpg", + "nullable" : true + }, + "lastSeenSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the proximity tag was last seen in seconds", + "example" : 1640995200, + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the proximity tag", + "example" : "Employee Badge 001", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "description" : "Serial number of the proximity tag", + "example" : "PROX-001-ABC123", + "nullable" : true + }, + "signalStrength" : { + "type" : "integer", + "format" : "int32", + "description" : "Signal strength of the proximity tag", + "example" : 85, + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/ProximityStatusEnum" + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "tagUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Proximity_ProximityHealthDetailsEnum" : { + "type" : "string", + "description" : "Detailed health information for the proximity tag", + "enum" : [ "FIRMWARE_BEHIND", "NONE" ] + }, + "Proximity_ProximityHealthEnum" : { + "type" : "string", + "description" : "Health status of the proximity tag", + "enum" : [ "GREEN" ] + }, + "Proximity_UpdateProximitySensorDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for updating details for a proximity tag.", + "properties" : { + "deletedUpdated" : { + "type" : "boolean", + "description" : "Whether the deleted status has been updated", + "example" : false, + "nullable" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the proximity tag", + "example" : "John Doe's employee badge", + "nullable" : true + }, + "descriptionUpdated" : { + "type" : "boolean", + "description" : "Whether the description has been updated", + "example" : true, + "nullable" : true + }, + "imageUrl" : { + "type" : "string", + "description" : "URL of the image for the proximity tag", + "example" : "https://example.com/badge-image.jpg", + "nullable" : true + }, + "imageUrlUpdated" : { + "type" : "boolean", + "description" : "Whether the image URL has been updated", + "example" : false, + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the proximity tag", + "example" : "Employee Badge 001", + "nullable" : true + }, + "nameUpdated" : { + "type" : "boolean", + "description" : "Whether the name has been updated", + "example" : true, + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "policyUuidUpdated" : { + "type" : "boolean", + "description" : "Whether the policy UUID has been updated", + "example" : true, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Proximity_UpdateProximitySensorDetailsWSResponse" : { + "type" : "object", + "description" : "Response object for updating details for a proximity tag.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "QrCodeStaticCredential" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "formatVersion" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastUsedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "managedCredUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "QrCodeStaticNewGuestPassCredentialSpec" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "formatVersion" : { + "type" : "integer", + "format" : "int32", + "description" : "QR static format version that determines the scannable payload packaging. Defaults to the current version when omitted.", + "example" : 1, + "nullable" : true + } + } + } ], + "description" : "Spec for a static QR code credential to be created and bound to the new guest pass. The token is server-generated (an RUUID); the only tunable is the format version, which defaults to the current one when omitted.", + "nullable" : true, + "properties" : { + "type" : { + "type" : "string", + "description" : "Discriminator for the credential type to create.", + "nullable" : true + } + }, + "required" : [ "type" ] + }, + "QualifiedAddressType" : { + "type" : "object", + "description" : "Qualified address information for the keypad location", + "properties" : { + "addressLine2" : { + "type" : "string", + "description" : "apt, suite, or unit", + "nullable" : true + }, + "addressline1" : { + "type" : "string", + "description" : "street address", + "nullable" : true + }, + "administrativeArea" : { + "type" : "string", + "description" : "state", + "nullable" : true + }, + "locality" : { + "type" : "string", + "description" : "city", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "description" : "zip code", + "nullable" : true + }, + "regionCode" : { + "type" : "string", + "description" : "country", + "nullable" : true + } + } + }, + "QueryStatusEnum" : { + "type" : "string", + "enum" : [ "ANSWERED", "PARTIALLY_ANSWERED", "CLARIFICATION_REQUESTED", "REDIRECTED", "INITIATED", "QUEUED", "IN_PROGRESS", "CALLING_TOOLS", "AWAITING_TOOL_RESULTS", "GENERATING_RESPONSE", "GENERATING_REPORT_OUTLINE", "GENERATING_REPORT_SECTIONS", "GENERATING_REPORT_DRAFT", "FILLING_OUT_CHARTS", "REFINING_REPORT", "USAGE_CAP_MODEL_DOWNGRADED", "NOT_UNDERSTOOD", "INVALID_REQUEST", "UNAUTHORIZED", "UNSUPPORTED", "DENIED", "INTERRUPTED", "NO_RESPONSE", "INVALID_AUTH_DATA", "INVALID_API_TOKEN", "MIND_DISABLED", "AI_UNAUTHORIZED", "OUT_OF_TRIAL_CREDITS", "FREE_TIER_CAP_REACHED", "UNKNOWN" ] + }, + "QueryTimelineEvent" : { + "type" : "object", + "properties" : { + "status" : { + "$ref" : "#/components/schemas/QueryStatusEnum" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "QueryTool" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "nullable" : true + }, + "contentType" : { + "type" : "string", + "nullable" : true + }, + "extra" : { + "type" : "string", + "nullable" : true + }, + "role" : { + "type" : "string", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "tool" : { + "type" : "string", + "nullable" : true + } + } + }, + "RBACSettingsType" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "RMARequest" : { + "type" : "object", + "properties" : { + "formSubmitted" : { + "type" : "boolean", + "nullable" : true + }, + "requestUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rmaOpportunityId" : { + "type" : "string", + "nullable" : true + }, + "salesforceAccountId" : { + "type" : "string", + "nullable" : true + }, + "salesforcePartnerContactId" : { + "type" : "string", + "nullable" : true + }, + "salesforcePartnerId" : { + "type" : "string", + "nullable" : true + } + } + }, + "RMAStatusEnum" : { + "type" : "string", + "enum" : [ "INITIATED", "PENDING", "APPROVED", "INPROGRESS", "COMPLETE", "RETURN", "STOLEN", "OPERATIONAL", "FULFILLMENT_ERROR" ] + }, + "RMAType" : { + "type" : "object", + "description" : "List of RMAs (Return Merchandise Authorizations)", + "properties" : { + "address" : { + "type" : "string", + "nullable" : true + }, + "advancedRMAs" : { + "$ref" : "#/components/schemas/AdvancedRMAType" + }, + "briefDescription" : { + "type" : "string", + "nullable" : true + }, + "city" : { + "type" : "string", + "nullable" : true + }, + "costInDollars" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "country" : { + "type" : "string", + "nullable" : true + }, + "customerUnresponsive" : { + "type" : "boolean", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "errorCode" : { + "$ref" : "#/components/schemas/ErrorCodeOrMessageEnum" + }, + "failureDiagnostics" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "fedExReturnLabelSent" : { + "type" : "boolean", + "nullable" : true + }, + "finalNotes" : { + "type" : "string", + "nullable" : true + }, + "hardwareUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "initialFirmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "initiatedBy" : { + "type" : "string", + "nullable" : true + }, + "inventoryNeeded" : { + "type" : "string", + "nullable" : true + }, + "inventoryNeededMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "isRefurbished" : { + "type" : "boolean", + "nullable" : true + }, + "knownIssue" : { + "type" : "boolean", + "nullable" : true + }, + "lastRecordedFirmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "lastUpdatedAtSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUpdatedBy" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "postalCode" : { + "type" : "string", + "nullable" : true + }, + "prevShippingInfoUsedBy" : { + "type" : "string", + "nullable" : true + }, + "prevShippingInfoUsedByAtSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "proactiveReplacement" : { + "type" : "boolean", + "nullable" : true + }, + "rctpPartnerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "recipientName" : { + "type" : "string", + "nullable" : true + }, + "recipientPhoneNumber" : { + "type" : "string", + "nullable" : true + }, + "replacementCourier" : { + "type" : "string", + "nullable" : true + }, + "replacementHardwareUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "replacementTrackingNumber" : { + "type" : "string", + "nullable" : true + }, + "requesterEmailAddress" : { + "type" : "string", + "nullable" : true + }, + "returnLabelRequestedUpdatedAtSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "returnLabelSent" : { + "type" : "boolean", + "nullable" : true + }, + "returnLabelSentUpdatedAtSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "returnTrackingNumber" : { + "type" : "string", + "nullable" : true + }, + "rmaRequest" : { + "$ref" : "#/components/schemas/RMARequest" + }, + "rmaRequestUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "sdCardReplaced" : { + "type" : "boolean", + "nullable" : true + }, + "shipmentMethod" : { + "$ref" : "#/components/schemas/ShipmentMethodEnum" + }, + "shipmentRequested" : { + "type" : "boolean", + "nullable" : true + }, + "shipmentRequestedBy" : { + "type" : "string", + "nullable" : true + }, + "shipmentRequestedUpdatedAtSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "shipmentSent" : { + "type" : "boolean", + "nullable" : true + }, + "shipmentSentUpdatedAtSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "skipAutoRegistration" : { + "type" : "boolean", + "nullable" : true + }, + "state" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/RMAStatusEnum" + }, + "storageCid" : { + "type" : "string", + "nullable" : true + }, + "street" : { + "type" : "string", + "nullable" : true + }, + "timestampSec" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warehouseInventoryNeeded" : { + "type" : "boolean", + "nullable" : true + }, + "zenDeskTicketAssigneeEmail" : { + "type" : "string", + "nullable" : true + }, + "zenDeskTicketSubject" : { + "type" : "string", + "nullable" : true + }, + "zendeskTicket" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Rapidsos_GetNearbyFeedsRequest" : { + "type" : "object", + "description" : "Request object for getting the closest 10 feeds by latitude and longitude.", + "properties" : { + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Latitude coordinate for finding nearby feeds", + "example" : 40.7128, + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Longitude coordinate for finding nearby feeds", + "example" : -74.006, + "nullable" : true + }, + "width" : { + "type" : "integer", + "format" : "int32", + "description" : "Width parameter for the search area", + "example" : 1000, + "nullable" : true + } + } + }, + "Rapidsos_GetNearbyFeedsResponse" : { + "type" : "object", + "description" : "Response object containing the closest 10 feed stream URLs by latitude and longitude.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "streamUrls" : { + "type" : "array", + "description" : "List of stream URLs for the closest 10 feeds", + "items" : { + "type" : "string", + "description" : "List of stream URLs for the closest 10 feeds", + "nullable" : true + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "RaptorBuilding" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "uid" : { + "type" : "string", + "nullable" : true + } + } + }, + "RaptorTemplate" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "uId" : { + "type" : "string", + "nullable" : true + }, + "uid" : { + "type" : "string", + "nullable" : true + } + } + }, + "RaptorType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "clientId" : { + "type" : "string", + "nullable" : true + }, + "clientSecret" : { + "type" : "string", + "nullable" : true + }, + "clientUid" : { + "type" : "string", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ReEnableDeviceHealthTrackingConditionEnum" : { + "type" : "string", + "description" : "Condition under which device health tracking will be re-enabled.", + "enum" : [ "MANUAL", "AUTOMATIC" ], + "example" : "MANUAL" + }, + "ReIdEquivalenceEdge" : { + "type" : "object", + "description" : "Raw equivalence edges recorded for this day", + "properties" : { + "cs" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "idA" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "idB" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "producer" : { + "type" : "string", + "nullable" : true + }, + "tm" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "ReaderDispositionEnum" : { + "type" : "string", + "enum" : [ "INGRESS", "EGRESS", "UNKNOWN" ] + }, + "RealtimeRelativeSecondsScheduleType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "pastSeconds" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "internalWriteOnly" : { + "type" : "boolean", + "nullable" : true + }, + "mutable" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "oneTimeUse" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "strategy" : { + "$ref" : "#/components/schemas/ScheduleStrategyEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RearmMonitoringRule" : { + "type" : "object", + "description" : "Rule used to re-arm monitoring after badge authentication disables monitoring.", + "properties" : { + "rearmedAfterMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The UNIX timestamp (in milliseconds) after which the zone re-arms.", + "nullable" : true + } + } + }, + "RecurringRuleTriggerType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "locationUuids" : { + "type" : "array", + "description" : "Optional list of locations to specify timezones for evaluation. Note that if not specified, then we rely on the Actions to derive timezones.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "repeatInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Interval of timeUnit to re-occur at. i.e. trigger every 5 minutes, repeatInerval would be 5", + "nullable" : true + }, + "timeUnit" : { + "$ref" : "#/components/schemas/RecurringTimeUnitEnum" + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" + } + } + }, + "RecurringTimeUnitEnum" : { + "type" : "string", + "description" : "Time unit of recurrence. i.e. trigger every 5 minutes, timeUnit would be MINUTES", + "enum" : [ "SECONDS", "MINUTES", "HOURS" ] + }, + "RegionConfigType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "inverted" : { + "type" : "boolean", + "nullable" : true + }, + "polygons" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, + "nullable" : true + } + } + }, + "RegionCoordinateType" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "y" : { + "type" : "number", + "format" : "float", + "nullable" : true + } + } + }, + "RegionCrossingActivityEventType" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "RegionOfInterest" : { + "type" : "object", + "description" : "Regions of interest that belong to the group. Group must have at least one region specified.", + "properties" : { + "activities" : { + "type" : "array", + "description" : "Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.", + "items" : { + "$ref" : "#/components/schemas/ActivityEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "polygon" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RegionOfInterestGroup" : { + "type" : "object", + "properties" : { + "inclusive" : { + "type" : "boolean", + "description" : "If true, regions in this group include specified activities. If false, regions in this group exclude specified activities.", + "nullable" : true + }, + "regionsOfInterest" : { + "type" : "array", + "description" : "Regions of interest that belong to the group. Group must have at least one region specified.", + "items" : { + "$ref" : "#/components/schemas/RegionOfInterest" + }, + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/RegionOfInterestGroupTypeEnum" + } + } + }, + "RegionOfInterestGroupTypeEnum" : { + "type" : "string", + "description" : "Represents type of activity regions in the group. Defaults to 'Activity'.", + "enum" : [ "ACTIVITY", "REPORTING", "CROSSING" ] + }, + "RegionPolygonType" : { + "type" : "object", + "properties" : { + "coordinates" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RegionCoordinateType" + }, + "nullable" : true + } + } + }, + "RelativeDateTimeIntervalsScheduleType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "intervals" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LocalDateTimeIntervalType" + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "internalWriteOnly" : { + "type" : "boolean", + "nullable" : true + }, + "mutable" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "oneTimeUse" : { + "type" : "boolean", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "strategy" : { + "$ref" : "#/components/schemas/ScheduleStrategyEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_AddThirdPartyCameraViaOnvifWSRequest" : { + "type" : "object", + "description" : "Add a third-party camera via ONVIF from an IP address and credentials.", + "properties" : { + "autoAssign" : { + "type" : "boolean", + "description" : "Provision (assign to the NVR) automatically after a successful probe. Defaults to false (probe-then-confirm).", + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IPv4 address of the camera to probe", + "example" : "10.5.4.20", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Camera name. When blank, derived from the ONVIF manufacturer and model.", + "nullable" : true + }, + "nvrUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "ONVIF password to try first (optional)", + "nullable" : true + }, + "trySavedCredentials" : { + "type" : "boolean", + "description" : "Also try the org's saved third-party camera credentials. Defaults to true.", + "nullable" : true + }, + "username" : { + "type" : "string", + "description" : "ONVIF username to try first (optional)", + "nullable" : true + } + } + }, + "Relay_AddThirdPartyCameraViaOnvifWSResponse" : { + "type" : "object", + "description" : "Result of adding a third-party camera via ONVIF.", + "properties" : { + "assignedDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "assignmentMsg" : { + "type" : "string", + "description" : "Why auto-assignment did not happen or failed, when applicable", + "nullable" : true + }, + "codec" : { + "type" : "string", + "description" : "Detected codec(s)", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "found" : { + "type" : "boolean", + "description" : "Whether an ONVIF-streamable camera was found at the address", + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Resolved camera IP address", + "nullable" : true + }, + "macAddress" : { + "type" : "string", + "description" : "Camera MAC address as reported by ONVIF", + "nullable" : true + }, + "manufacturer" : { + "type" : "string", + "description" : "Manufacturer reported by ONVIF", + "nullable" : true + }, + "model" : { + "type" : "string", + "description" : "Model reported by ONVIF", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name the camera was (or would be) provisioned with", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "RTSP stream URL derived from ONVIF", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_AssignThirdPartyCameraToNVRWSRequest" : { + "type" : "object", + "description" : "Request object for assigning a third-party camera to an NVR.", + "properties" : { + "discoveredCameraMacAddress" : { + "type" : "string", + "description" : "MAC address of the discovered camera to assign", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name for the third-party camera", + "example" : "Front Door Camera", + "nullable" : true + }, + "nvruuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "RTSP URL for the camera stream", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + } + } + }, + "Relay_AssignThirdPartyCameraToNVRWSResponse" : { + "type" : "object", + "description" : "Response object for assigning a third-party camera to an NVR.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_AssignThirdPartyCameraToRelayCameraWSRequest" : { + "type" : "object", + "description" : "Request object for assigning a third-party camera to a relay camera.", + "properties" : { + "discoveredCameraMacAddress" : { + "type" : "string", + "description" : "MAC address of the discovered camera to assign", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name for the third-party camera", + "example" : "Front Door Camera", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "RTSP URL for the camera stream", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + } + } + }, + "Relay_AssignThirdPartyCameraToRelayCameraWSResponse" : { + "type" : "object", + "description" : "Response object for assigning a third-party camera to a relay camera.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_AssignThirdPartyMultiFacetCameraToNVRWSRequest" : { + "type" : "object", + "description" : "Request to assign a multi-sensor third-party camera to an NVR as one multi-facet camera.", + "properties" : { + "discoveredCameraMacAddress" : { + "type" : "string", + "description" : "MAC address of the discovered multi-sensor camera to assign", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name for the multi-facet third-party camera", + "example" : "Loading Dock Bispectrum", + "nullable" : true + }, + "nvruuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rtspUrls" : { + "type" : "array", + "description" : "Ordered RTSP URLs, one per sensor/lens; index 0 -> VIDEO_0 (primary), index 1 -> VIDEO_1, ...", + "items" : { + "type" : "string", + "description" : "Ordered RTSP URLs, one per sensor/lens; index 0 -> VIDEO_0 (primary), index 1 -> VIDEO_1, ...", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Relay_AssignThirdPartyMultiFacetCameraToNVRWSResponse" : { + "type" : "object", + "description" : "Response object for assigning a multi-sensor third-party camera as one multi-facet camera.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "facetCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of video facets (streams) bound to the camera", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_AuthenticateThirdPartyCameraWSRequest" : { + "type" : "object", + "description" : "Request object for authenticating a third-party camera with RTSP URL.", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", + "example" : "password123", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "The RTSP URL of the third-party camera. This RTSP URL should reference a stream that provides H.264 encoded video", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + }, + "thirdPartyCameraMacAddress" : { + "type" : "string", + "description" : "The MAC address of the third-party camera this request is operating on", + "nullable" : true + }, + "trySavedCredentials" : { + "type" : "boolean", + "description" : "Whether the third-party credentials saved in the account should be used when trying to validate whether the provided RTSP URL is valid", + "example" : false, + "nullable" : true + }, + "username" : { + "type" : "string", + "description" : "Username to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", + "example" : "admin", + "nullable" : true + } + } + }, + "Relay_AuthenticateThirdPartyCameraWSResponse" : { + "type" : "object", + "description" : "Response object for authenticating a third-party camera with RTSP URL.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "result" : { + "$ref" : "#/components/schemas/DiscoveredThirdPartyCameraType" + }, + "rtspUrlStatus" : { + "$ref" : "#/components/schemas/UrlStatusEnum" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_CreateThirdPartyCameraPasswordWSRequest" : { + "type" : "object", + "description" : "Request object for creating a third-party camera password.", + "properties" : { + "notes" : { + "type" : "string", + "description" : "Notes for the password entry", + "example" : "Default admin password", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password for the third-party camera", + "example" : "password123", + "nullable" : true + }, + "username" : { + "type" : "string", + "description" : "Username for the third-party camera", + "example" : "admin", + "nullable" : true + } + } + }, + "Relay_CreateThirdPartyCameraPasswordWSResponse" : { + "type" : "object", + "description" : "Response object for creating a third-party camera password.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "passwordUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_DeleteThirdPartyCameraDiscoveryWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a third-party camera discovery.", + "properties" : { + "thirdPartyCameraMacAddress" : { + "type" : "string", + "description" : "MAC address of the third-party camera to delete", + "nullable" : true + } + } + }, + "Relay_DeleteThirdPartyCameraDiscoveryWSResponse" : { + "type" : "object", + "description" : "Request object for creating a third-party camera password." + }, + "Relay_DeleteThirdPartyCameraPasswordWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a third-party camera password.", + "properties" : { + "passwordUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_DeleteThirdPartyCameraPasswordWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a third-party camera password.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_DiscoveryWithUnassignedRtspEndpoints" : { + "type" : "object", + "description" : "Discovery information with unassigned RTSP endpoints available for assignment.", + "properties" : { + "codec" : { + "type" : "string", + "description" : "Codec of the discovered device", + "example" : "H.264", + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address of the discovered device", + "example" : "192.168.1.100", + "nullable" : true + }, + "macAddress" : { + "type" : "string", + "description" : "MAC address of the discovered device", + "nullable" : true + }, + "manufacturer" : { + "type" : "string", + "description" : "Manufacturer of the discovered device", + "example" : "Hikvision", + "nullable" : true + }, + "model" : { + "type" : "string", + "description" : "Model of the discovered device", + "example" : "DS-2CD2142FWD-I", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "unassignedRtspEndpoints" : { + "type" : "array", + "description" : "List of unassigned RTSP endpoints that are available for assignment. Contains only endpoints with status GOOD and that are not currently assigned.", + "items" : { + "$ref" : "#/components/schemas/Relay_ExternalRtspEndpoint" + }, + "nullable" : true + } + } + }, + "Relay_ExecuteThirdPartyCameraDiscoveryWSRequest" : { + "type" : "object", + "description" : "Request object for executing third-party camera discovery.", + "properties" : { + "additionalScanCidrs" : { + "type" : "array", + "description" : "Optional list of additional IPv4 CIDRs (e.g. \"10.5.0.0/24\") to scan for cameras on routed subnets that the NVR is not directly attached to. When empty (the default), discovery only covers the NVR's own directly-attached subnets. Multicast/WS-Discovery cannot cross routers, so these subnets are covered by an RTSP port scan followed by unicast ONVIF probes. At most 8 entries, each /16 or smaller.", + "items" : { + "type" : "string", + "description" : "Optional list of additional IPv4 CIDRs (e.g. \"10.5.0.0/24\") to scan for cameras on routed subnets that the NVR is not directly attached to. When empty (the default), discovery only covers the NVR's own directly-attached subnets. Multicast/WS-Discovery cannot cross routers, so these subnets are covered by an RTSP port scan followed by unicast ONVIF probes. At most 8 entries, each /16 or smaller.", + "nullable" : true + }, + "nullable" : true + }, + "deviceFilter" : { + "type" : "array", + "description" : "Set of device UUIDs to filter discovery by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationFilter" : { + "type" : "array", + "description" : "Set of location UUIDs to filter discovery by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + } + } + }, + "Relay_ExecuteThirdPartyCameraDiscoveryWSResponse" : { + "type" : "object", + "description" : "Response object for executing third-party camera discovery.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "scanId" : { + "type" : "string", + "description" : "Id of the discovery run that was started, for polling progress via getThirdPartyCameraDiscoveryScanStatus. Null if no run was started.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_ExternalRtspEndpoint" : { + "type" : "object", + "description" : "External RTSP endpoint configuration for camera streams.", + "properties" : { + "lastRtspUrlStatus" : { + "$ref" : "#/components/schemas/UrlStatusEnum" + }, + "lensRole" : { + "$ref" : "#/components/schemas/LensRoleEnum" + }, + "onvifProfileToken" : { + "type" : "string", + "description" : "ONVIF media profile token backing this endpoint (multi-sensor grouping); null when unknown", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password for RTSP authentication", + "example" : "password123", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "RTSP URL for the camera stream", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + }, + "source" : { + "$ref" : "#/components/schemas/RtspEndpointSourceEnum" + }, + "username" : { + "type" : "string", + "description" : "Username for RTSP authentication", + "example" : "admin", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSRequest" : { + "type" : "object", + "description" : "Request object for finding discoveries with unassigned RTSP endpoints." + }, + "Relay_FindDiscoveriesWithUnassignedRtspEndpointsWSResponse" : { + "type" : "object", + "description" : "Response object containing discoveries with unassigned RTSP endpoints.", + "properties" : { + "discoveries" : { + "type" : "array", + "description" : "List of discoveries with unassigned RTSP endpoints", + "items" : { + "$ref" : "#/components/schemas/Relay_DiscoveryWithUnassignedRtspEndpoints" + }, + "nullable" : true + } + } + }, + "Relay_GetAssignedThirdPartyCamerasWSRequest" : { + "type" : "object", + "description" : "Request object for getting third-party cameras assigned to a specific NVR.", + "properties" : { + "nvruuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_GetAssignedThirdPartyCamerasWSResponse" : { + "type" : "object", + "description" : "Response object containing third-party cameras assigned to a specific NVR.", + "properties" : { + "assignedCameras" : { + "type" : "array", + "description" : "List of third-party cameras assigned to the specified NVR", + "items" : { + "$ref" : "#/components/schemas/CameraType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_GetFullNVRStateWSRequest" : { + "type" : "object", + "description" : "Request object for getting detailed information about the state of a specified NVR.", + "properties" : { + "force" : { + "type" : "boolean", + "description" : "Whether to force refresh the NVR state", + "example" : false, + "nullable" : true + }, + "nvruuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + } + } + }, + "Relay_GetFullNVRStateWSResponse" : { + "type" : "object", + "description" : "Response object containing detailed information about the state of a specified NVR.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "fullNVRState" : { + "$ref" : "#/components/schemas/FullDeviceStateType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_GetImportThirdPartyCamerasFormatWSResponse" : { + "type" : "object", + "description" : "Response object for getting the import format for third-party cameras.", + "properties" : { + "example" : { + "type" : "string", + "description" : "Example of the import format", + "example" : "CSV format example", + "nullable" : true + }, + "explanation" : { + "type" : "string", + "description" : "Explanation of the import format", + "example" : "Format explanation", + "nullable" : true + } + } + }, + "Relay_GetMinimalNVRStateListWSRequest" : { + "type" : "object", + "description" : "Request object for getting basic state information about all NVRs in the organization." + }, + "Relay_GetMinimalNVRStateListWSResponse" : { + "type" : "object", + "description" : "Response object containing basic state information about all NVRs in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "nvrstates" : { + "type" : "array", + "description" : "List of minimal NVR state information for all NVRs in the organization", + "items" : { + "$ref" : "#/components/schemas/MinimalNVRStateType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_GetMinimalThirdPartyCameraStateListWSRequest" : { + "type" : "object", + "description" : "Request object for getting basic state information about all third-party cameras in the organization." + }, + "Relay_GetMinimalThirdPartyCameraStateListWSResponse" : { + "type" : "object", + "description" : "Response object containing basic state information about all third-party cameras in the organization.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "thirdPartyCameraStateList" : { + "type" : "array", + "description" : "List of minimal third-party camera state information for all cameras in the organization", + "items" : { + "$ref" : "#/components/schemas/Relay_MinimalThirdPartyCameraStateType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_GetNVRDetailsWSRequest" : { + "type" : "object", + "description" : "Request object for getting details for specified NVRs.", + "properties" : { + "nvruuids" : { + "type" : "array", + "description" : "List of NVR UUIDs to get details for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Relay_GetNVRDetailsWSResponse" : { + "type" : "object", + "description" : "Response object containing details for specified NVRs.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "nvrs" : { + "type" : "array", + "description" : "List of NVR details for the specified NVRs", + "items" : { + "$ref" : "#/components/schemas/Relay_NVRExternalType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_GetRtspEndpointsWSRequest" : { + "type" : "object", + "description" : "Request object for getting RTSP endpoints for a device with the specified MAC address.", + "properties" : { + "discoveredCameraMacAddress" : { + "type" : "string", + "description" : "MAC address of the discovered camera to get RTSP endpoints for", + "nullable" : true + } + } + }, + "Relay_GetRtspEndpointsWSResponse" : { + "type" : "object", + "description" : "Response object containing RTSP endpoints for a device with the specified MAC address.", + "properties" : { + "rtspEndpoints" : { + "type" : "array", + "description" : "List of RTSP endpoints for the discovered camera", + "items" : { + "$ref" : "#/components/schemas/Relay_ExternalRtspEndpoint" + }, + "nullable" : true + } + } + }, + "Relay_GetThirdPartyCameraDiscoveryScanStatusWSRequest" : { + "type" : "object", + "description" : "Request object for getting the progress of the current/most-recent third-party camera discovery run in the organization." + }, + "Relay_GetThirdPartyCameraDiscoveryScanStatusWSResponse" : { + "type" : "object", + "description" : "Progress of the current/most-recent third-party camera discovery run.", + "properties" : { + "camerasFound" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of cameras discovered so far in this run.", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "hasRun" : { + "type" : "boolean", + "description" : "Whether discovery has ever been run for this org. When false, all other fields are unset/zero.", + "nullable" : true + }, + "inProgress" : { + "type" : "boolean", + "description" : "Whether a discovery run is still in progress (at least one Relay scan outstanding and the run is not stale).", + "nullable" : true + }, + "nvrCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of Relays (NVRs) this run is scanning.", + "nullable" : true + }, + "nvrProgress" : { + "type" : "array", + "description" : "Per-Relay live scan progress and per-IP probe results (for troubleshooting).", + "items" : { + "$ref" : "#/components/schemas/Relay_NvrScanProgressType" + }, + "nullable" : true + }, + "pendingCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Relays whose scan has not yet finished. Zero means the run is complete.", + "nullable" : true + }, + "scanId" : { + "type" : "string", + "description" : "Opaque id of the run, so clients can tell if a newer run superseded theirs.", + "nullable" : true + }, + "startedMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch millis when the run started.", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_GetThirdPartyCameraPasswordsWSRequest" : { + "type" : "object", + "description" : "Request object for getting third-party camera passwords." + }, + "Relay_GetThirdPartyCameraPasswordsWSResponse" : { + "type" : "object", + "description" : "Response object containing third-party camera passwords.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "passwords" : { + "type" : "array", + "description" : "List of third-party camera passwords", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyCameraPasswordType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_ImportThirdPartyCamerasWSResponse" : { + "type" : "object", + "description" : "Response object for importing third-party cameras.", + "properties" : { + "importResults" : { + "type" : "array", + "description" : "List of import results for third-party cameras", + "items" : { + "$ref" : "#/components/schemas/Relay_ThirdPartyCameraImportResult" + }, + "nullable" : true + }, + "messages" : { + "type" : "array", + "description" : "List of messages from the import operation", + "items" : { + "type" : "string", + "description" : "List of messages from the import operation", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Relay_IpProbeResultType" : { + "type" : "object", + "description" : "Result of probing a single IP address during third-party camera discovery.", + "properties" : { + "acceptedUsername" : { + "type" : "string", + "description" : "Username of the credentials that succeeded, if any.", + "nullable" : true + }, + "codec" : { + "type" : "string", + "description" : "Video codec(s) the device advertised over ONVIF (e.g. \"H264\"), if any.", + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "The probed IP address.", + "nullable" : true + }, + "macAddress" : { + "type" : "string", + "description" : "MAC address, if known.", + "nullable" : true + }, + "manufacturer" : { + "type" : "string", + "description" : "Manufacturer reported over ONVIF, if any.", + "nullable" : true + }, + "model" : { + "type" : "string", + "description" : "Model reported over ONVIF, if any.", + "nullable" : true + }, + "rtspFound" : { + "type" : "boolean", + "description" : "Whether an RTSP stream URI was obtained for this IP.", + "nullable" : true + }, + "source" : { + "type" : "string", + "description" : "How the IP was found: MULTICAST (WS-Discovery) or PORT_SCAN (554 open).", + "nullable" : true + }, + "status" : { + "type" : "string", + "description" : "ONVIF probe outcome: GOOD, NOT_SUPPORTED, NOT_AUTHENTICATED, NO_ONVIF, NOT_REACHABLE.", + "nullable" : true + }, + "statusDetail" : { + "type" : "string", + "description" : "Human-readable detail about the outcome — especially why a device that responded to ONVIF wasn't usable.", + "nullable" : true + } + } + }, + "Relay_ManualDiscoverThirdPartyCameraWSRequest" : { + "type" : "object", + "description" : "Request object for manually discovering a third-party camera with RTSP URL.", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", + "example" : "password123", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "The RTSP URL of the third-party camera being manually added. This RTSP URL should reference a stream that provides H.264 encoded video", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + }, + "trySavedCredentials" : { + "type" : "boolean", + "description" : "Whether the third-party credentials saved in the account should be used when trying to validate whether the provided RTSP URL is valid", + "example" : false, + "nullable" : true + }, + "username" : { + "type" : "string", + "description" : "Username to access the RTSP URL. This field MUST be non-empty if trySavedCredentials is false", + "example" : "admin", + "nullable" : true + } + } + }, + "Relay_ManualDiscoverThirdPartyCameraWSResponse" : { + "type" : "object", + "description" : "Response object for manually discovering a third-party camera with RTSP URL.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "result" : { + "$ref" : "#/components/schemas/DiscoveredThirdPartyCameraType" + }, + "rtspUrlStatus" : { + "$ref" : "#/components/schemas/UrlStatusEnum" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_MinimalThirdPartyCameraStateType" : { + "type" : "object", + "description" : "Minimal third-party camera state information.", + "properties" : { + "assignedNVRUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "assignedRelayCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "codec" : { + "type" : "string", + "description" : "Codec used by the third-party camera", + "example" : "H.264", + "nullable" : true + }, + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "defaultInterface" : { + "type" : "string", + "nullable" : true + }, + "defaultInterfaceMac" : { + "type" : "string", + "nullable" : true + }, + "directionRadians" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "discoveredByDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "externalIPAddress" : { + "type" : "string", + "nullable" : true + }, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "firmwareUpdateInProgress" : { + "type" : "boolean", + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "lastRtspUrlStatus" : { + "$ref" : "#/components/schemas/UrlStatusEnum" + }, + "lastVisibleLocationMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "Map of location UUID to last time this third-party device was known to be visible", + "nullable" : true + }, + "description" : "Map of location UUID to last time this third-party device was known to be visible", + "nullable" : true + }, + "lastVisibleMs" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "Map of device UUID to last time this third-party device was known to be visible", + "nullable" : true + }, + "description" : "Map of device UUID to last time this third-party device was known to be visible", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "liveStreamShared" : { + "type" : "boolean", + "nullable" : true + }, + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "manufacturer" : { + "type" : "string", + "description" : "Manufacturer of the third-party camera", + "example" : "Hikvision", + "nullable" : true + }, + "mediaRegion" : { + "type" : "string", + "nullable" : true + }, + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "model" : { + "type" : "string", + "description" : "Model of the third-party camera", + "example" : "DS-2CD2142FWD-I", + "nullable" : true + }, + "mummified" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "region" : { + "type" : "string", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "RTSP URL for the third-party camera stream", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + }, + "secondaryLanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "nullable" : true + }, + "ssid" : { + "type" : "string", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "wifiApMac" : { + "type" : "string", + "nullable" : true + }, + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Relay_NVRExternalType" : { + "type" : "object", + "description" : "External NVR type.", + "properties" : { + "archiveRegion" : { + "type" : "string", + "nullable" : true + }, + "cameraFramerate" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "customData" : { + "type" : "string", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "deviceFacetRadians" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "nullable" : true + }, + "directionRadians" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "facetNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "mediaRegion" : { + "type" : "string", + "nullable" : true + }, + "mediaRegionHistory" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaRegionHistoryEntryType" + }, + "nullable" : true + }, + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "mediaStorageDeviceUuidByFacet" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "mummified" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "pending" : { + "type" : "boolean", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "primaryLinkSpeedMbps" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "secondaryLinkSpeedMbps" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "totalStreamingPixels" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "unregisteredEmailSent" : { + "type" : "boolean", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_NvrScanProgressType" : { + "type" : "object", + "description" : "Live scan progress for a single Relay (NVR) within a discovery run.", + "properties" : { + "camerasFound" : { + "type" : "integer", + "format" : "int32", + "description" : "Cameras discovered by this Relay so far.", + "nullable" : true + }, + "currentIp" : { + "type" : "string", + "description" : "IP currently being probed, if any.", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "description" : "Error message if this Relay's scan failed.", + "nullable" : true + }, + "ipResults" : { + "type" : "array", + "description" : "Per-IP probe results for troubleshooting.", + "items" : { + "$ref" : "#/components/schemas/Relay_IpProbeResultType" + }, + "nullable" : true + }, + "ipResultsTruncated" : { + "type" : "boolean", + "description" : "True if ipResults was capped (more IPs were probed than are listed).", + "nullable" : true + }, + "ipsProbed" : { + "type" : "integer", + "format" : "int32", + "description" : "IPs probed so far in the current phase.", + "nullable" : true + }, + "ipsTotal" : { + "type" : "integer", + "format" : "int32", + "description" : "IPs to ONVIF-probe in the current phase (0 while the phase is opaque, e.g. nmap).", + "nullable" : true + }, + "nvrUuid" : { + "type" : "string", + "description" : "Relay (NVR) uuid this progress is for.", + "nullable" : true + }, + "phase" : { + "type" : "string", + "description" : "DISCOVERING | PORT_SCANNING | PROBING | COMPLETE | FAILED.", + "nullable" : true + }, + "scannedCidrs" : { + "type" : "array", + "description" : "Subnets/CIDRs being scanned (meaningful during the opaque port-scan phase).", + "items" : { + "type" : "string", + "description" : "Subnets/CIDRs being scanned (meaningful during the opaque port-scan phase).", + "nullable" : true + }, + "nullable" : true + }, + "updatedMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Epoch millis this progress was last updated.", + "nullable" : true + } + } + }, + "Relay_PTZMoveWSRequest" : { + "type" : "object", + "description" : "Request object for moving a PTZ camera.", + "properties" : { + "thirdPartyCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "xmovementPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "X-axis movement in permyriad units", + "example" : 1000, + "nullable" : true + }, + "ymovementPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Y-axis movement in permyriad units", + "example" : 1000, + "nullable" : true + }, + "zmovementPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Z-axis movement in permyriad units", + "example" : 1000, + "nullable" : true + } + } + }, + "Relay_PTZMoveWSResponse" : { + "type" : "object", + "description" : "Response object for moving a PTZ camera.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_PTZStatusWSRequest" : { + "type" : "object", + "description" : "Request object for getting PTZ status of a camera.", + "properties" : { + "thirdPartyCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_PTZStatusWSResponse" : { + "type" : "object", + "description" : "Response object containing PTZ status of a camera.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "xpositionPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Current X-axis position in permyriad units", + "example" : 5000, + "nullable" : true + }, + "ypositionPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Current Y-axis position in permyriad units", + "example" : 5000, + "nullable" : true + }, + "zpositionPermyriad" : { + "type" : "integer", + "format" : "int32", + "description" : "Current Z-axis position in permyriad units", + "example" : 5000, + "nullable" : true + } + } + }, + "Relay_RebootNVRVWSRequest" : { + "type" : "object", + "description" : "Request object for rebooting an NVR.", + "properties" : { + "nvrUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_RebootNVRVWSResponse" : { + "type" : "object", + "description" : "Response object for rebooting an NVR.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "result" : { + "$ref" : "#/components/schemas/Common_devices_RebootDeviceWSResponse_RebootResult" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_ThirdPartyCameraImportResult" : { + "type" : "object", + "description" : "Result of importing a third-party camera.", + "properties" : { + "discoveredThirdPartyCamera" : { + "$ref" : "#/components/schemas/DiscoveredThirdPartyCameraType" + }, + "message" : { + "type" : "string", + "description" : "Message describing the import result", + "example" : "Successfully imported camera", + "nullable" : true + }, + "rtspUrl" : { + "type" : "string", + "description" : "RTSP URL that was imported", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + }, + "urlStatus" : { + "$ref" : "#/components/schemas/UrlStatusEnum" + } + } + }, + "Relay_UnassignThirdPartyCameraWSRequest" : { + "type" : "object", + "description" : "Request object for unassigning a third-party camera from an NVR.", + "properties" : { + "rtspUrl" : { + "type" : "string", + "description" : "RTSP URL of the camera to unassign", + "example" : "rtsp://192.168.1.100:554/stream1", + "nullable" : true + }, + "thirdPartyCameraMacAddress" : { + "type" : "string", + "description" : "MAC address of the third-party camera to unassign", + "nullable" : true + }, + "thirdPartyCameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_UnassignThirdPartyCameraWSResponse" : { + "type" : "object", + "description" : "Response object for unassigning a third-party camera from an NVR.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_UnregisterNVRWSRequest" : { + "type" : "object", + "description" : "Request object for unregistering an NVR from the system.", + "properties" : { + "nvruuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_UnregisterNVRWSResponse" : { + "type" : "object", + "description" : "Response object for unregistering an NVR from the system.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_UpdateFirmwareWSStatus" : { + "type" : "string", + "description" : "Status enumeration for firmware update web service responses.", + "enum" : [ "ALREADY_ON_THE_LATEST_FIRMWARE", "DEVICE_ON_A_SPECIAL_FIRMWARE_AND_CANNOT_BE_UPDATED", "UPDATE_STARTED", "UNABLE_TO_REACH_DEVICE", "FIRMWARE_UPDATE_ALREADY_IN_PROGESS", "DEVICE_NOT_AUTHROIZED" ] + }, + "Relay_UpdateNVRFirmwareWSRequest" : { + "type" : "object", + "description" : "Request object for updating NVR firmware.", + "properties" : { + "nvruuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_UpdateNVRFirmwareWSResponse" : { + "type" : "object", + "description" : "Response object for updating NVR firmware.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/Relay_UpdateFirmwareWSStatus" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Relay_UpdateNVRWSRequest" : { + "type" : "object", + "description" : "Request object for updating NVR details.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description of the NVR", + "example" : "Primary NVR for main building", + "nullable" : true + }, + "descriptionUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "directionRadians" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "directionRadiansUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "floorNumberUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "latitudeUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationUuidUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "longitudeUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the NVR", + "example" : "Main NVR", + "nullable" : true + }, + "nameUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Relay_UpdateNVRWSResponse" : { + "type" : "object", + "description" : "Response object for updating NVR details.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "RemoteDoorUnlockActionType" : { + "type" : "object", + "properties" : { + "doorId" : { + "type" : "string", + "nullable" : true + }, + "placeId" : { + "type" : "string", + "nullable" : true + }, + "system" : { + "$ref" : "#/components/schemas/RemoteDoorUnlockSystemEnum" + } + } + }, + "RemoteDoorUnlockSystemEnum" : { + "type" : "string", + "enum" : [ "BRIVO", "OPENPATH", "KISI", "PLACEOS", "GENEA", "PDK", "INNER_RANGE", "RHOMBUS", "HONEYWELL_ELEMENTS", "UNKNOWN" ] + }, + "RemoveAccessUpdate" : { + "type" : "object", + "allOf" : [ ], + "nullable" : true, + "properties" : { + "action" : { + "$ref" : "#/components/schemas/GuestInviteAccessActionEnum" + } + }, + "required" : [ "action" ] + }, + "RenewalClaimKey" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "entries" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ClaimKeyEntry" + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "claimEndDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date/time when claiming of licenses represented by this claim key ended successfully.", + "nullable" : true + }, + "claimStartDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date/time when claiming of licenses represented by this claim key started.", + "nullable" : true + }, + "createdOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "expirationEmailState" : { + "$ref" : "#/components/schemas/ClaimKeyExpirationEmailStateEnum" + }, + "gracePeriodEndDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "maskedClaimCode" : { + "type" : "string", + "description" : "Masked claim code for redeemed claim keys. This field can be used for reference purposes.", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "renewedByClaimKeyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "requestId" : { + "type" : "string", + "description" : "Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.", + "nullable" : true + }, + "returnHistory" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClaimKeyReturnEvent" + }, + "nullable" : true + }, + "state" : { + "$ref" : "#/components/schemas/ClaimKeyStateEnum" + }, + "trial" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ClaimKeyTypeEnum" + }, + "updatedOn" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ReportBucketSizeEnum" : { + "type" : "string", + "description" : "Size of the report buckets", + "enum" : [ "QUARTER_HOUR", "HOUR", "DAY", "WEEK", "MONTH" ] + }, + "ReportContributor" : { + "type" : "object", + "description" : "A user who has contributed to an incident report.", + "properties" : { + "userName" : { + "type" : "string", + "description" : "Name of the user, refreshed each time they contribute to the report.", + "nullable" : true + } + } + }, + "ReportIntervalEnum" : { + "type" : "string", + "description" : "Report interval for filtering face events", + "enum" : [ "MINUTELY", "QUARTERHOURLY", "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ] + }, + "ReportLookbackTypeEnum" : { + "type" : "string", + "enum" : [ "ROLLING", "PREVIOUS_DAY", "PREVIOUS_WEEK", "PREVIOUS_MONTH" ] + }, + "ReportLookbackUnitEnum" : { + "type" : "string", + "enum" : [ "HOURS", "DAYS", "WEEKS" ] + }, + "ReportScopeEnum" : { + "type" : "string", + "description" : "Scope of the report to reset", + "enum" : [ "REGION", "DEVICE", "LOCATION", "ORG" ] + }, + "ReportTypeEnum" : { + "type" : "string", + "description" : "Type of report to receive", + "enum" : [ "CROWD", "PEOPLE", "FACES", "MOTION", "BANDWIDTH", "VEHICLES", "LICENSEPLATES", "ALERTS", "DWELL" ] + }, + "Report_AuditEventWeb" : { + "type" : "object", + "description" : "Web representation of an audit event.", + "properties" : { + "action" : { + "$ref" : "#/components/schemas/AuditActionEnum" + }, + "asi" : { + "type" : "string", + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/ClientEnum" + }, + "displayText" : { + "type" : "string", + "description" : "Display text for the audit event", + "example" : "User login successful", + "nullable" : true + }, + "failure" : { + "type" : "boolean", + "description" : "Whether the audit event represents a failure", + "example" : false, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "principalName" : { + "type" : "string", + "nullable" : true + }, + "principalType" : { + "$ref" : "#/components/schemas/PrincipalUuidEnum" + }, + "principalUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "selectiveUpdateStr" : { + "type" : "string", + "nullable" : true + }, + "sourceCity" : { + "type" : "string", + "nullable" : true + }, + "sourceCountry" : { + "type" : "string", + "nullable" : true + }, + "sourceIp" : { + "type" : "string", + "nullable" : true + }, + "sourceState" : { + "type" : "string", + "nullable" : true + }, + "targetName" : { + "type" : "string", + "nullable" : true + }, + "targetUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "userAgent" : { + "type" : "string", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Report_GetAuditFeedForPrincipalWSRequest" : { + "type" : "object", + "description" : "Request object for getting audit feed for a specific principal.", + "properties" : { + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Max number of audit records to retrieve", + "nullable" : true + }, + "principalUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "principalUuid" ] + }, + "Report_GetAuditFeedForPrincipalWSResponse" : { + "type" : "object", + "description" : "Response object for getting audit feed for a specific principal.", + "properties" : { + "auditEvents" : { + "type" : "array", + "description" : "List of audit events for the principal", + "items" : { + "$ref" : "#/components/schemas/Report_AuditEventWeb" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetAuditFeedForTargetWSRequest" : { + "type" : "object", + "description" : "Request object for getting audit feed for a specific target.", + "properties" : { + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Max number of audit records to retrieve", + "nullable" : true + }, + "targetUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "targetUuid" ] + }, + "Report_GetAuditFeedForTargetWSResponse" : { + "type" : "object", + "description" : "Response object for getting audit feed for a specific target.", + "properties" : { + "auditEvents" : { + "type" : "array", + "description" : "List of audit events for the target", + "items" : { + "$ref" : "#/components/schemas/Report_AuditEventWeb" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetAuditFeedWSRequest" : { + "type" : "object", + "description" : "Request object for getting audit feed.", + "properties" : { + "excludeActions" : { + "type" : "array", + "description" : "If not empty, events with actions specified in the list are filtered out. If both include and exclude actions are specified, exclude actions are ignored.", + "items" : { + "$ref" : "#/components/schemas/AuditActionEnum" + }, + "maxItems" : 50, + "nullable" : true + }, + "includeActions" : { + "type" : "array", + "description" : "If not empty, only events with actions specified in the list are returned. If both include and exclude actions are specified, exclude actions are ignored. ", + "items" : { + "$ref" : "#/components/schemas/AuditActionEnum" + }, + "maxItems" : 50, + "nullable" : true + }, + "timestampMsAfter" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds after which to get audit events", + "example" : 1640995200000, + "nullable" : true + }, + "timestampMsBefore" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds before which to get audit events", + "example" : 1640998800000, + "nullable" : true + } + } + }, + "Report_GetAuditFeedWSResponse" : { + "type" : "object", + "description" : "Response object for getting audit feed.", + "properties" : { + "auditEvents" : { + "type" : "array", + "description" : "List of audit events", + "items" : { + "$ref" : "#/components/schemas/Report_AuditEventWeb" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetAverageReportWSRequest" : { + "type" : "object", + "description" : "Request object for getting average reports.", + "properties" : { + "endDate" : { + "type" : "string", + "description" : "End date for the report", + "example" : "2024-01-31", + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "description" : "Start date for the report", + "example" : "2024-01-01", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Report_GetAverageReportWSResponse" : { + "type" : "object", + "description" : "Response object for getting average reports.", + "properties" : { + "average" : { + "type" : "number", + "format" : "double", + "description" : "Overall average value", + "example" : 15.5, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "groupAverageMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "description" : "Map of group IDs to their average values", + "nullable" : true + }, + "description" : "Map of group IDs to their average values", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetAverageReportsWSRequest" : { + "type" : "object", + "description" : "Request object for getting average reports.", + "properties" : { + "endDate" : { + "type" : "string", + "description" : "End date for the report", + "example" : "2024-01-31", + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "description" : "Start date for the report", + "example" : "2024-01-01", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + } + } + }, + "Report_GetAverageReportsWSResponse" : { + "type" : "object", + "description" : "Response object for getting average reports.", + "properties" : { + "averageMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "description" : "Map of UUIDs to their average values", + "nullable" : true + }, + "description" : "Map of UUIDs to their average values", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "groupAverageMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "description" : "Map of UUIDs to their group average maps", + "nullable" : true + }, + "description" : "Map of UUIDs to their group average maps", + "nullable" : true + }, + "description" : "Map of UUIDs to their group average maps", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetBatchThresholdCrossingCountReportWSRequest" : { + "type" : "object", + "description" : "Request object for getting batch threshold crossing count reports.", + "properties" : { + "bucketSize" : { + "$ref" : "#/components/schemas/ReportBucketSizeEnum" + }, + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "dedupe" : { + "type" : "boolean", + "description" : "Whether to deduplicate the results", + "example" : true, + "nullable" : true + }, + "deviceUuids" : { + "type" : "array", + "description" : "UUID of devices to get threshold crossing count report for", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "example" : 1640998800000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + } + } + }, + "Report_GetCountReportV2WSRequest" : { + "type" : "object", + "description" : "Request object for getting count reports V2.", + "properties" : { + "endDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use endTimeMs instead", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use startTimeMs instead", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + }, + "types" : { + "type" : "array", + "description" : "Types of reports to receive", + "items" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + }, + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "interval", "scope", "types" ] + }, + "Report_GetCountReportWSRequest" : { + "type" : "object", + "description" : "Request object for getting count reports.", + "properties" : { + "endDate" : { + "type" : "string", + "description" : "End date for the report", + "example" : "2024-01-31", + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "description" : "Start date for the report", + "example" : "2024-01-01", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Report_GetCountReportWSResponse" : { + "type" : "object", + "description" : "Response object for getting count reports.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "timeSeriesDataPoints" : { + "type" : "array", + "description" : "List of time series data points for count report", + "items" : { + "$ref" : "#/components/schemas/TimeSeriesDataPointV2Type" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetCountReportsForDevicesAtLocationWSRequest" : { + "type" : "object", + "description" : "Request object for getting count reports for devices at a specific location.", + "properties" : { + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End timestamp in epoch milliseconds.", + "minimum" : 0, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start timestamp in epoch milliseconds.", + "minimum" : 0, + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + } + }, + "required" : [ "endTimeMs", "interval", "locationUuid", "startTimeMs", "type" ] + }, + "Report_GetCountReportsWSRequest" : { + "type" : "object", + "description" : "Request object for getting count reports.", + "properties" : { + "endDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use endTimeMs instead", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use startTimeMs instead", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + } + }, + "required" : [ "interval", "scope", "type" ] + }, + "Report_GetCountReportsWSResponse" : { + "type" : "object", + "description" : "Response object for getting count reports.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "timeSeriesDataPointsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of UUIDs to their time series data points", + "items" : { + "$ref" : "#/components/schemas/TimeSeriesDataPointV2Type" + }, + "nullable" : true + }, + "description" : "Map of UUIDs to their time series data points", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetCustomLLMNumericWSResponse" : { + "type" : "object", + "description" : "Response object for custom LLM numeric reports.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "reports" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of numeric count reports", + "items" : { + "$ref" : "#/components/schemas/NumericAggregationValue" + }, + "nullable" : true + }, + "description" : "Map of numeric count reports", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetCustomLLMReportWSRequest" : { + "type" : "object", + "description" : "Request object for custom LLM reports.", + "properties" : { + "deviceFacetUuids" : { + "type" : "array", + "description" : "Uuids of the selected devices", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The end timestamp (in Unix epoch milliseconds) of the selected interval", + "example" : 1640998800000, + "nullable" : true + }, + "extendedResponse" : { + "type" : "boolean", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The start timestamp (in Unix epoch milliseconds) of the selected interval", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetCustomLLMReportWSResponse" : { + "type" : "object", + "description" : "Response object for custom LLM reports.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "timeSeriesDataPoints" : { + "type" : "array", + "description" : "List of time series data points", + "items" : { + "$ref" : "#/components/schemas/SceneQueryReport" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetCustomLLMWBinaryWSResponse" : { + "type" : "object", + "description" : "Response object for custom LLM binary reports.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "reports" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of binary count reports", + "items" : { + "$ref" : "#/components/schemas/BinaryAggregationValue" + }, + "nullable" : true + }, + "description" : "Map of binary count reports", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetCustomLLMWSRequest" : { + "type" : "object", + "description" : "Request object for custom LLM reports.", + "properties" : { + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The end timestamp (in Unix epoch milliseconds) of the selected interval", + "example" : 1640998800000, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The start timestamp (in Unix epoch milliseconds) of the selected interval", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetDiagnosticFeedWSRequest" : { + "type" : "object", + "description" : "Request object for getting diagnostic feed.", + "properties" : { + "timestampMsAfter" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds after which to get diagnostic events", + "example" : 1640995200000, + "nullable" : true + }, + "timestampMsBefore" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds before which to get diagnostic events", + "example" : 1640998800000, + "nullable" : true + } + } + }, + "Report_GetDiagnosticFeedWSResponse" : { + "type" : "object", + "description" : "Response object for getting diagnostic feed.", + "properties" : { + "diagnosticEvents" : { + "type" : "array", + "description" : "List of diagnostic events", + "items" : { + "$ref" : "#/components/schemas/DiagnosticEventType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetLicensePlatesByDeviceWSRequest" : { + "type" : "object", + "description" : "Request object for getting license plates by device.", + "properties" : { + "dateLocal" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use timestampMs instead", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + } + }, + "required" : [ "deviceUuid", "interval" ] + }, + "Report_GetLicensePlatesByDeviceWSResponse" : { + "type" : "object", + "description" : "Response object for getting license plates by device.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "licensePlateEvents" : { + "type" : "array", + "description" : "List of license plate events", + "items" : { + "$ref" : "#/components/schemas/VehicleEventIndexType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetOccupancyCountWSRequest" : { + "type" : "object", + "description" : "Request object for getting occupancy count from a device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "endMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "example" : 1640998800000, + "nullable" : true + }, + "startMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetOccupancyCountWSResponse" : { + "type" : "object", + "description" : "Response object for getting occupancy count from a device.", + "properties" : { + "approximateTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Approximate timestamp in milliseconds when the count was estimated", + "example" : 1640995200000, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "estimatedCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Estimated occupancy count", + "example" : 15, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetOccupancyCountsWSRequest" : { + "type" : "object", + "description" : "Request object for getting occupancy counts from a device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The end timestamp (in Unix epoch milliseconds) of the selected interval", + "example" : 1640998800000, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The start timestamp (in Unix epoch milliseconds) of the selected interval", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetOccupancyCountsWSResponse" : { + "type" : "object", + "description" : "Response object for getting occupancy counts from a device.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "timeSeriesDataPoints" : { + "type" : "array", + "description" : "List of time series data points with occupancy counts", + "items" : { + "$ref" : "#/components/schemas/Report_TimeSeriesDataPointV2ExtendedType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetProximityTagLocationsByDateWSRequest" : { + "type" : "object", + "description" : "Request object for getting proximity tag locations by date.", + "properties" : { + "endDateStr" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use endTimeMs instead", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "startDateStr" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use startTimeMs instead", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "tagUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "tagUuid" ] + }, + "Report_GetProximityTagLocationsByDateWSResponse" : { + "type" : "object", + "description" : "Response object for getting proximity tag locations by date.", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List of proximity tag time series data points", + "items" : { + "$ref" : "#/components/schemas/ProximityTagTimeSeriesDataPointType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetRunningAverageWSRequest" : { + "type" : "object", + "description" : "Request object for getting running average statistics.", + "properties" : { + "endDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use endTimeMs instead", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use startTimeMs instead", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "interval", "scope" ] + }, + "Report_GetRunningAverageWSResponse" : { + "type" : "object", + "description" : "Response object for getting running average statistics.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "statsDataPoints" : { + "type" : "array", + "description" : "List of weekly statistics data points", + "items" : { + "$ref" : "#/components/schemas/WeeklyStatisticsDataPoint" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetSummaryCountReportWSRequest" : { + "type" : "object", + "description" : "Request object for getting summary count reports.", + "properties" : { + "endDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use endTimeMs instead", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "interval" : { + "$ref" : "#/components/schemas/ReportIntervalEnum" + }, + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "startDate" : { + "type" : "string", + "deprecated" : true, + "description" : "Deprecated input, use startTimeMs instead", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start datetime provided as a UNIX timestamp in milliseconds", + "minimum" : 0, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ReportTypeEnum" + } + }, + "required" : [ "interval", "scope", "type" ] + }, + "Report_GetSummaryCountReportWSResponse" : { + "type" : "object", + "description" : "Response object for getting summary count reports.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "timeSeriesDataPoints" : { + "type" : "array", + "description" : "List of summary count time series data points", + "items" : { + "$ref" : "#/components/schemas/SummaryCountTimeSeriesDataPointType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingCountReportForOrgWSRequest" : { + "type" : "object", + "description" : "Request object for getting org wide threshold crossing count reports.", + "properties" : { + "bucketSize" : { + "$ref" : "#/components/schemas/ReportBucketSizeEnum" + }, + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "dedupe" : { + "type" : "boolean", + "description" : "Whether to deduplicate the results", + "example" : true, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "example" : 1640998800000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingCountReportWSRequest" : { + "type" : "object", + "description" : "Request object for getting threshold crossing count reports.", + "properties" : { + "bucketSize" : { + "$ref" : "#/components/schemas/ReportBucketSizeEnum" + }, + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "dedupe" : { + "type" : "boolean", + "description" : "Whether to deduplicate the results", + "example" : true, + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "example" : 1640998800000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "timeZone" : { + "type" : "string", + "description" : "String of timezone for bucketing", + "example" : "America/Los_Angeles", + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingCountReportWSResponse" : { + "type" : "object", + "description" : "Response object for getting threshold crossing count reports.", + "properties" : { + "crossingCounts" : { + "type" : "array", + "description" : "List of crossing counts", + "items" : { + "$ref" : "#/components/schemas/CrossingCountsType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingCountsWSRequest" : { + "type" : "object", + "description" : "Request object for getting threshold crossing counts.", + "properties" : { + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "dailyResetTimeMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Daily reset time in minutes", + "example" : 0, + "nullable" : true + }, + "devices" : { + "type" : "array", + "description" : "List of device UUIDs to get threshold crossing counts for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "example" : 1640998800000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingCountsWSResponse" : { + "type" : "object", + "description" : "Response object for getting threshold crossing counts.", + "properties" : { + "counts" : { + "type" : "array", + "description" : "List of threshold crossing counts", + "items" : { + "$ref" : "#/components/schemas/Report_GetThresholdCrossingCountsWSResponse_ThresholdCrossingCountType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingCountsWSResponse_ThresholdCrossingCountType" : { + "type" : "object", + "description" : "Threshold crossing count data point.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Count of threshold crossings", + "example" : 5, + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingEventsForDeviceWSRequest" : { + "type" : "object", + "description" : "Request object for getting threshold crossing events for a specific device.", + "properties" : { + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End timestamp of query period in epoch MS", + "example" : 1640998800000, + "nullable" : true + }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "Should be null on first request and populated on subsequent requests if provided in the response to retrieve the next page", + "nullable" : true + }, + "maxPageSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Max number of results to return. Response's lastEvaluatedKey will be null if no additional results are available", + "example" : 100, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start timestamp of query period in epoch MS", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingEventsForDeviceWSResponse" : { + "type" : "object", + "description" : "Response object for getting threshold crossing events for a specific device.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "lastEvaluatedKey" : { + "type" : "string", + "description" : "If a max page size was specified and there are additional results that can be retrieved this will be non-null and should be supplied in the next request to retrieve the next page of results", + "nullable" : true + }, + "thresholdCrossingEvents" : { + "type" : "array", + "description" : "List of threshold crossing events for the device", + "items" : { + "$ref" : "#/components/schemas/MinimalThresholdEventType" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingEventsWSRequest" : { + "type" : "object", + "description" : "Request object for getting threshold crossing events.", + "properties" : { + "crossingObject" : { + "$ref" : "#/components/schemas/CrossingObjectEnum" + }, + "devices" : { + "type" : "array", + "description" : "List of device UUIDs to get threshold crossing events for", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End time in milliseconds", + "example" : 1640998800000, + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Report_GetThresholdCrossingEventsWSResponse" : { + "type" : "object", + "description" : "Response object for getting threshold crossing events.", + "properties" : { + "deviceToThresholdCrossingEventMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of device UUIDs to their threshold crossing events", + "items" : { + "$ref" : "#/components/schemas/MinimalThresholdEventType" + }, + "nullable" : true + }, + "description" : "Map of device UUIDs to their threshold crossing events", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_ResetRunningAverageWSRequest" : { + "type" : "object", + "description" : "Request object for resetting running average.", + "properties" : { + "scope" : { + "$ref" : "#/components/schemas/ReportScopeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Report_ResetRunningAverageWSResponse" : { + "type" : "object", + "description" : "Response object for resetting running average.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Report_TimeSeriesDataPointV2ExtendedType" : { + "type" : "object", + "description" : "Extended time series data point with additional timestamp information.", + "properties" : { + "approximateTimestampMsMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "A mapping of timestamps (in Unix epoch milliseconds) that indicate, for each type and interval, the point in time where the aggregated occupancy count is closest to the occupancy observed in the corresponding video segment", + "nullable" : true + }, + "description" : "A mapping of timestamps (in Unix epoch milliseconds) that indicate, for each type and interval, the point in time where the aggregated occupancy count is closest to the occupancy observed in the corresponding video segment", + "nullable" : true + }, + "dateLocal" : { + "type" : "string", + "nullable" : true + }, + "dateUtc" : { + "type" : "string", + "nullable" : true + }, + "eventCountMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "nullable" : true + }, + "reportingDevicesMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "The representative timestamp (in Unix epoch milliseconds) for the interval", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "RequestToExitEnumType" : { + "type" : "string", + "enum" : [ "integrated", "remote" ] + }, + "RequestToExitPhysicalPortEnumType" : { + "type" : "string", + "enum" : [ "GPIO_INPUT", "GPIO_INPUT_SUPERVISED" ] + }, + "RequestToExitPortType" : { + "type" : "object", + "properties" : { + "boardNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "portNum" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "portType" : { + "$ref" : "#/components/schemas/RequestToExitPhysicalPortEnumType" + }, + "supervisionConfiguration" : { + "$ref" : "#/components/schemas/PortSupervisionConfigurationType" + } + } + }, + "RequestToExitShadowType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "state" : { + "$ref" : "#/components/schemas/RequestToExitStateEnumType" + }, + "stateUpdateEventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "supervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "RequestToExitStateChangeEventType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "intentOnly" : { + "type" : "boolean", + "nullable" : true + }, + "newState" : { + "$ref" : "#/components/schemas/RequestToExitStateEnumType" + }, + "newSupervisionState" : { + "$ref" : "#/components/schemas/SupervisionStateEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "correlationId" : { + "type" : "string", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RequestToExitStateEnumType" : { + "type" : "string", + "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] + }, + "RequestedBy" : { + "type" : "object", + "properties" : { + "email" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "principalType" : { + "$ref" : "#/components/schemas/RequestedByPrincipalTypeEnum" + } + } + }, + "RequestedByPrincipalTypeEnum" : { + "type" : "string", + "enum" : [ "USER", "API_TOKEN", "RHOMBUS_SUPPORT", "PARTNER_SUPPORT", "UNKNOWN" ] + }, + "Resolution" : { + "type" : "object", + "properties" : { + "height" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "width" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "Response" : { + "type" : "object", + "nullable" : true, + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "closed" : { + "type" : "boolean", + "nullable" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/NewCookie" + }, + "nullable" : true + }, + "date" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "entity" : { + "type" : "object", + "nullable" : true + }, + "entityTag" : { + "$ref" : "#/components/schemas/EntityTag" + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "language" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "length" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "links" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "nullable" : true, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri", + "nullable" : true + }, + "mediaType" : { + "$ref" : "#/components/schemas/MediaType" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "statusInfo" : { + "$ref" : "#/components/schemas/StatusType" + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "empty" : { + "type" : "boolean", + "nullable" : true + } + } + } + } + }, + "ResponseEntity" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "object", + "nullable" : true + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "accept" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaType" + }, + "nullable" : true + }, + "acceptCharset" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "registered" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "nullable" : true + }, + "acceptLanguage" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "range" : { + "type" : "string", + "nullable" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + } + }, + "nullable" : true + }, + "acceptLanguageAsLocales" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } + }, + "nullable" : true + }, + "acceptPatch" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaType" + }, + "nullable" : true + }, + "accessControlAllowCredentials" : { + "type" : "boolean", + "nullable" : true + }, + "accessControlAllowHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "accessControlAllowMethods" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "nullable" : true + }, + "accessControlAllowOrigin" : { + "type" : "string", + "nullable" : true + }, + "accessControlExposeHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "accessControlMaxAge" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "accessControlRequestHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "accessControlRequestMethod" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "all" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "writeOnly" : true + }, + "allow" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "nullable" : true, + "uniqueItems" : true + }, + "basicAuth" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "bearerAuth" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "cacheControl" : { + "type" : "string", + "nullable" : true + }, + "connection" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" + }, + "contentLanguage" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } + }, + "contentLength" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "contentType" : { + "$ref" : "#/components/schemas/MediaType" + }, + "date" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "empty" : { + "type" : "boolean", + "nullable" : true + }, + "etag" : { + "type" : "string", + "nullable" : true + }, + "expires" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "host" : { + "type" : "object", + "nullable" : true, + "properties" : { + "address" : { + "type" : "object", + "nullable" : true, + "properties" : { + "address" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "anyLocalAddress" : { + "type" : "boolean", + "nullable" : true + }, + "canonicalHostName" : { + "type" : "string", + "nullable" : true + }, + "hostAddress" : { + "type" : "string", + "nullable" : true + }, + "hostName" : { + "type" : "string", + "nullable" : true + }, + "linkLocalAddress" : { + "type" : "boolean", + "nullable" : true + }, + "loopbackAddress" : { + "type" : "boolean", + "nullable" : true + }, + "mcglobal" : { + "type" : "boolean", + "nullable" : true + }, + "mclinkLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcnodeLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcorgLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcsiteLocal" : { + "type" : "boolean", + "nullable" : true + }, + "multicastAddress" : { + "type" : "boolean", + "nullable" : true + }, + "siteLocalAddress" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "hostName" : { + "type" : "string", + "nullable" : true + }, + "hostString" : { + "type" : "string", + "nullable" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "unresolved" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "ifMatch" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "ifModifiedSince" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "ifNoneMatch" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "ifUnmodifiedSince" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastModified" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "location" : { + "type" : "string", + "format" : "uri", + "nullable" : true + }, + "origin" : { + "type" : "string", + "nullable" : true + }, + "pragma" : { + "type" : "string", + "nullable" : true + }, + "range" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpRange" + }, + "nullable" : true + }, + "upgrade" : { + "type" : "string", + "nullable" : true + }, + "vary" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + } + } + }, + "statusCode" : { + "$ref" : "#/components/schemas/HttpStatusCode" + }, + "statusCodeValue" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "ResponseEntityString" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "nullable" : true + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true, + "properties" : { + "accept" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaType" + }, + "nullable" : true + }, + "acceptCharset" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "registered" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "nullable" : true + }, + "acceptLanguage" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "range" : { + "type" : "string", + "nullable" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + } + }, + "nullable" : true + }, + "acceptLanguageAsLocales" : { + "type" : "array", + "items" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } + }, + "nullable" : true + }, + "acceptPatch" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MediaType" + }, + "nullable" : true + }, + "accessControlAllowCredentials" : { + "type" : "boolean", + "nullable" : true + }, + "accessControlAllowHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "accessControlAllowMethods" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "nullable" : true + }, + "accessControlAllowOrigin" : { + "type" : "string", + "nullable" : true + }, + "accessControlExposeHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "accessControlMaxAge" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "accessControlRequestHeaders" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "accessControlRequestMethod" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "all" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "writeOnly" : true + }, + "allow" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpMethod" + }, + "nullable" : true, + "uniqueItems" : true + }, + "basicAuth" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "bearerAuth" : { + "type" : "string", + "nullable" : true, + "writeOnly" : true + }, + "cacheControl" : { + "type" : "string", + "nullable" : true + }, + "connection" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" + }, + "contentLanguage" : { + "type" : "object", + "nullable" : true, + "properties" : { + "country" : { + "type" : "string", + "nullable" : true + }, + "displayCountry" : { + "type" : "string", + "nullable" : true + }, + "displayLanguage" : { + "type" : "string", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "displayScript" : { + "type" : "string", + "nullable" : true + }, + "displayVariant" : { + "type" : "string", + "nullable" : true + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string", + "nullable" : true + }, + "iso3Language" : { + "type" : "string", + "nullable" : true + }, + "language" : { + "type" : "string", + "nullable" : true + }, + "script" : { + "type" : "string", + "nullable" : true + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "variant" : { + "type" : "string", + "nullable" : true + } + } + }, + "contentLength" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "contentType" : { + "$ref" : "#/components/schemas/MediaType" + }, + "date" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "empty" : { + "type" : "boolean", + "nullable" : true + }, + "etag" : { + "type" : "string", + "nullable" : true + }, + "expires" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "host" : { + "type" : "object", + "nullable" : true, + "properties" : { + "address" : { + "type" : "object", + "nullable" : true, + "properties" : { + "address" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "anyLocalAddress" : { + "type" : "boolean", + "nullable" : true + }, + "canonicalHostName" : { + "type" : "string", + "nullable" : true + }, + "hostAddress" : { + "type" : "string", + "nullable" : true + }, + "hostName" : { + "type" : "string", + "nullable" : true + }, + "linkLocalAddress" : { + "type" : "boolean", + "nullable" : true + }, + "loopbackAddress" : { + "type" : "boolean", + "nullable" : true + }, + "mcglobal" : { + "type" : "boolean", + "nullable" : true + }, + "mclinkLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcnodeLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcorgLocal" : { + "type" : "boolean", + "nullable" : true + }, + "mcsiteLocal" : { + "type" : "boolean", + "nullable" : true + }, + "multicastAddress" : { + "type" : "boolean", + "nullable" : true + }, + "siteLocalAddress" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "hostName" : { + "type" : "string", + "nullable" : true + }, + "hostString" : { + "type" : "string", + "nullable" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "unresolved" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "ifMatch" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "ifModifiedSince" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "ifNoneMatch" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "ifUnmodifiedSince" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastModified" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "location" : { + "type" : "string", + "format" : "uri", + "nullable" : true + }, + "origin" : { + "type" : "string", + "nullable" : true + }, + "pragma" : { + "type" : "string", + "nullable" : true + }, + "range" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HttpRange" + }, + "nullable" : true + }, + "upgrade" : { + "type" : "string", + "nullable" : true + }, + "vary" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + } + } + }, + "statusCode" : { + "$ref" : "#/components/schemas/HttpStatusCode" + }, + "statusCodeValue" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, + "ResponseTypeEnum" : { + "type" : "string", + "enum" : [ "ANSWER", "REPORT", "FORM_FILL", "UNKNOWN" ] + }, + "ReturnTypeEnum" : { + "type" : "string", + "description" : "Type of return for the inventory audit (deprecated)", + "enum" : [ "TRIAL", "SALES", "RMA", "WARRANTY", "OTHER", "UNKNOWN" ] + }, + "RhombusAppEnum" : { + "type" : "string", + "enum" : [ "PARTNER", "CONSOLE", "RHOMBUS_KEY", "UNKNOWN" ] + }, + "RhombusDayOfWeekEnum" : { + "type" : "string", + "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] + }, + "RhombusGuestLocationAccessControlGuestPass" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "guestEmail" : { + "type" : "string", + "nullable" : true + }, + "guestUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "inviteToAccessPeriod" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "accessPeriods" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/LocationGuestPassAccessPeriod" + }, + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lifecycle" : { + "$ref" : "#/components/schemas/LocationGuestPassLifecycleEnum" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "passStartTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "principalType" : { + "$ref" : "#/components/schemas/LocationGuestPassPrincipalTypeEnum" + }, + "reconciledAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "reconciledVersion" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "sortKey" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "stampVersion" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "stampedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RhombusKeyAppConfigType" : { + "type" : "object", + "properties" : { + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "preferences" : { + "$ref" : "#/components/schemas/RhombusKeyAppPreferencesType" + }, + "rhombusOrgUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "settings" : { + "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "RhombusKeyAppPreferencesType" : { + "type" : "object", + "properties" : { + "favoriteAccessControlledDoorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "favoriteAccessControlledElevatorUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + } + } + }, + "RhombusKeyAppSettingsType" : { + "type" : "object", + "properties" : { + "bypassSaml" : { + "type" : "boolean", + "nullable" : true + }, + "credentialProvisioningRules" : { + "$ref" : "#/components/schemas/RhombusSecureMobileCredentialProvisioningRulesType" + }, + "remoteUnlockEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "rhombusKeyAccessEnabled" : { + "type" : "boolean", + "nullable" : true + } + } + }, + "RhombusOrgUserType" : { + "type" : "object", + "description" : "List of users in the organization for reports", + "properties" : { + "accessibleRhombusApps" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RhombusAppEnum" + }, + "nullable" : true, + "uniqueItems" : true + }, + "accountOwner" : { + "type" : "boolean", + "nullable" : true + }, + "bypassSaml" : { + "type" : "boolean", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "firstName" : { + "type" : "string", + "nullable" : true + }, + "lastName" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUserCustomizationFlags" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "restrictMobileSignInOverride" : { + "type" : "boolean", + "nullable" : true + }, + "restrictToAllowedLoginIps" : { + "type" : "boolean", + "nullable" : true + }, + "rhombusUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/UserStatusEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RhombusOsdpDoorReaderType" : { + "type" : "object", + "properties" : { + "allowCredsDuringUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "disableCardReader" : { + "type" : "boolean", + "nullable" : true + }, + "disableKeypad" : { + "type" : "boolean", + "nullable" : true + }, + "disableQrScanner" : { + "type" : "boolean", + "nullable" : true + }, + "disableWaveToUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "disposition" : { + "$ref" : "#/components/schemas/ReaderDispositionEnum" + }, + "hardwareUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "osdpAddress" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/OsdpReaderPortType" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "readerType" : { + "$ref" : "#/components/schemas/DoorReaderEnumType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "serialNumber" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RhombusSamlDomainEnum" : { + "type" : "string", + "enum" : [ "RHOMBUS_COM", "RHOMBUS_SYSTEMS_COM" ] + }, + "RhombusSecureCsnType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "algorithm" : { + "$ref" : "#/components/schemas/SecureTokenAlgorithmEnum" + }, + "baseKeyIdentifier" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastUsedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "managedCredUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "RhombusSecureMobileAppState" : { + "type" : "object", + "description" : "Updated mobile app state", + "properties" : { + "appName" : { + "type" : "string", + "nullable" : true + }, + "appNotifications" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "appOS" : { + "type" : "string", + "nullable" : true + }, + "appStatusUpdatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "appVersion" : { + "type" : "string", + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/MobileTokenOSEnum" + }, + "credentialUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "deviceModel" : { + "type" : "string", + "nullable" : true + }, + "installationId" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "tapToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "userAgent" : { + "type" : "string", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waveToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + } + } + }, + "RhombusSecureMobileAppStateStats" : { + "type" : "object", + "description" : "Mobile app state statistics", + "properties" : { + "tapToUnlockStats" : { + "$ref" : "#/components/schemas/RhombusSecureMobileCredStatRhombusSecureMobileFeatureStatus" + }, + "versionStats" : { + "$ref" : "#/components/schemas/RhombusSecureMobileCredStatString" + }, + "waveToUnlockStats" : { + "$ref" : "#/components/schemas/RhombusSecureMobileCredStatRhombusSecureMobileFeatureStatus" + } + } + }, + "RhombusSecureMobileCredStatRhombusSecureMobileFeatureStatus" : { + "type" : "object", + "properties" : { + "androidCredRefMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StatsCredentialReference" + }, + "nullable" : true + }, + "nullable" : true + }, + "androidTotal" : { + "type" : "integer", + "format" : "int64", + "nullable" : true, + "readOnly" : true + }, + "androidTotalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true, + "readOnly" : true + }, + "iphoneCredRefMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StatsCredentialReference" + }, + "nullable" : true + }, + "nullable" : true + }, + "iphoneTotal" : { + "type" : "integer", + "format" : "int32", + "nullable" : true, + "readOnly" : true + }, + "iphoneTotalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true, + "readOnly" : true + }, + "total" : { + "type" : "integer", + "format" : "int64", + "nullable" : true, + "readOnly" : true + } + } + }, + "RhombusSecureMobileCredStatString" : { + "type" : "object", + "properties" : { + "androidCredRefMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StatsCredentialReference" + }, + "nullable" : true + }, + "nullable" : true + }, + "androidTotal" : { + "type" : "integer", + "format" : "int64", + "nullable" : true, + "readOnly" : true + }, + "androidTotalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true, + "readOnly" : true + }, + "iphoneCredRefMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/StatsCredentialReference" + }, + "nullable" : true + }, + "nullable" : true + }, + "iphoneTotal" : { + "type" : "integer", + "format" : "int32", + "nullable" : true, + "readOnly" : true + }, + "iphoneTotalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true, + "readOnly" : true + }, + "total" : { + "type" : "integer", + "format" : "int64", + "nullable" : true, + "readOnly" : true + } + } + }, + "RhombusSecureMobileCredentialProvisioningRulesType" : { + "type" : "object", + "properties" : { + "endDateProvisioner" : { + "$ref" : "#/components/schemas/EpochSecondsProvisioner" + }, + "maxMobileCredsAllowed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "startDateProvisioner" : { + "$ref" : "#/components/schemas/EpochSecondsProvisioner" + } + } + }, + "RhombusSecureMobileFeature" : { + "type" : "object", + "nullable" : true, + "properties" : { + "settings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeatureSetting" + }, + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeatureStatusEnum" + } + } + }, + "RhombusSecureMobileFeatureSetting" : { + "type" : "object", + "nullable" : true, + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeatureSettingStatusEnum" + }, + "value" : { + "type" : "string", + "nullable" : true + } + } + }, + "RhombusSecureMobileFeatureSettingStatusEnum" : { + "type" : "string", + "enum" : [ "OPTIMAL", "INHIBITED" ] + }, + "RhombusSecureMobileFeatureStatusEnum" : { + "type" : "string", + "enum" : [ "OPT_OUT", "UNAVAILABLE", "OPTIMAL", "INHIBITED", "UNKNOWN" ] + }, + "RhombusSecureMobileType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "algorithm" : { + "$ref" : "#/components/schemas/SecureTokenAlgorithmEnum" + }, + "appName" : { + "type" : "string", + "nullable" : true + }, + "appNotifications" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "appOS" : { + "type" : "string", + "nullable" : true + }, + "appStatusUpdatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "appVersion" : { + "type" : "string", + "nullable" : true + }, + "baseKeyIdentifier" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "clientType" : { + "$ref" : "#/components/schemas/MobileTokenOSEnum" + }, + "deviceModel" : { + "type" : "string", + "nullable" : true + }, + "installationId" : { + "type" : "string", + "nullable" : true + }, + "tapToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + }, + "userAgent" : { + "type" : "string", + "nullable" : true + }, + "waveToUnlock" : { + "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + } + } + } ], + "nullable" : true, + "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastUsedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "managedCredUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "RhombusShipmentInfoType" : { + "type" : "object", + "nullable" : true, + "properties" : { + "additionalEmails" : { + "type" : "string", + "nullable" : true + }, + "chosenCarrierName" : { + "type" : "string", + "nullable" : true + }, + "claimKeyToLicenseMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "nullable" : true + }, + "claimKeyToLicenseMapV2" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SalesforceLicenseStartDateTimeAndEndDateTime" + }, + "nullable" : true + }, + "nullable" : true + }, + "customerEmails" : { + "type" : "string", + "nullable" : true + }, + "customerName" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "partnerOrgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "purchaseOrderNumber" : { + "type" : "string", + "nullable" : true + }, + "rmaReturnTrackingNumber" : { + "type" : "string", + "nullable" : true + }, + "rmaUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rmaUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "salesForceOpportunityId" : { + "type" : "string", + "nullable" : true + }, + "zendeskTicketNumber" : { + "type" : "string", + "nullable" : true + } + } + }, + "RhombusUserFidoCredential" : { + "type" : "object", + "description" : "If registration succeeded, this field will return non-sensitive metadata representing the newly registered WebAuthn credential. If registration failed it will be null.", + "properties" : { + "capability" : { + "$ref" : "#/components/schemas/CredentialCapabilityEnum" + }, + "capabilityConfirmedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "credentialId" : { + "type" : "string", + "nullable" : true + }, + "deleted" : { + "type" : "boolean", + "nullable" : true + }, + "displayName" : { + "type" : "string", + "nullable" : true + }, + "lastSeenInfoMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/LastSeenInfo" + }, + "nullable" : true + }, + "rhombusUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "signatureCounterUnreliable" : { + "type" : "boolean", + "nullable" : true + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "RingClaimResultEnum" : { + "type" : "string", + "description" : "Claim outcome: ANSWERED for the winning session, ANSWERED_ELSEWHERE, or EXPIRED.", + "enum" : [ "ANSWERED", "ANSWERED_ELSEWHERE", "EXPIRED" ] + }, + "RobotAction" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "DEPLOY" : "#/components/schemas/DeployRobotAction", + "UNKNOWN" : "#/components/schemas/NoOpAction" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DeployRobotAction" + }, { + "$ref" : "#/components/schemas/NoOpAction" + } ], + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/RobotActionTypeEnum" + } + } + }, + "RobotActionTypeEnum" : { + "type" : "string", + "enum" : [ "DEPLOY", "UNKNOWN" ] + }, + "RobotActivityEnum" : { + "type" : "string", + "enum" : [ "IDLE", "MANUAL_CMD_VEL", "MANUAL_ACTION", "MANUAL_POSTURE", "NAVIGATE_TO_POSE", "NAVIGATE_TO_HOME", "NAVIGATE_TO_WAYPOINT", "ROUTE_RUN", "LOW_BATTERY_DOCKING", "IDLE_DOCKING", "DWELLING", "EMERGENCY", "UNKNOWN" ] + }, + "RobotActivityEvent" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "waypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "activityEvent" : { + "$ref" : "#/components/schemas/ActivityEnum" + } + } + }, + "RobotEvent" : { + "type" : "object", + "nullable" : true, + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/RobotActivityEnum" + }, + "activity_uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "distance_remaining" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "estimated_time_remaining_sec" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "event" : { + "$ref" : "#/components/schemas/BehaviorEventTypeEnum" + }, + "failure_reason" : { + "type" : "string", + "nullable" : true + }, + "goal_pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "navigation_time_sec" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "originator" : { + "$ref" : "#/components/schemas/BaseEventOriginator" + }, + "phase" : { + "type" : "string", + "nullable" : true + }, + "phase_event" : { + "type" : "string", + "nullable" : true + }, + "phase_uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "preempted_by" : { + "$ref" : "#/components/schemas/PreemptedBy" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "robotUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "route_uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "started_at_ms" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypoint_index" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "waypoint_total" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "waypoint_uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RobotFloorPlan" : { + "type" : "object", + "properties" : { + "eastEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "northEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "rotation" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "southEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "westEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + } + }, + "RobotFloorPlan_Public" : { + "type" : "object", + "properties" : { + "eastEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "northEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "rotation" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "southEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "westEdge" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + } + }, + "RobotLocalizationEngineEnum" : { + "type" : "string", + "enum" : [ "AMCL", "RTABMAP" ] + }, + "RobotMapFilter" : { + "type" : "object", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "maskLocator" : { + "type" : "string", + "nullable" : true + }, + "md5" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/RobotMapFilterTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RobotMapFilterTypeEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "KEEPOUT" ] + }, + "RobotMapFilterTypeEnum_Public" : { + "type" : "string", + "enum" : [ "UNKNOWN", "KEEPOUT" ] + }, + "RobotMapFilter_Public" : { + "type" : "object", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "md5" : { + "type" : "string", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/RobotMapFilterTypeEnum_Public" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RobotMapMeta" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "etag" : { + "type" : "string", + "nullable" : true + }, + "floorPlan" : { + "$ref" : "#/components/schemas/RobotFloorPlan" + }, + "freeThresh" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "initiatedByDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "negate" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "occupiedThresh" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "origin" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "description" : "Serialized as [x, y, z]" + }, + "maxItems" : 3, + "minItems" : 3, + "nullable" : true + }, + "pkgLocator" : { + "type" : "string", + "nullable" : true + }, + "pkgType" : { + "$ref" : "#/components/schemas/RobotMapPackagingTypeEnum" + }, + "resolution" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "sizeBytes" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uploadState" : { + "$ref" : "#/components/schemas/RobotMapUploadStateEnum" + }, + "uploaded" : { + "type" : "boolean", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RobotMapMeta_Public" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "etag" : { + "type" : "string", + "nullable" : true + }, + "floorPlan" : { + "$ref" : "#/components/schemas/RobotFloorPlan_Public" + }, + "freeThresh" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "initiatedByDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "negate" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "occupiedThresh" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "origin" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "description" : "Serialized as [x, y, z]" + }, + "maxItems" : 3, + "minItems" : 3, + "nullable" : true + }, + "resolution" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "sizeBytes" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uploadState" : { + "$ref" : "#/components/schemas/RobotMapUploadStateEnum_Public" + }, + "uploaded" : { + "type" : "boolean", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "RobotMapPackagingTypeEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "V1" ] + }, + "RobotMapUploadStateEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "PENDING", "PROCESSING", "READY" ] + }, + "RobotMapUploadStateEnum_Public" : { + "type" : "string", + "enum" : [ "UNKNOWN", "PENDING", "PROCESSING", "READY" ] + }, + "RobotOperatingModeEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "DOCKED", "DISCOVERY", "PATROL", "MANUAL" ] + }, + "RobotPatrol" : { + "type" : "object", + "description" : "The patrol (device, route reference, deploy rule, waypoint rules)", + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerRuleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypointRules" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + } + } + }, + "RobotPlatformCapability" : { + "type" : "object", + "properties" : { + "driveType" : { + "type" : "string", + "nullable" : true + }, + "facetOrientationDegrees" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, + "movementAxes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AxisRange" + }, + "nullable" : true + }, + "platform" : { + "$ref" : "#/components/schemas/RobotPlatformEnum" + }, + "postureAxes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AxisRange" + }, + "nullable" : true + }, + "supportedActions" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "supportedAvoidanceModes" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true + } + } + }, + "RobotPlatformEnum" : { + "type" : "string", + "enum" : [ "go2", "go2_v2", "diablo", "diablo_2dlidar", "turtlebot4", "sim_turtlebot4", "backpack_v1", "doombot", "unknown" ] + }, + "RobotRoute" : { + "type" : "object", + "description" : "The robot route", + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "triggerRuleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypointMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RouteWaypoint" + }, + "nullable" : true + } + } + }, + "RobotSettings" : { + "type" : "object", + "properties" : { + "battery_recovered_threshold_pct" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "home_latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "home_longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "low_battery_threshold_pct" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "map_assigned_at_ms" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "map_assignment_id" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "map_id" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "preferred_localization_engine" : { + "$ref" : "#/components/schemas/RobotLocalizationEngineEnum" + } + } + }, + "RobotSettingsSelectiveUpdate" : { + "type" : "object", + "properties" : { + "battery_recovered_threshold_pct" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "home_latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "home_longitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "low_battery_threshold_pct" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "map_assigned_at_ms" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "map_assignment_id" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "map_id" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "preferred_localization_engine" : { + "$ref" : "#/components/schemas/RobotLocalizationEngineEnum" + }, + "updatedSetMethodMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, + "nullable" : true + } + } + }, + "Robot_AssignMapWSRequest" : { + "type" : "object", + "description" : "New map assignment", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "floorPlan" : { + "$ref" : "#/components/schemas/RobotFloorPlan_Public" + }, + "mapFilterUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_AssignMapWSResponse" : { + "type" : "object", + "description" : "The robot map assignment information.", + "properties" : { + "assignmentTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "assignmentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "mapMeta" : { + "$ref" : "#/components/schemas/RobotMapMeta_Public" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_CreatePatrolWSRequest" : { + "type" : "object", + "description" : "Creates a robot's scheduled deployment of a route with per-patrol waypoint actions.", + "properties" : { + "deployConditions" : { + "type" : "array", + "description" : "Triggers that initiate the deployment (e.g. scheduled or recurring). Omit or leave empty for a patrol with no autonomous schedule.", + "items" : { + "$ref" : "#/components/schemas/BaseRuleTriggerType" + }, + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Human-facing name for the patrol", + "nullable" : true + }, + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypointActions" : { + "type" : "array", + "description" : "Bespoke, per-robot waypoint arrival actions for existing RouteWaypoints.", + "items" : { + "$ref" : "#/components/schemas/Robot_WaypointActionWSRequest" + }, + "nullable" : true + } + }, + "required" : [ "deviceUuid", "routeUuid" ] + }, + "Robot_CreatePatrolWSResponse" : { + "type" : "object", + "description" : "The created patrol, fully composed.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "patrolView" : { + "$ref" : "#/components/schemas/Robot_PatrolView" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_CreateRobotRouteWSRequest" : { + "type" : "object", + "description" : "Request to create a robot patrol route with waypoints and optional trigger rules.", + "properties" : { + "deployConditions" : { + "type" : "array", + "description" : "Triggers that initiate the patrol (e.g., scheduled or recurring). Multiple triggers are combined as alternatives — any one firing deploys the route.", + "items" : { + "$ref" : "#/components/schemas/BaseRuleTriggerType" + }, + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "Name of the route", + "nullable" : true + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypoints" : { + "type" : "array", + "description" : "Ordered list of waypoints that define the route. Waypoint UUIDs are ignored on create and assigned by the system.", + "items" : { + "$ref" : "#/components/schemas/Robot_RouteWaypointWSRequest" + }, + "nullable" : true + } + } + }, + "Robot_CreateRobotRouteWSResponse" : { + "type" : "object", + "description" : "The created route with its associated rules.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "routeView" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_CreateRobotWaypointWSRequest" : { + "type" : "object", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "pose" : { + "$ref" : "#/components/schemas/Pose" + } + } + }, + "Robot_CreateRobotWaypointWSResponse" : { + "type" : "object", + "description" : "The created waypoint.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "waypoint" : { + "$ref" : "#/components/schemas/Waypoint" + } + } + }, + "Robot_DeletePatrolWSRequest" : { + "type" : "object", + "description" : "Delete a patrol by its patrolUuid. Authorization is derived from the patrol's own device/location — no device input is accepted.", + "properties" : { + "patrolUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "patrolUuid" ] + }, + "Robot_DeletePatrolWSResponse" : { + "type" : "object", + "description" : "The deleted patrol, or null if none existed.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "patrol" : { + "$ref" : "#/components/schemas/RobotPatrol" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_DeleteRobotRouteWSRequest" : { + "type" : "object", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_DeleteRobotRouteWSResponse" : { + "type" : "object", + "description" : "The deleted route with its associated rules.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "routeView" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_DeleteRobotWSRequest" : { + "type" : "object", + "description" : "Request to delete a robot device.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "mummify" : { + "type" : "boolean", + "description" : "Whether to mummify the device instead of hard delete", + "example" : false, + "nullable" : true + } + }, + "required" : [ "deviceUuid", "mummify" ] + }, + "Robot_DeleteRobotWSResponse" : { + "type" : "object", + "description" : "Response from deleting a robot device.", + "properties" : { + "responseStatus" : { + "$ref" : "#/components/schemas/WebResponseStatusEnum" + } + } + }, + "Robot_DeleteRobotWaypointWSRequest" : { + "type" : "object", + "description" : "Request to delete a robot waypoint.", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "mapUuid", "waypointUuid" ] + }, + "Robot_DeleteRobotWaypointWSResponse" : { + "type" : "object", + "description" : "The deleted waypoint.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "waypoint" : { + "$ref" : "#/components/schemas/Waypoint" + } + } + }, + "Robot_DeployRobotWSRequest" : { + "type" : "object", + "description" : "Request to deploy the robot to a mapped location.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "navType" : { + "$ref" : "#/components/schemas/NavigationTypeEnum" + }, + "patrolUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "waypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_DeployRobotWSResponse" : { + "type" : "object", + "description" : "Response from deploying a robot.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "routeRunUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_FindPatrolsByRobotWSRequest" : { + "type" : "object", + "description" : "Find all patrols for a robot on its currently assigned map. The map is resolved server-side from the device's map assignment.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "deviceUuid" ] + }, + "Robot_FindPatrolsByRouteWSRequest" : { + "type" : "object", + "description" : "Find all patrols deployed on a route (across every robot that runs it; a robot may have multiple patrols on the same route).", + "properties" : { + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "routeUuid" ] + }, + "Robot_FindPatrolsWSResponse" : { + "type" : "object", + "description" : "The matching patrols, each fully composed.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "patrolViews" : { + "type" : "array", + "description" : "The matching patrol views", + "items" : { + "$ref" : "#/components/schemas/Robot_PatrolView" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_FindRobotEventsWSRequest" : { + "type" : "object", + "description" : "Request to find robot events for a given robot within a time range.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "endMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End of the time range in epoch milliseconds (exclusive)", + "nullable" : true + }, + "startMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start of the time range in epoch milliseconds (inclusive)", + "nullable" : true + } + }, + "required" : [ "deviceUuid", "startMs" ] + }, + "Robot_FindRobotMapsWSRequest" : { + "type" : "object", + "description" : "Find robot maps", + "properties" : { + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_FindRobotMapsWSResponse" : { + "type" : "object", + "description" : "A list of available robot maps.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "maps" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RobotMapMeta_Public" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_FindRobotRoutesWSRequest" : { + "type" : "object", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_FindRobotRoutesWSResponse" : { + "type" : "object", + "description" : "Response containing robot routes with their associated rules.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "routeViews" : { + "type" : "array", + "description" : "The routes and their rules", + "items" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_FindRobotWaypointsByMapWSRequest" : { + "type" : "object", + "description" : "Request to find all waypoints for a given map.", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "mapUuid" ] + }, + "Robot_FindRobotWaypointsByMapWSResponse" : { + "type" : "object", + "description" : "Response containing the waypoints for a map.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "waypoints" : { + "type" : "array", + "description" : "List of waypoints for the map", + "items" : { + "$ref" : "#/components/schemas/Waypoint" + }, + "nullable" : true + } + } + }, + "Robot_FindRouteRunsByRouteWSRequest" : { + "type" : "object", + "description" : "Request to find route runs for a given route within a time range.", + "properties" : { + "endMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End of the time range in epoch milliseconds, defaults to Long.MAX_VALUE", + "nullable" : true + }, + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start of the time range in epoch milliseconds", + "nullable" : true + } + }, + "required" : [ "routeUuid", "startMs" ] + }, + "Robot_FindRouteRunsByRouteWSResponse" : { + "type" : "object", + "description" : "Response containing the route runs for a route.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "routeRuns" : { + "type" : "array", + "description" : "List of route runs for the route", + "items" : { + "$ref" : "#/components/schemas/RouteRun" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_FindRoutesAndPatrolsByDeviceWSRequest" : { + "type" : "object", + "description" : "List the routes and patrols on a robot's currently assigned map. The mapUuid is resolved server-side from the device's map assignment.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "deviceUuid" ] + }, + "Robot_FindRoutesAndPatrolsByMapWSRequest" : { + "type" : "object", + "description" : "List every route defined on a map and every patrol deployed on those routes.", + "properties" : { + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "mapUuid" ] + }, + "Robot_FindRoutesAndPatrolsByMapWSResponse" : { + "type" : "object", + "description" : "The map's routes and the patrols deployed on them.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "patrolViews" : { + "type" : "array", + "description" : "Every patrol deployed on the map's routes, fully composed", + "items" : { + "$ref" : "#/components/schemas/Robot_PatrolView" + }, + "nullable" : true + }, + "routeViews" : { + "type" : "array", + "description" : "Every route defined on the map, with its resolved rules", + "items" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_FindWaypointRunsByRouteRunWSRequest" : { + "type" : "object", + "description" : "Request to find waypoint runs for a given route run.", + "properties" : { + "routeRunUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "routeRunUuid" ] + }, + "Robot_FindWaypointRunsByRouteRunWSResponse" : { + "type" : "object", + "description" : "Response containing the waypoint runs for a route run.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "waypointRuns" : { + "type" : "array", + "description" : "List of waypoint runs for the route run", + "items" : { + "$ref" : "#/components/schemas/WaypointRun" + }, + "nullable" : true + } + } + }, + "Robot_FindWaypointRunsByRouteWSRequest" : { + "type" : "object", + "description" : "Request to find waypoint runs for a given route within a time range.", + "properties" : { + "endMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End of the time range in epoch milliseconds, defaults to Long.MAX_VALUE", + "nullable" : true + }, + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start of the time range in epoch milliseconds", + "nullable" : true + } + }, + "required" : [ "routeUuid", "startMs" ] + }, + "Robot_FindWaypointRunsByRouteWSResponse" : { + "type" : "object", + "description" : "Response containing the waypoint runs for a route.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "waypointRuns" : { + "type" : "array", + "description" : "List of waypoint runs for the route", + "items" : { + "$ref" : "#/components/schemas/WaypointRun" + }, + "nullable" : true + } + } + }, + "Robot_GetAllMediaUrisWSRequest" : { + "type" : "object", + "description" : "Request object for retrieving the media uris of every facet a robot has configured.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_GetAllMediaUrisWSResponse" : { + "type" : "object", + "description" : "Media uris for every configured facet of a robot, plus the robot's device-level uris.", + "properties" : { + "audioFacetUris" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Robot_RobotAudioFacetUrisView" + }, + "description" : "Audio uris keyed by the audio facet that serves them", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lanCheckUrls" : { + "type" : "array", + "description" : "List of LAN check URLs to verify robot availability on the local network. Not faceted", + "items" : { + "type" : "string", + "description" : "List of LAN check URLs to verify robot availability on the local network. Not faceted", + "nullable" : true + }, + "nullable" : true + }, + "videoFacetUris" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Robot_RobotVideoFacetUrisView" + }, + "description" : "Video uris keyed by the video facet that serves them", + "nullable" : true + }, + "wanLiveRobotUri" : { + "type" : "string", + "description" : "WAN URI for the robot control websocket. Not faceted", + "nullable" : true + } + } + }, + "Robot_GetMapAssignmentWSRequest" : { + "type" : "object", + "description" : "Retrieve the map assignment information for a device", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_GetMapAssignmentWSResponse" : { + "type" : "object", + "description" : "The robot map assignment information.", + "properties" : { + "assignmentTimeMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "assignmentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "mapFilters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RobotMapFilter_Public" + }, + "nullable" : true + }, + "mapMeta" : { + "$ref" : "#/components/schemas/RobotMapMeta_Public" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_GetPatrolWSRequest" : { + "type" : "object", + "description" : "Fetch a patrol by its patrolUuid. Authorization resolves the patrol's map location from the patrolUuid (no device/route/map input required).", + "properties" : { + "patrolUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + }, + "required" : [ "patrolUuid" ] + }, + "Robot_GetPatrolWSResponse" : { + "type" : "object", + "description" : "The requested patrol, fully composed, or null if none exists.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "patrolView" : { + "$ref" : "#/components/schemas/Robot_PatrolView" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_GetRobotConfigWSResponse" : { + "type" : "object", + "description" : "Response containing robot configuration.", + "properties" : { + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" + } + } + }, + "Robot_GetRobotFullStateWSResponse" : { + "type" : "object", + "description" : "Response containing full state information for a robot.", + "properties" : { + "fullState" : { + "$ref" : "#/components/schemas/Robot_RobotFullDeviceStateType" + } + } + }, + "Robot_GetRobotMapFilterImageWSRequest" : { + "type" : "object", + "description" : "Request for the mask image of a map filter the robot applies.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "mapFilterUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_GetRobotMapImageWSRequest" : { + "type" : "object", + "description" : "Response containing the robot's current assigned map image.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_GetRobotMapMetaWSRequest" : { + "type" : "object", + "description" : "Retrieve map meta", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_GetRobotMapMetaWSResponse" : { + "type" : "object", + "description" : "Contains information pulled from the uploaded map package", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "statusCode" : { - "$ref" : "#/components/schemas/HttpStatusCode" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "statusCodeValue" : { - "type" : "integer", - "format" : "int32", + "origin" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "description" : "Origin as [x, y, z]" + }, + "maxItems" : 3, + "minItems" : 3, + "nullable" : true + }, + "resolution" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "ResponseTypeEnum" : { - "type" : "string", - "enum" : [ "ANSWER", "REPORT", "UNKNOWN" ] - }, - "ReturnTypeEnum" : { - "type" : "string", - "description" : "Type of return for the inventory audit (deprecated)", - "enum" : [ "TRIAL", "SALES", "RMA", "WARRANTY", "OTHER", "UNKNOWN" ] + "Robot_GetRobotMediaUrisWSResponse" : { + "type" : "object", + "properties" : { + "lanCheckUrls" : { + "type" : "array", + "description" : "List of LAN check URLs to verify device availability on local network", + "items" : { + "type" : "string", + "description" : "List of LAN check URLs to verify device availability on local network", + "nullable" : true + }, + "nullable" : true + }, + "lanLiveH264Uris" : { + "type" : "array", + "description" : "List of LAN URIs for live H.264 video streams", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for live H.264 video streams", + "nullable" : true + }, + "nullable" : true + }, + "lanLiveMpdUris" : { + "type" : "array", + "description" : "List of LAN URIs for live MPD streams", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for live MPD streams", + "nullable" : true + }, + "nullable" : true + }, + "lanLiveOpusUris" : { + "type" : "array", + "description" : "List of LAN URIs for live Opus audio streams", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for live Opus audio streams", + "nullable" : true + }, + "nullable" : true + }, + "lanVodM3u8UrisTemplates" : { + "type" : "array", + "description" : "List of LAN URI templates for VOD M3U8 streams", + "items" : { + "type" : "string", + "description" : "List of LAN URI templates for VOD M3U8 streams", + "nullable" : true + }, + "nullable" : true + }, + "lanVodMpdUrisTemplates" : { + "type" : "array", + "description" : "List of LAN URI templates for VOD MPD streams", + "items" : { + "type" : "string", + "description" : "List of LAN URI templates for VOD MPD streams", + "nullable" : true + }, + "nullable" : true + }, + "wanLiveH264Uri" : { + "type" : "string", + "description" : "WAN URI for live H.264 video stream", + "nullable" : true + }, + "wanLiveMpdUri" : { + "type" : "string", + "description" : "WAN URI for live MPD stream", + "nullable" : true + }, + "wanLiveOpusUri" : { + "type" : "string", + "description" : "WAN URI for live Opus audio stream", + "nullable" : true + }, + "wanLiveRobotUri" : { + "type" : "string", + "nullable" : true + }, + "wanVodM3u8UriTemplate" : { + "type" : "string", + "description" : "WAN URI template for VOD M3U8 streams", + "nullable" : true + }, + "wanVodMpdUriTemplate" : { + "type" : "string", + "description" : "WAN URI template for VOD MPD streams", + "nullable" : true + } + } }, - "RhombusAppEnum" : { - "type" : "string", - "enum" : [ "PARTNER", "CONSOLE", "RHOMBUS_KEY", "UNKNOWN" ] + "Robot_GetRobotMinimalStateListWSResponse" : { + "type" : "object", + "description" : "Response containing minimal state information for all robots in organization.", + "properties" : { + "minimalStates" : { + "type" : "array", + "description" : "List of minimal device state information for robots", + "items" : { + "$ref" : "#/components/schemas/MinimalRobotStateType" + }, + "nullable" : true + } + } }, - "RhombusDayOfWeekEnum" : { - "type" : "string", - "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] + "Robot_GetRobotRouteWSRequest" : { + "type" : "object", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } }, - "RhombusKeyAppConfigType" : { + "Robot_GetRobotRouteWSResponse" : { "type" : "object", + "description" : "Response containing the robot route with its associated rules.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "orgUuid" : { + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "routeView" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_GetRobotWaypointWSRequest" : { + "type" : "object", + "description" : "Request to get a robot waypoint.", + "properties" : { + "mapUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "preferences" : { - "$ref" : "#/components/schemas/RhombusKeyAppPreferencesType" - }, - "rhombusOrgUserUuid" : { + "waypointUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + }, + "required" : [ "waypointUuid" ] + }, + "Robot_GetRobotWaypointWSResponse" : { + "type" : "object", + "description" : "Response containing the robot waypoint.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "settings" : { - "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "warningMsg" : { + "type" : "string", "nullable" : true + }, + "waypoint" : { + "$ref" : "#/components/schemas/Waypoint" } } }, - "RhombusKeyAppPreferencesType" : { + "Robot_GetRouteRunWSRequest" : { "type" : "object", + "description" : "Request to get a route run.", "properties" : { - "favoriteAccessControlledDoorUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, + "routeRunUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "routeRunUuid" ] }, - "RhombusKeyAppSettingsType" : { + "Robot_GetRouteRunWSResponse" : { "type" : "object", + "description" : "Response containing the route run.", "properties" : { - "bypassSaml" : { + "error" : { "type" : "boolean", "nullable" : true }, - "credentialProvisioningRules" : { - "$ref" : "#/components/schemas/RhombusSecureMobileCredentialProvisioningRulesType" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "remoteUnlockEnabled" : { - "type" : "boolean", + "routeRun" : { + "$ref" : "#/components/schemas/RouteRun" + }, + "warningMsg" : { + "type" : "string", "nullable" : true + } + } + }, + "Robot_PatrolView" : { + "type" : "object", + "description" : "A patrol with its route view, deploy rule, and waypoint action rules.", + "properties" : { + "deployCondition" : { + "$ref" : "#/components/schemas/RuleType" }, - "rhombusKeyAccessEnabled" : { - "type" : "boolean", + "patrol" : { + "$ref" : "#/components/schemas/RobotPatrol" + }, + "routeView" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" + }, + "waypointRules" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "The patrol's per-patrol waypoint arrival rules, keyed by RouteWaypoint UUID", + "items" : { + "$ref" : "#/components/schemas/RuleType" + }, + "nullable" : true + }, + "description" : "The patrol's per-patrol waypoint arrival rules, keyed by RouteWaypoint UUID", "nullable" : true } } }, - "RhombusOrgUserType" : { + "Robot_RobotAudioFacetUrisView" : { "type" : "object", - "description" : "List of users in the organization for reports", + "description" : "Live uris for one audio facet of a robot.", "properties" : { - "accessibleRhombusApps" : { + "lanLiveOpusUris" : { "type" : "array", + "description" : "List of LAN URIs for the live Opus audio stream of this facet", "items" : { - "$ref" : "#/components/schemas/RhombusAppEnum" + "type" : "string", + "description" : "List of LAN URIs for the live Opus audio stream of this facet", + "nullable" : true }, - "nullable" : true, - "uniqueItems" : true + "nullable" : true }, - "accountOwner" : { + "wanLiveOpusUri" : { + "type" : "string", + "description" : "WAN URI for the live Opus audio stream of this facet", + "nullable" : true + } + } + }, + "Robot_RobotFullDeviceStateType" : { + "type" : "object", + "description" : "Full device state information for the robot", + "properties" : { + "activity" : { + "$ref" : "#/components/schemas/RobotActivityEnum" + }, + "activityStartedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "activityUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "activityUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "afSupport" : { "type" : "boolean", "nullable" : true }, - "bypassSaml" : { + "audioSupported" : { + "type" : "boolean", + "nullable" : true + }, + "baseVideoOperationUri" : { + "type" : "string", + "nullable" : true + }, + "batteryPercent" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "charging" : { "type" : "boolean", "nullable" : true }, + "connectionStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "connectionTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "deleted" : { - "type" : "boolean", + "defaultInterface" : { + "type" : "string", "nullable" : true }, - "firstName" : { + "defaultInterfaceMac" : { "type" : "string", "nullable" : true }, - "lastName" : { + "description" : { "type" : "string", "nullable" : true }, - "name" : { + "directionRadians" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "distanceRemaining" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "estimatedTimeRemainingSec" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "event" : { + "$ref" : "#/components/schemas/BehaviorEventTypeEnum" + }, + "externalIPAddress" : { "type" : "string", "nullable" : true }, - "orgUserCustomizationFlags" : { + "facetNameMap" : { "type" : "object", "additionalProperties" : { "type" : "string", @@ -122671,130 +149301,272 @@ }, "nullable" : true }, - "orgUuid" : { + "failureReason" : { + "type" : "string", + "nullable" : true + }, + "firmwareUpdateInProgress" : { + "type" : "boolean", + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "floorNumber" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "goalPose" : { + "$ref" : "#/components/schemas/Pose" + }, + "healthStatus" : { + "$ref" : "#/components/schemas/DeviceStatusEnum" + }, + "healthStatusDetails" : { + "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" + }, + "hwVariation" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "lanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "lastEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rhombusUserUuid" : { + "latestFirmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "latitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "liveStreamShared" : { + "type" : "boolean", + "nullable" : true + }, + "liveStreamsSharedCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/UserStatusEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "longitude" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "uuid" : { + "mapId" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "RhombusOsdpDoorReaderType" : { - "type" : "object", - "properties" : { - "allowCredsDuringUnlock" : { + }, + "maxZoomPercent" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "mediaRegion" : { + "type" : "string", + "nullable" : true + }, + "mediaStorageDeviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "mode" : { + "$ref" : "#/components/schemas/RobotOperatingModeEnum" + }, + "mummified" : { "type" : "boolean", "nullable" : true }, - "baseType" : { - "$ref" : "#/components/schemas/ComponentBaseEnumType" + "name" : { + "type" : "string", + "nullable" : true }, - "createdAtMillis" : { + "navPath" : { + "type" : "array", + "items" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nullable" : true + }, + "navPathTsMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "navigationTimeSec" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "disableCardReader" : { - "type" : "boolean", + "onCameraState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true + }, "nullable" : true }, - "disableKeypad" : { - "type" : "boolean", + "onCloudState" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "nullable" : true + }, "nullable" : true }, - "disableWaveToUnlock" : { - "type" : "boolean", + "orientation" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "hardwareUuid" : { + "pathUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "phase" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "name" : { + "phaseEvent" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "phaseUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "osdpAddress" : { + "policyUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "poseUpdatedAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "otherReaderUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "position" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "ownerDeviceUuid" : { + "preemptedBy" : { + "$ref" : "#/components/schemas/PreemptedBy" + }, + "progressUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "region" : { + "type" : "string", + "nullable" : true + }, + "roamingLatitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "roamingLongitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "robotPlatform" : { + "$ref" : "#/components/schemas/RobotPlatformEnum" + }, + "robotPlatformCapability" : { + "$ref" : "#/components/schemas/RobotPlatformCapability" + }, + "routeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerHardwareType" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "secondaryLanAddresses" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true }, - "port" : { - "$ref" : "#/components/schemas/OsdpReaderPortType" + "serialNumber" : { + "type" : "string", + "nullable" : true }, - "portImmutable" : { - "type" : "boolean", + "ssid" : { + "type" : "string", "nullable" : true }, - "readerType" : { - "$ref" : "#/components/schemas/DoorReaderEnumType" + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "remoteUnlockAudioFeedbackEnabled" : { - "type" : "boolean", + "stateUpdatedTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "serialNumber" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "type" : { - "$ref" : "#/components/schemas/ComponentEnumType" + "supportedFacets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceFacetEnum" + }, + "nullable" : true, + "uniqueItems" : true }, - "updatedAtMillis" : { + "updatedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true @@ -122805,488 +149577,675 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "versionsBehind" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "waypointIndex" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "waypointTotal" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "waypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "wifiApMac" : { + "type" : "string", + "nullable" : true + }, + "wifiBars" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "wifiSignalStrength" : { + "type" : "integer", + "format" : "int32", + "nullable" : true } } }, - "RhombusSamlDomainEnum" : { - "type" : "string", - "enum" : [ "RHOMBUS_COM", "RHOMBUS_SYSTEMS_COM" ] + "Robot_RobotRouteView" : { + "type" : "object", + "description" : "A view of the ordered sequence of poses that the robot follows", + "properties" : { + "deployCondition" : { + "$ref" : "#/components/schemas/RuleType" + }, + "route" : { + "$ref" : "#/components/schemas/RobotRoute" + }, + "waypointRules" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Action rules for each RouteWaypoint, keyed by RouteWaypoint UUID (not Waypoint UUID)", + "items" : { + "$ref" : "#/components/schemas/RuleType" + }, + "nullable" : true + }, + "description" : "Action rules for each RouteWaypoint, keyed by RouteWaypoint UUID (not Waypoint UUID)", + "nullable" : true + } + } }, - "RhombusSecureCsnType" : { + "Robot_RobotVideoFacetUrisView" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "algorithm" : { - "$ref" : "#/components/schemas/SecureTokenAlgorithmEnum" + "description" : "Live and VOD uris for one video facet of a robot.", + "properties" : { + "lanLiveH264Uris" : { + "type" : "array", + "description" : "List of LAN URIs for the live realtime video stream of this facet", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for the live realtime video stream of this facet", + "nullable" : true }, - "baseKeyIdentifier" : { - "type" : "integer", - "format" : "int32", + "nullable" : true + }, + "lanLiveM3u8Uris" : { + "type" : "array", + "description" : "List of LAN URIs for the live M3U8 stream of this facet", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for the live M3U8 stream of this facet", "nullable" : true - } + }, + "nullable" : true + }, + "lanLiveMpdUris" : { + "type" : "array", + "description" : "List of LAN URIs for the live MPD stream of this facet", + "items" : { + "type" : "string", + "description" : "List of LAN URIs for the live MPD stream of this facet", + "nullable" : true + }, + "nullable" : true + }, + "lanVodM3u8UrisTemplates" : { + "type" : "array", + "description" : "List of LAN URI templates for VOD M3U8 streams of this facet", + "items" : { + "type" : "string", + "description" : "List of LAN URI templates for VOD M3U8 streams of this facet", + "nullable" : true + }, + "nullable" : true + }, + "lanVodMpdUrisTemplates" : { + "type" : "array", + "description" : "List of LAN URI templates for VOD MPD streams of this facet", + "items" : { + "type" : "string", + "description" : "List of LAN URI templates for VOD MPD streams of this facet", + "nullable" : true + }, + "nullable" : true + }, + "wanLiveH264Uri" : { + "type" : "string", + "description" : "WAN URI for the live realtime video stream of this facet", + "nullable" : true + }, + "wanLiveM3u8Uri" : { + "type" : "string", + "description" : "WAN URI for the live M3U8 stream of this facet", + "nullable" : true + }, + "wanLiveMpdUri" : { + "type" : "string", + "description" : "WAN URI for the live MPD stream of this facet", + "nullable" : true + }, + "wanVodM3u8UriTemplate" : { + "type" : "string", + "description" : "WAN URI template for VOD M3U8 streams of this facet", + "nullable" : true + }, + "wanVodMpdUriTemplate" : { + "type" : "string", + "description" : "WAN URI template for VOD MPD streams of this facet", + "nullable" : true } - } ], - "nullable" : true, + } + }, + "Robot_RouteWaypointRuleWSRequest" : { + "type" : "object", + "description" : "Defines an action rule that triggers when a robot arrives at a waypoint.", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "action" : { + "$ref" : "#/components/schemas/RuleActionType" + }, + "ruleFilters" : { + "$ref" : "#/components/schemas/RuleFilterType" + }, + "ruleName" : { + "type" : "string", + "description" : "Name of the rule", + "example" : "Arrived at gas meter", "nullable" : true + } + } + }, + "Robot_RouteWaypointWSRequest" : { + "type" : "object", + "description" : "A waypoint within a robot route. On create, uuid is ignored and system-assigned. On update, null uuid creates a new waypoint; non-null identifies an existing one.", + "properties" : { + "dwellStrategy" : { + "$ref" : "#/components/schemas/DwellStrategyEnum" }, - "endDateEpochSecExclusive" : { + "dwellTimeSecs" : { "type" : "integer", "format" : "int64", + "default" : 15, + "description" : "Duration in seconds the robot dwells at this waypoint", "nullable" : true }, - "lastUsedAccessControlledDoorUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Display name for the waypoint", "nullable" : true }, - "lastUsedAtMillis" : { + "ordinal" : { "type" : "integer", - "format" : "int64", + "format" : "int32", + "description" : "Determines the order in which waypoints are traversed. Lower ordinals go first", "nullable" : true }, - "lastUsedLocationUuid" : { + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "rules" : { + "type" : "array", + "description" : "Actions to execute when the robot arrives at this waypoint", + "items" : { + "$ref" : "#/components/schemas/Robot_RouteWaypointRuleWSRequest" + }, + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lowercaseHexValue" : { + "waypointRefUuid" : { "type" : "string", - "nullable" : true, - "readOnly" : true - }, - "managedCredUuid" : { + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Robot_SendHomeWSRequest" : { + "type" : "object", + "description" : "Request to send the robot back to its docking/home pose.", + "properties" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Robot_SendHomeWSResponse" : { + "type" : "object", + "description" : "Response from sending a robot home.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "note" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "orgUuid" : { + "warningMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Robot_UpdatePatrolWSRequest" : { + "type" : "object", + "description" : "Update a patrol's name, deploy schedule, enabled flag, and/or waypoint actions. Only supplied fields are applied. Authorization is derived from the patrol's own device/location — no device input is accepted.", + "properties" : { + "deployConditions" : { + "type" : "array", + "description" : "Updated deploy triggers. Omit to leave unchanged; send null or an empty list to clear (deletes the deploy rule); send a non-empty list to replace.", + "items" : { + "$ref" : "#/components/schemas/BaseRuleTriggerType" + }, "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + "enabled" : { + "type" : "boolean", + "description" : "Whether the patrol deploys autonomously. Omit to leave unchanged.", + "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "name" : { + "type" : "string", + "description" : "Updated name. Omit to leave unchanged.", "nullable" : true }, - "userUuid" : { + "patrolUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "value" : { - "type" : "string", + "waypointActions" : { + "type" : "array", + "description" : "Per-patrol waypoint actions. When present, replaces the patrol's waypoint actions wholesale. Omit to leave unchanged.", + "items" : { + "$ref" : "#/components/schemas/Robot_WaypointActionWSRequest" + }, "nullable" : true - }, - "workflowStatus" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } - } + }, + "required" : [ "patrolUuid" ] }, - "RhombusSecureMobileAppState" : { + "Robot_UpdatePatrolWSResponse" : { "type" : "object", - "description" : "Updated mobile app state", + "description" : "The updated patrol, fully composed.", "properties" : { - "appName" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "appNotifications" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + "patrolView" : { + "$ref" : "#/components/schemas/Robot_PatrolView" }, - "appOS" : { + "warningMsg" : { "type" : "string", "nullable" : true + } + } + }, + "Robot_UpdateRobotConfigWSRequest" : { + "type" : "object", + "description" : "Request to update robot configuration.", + "properties" : { + "configUpdate" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" + } + } + }, + "Robot_UpdateRobotConfigWSResponse" : { + "type" : "object", + "description" : "Response indicating the result of updating robot device configuration.", + "properties" : { + "config" : { + "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" }, - "appStatusUpdatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "error" : { + "type" : "boolean", "nullable" : true }, - "appVersion" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "clientType" : { - "$ref" : "#/components/schemas/MobileTokenOSEnum" + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Robot_UpdateRobotDetailsWSRequest" : { + "type" : "object", + "description" : "Request to update robot details.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Optional description for the robot", + "example" : "Patrols the lobby.", + "nullable" : true }, - "credentialUuid" : { + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceModel" : { - "type" : "string", - "nullable" : true - }, - "installationId" : { - "type" : "string", + "latitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional latitude coordinate", + "example" : 37.7749, "nullable" : true }, - "orgUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tapToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + "longitude" : { + "type" : "number", + "format" : "double", + "description" : "Optional longitude coordinate", + "example" : -122.4194, + "nullable" : true }, - "userAgent" : { + "name" : { "type" : "string", + "description" : "Optional name for the robot", + "example" : "Robocop", "nullable" : true }, - "userUuid" : { + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "subLocationsHierarchyKeyUpdated" : { + "type" : "boolean", + "description" : "Whether the sub-locations hierarchy key has been updated", + "example" : false, + "nullable" : true + } + } + }, + "Robot_UpdateRobotMapWSRequest" : { + "type" : "object", + "description" : "Updates a robot map", + "properties" : { + "cascadeUpdate" : { + "type" : "boolean", + "nullable" : true + }, + "floorPlan" : { + "$ref" : "#/components/schemas/RobotFloorPlan_Public" + }, + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "waveToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "RhombusSecureMobileAppStateStats" : { + "Robot_UpdateRobotMapWSResponse" : { "type" : "object", - "description" : "Mobile app state statistics", + "description" : "The result of an update to a robot map", "properties" : { - "tapToUnlockStats" : { - "$ref" : "#/components/schemas/RhombusSecureMobileCredStatRhombusSecureMobileFeatureStatus" + "error" : { + "type" : "boolean", + "nullable" : true }, - "versionStats" : { - "$ref" : "#/components/schemas/RhombusSecureMobileCredStatString" + "errorMsg" : { + "type" : "string", + "nullable" : true }, - "waveToUnlockStats" : { - "$ref" : "#/components/schemas/RhombusSecureMobileCredStatRhombusSecureMobileFeatureStatus" + "mapMeta" : { + "$ref" : "#/components/schemas/RobotMapMeta_Public" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "RhombusSecureMobileCredStatRhombusSecureMobileFeatureStatus" : { + "Robot_UpdateRobotRouteWSRequest" : { "type" : "object", + "description" : "Request to update an existing robot patrol route. Only non-null fields are applied.", "properties" : { - "androidCredRefMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/StatsCredentialReference" - }, - "nullable" : true + "deployConditions" : { + "type" : "array", + "description" : "Updated triggers that initiate the patrol. Omit the field to leave existing deploy conditions unchanged. Send null or an empty list to clear (deletes the existing trigger rule). Send a non-empty list to replace the existing triggers.", + "items" : { + "$ref" : "#/components/schemas/BaseRuleTriggerType" }, "nullable" : true }, - "androidTotal" : { - "type" : "integer", - "format" : "int64", - "nullable" : true, - "readOnly" : true + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "androidTotalMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true, - "readOnly" : true + "name" : { + "type" : "string", + "description" : "Updated name of the route", + "nullable" : true }, - "iphoneCredRefMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/StatsCredentialReference" - }, - "nullable" : true - }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "iphoneTotal" : { - "type" : "integer", - "format" : "int32", - "nullable" : true, - "readOnly" : true + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "iphoneTotalMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "waypoints" : { + "type" : "array", + "description" : "Updated list of waypoints. Waypoints with a UUID update existing entries; waypoints without a UUID are created as new.", + "items" : { + "$ref" : "#/components/schemas/Robot_RouteWaypointWSRequest" }, - "nullable" : true, - "readOnly" : true - }, - "total" : { - "type" : "integer", - "format" : "int64", - "nullable" : true, - "readOnly" : true + "nullable" : true } - } + }, + "required" : [ "uuid" ] }, - "RhombusSecureMobileCredStatString" : { + "Robot_UpdateRobotRouteWSResponse" : { "type" : "object", + "description" : "Response containing the updated robot route with its associated rules.", "properties" : { - "androidCredRefMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/StatsCredentialReference" - }, - "nullable" : true - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "androidTotal" : { - "type" : "integer", - "format" : "int64", - "nullable" : true, - "readOnly" : true - }, - "androidTotalMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true, - "readOnly" : true - }, - "iphoneCredRefMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/StatsCredentialReference" - }, - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "iphoneTotal" : { - "type" : "integer", - "format" : "int32", - "nullable" : true, - "readOnly" : true - }, - "iphoneTotalMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true, - "readOnly" : true + "routeView" : { + "$ref" : "#/components/schemas/Robot_RobotRouteView" }, - "total" : { - "type" : "integer", - "format" : "int64", - "nullable" : true, - "readOnly" : true + "warningMsg" : { + "type" : "string", + "nullable" : true } } }, - "RhombusSecureMobileCredentialProvisioningRulesType" : { + "Robot_UpdateRobotWaypointWSRequest" : { "type" : "object", + "description" : "Request to update a robot waypoint.", "properties" : { - "endDateProvisioner" : { - "$ref" : "#/components/schemas/EpochSecondsProvisioner" - }, - "maxMobileCredsAllowed" : { - "type" : "integer", - "format" : "int32", + "name" : { + "type" : "string", + "description" : "Updated name of the waypoint", "nullable" : true }, - "startDateProvisioner" : { - "$ref" : "#/components/schemas/EpochSecondsProvisioner" + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "waypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } - } + }, + "required" : [ "waypointUuid" ] }, - "RhombusSecureMobileFeature" : { + "Robot_UpdateRobotWaypointWSResponse" : { "type" : "object", - "nullable" : true, + "description" : "Response containing the updated waypoint.", "properties" : { - "settings" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeatureSetting" - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeatureStatusEnum" + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "waypoint" : { + "$ref" : "#/components/schemas/Waypoint" } } }, - "RhombusSecureMobileFeatureSetting" : { + "Robot_UpdateRouteRunWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request to update a route run.", "properties" : { - "name" : { + "selectiveUpdate" : { + "$ref" : "#/components/schemas/RouteRunSelectiveUpdate" + } + }, + "required" : [ "selectiveUpdate" ] + }, + "Robot_UpdateRouteRunWSResponse" : { + "type" : "object", + "description" : "Response containing the updated route run.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { "type" : "string", "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeatureSettingStatusEnum" + "routeRun" : { + "$ref" : "#/components/schemas/RouteRun" }, - "value" : { + "warningMsg" : { "type" : "string", "nullable" : true } } }, - "RhombusSecureMobileFeatureSettingStatusEnum" : { - "type" : "string", - "enum" : [ "OPTIMAL", "INHIBITED" ] - }, - "RhombusSecureMobileFeatureStatusEnum" : { - "type" : "string", - "enum" : [ "OPT_OUT", "UNAVAILABLE", "OPTIMAL", "INHIBITED", "UNKNOWN" ] - }, - "RhombusSecureMobileType" : { + "Robot_WaypointActionWSRequest" : { "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "algorithm" : { - "$ref" : "#/components/schemas/SecureTokenAlgorithmEnum" - }, - "appName" : { - "type" : "string", - "nullable" : true - }, - "appNotifications" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" - }, - "appOS" : { - "type" : "string", - "nullable" : true - }, - "appStatusUpdatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "appVersion" : { - "type" : "string", - "nullable" : true - }, - "baseKeyIdentifier" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "clientType" : { - "$ref" : "#/components/schemas/MobileTokenOSEnum" - }, - "deviceModel" : { - "type" : "string", - "nullable" : true - }, - "installationId" : { - "type" : "string", - "nullable" : true - }, - "tapToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" - }, - "userAgent" : { - "type" : "string", - "nullable" : true + "description" : "Per-patrol arrival actions for an existing RouteWaypoint on a patrol.", + "properties" : { + "routeWaypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "rules" : { + "type" : "array", + "description" : "Arrival action rules to author for the assignment's robot", + "items" : { + "$ref" : "#/components/schemas/Robot_RouteWaypointRuleWSRequest" }, - "waveToUnlock" : { - "$ref" : "#/components/schemas/RhombusSecureMobileFeature" - } + "nullable" : true } - } ], - "nullable" : true, + }, + "required" : [ "routeWaypointUuid" ] + }, + "RouteRun" : { + "type" : "object", "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "adhoc" : { + "type" : "boolean", "nullable" : true }, - "endDateEpochSecExclusive" : { + "arrivedAtEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "arrivedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "lastUsedAccessControlledDoorUuid" : { + "completedAtEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastUsedAtMillis" : { + "completedAtMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "lastUsedLocationUuid" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lowercaseHexValue" : { - "type" : "string", - "nullable" : true, - "readOnly" : true - }, - "managedCredUuid" : { + "mapUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "note" : { + "name" : { "type" : "string", "nullable" : true }, @@ -123297,196 +150256,295 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", + "parentRouteRunUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "routeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "userUuid" : { + "startedAtEventUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "startedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/RunStatusEnum" + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "RouteRunSelectiveUpdate" : { + "type" : "object", + "description" : "Selective update containing the fields to update", + "properties" : { + "realTarget" : { + "$ref" : "#/components/schemas/RouteRun" }, - "value" : { - "type" : "string", + "updatedFieldNameMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true - }, - "workflowStatus" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" } } }, - "RhombusShipmentInfoType" : { + "RouteWaypoint" : { "type" : "object", - "nullable" : true, "properties" : { - "additionalEmails" : { + "dwellEventId" : { "type" : "string", "nullable" : true }, - "chosenCarrierName" : { + "dwellEventType" : { "type" : "string", "nullable" : true }, - "claimKeyToLicenseMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true - }, - "nullable" : true, - "uniqueItems" : true - }, - "nullable" : true + "dwellStrategy" : { + "$ref" : "#/components/schemas/DwellStrategyEnum" }, - "claimKeyToLicenseMapV2" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SalesforceLicenseStartDateTimeAndEndDateTime" - }, - "nullable" : true - }, + "dwellTimeMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "customerEmails" : { + "name" : { "type" : "string", "nullable" : true }, - "customerName" : { - "type" : "string", + "ordinal" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "orgUuid" : { + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "ruleReferences" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "partnerOrgUuid" : { + "waypointRefUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Rs485FrameCheckEnum" : { + "type" : "string", + "description" : "Frame check for the line. Optional: the bytes do not indicate which is in use, and RSI recommends CRC, so that is the default.", + "enum" : [ "SCHLAGE_RSI_CRC", "SCHLAGE_RSI_CHECKSUM" ] + }, + "RtspEndpoint" : { + "type" : "object", + "properties" : { + "audioSupported" : { + "type" : "boolean", + "nullable" : true }, - "purchaseOrderNumber" : { + "lastRtspUrlStatus" : { + "$ref" : "#/components/schemas/UrlStatusEnum" + }, + "lensRole" : { + "$ref" : "#/components/schemas/LensRoleEnum" + }, + "onvifProfileToken" : { "type" : "string", "nullable" : true }, - "rmaReturnTrackingNumber" : { + "rtspUrl" : { "type" : "string", "nullable" : true }, - "rmaUuid" : { + "source" : { + "$ref" : "#/components/schemas/RtspEndpointSourceEnum" + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "RtspEndpointSourceEnum" : { + "type" : "string", + "enum" : [ "USER", "ONVIF" ] + }, + "RuleActionType" : { + "type" : "object", + "description" : "The action to take when this lockdown rule is triggered.", + "properties" : { + "activateLocationLockdown" : { + "$ref" : "#/components/schemas/ActivateLocationLockdownActionType" }, - "rmaUuids" : { + "alertAction" : { + "type" : "boolean", + "nullable" : true + }, + "audioPlaybackActions" : { "type" : "array", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/AudioPlaybackActionType" }, "nullable" : true }, - "salesForceOpportunityId" : { - "type" : "string", + "cancelLoopingAudioPlaybackAction" : { + "$ref" : "#/components/schemas/CancelLoopingAudioPlaybackActionType" + }, + "changeComponentCompositeAccessStateActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ChangeComponentCompositeAccessStateActionType" + }, "nullable" : true }, - "zendeskTicketNumber" : { - "type" : "string", + "connectAudioDeviceToMobileAppAction" : { + "$ref" : "#/components/schemas/ConnectAudioDeviceToMobileAppActionType" + }, + "connectAudioDeviceToPhoneNumberAction" : { + "$ref" : "#/components/schemas/ConnectAudioDeviceToPhoneNumberActionType" + }, + "createAlarmAction" : { + "$ref" : "#/components/schemas/CreateAlarmActionType" + }, + "customActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CustomRuleAction" + }, "nullable" : true - } - } - }, - "RhombusUserFidoCredential" : { - "type" : "object", - "description" : "If registration succeeded, this field will return non-sensitive metadata representing the newly registered WebAuthn credential. If registration failed it will be null.", - "properties" : { - "capability" : { - "$ref" : "#/components/schemas/CredentialCapabilityEnum" }, - "capabilityConfirmedAtMillis" : { - "type" : "integer", - "format" : "int64", + "customLLMActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CustomLLMActionType" + }, "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", + "emailAuditLogExportActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EmailAuditLogExportActionType" + }, "nullable" : true }, - "credentialId" : { - "type" : "string", + "enableDisableAudioRecordActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EnableDisableAudioRecordActionType" + }, "nullable" : true }, - "deleted" : { - "type" : "boolean", + "integrationCommandActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/IntegrationCommandActionType" + }, "nullable" : true }, - "displayName" : { - "type" : "string", + "integrationNotificationActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/IntegrationNotificationActionType" + }, "nullable" : true }, - "lastSeenInfoMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/LastSeenInfo" + "liveNotificationAction" : { + "type" : "boolean", + "nullable" : true + }, + "remoteDoorUnlockActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RemoteDoorUnlockActionType" }, "nullable" : true }, - "rhombusUserUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "robotActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RobotAction" + }, "nullable" : true }, - "signatureCounterUnreliable" : { - "type" : "boolean", + "thirdPartyAudioPlaybackAction" : { + "$ref" : "#/components/schemas/ThirdPartyAudioPlaybackActionType" + }, + "thirdPartyStrobeSirenAction" : { + "$ref" : "#/components/schemas/ThirdPartyStrobeSirenActionType" + }, + "triggerComponentRelayActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TriggerComponentRelayActionType" + }, "nullable" : true }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", + "webhookActions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/WebhookActionType" + }, "nullable" : true } } }, - "RobotActivityEvent" : { + "RuleEventOriginator" : { "type" : "object", "allOf" : [ { "type" : "object", "properties" : { - "waypointUuid" : { + "ruleName" : { + "type" : "string", + "nullable" : true + }, + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -123497,246 +150555,222 @@ } ], "nullable" : true, "properties" : { - "activityEvent" : { - "$ref" : "#/components/schemas/ActivityEnum" + "type" : { + "$ref" : "#/components/schemas/EventOriginatorEnum" } } }, - "RobotFloorPlan" : { + "RuleFilterType" : { "type" : "object", + "description" : "Optional filters to apply to this lockdown rule.", "properties" : { - "eastEdge" : { - "type" : "number", - "format" : "double", + "scheduleUuids" : { + "type" : "array", + "description" : "List of schedules that apply to the rule. at least one schedule must be met to trigger this rule. If null, then this rule is enabled all the time.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "nullable" : true }, - "floorNumber" : { + "triggerBackoffSecs" : { "type" : "integer", "format" : "int32", - "nullable" : true - }, - "northEdge" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "rotation" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "southEdge" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "westEdge" : { - "type" : "number", - "format" : "double", + "description" : "Number of seconds to back off after rule is triggered before triggering again. I.e. this rule will only trigger once every X seconds regardless of how many triggering events occur within that window", "nullable" : true } } }, - "RobotFloorPlan_Public" : { + "RuleLockdownEventOriginator" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "ruleName" : { + "type" : "string", + "nullable" : true + }, + "ruleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "type" : { + "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" + } + } + }, + "RulePromptCatalog" : { "type" : "object", "properties" : { - "eastEdge" : { - "type" : "number", - "format" : "double", + "cameras" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RulePromptCatalogCamera" + }, "nullable" : true }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", + "people" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RulePromptCatalogPerson" + }, "nullable" : true }, - "northEdge" : { - "type" : "number", - "format" : "double", + "schedules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RulePromptCatalogSchedule" + }, "nullable" : true - }, - "rotation" : { - "type" : "number", - "format" : "double", + } + } + }, + "RulePromptCatalogCamera" : { + "type" : "object", + "properties" : { + "locationName" : { + "type" : "string", "nullable" : true }, - "southEdge" : { - "type" : "number", - "format" : "double", + "name" : { + "type" : "string", "nullable" : true }, - "westEdge" : { - "type" : "number", - "format" : "double", + "uuid" : { + "type" : "string", "nullable" : true } } }, - "RobotMapMeta" : { + "RulePromptCatalogPerson" : { "type" : "object", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "floorPlan" : { - "$ref" : "#/components/schemas/RobotFloorPlan" - }, - "freeThresh" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "negate" : { - "type" : "integer", - "format" : "int32", + "uuid" : { + "type" : "string", "nullable" : true - }, - "occupiedThresh" : { - "type" : "number", - "format" : "double", + } + } + }, + "RulePromptCatalogSchedule" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", "nullable" : true }, - "orgUuid" : { + "uuid" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "origin" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "description" : "Serialized as [x, y, z]" - }, - "maxItems" : 3, - "minItems" : 3, + } + } + }, + "RulePromptClarificationOption" : { + "type" : "object", + "properties" : { + "entityType" : { + "type" : "string", "nullable" : true }, - "pkgLocator" : { + "entityUuid" : { "type" : "string", "nullable" : true }, - "pkgType" : { - "$ref" : "#/components/schemas/RobotMapPackagingTypeEnum" - }, - "resolution" : { - "type" : "number", - "format" : "float", + "label" : { + "type" : "string", "nullable" : true }, - "uploaded" : { - "type" : "boolean", + "secondaryLabel" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "value" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "RobotMapMeta_Public" : { + "RulePromptDraft" : { "type" : "object", "properties" : { - "enabled" : { - "type" : "boolean", - "nullable" : true - }, - "floorPlan" : { - "$ref" : "#/components/schemas/RobotFloorPlan_Public" - }, - "freeThresh" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "cameraUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, "nullable" : true }, - "negate" : { + "matchCount" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "occupiedThresh" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "orgUuid" : { + "name" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "origin" : { + "personUuids" : { "type" : "array", "items" : { - "type" : "number", - "format" : "double", - "description" : "Serialized as [x, y, z]" + "type" : "string", + "nullable" : true }, - "maxItems" : 3, - "minItems" : 3, "nullable" : true }, - "resolution" : { - "type" : "number", - "format" : "float", + "proposedSchedule" : { + "$ref" : "#/components/schemas/ProposedSchedule" + }, + "proximityMeters" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "uploaded" : { - "type" : "boolean", + "scheduleUuid" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "summary" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "windowMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "RobotMapPackagingTypeEnum" : { + "RuleTriggerConjunctionEnum" : { "type" : "string", - "enum" : [ "UNKNOWN", "V1" ] + "enum" : [ "AND", "OR", "UNKNOWN" ] }, - "RobotOperatingModeEnum" : { + "RuleTriggerTypeEnum" : { "type" : "string", - "enum" : [ "UNKNOWN", "DOCKED", "DISCOVERY", "PATROL", "MANUAL" ] + "enum" : [ "DEVICE_ACTIVITY_EVENT", "AUDIT_EVENT", "DIAGNOSTIC_EVENT", "ALERT_MONITORING_EVENT", "BADGE_INTEGRATION_EVENT", "SCHEDULED_EVENT", "VISION_LLM_EVENT", "RECURRING_EVENT", "LOCATION_LOCKDOWN_ACTIVATED_EVENT", "LOCATION_LOCKDOWN_DEACTIVATED_EVENT", "BUTTON_INTEGRATION_EVENT", "CUSTOM_LLM_EVENT", "SHELLY_INTEGRATION_EVENT", "INCOMING_WEBHOOK_EVENT", "UNKNOWN" ] }, - "RobotRoute" : { + "RuleType" : { "type" : "object", + "description" : "Updated rule data", "properties" : { - "createdAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "action" : { + "$ref" : "#/components/schemas/RuleActionType" }, - "mapUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "conjunction" : { + "$ref" : "#/components/schemas/RuleTriggerConjunctionEnum" }, "name" : { "type" : "string", @@ -123749,303 +150783,213 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "updatedAtMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "uuid" : { + "ownerUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "waypoints" : { + "ruleFilters" : { + "$ref" : "#/components/schemas/RuleFilterType" + }, + "ruleType" : { + "$ref" : "#/components/schemas/RuleTypeEnum" + }, + "triggers" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Waypoint" + "$ref" : "#/components/schemas/BaseRuleTriggerType" }, "nullable" : true - } - } - }, - "RobotSettings" : { - "type" : "object", - "properties" : { - "home_latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "home_longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "map_assigned_at_ms" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "map_assignment_id" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true }, - "map_id" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "pose" : { - "$ref" : "#/components/schemas/Pose" } } }, - "RobotSettingsSelectiveUpdate" : { + "RuleTypeEnum" : { + "type" : "string", + "enum" : [ "BUTTON_DEFINED", "USER_DEFINED", "DOORBELL_CAMERA_DEFINED", "DOOR_CONTROLLER_DEFINED", "LOCKDOWN_PLAN_DEFINED", "CUSTOM_LLM_DEFINED", "ROBOT_DEFINED", "SCHEDULED_REPORT_DEFINED" ] + }, + "RulesEventRecordType" : { "type" : "object", + "description" : "List of rules event records", "properties" : { - "home_latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true + "activatedLocationLockdownRecord" : { + "$ref" : "#/components/schemas/ActivateLocationLockdownActionRecordType" }, - "home_longitude" : { - "type" : "number", - "format" : "double", + "alertActionRecord" : { + "$ref" : "#/components/schemas/AlertActionRecordType" + }, + "alertMonitoringEventRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlertMonitoringEventRecordType" + }, "nullable" : true }, - "map_assigned_at_ms" : { - "type" : "integer", - "format" : "int64", + "audioPlaybackActionRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AudioPlaybackActionRecordType" + }, "nullable" : true }, - "map_assignment_id" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "cancelLoopingAudioPlaybackActionRecordType" : { + "$ref" : "#/components/schemas/CancelLoopingAudioPlaybackActionRecordType" + }, + "changeComponentCompositeAccessStateRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ChangeComponentCompositeAccessStateRecordType" + }, "nullable" : true }, - "map_id" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "createAlarmRecord" : { + "$ref" : "#/components/schemas/CreateAlarmActionRecordType" + }, + "deviceEventRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeviceEventRecordType" + }, "nullable" : true }, - "pose" : { - "$ref" : "#/components/schemas/Pose" + "enableDisableAudioRecordActionRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EnableDisableAudioRecordActionRecordType" + }, + "nullable" : true }, - "updatedSetMethodMap" : { + "integrationActionStatuses" : { "type" : "object", "additionalProperties" : { - "type" : "boolean", - "nullable" : true + "$ref" : "#/components/schemas/IntegrationActionStatusEnum" }, "nullable" : true - } - } - }, - "Robot_AssignMapWSRequest" : { - "type" : "object", - "description" : "New map assignment", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true }, - "floorPlan" : { - "$ref" : "#/components/schemas/RobotFloorPlan_Public" + "liveNotificationActionRecord" : { + "$ref" : "#/components/schemas/LiveNotificationActionRecordType" }, - "mapUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Robot_AssignMapWSResponse" : { - "type" : "object", - "description" : "The robot map assignment information.", - "properties" : { - "assignmentTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true }, - "assignmentUuid" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", + "scheduledEventRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ScheduledEventRecordType" + }, "nullable" : true }, - "mapMeta" : { - "$ref" : "#/components/schemas/RobotMapMeta_Public" - }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Robot_CreateRobotRouteWSRequest" : { - "type" : "object", - "properties" : { - "mapUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "triggerComponentRelayRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TriggerComponentRelayActionRecordType" + }, "nullable" : true }, - "name" : { - "type" : "string", + "triggeredTimestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "waypoints" : { + "unlockDoorActionRecords" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Waypoint" + "$ref" : "#/components/schemas/UnlockDoorActionRecordType" }, "nullable" : true - } - } - }, - "Robot_CreateRobotRouteWSResponse" : { - "type" : "object", - "description" : "The created route.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "route" : { - "$ref" : "#/components/schemas/RobotRoute" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Robot_DeleteRobotRouteWSRequest" : { - "type" : "object", - "properties" : { "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Robot_DeleteRobotRouteWSResponse" : { - "type" : "object", - "description" : "The deleted route.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", - "nullable" : true - }, - "route" : { - "$ref" : "#/components/schemas/RobotRoute" }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Robot_DeleteRobotWSRequest" : { - "type" : "object", - "description" : "Request to delete a robot device.", - "properties" : { - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "visionLLMEventRecords" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/VisionLLMEventRecordType" + }, "nullable" : true }, - "mummify" : { - "type" : "boolean", - "description" : "Whether to mummify the device instead of hard delete", - "example" : false, + "webhookActionStatuses" : { + "type" : "object", + "additionalProperties" : { + "type" : "boolean", + "nullable" : true + }, "nullable" : true } - }, - "required" : [ "deviceUuid", "mummify" ] + } }, - "Robot_DeleteRobotWSResponse" : { + "Rules_CreateRuleWSRequest" : { "type" : "object", - "description" : "Response from deleting a robot device.", + "description" : "Request object for creating a rule.", "properties" : { - "responseStatus" : { - "$ref" : "#/components/schemas/WebResponseStatusEnum" + "rule" : { + "$ref" : "#/components/schemas/RuleType" } } }, - "Robot_DeployRobotWSRequest" : { + "Rules_CreateRuleWSResponse" : { "type" : "object", - "description" : "Request to deploy the robot to a mapped location.", + "description" : "Response object for creating a rule.", "properties" : { - "destination" : { - "type" : "number", - "format" : "double", + "error" : { + "type" : "boolean", "nullable" : true }, - "destinationOrientation" : { - "type" : "number", - "format" : "double", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "deviceUuid" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "webhookSecrets" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Shared secret per webhook action, keyed by webhook URL. Use it to verify the x-rhombus-signature-sha256 HMAC on webhooks Rhombus sends when this rule fires. Returned once at create time; store it securely.", + "nullable" : true + }, + "description" : "Shared secret per webhook action, keyed by webhook URL. Use it to verify the x-rhombus-signature-sha256 HMAC on webhooks Rhombus sends when this rule fires. Returned once at create time; store it securely.", + "nullable" : true } } }, - "Robot_DeployRobotWSResponse" : { - "type" : "object", - "description" : "Response from deleting a robot device." - }, - "Robot_FindRobotMapsWSRequest" : { + "Rules_DeleteIncomingWebhookTokenWSRequest" : { "type" : "object", - "description" : "Find robot maps", + "description" : "Request object for deleting an incoming webhook trigger token.", "properties" : { - "locationUuid" : { + "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -124054,9 +150998,9 @@ } } }, - "Robot_FindRobotMapsWSResponse" : { + "Rules_DeleteIncomingWebhookTokenWSResponse" : { "type" : "object", - "description" : "A list of available robot maps.", + "description" : "Response object for deleting an incoming webhook trigger token.", "properties" : { "error" : { "type" : "boolean", @@ -124066,23 +151010,17 @@ "type" : "string", "nullable" : true }, - "maps" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RobotMapMeta_Public" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Robot_FindRobotRoutesWSRequest" : { + "Rules_DeleteRulePauseSettingWSRequest" : { "type" : "object", + "description" : "Request object for deleting a rule pause setting.", "properties" : { - "mapUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -124091,9 +151029,9 @@ } } }, - "Robot_FindRobotRoutesWSResponse" : { + "Rules_DeleteRulePauseSettingWSResponse" : { "type" : "object", - "description" : "Response containing the robot routes.", + "description" : "Response object for deleting a rule pause setting.", "properties" : { "error" : { "type" : "boolean", @@ -124103,24 +151041,17 @@ "type" : "string", "nullable" : true }, - "routes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RobotRoute" - }, - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Robot_GetMapAssignmentWSRequest" : { + "Rules_DeleteRuleWSRequest" : { "type" : "object", - "description" : "Retrieve the map assignment information for a device", + "description" : "Request object for deleting a rule.", "properties" : { - "deviceUuid" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -124129,22 +151060,10 @@ } } }, - "Robot_GetMapAssignmentWSResponse" : { + "Rules_DeleteRuleWSResponse" : { "type" : "object", - "description" : "The robot map assignment information.", + "description" : "Response object for deleting a rule.", "properties" : { - "assignmentTimeMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "assignmentUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "error" : { "type" : "boolean", "nullable" : true @@ -124153,62 +151072,56 @@ "type" : "string", "nullable" : true }, - "mapMeta" : { - "$ref" : "#/components/schemas/RobotMapMeta_Public" - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Robot_GetRobotConfigWSResponse" : { - "type" : "object", - "description" : "Response containing robot configuration.", - "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" - } - } - }, - "Robot_GetRobotFullStateWSResponse" : { - "type" : "object", - "description" : "Response containing full state information for a robot.", - "properties" : { - "fullState" : { - "$ref" : "#/components/schemas/Robot_RobotFullDeviceStateType" - } - } - }, - "Robot_GetRobotMapImageWSRequest" : { + "Rules_GenerateIncomingWebhookTokenWSRequest" : { "type" : "object", - "description" : "Response containing the robot's current assigned map image.", + "description" : "Request object for generating an incoming webhook trigger token.", "properties" : { - "deviceUuid" : { + "displayName" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Optional display name for the webhook token, shown in api token listings", "nullable" : true } } }, - "Robot_GetRobotMapMetaWSRequest" : { + "Rules_GenerateIncomingWebhookTokenWSResponse" : { "type" : "object", - "description" : "Retrieve map meta", + "description" : "Response object for generating an incoming webhook trigger token.", "properties" : { - "deviceUuid" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "webhookToken" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "webhookUrl" : { + "type" : "string", + "description" : "Full public URL that fires triggers referencing this token", + "nullable" : true } } }, - "Robot_GetRobotMapMetaWSResponse" : { + "Rules_GetRulePauseSettingsResponse" : { "type" : "object", - "description" : "Contains information pulled from the uploaded map package", + "description" : "Response object for getting rule pause settings.", "properties" : { "error" : { "type" : "boolean", @@ -124218,20 +151131,17 @@ "type" : "string", "nullable" : true }, - "origin" : { - "type" : "array", - "items" : { - "type" : "number", - "format" : "double", - "description" : "Origin as [x, y, z]" + "rulesPausedMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Map of rule UUIDs to their pause settings", + "items" : { + "$ref" : "#/components/schemas/ScheduledIntervalType" + }, + "nullable" : true }, - "maxItems" : 3, - "minItems" : 3, - "nullable" : true - }, - "resolution" : { - "type" : "number", - "format" : "float", + "description" : "Map of rule UUIDs to their pause settings", "nullable" : true }, "warningMsg" : { @@ -124240,129 +151150,70 @@ } } }, - "Robot_GetRobotMediaUrisWSResponse" : { + "Rules_GetRulePauseSettingsWSRequest" : { + "type" : "object", + "description" : "Request object for getting rule pause settings." + }, + "Rules_GetRulesForOrgWSRequest" : { "type" : "object", + "description" : "Request object for getting rules for an organization." + }, + "Rules_GetRulesForOrgWSResponse" : { + "type" : "object", + "description" : "Response object for getting rules for an organization.", "properties" : { - "lanCheckUrls" : { - "type" : "array", - "description" : "List of LAN check URLs to verify device availability on local network", - "items" : { - "type" : "string", - "description" : "List of LAN check URLs to verify device availability on local network", - "nullable" : true - }, - "nullable" : true - }, - "lanLiveH264Uris" : { - "type" : "array", - "description" : "List of LAN URIs for live H.264 video streams", - "items" : { - "type" : "string", - "description" : "List of LAN URIs for live H.264 video streams", - "nullable" : true - }, - "nullable" : true - }, - "lanLiveMpdUris" : { - "type" : "array", - "description" : "List of LAN URIs for live MPD streams", - "items" : { - "type" : "string", - "description" : "List of LAN URIs for live MPD streams", - "nullable" : true - }, - "nullable" : true - }, - "lanLiveOpusUris" : { - "type" : "array", - "description" : "List of LAN URIs for live Opus audio streams", - "items" : { - "type" : "string", - "description" : "List of LAN URIs for live Opus audio streams", - "nullable" : true - }, + "error" : { + "type" : "boolean", "nullable" : true }, - "lanVodM3u8UrisTemplates" : { - "type" : "array", - "description" : "List of LAN URI templates for VOD M3U8 streams", - "items" : { - "type" : "string", - "description" : "List of LAN URI templates for VOD M3U8 streams", - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "lanVodMpdUrisTemplates" : { + "rules" : { "type" : "array", - "description" : "List of LAN URI templates for VOD MPD streams", + "description" : "List of rules for the organization", "items" : { - "type" : "string", - "description" : "List of LAN URI templates for VOD MPD streams", - "nullable" : true + "$ref" : "#/components/schemas/RuleType" }, "nullable" : true }, - "wanLiveH264Uri" : { - "type" : "string", - "description" : "WAN URI for live H.264 video stream", - "nullable" : true - }, - "wanLiveMpdUri" : { - "type" : "string", - "description" : "WAN URI for live MPD stream", - "nullable" : true - }, - "wanLiveOpusUri" : { - "type" : "string", - "description" : "WAN URI for live Opus audio stream", - "nullable" : true - }, - "wanLiveRobotUri" : { - "type" : "string", - "nullable" : true - }, - "wanVodM3u8UriTemplate" : { - "type" : "string", - "description" : "WAN URI template for VOD M3U8 streams", - "nullable" : true - }, - "wanVodMpdUriTemplate" : { + "warningMsg" : { "type" : "string", - "description" : "WAN URI template for VOD MPD streams", "nullable" : true } } }, - "Robot_GetRobotMinimalStateListWSResponse" : { + "Rules_PauseRuleWSRequest" : { "type" : "object", - "description" : "Response containing minimal state information for all robots in organization.", + "description" : "Request object for pausing a rule.", "properties" : { - "minimalStates" : { - "type" : "array", - "description" : "List of minimal device state information for robots", - "items" : { - "$ref" : "#/components/schemas/MinimalRobotStateType" - }, + "durationSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration to pause the rule in seconds", + "example" : 3600, "nullable" : true - } - } - }, - "Robot_GetRobotRouteWSRequest" : { - "type" : "object", - "properties" : { - "uuid" : { + }, + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "scheduledTimestampSec" : { + "type" : "integer", + "format" : "int64", + "description" : "Scheduled timestamp in seconds when the pause should take effect", + "example" : 1640995200, + "nullable" : true } } }, - "Robot_GetRobotRouteWSResponse" : { + "Rules_PauseRuleWSResponse" : { "type" : "object", - "description" : "Response containing the robot Route.", + "description" : "Response object for pausing a rule.", "properties" : { "error" : { "type" : "boolean", @@ -124372,689 +151223,446 @@ "type" : "string", "nullable" : true }, - "route" : { - "$ref" : "#/components/schemas/RobotRoute" - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Robot_RobotFullDeviceStateType" : { + "Rules_UpdateRuleWSRequest" : { "type" : "object", - "description" : "Full device state information for the robot", + "description" : "Request object for updating a rule.", "properties" : { - "afSupport" : { - "type" : "boolean", - "nullable" : true - }, - "audioSupported" : { - "type" : "boolean", - "nullable" : true - }, - "baseVideoOperationUri" : { - "type" : "string", - "nullable" : true - }, - "batteryPercent" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "charging" : { + "ruleUpdate" : { + "$ref" : "#/components/schemas/RuleType" + } + } + }, + "Rules_UpdateRuleWSResponse" : { + "type" : "object", + "description" : "Response object for updating a rule.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "connectionStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "connectionTimestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "defaultInterface" : { - "type" : "string", - "nullable" : true - }, - "defaultInterfaceMac" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "directionRadians" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "externalIPAddress" : { + "warningMsg" : { "type" : "string", "nullable" : true }, - "facetNameMap" : { + "webhookSecrets" : { "type" : "object", "additionalProperties" : { "type" : "string", + "description" : "Shared secret per webhook action, keyed by webhook URL. Use it to verify the x-rhombus-signature-sha256 HMAC on webhooks Rhombus sends when this rule fires. Existing webhook URLs keep their previous secret; newly added webhook URLs get a new secret returned here. Store it securely.", "nullable" : true }, + "description" : "Shared secret per webhook action, keyed by webhook URL. Use it to verify the x-rhombus-signature-sha256 HMAC on webhooks Rhombus sends when this rule fires. Existing webhook URLs keep their previous secret; newly added webhook URLs get a new secret returned here. Store it securely.", "nullable" : true - }, - "firmwareUpdateInProgress" : { - "type" : "boolean", - "nullable" : true - }, - "firmwareVersion" : { + } + } + }, + "Rules_records_DeleteRulesEventRecordWSRequest" : { + "type" : "object", + "description" : "Request object for deleting a rules event record.", + "properties" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "floorNumber" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "healthStatus" : { - "$ref" : "#/components/schemas/DeviceStatusEnum" - }, - "healthStatusDetails" : { - "$ref" : "#/components/schemas/DeviceHealthStatusDetailsEnum" - }, - "hwVariation" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "lanAddresses" : { + } + } + }, + "Rules_records_DeleteRulesEventRecordWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a rules event record." + }, + "Rules_records_GetLatestRulesEventRecordsWSRequest" : { + "type" : "object", + "description" : "Request object for getting latest rules event records.", + "properties" : { + "associatedUuids" : { "type" : "array", + "description" : "List of associated UUIDs to filter by", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "latestFirmwareVersion" : { - "type" : "string", - "nullable" : true - }, - "latitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "liveStreamShared" : { - "type" : "boolean", - "nullable" : true - }, - "liveStreamsSharedCount" : { + "n" : { "type" : "integer", "format" : "int32", + "description" : "Number of latest records to retrieve", + "example" : 10, "nullable" : true }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "longitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "mapId" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "maxZoomPercent" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "mediaRegion" : { - "type" : "string", - "nullable" : true - }, - "mediaStorageDeviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "mode" : { - "$ref" : "#/components/schemas/RobotOperatingModeEnum" - }, - "mummified" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "onCameraState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "nullable" : true - }, - "nullable" : true - }, - "onCloudState" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "nullable" : true + } + } + }, + "Rules_records_GetLatestRulesEventRecordsWSResponse" : { + "type" : "object", + "description" : "Response object for getting latest rules event records.", + "properties" : { + "rulesEventRecords" : { + "type" : "array", + "description" : "List of latest rules event records", + "items" : { + "$ref" : "#/components/schemas/RulesEventRecordType" }, "nullable" : true - }, - "orientation" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "policyUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "position" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "region" : { - "type" : "string", - "nullable" : true - }, - "roamingLatitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "roamingLongitude" : { - "type" : "number", - "format" : "double", - "nullable" : true - }, - "secondaryLanAddresses" : { + } + } + }, + "Rules_records_GetRulesEventRecordsWSRequest" : { + "type" : "object", + "description" : "Request object for getting rules event records.", + "properties" : { + "associatedUuids" : { "type" : "array", + "description" : "Associated uuids for devices, components, locations and componenet composites. **Optional, can be null.", "items" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "nullable" : true }, - "serialNumber" : { - "type" : "string", - "nullable" : true - }, - "ssid" : { - "type" : "string", + "endTime" : { + "type" : "integer", + "format" : "int64", + "description" : "End time for the query period", + "example" : 1640998800000, "nullable" : true }, - "stateUpdatedTimestampMs" : { + "startTime" : { "type" : "integer", "format" : "int64", + "description" : "Start time for the query period", + "example" : 1640995200000, "nullable" : true - }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "supportedFacets" : { + } + } + }, + "Rules_records_GetRulesEventRecordsWSResponse" : { + "type" : "object", + "description" : "Response object for getting rules event records.", + "properties" : { + "rulesEventRecords" : { "type" : "array", + "description" : "List of rules event records", "items" : { - "$ref" : "#/components/schemas/DeviceFacetEnum" + "$ref" : "#/components/schemas/RulesEventRecordType" }, - "nullable" : true, - "uniqueItems" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "versionsBehind" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "wifiApMac" : { - "type" : "string", - "nullable" : true - }, - "wifiBars" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "wifiSignalStrength" : { - "type" : "integer", - "format" : "int32", "nullable" : true } } }, - "Robot_UpdateRobotConfigWSRequest" : { + "Rules_records_GetRulesFilteredWSRequest" : { "type" : "object", - "description" : "Request to update robot configuration.", + "description" : "Request object for getting filtered rules.", "properties" : { - "configUpdate" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalUpdateableFacetedUserConfig" + "associatedUuids" : { + "type" : "array", + "description" : "List of associated UUIDs to filter by", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "ruleTypeFilter" : { + "type" : "array", + "description" : "List of rule types to filter by", + "items" : { + "$ref" : "#/components/schemas/RuleTypeEnum" + }, + "nullable" : true } } }, - "Robot_UpdateRobotConfigWSResponse" : { + "RunStatusEnum" : { + "type" : "string", + "enum" : [ "PENDING", "NAVIGATING", "ARRIVED", "COMPLETED" ] + }, + "SAMLSettingsType" : { "type" : "object", - "description" : "Response indicating the result of updating robot device configuration.", "properties" : { - "config" : { - "$ref" : "#/components/schemas/Device_config_userconfig_ExternalReadableFacetedUserConfig" + "addUsersOnRoleMismatch" : { + "type" : "boolean", + "nullable" : true }, - "error" : { + "enabled" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "idpMetaDataXml" : { "type" : "string", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "justInTimeAccountProvisioningEnabled" : { + "type" : "boolean", "nullable" : true } } }, - "Robot_UpdateRobotDetailsWSRequest" : { + "SCIMRolesFormatEnum" : { + "type" : "string", + "enum" : [ "LIST_OF_STRINGS", "LIST_OF_MULTI_VALUED_ATTRIBUTES" ] + }, + "SCIMSettingsType" : { "type" : "object", - "description" : "Request to update robot details.", "properties" : { - "description" : { - "type" : "string", - "description" : "Optional description for the robot", - "example" : "Patrols the lobby.", + "addUsersOnRoleMismatch" : { + "type" : "boolean", "nullable" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "latitude" : { - "type" : "number", - "format" : "double", - "description" : "Optional latitude coordinate", - "example" : 37.7749, + "forceRolesStrictSchemaFormat" : { + "type" : "boolean", "nullable" : true }, - "locationUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "longitude" : { - "type" : "number", - "format" : "double", - "description" : "Optional longitude coordinate", - "example" : -122.4194, - "nullable" : true - }, - "name" : { - "type" : "string", - "description" : "Optional name for the robot", - "example" : "Robocop", - "nullable" : true + "rhombusKeyAppSettings" : { + "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" }, - "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "rolesFormat" : { + "$ref" : "#/components/schemas/SCIMRolesFormatEnum" }, - "subLocationsHierarchyKeyUpdated" : { - "type" : "boolean", - "description" : "Whether the sub-locations hierarchy key has been updated", - "example" : false, - "nullable" : true - } - } - }, - "Robot_UpdateRobotMapWSRequest" : { - "type" : "object", - "description" : "Updates a robot map", - "properties" : { - "cascadeUpdate" : { + "sendWelcomeEmailToNewRhombusKeyUsers" : { "type" : "boolean", "nullable" : true }, - "floorPlan" : { - "$ref" : "#/components/schemas/RobotFloorPlan_Public" - }, - "locationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "sendWelcomeEmailToNewUsers" : { + "type" : "boolean", "nullable" : true }, - "mapUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Robot_UpdateRobotMapWSResponse" : { + "SalesforceLicenseStartDateTimeAndEndDateTime" : { "type" : "object", - "description" : "The result of an update to a robot map", + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "contractEndDateTime" : { "type" : "string", "nullable" : true }, - "mapMeta" : { - "$ref" : "#/components/schemas/RobotMapMeta_Public" - }, - "warningMsg" : { + "contractStartDateTime" : { "type" : "string", "nullable" : true } } }, - "Robot_UpdateRobotRouteWSRequest" : { + "SaltoSettings" : { "type" : "object", "properties" : { - "mapUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "alertUnauthorizedFaces" : { + "type" : "boolean", "nullable" : true }, - "name" : { - "type" : "string", + "createSeekPoints" : { + "type" : "boolean", "nullable" : true }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "enabled" : { + "type" : "boolean", "nullable" : true }, - "waypoints" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Waypoint" - }, - "nullable" : true - } - } - }, - "Robot_UpdateRobotRouteWSResponse" : { - "type" : "object", - "description" : "Response containing the updated robot Route.", - "properties" : { - "error" : { + "identifyFacesFromBadge" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "saveClips" : { + "type" : "boolean", "nullable" : true }, - "route" : { - "$ref" : "#/components/schemas/RobotRoute" - }, - "warningMsg" : { - "type" : "string", + "tokenToCamerasMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, "nullable" : true } } }, - "RtspEndpoint" : { + "SavedClipV2Type" : { "type" : "object", + "description" : "List of saved clips", "properties" : { - "audioSupported" : { - "type" : "boolean", - "nullable" : true + "accessSettings" : { + "$ref" : "#/components/schemas/ClipAccessSettings" }, - "lastRtspUrlStatus" : { - "$ref" : "#/components/schemas/UrlStatusEnum" + "alterMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlteredView" + }, + "nullable" : true + }, + "nullable" : true }, - "onvifProfileToken" : { - "type" : "string", + "analyzed" : { + "type" : "boolean", "nullable" : true }, - "rtspUrl" : { - "type" : "string", + "byteCount" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "source" : { - "$ref" : "#/components/schemas/RtspEndpointSourceEnum" + "clipLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" }, - "uuid" : { + "clipLocationV2" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "RtspEndpointSourceEnum" : { - "type" : "string", - "enum" : [ "USER", "ONVIF" ] - }, - "RuleActionType" : { - "type" : "object", - "description" : "The action to take when this lockdown rule is triggered.", - "properties" : { - "activateLocationLockdown" : { - "$ref" : "#/components/schemas/ActivateLocationLockdownActionType" }, - "alertAction" : { + "consoleDelete" : { "type" : "boolean", "nullable" : true }, - "audioPlaybackActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AudioPlaybackActionType" - }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "cancelLoopingAudioPlaybackAction" : { - "$ref" : "#/components/schemas/CancelLoopingAudioPlaybackActionType" - }, - "changeComponentCompositeAccessStateActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ChangeComponentCompositeAccessStateActionType" - }, + "description" : { + "type" : "string", "nullable" : true }, - "connectAudioDeviceToPhoneNumberAction" : { - "$ref" : "#/components/schemas/ConnectAudioDeviceToPhoneNumberActionType" - }, - "customActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CustomRuleAction" + "deviceIntervalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true }, "nullable" : true }, - "customLLMActions" : { + "devicePresentationOrder" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/CustomLLMActionType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "enableDisableAudioRecordActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EnableDisableAudioRecordActionType" - }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "integrationCommandActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/IntegrationCommandActionType" + "deviceUuidMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MetaDataLocationType" }, "nullable" : true }, - "integrationNotificationActions" : { + "deviceUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/IntegrationNotificationActionType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "liveNotificationAction" : { - "type" : "boolean", + "durationSec" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "remoteDoorUnlockActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RemoteDoorUnlockActionType" - }, + "externalTransactionId" : { + "type" : "string", "nullable" : true }, - "thirdPartyAudioPlaybackAction" : { - "$ref" : "#/components/schemas/ThirdPartyAudioPlaybackActionType" + "fisheyeHardware" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "triggerComponentRelayActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TriggerComponentRelayActionType" + "fisheyeMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DewarpedView" + }, + "nullable" : true }, "nullable" : true }, - "webhookActions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/WebhookActionType" - }, - "nullable" : true - } - } - }, - "RuleEventOriginator" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "ruleName" : { - "type" : "string", - "nullable" : true - }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/EventOriginatorEnum" - } - } - }, - "RuleFilterType" : { - "type" : "object", - "description" : "Optional filters to apply to this lockdown rule.", - "properties" : { - "scheduleUuids" : { + "integrationUploadList" : { "type" : "array", - "description" : "List of schedules that apply to the rule. at least one schedule must be met to trigger this rule. If null, then this rule is enabled all the time.", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "triggerBackoffSecs" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of seconds to back off after rule is triggered before triggering again. I.e. this rule will only trigger once every X seconds regardless of how many triggering events occur within that window", - "nullable" : true - } - } - }, - "RuleLockdownEventOriginator" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "ruleName" : { - "type" : "string", - "nullable" : true - }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/LockdownEventOriginatorEnumType" - } - } - }, - "RuleTriggerConjunctionEnum" : { - "type" : "string", - "enum" : [ "AND", "OR", "UNKNOWN" ] - }, - "RuleTriggerTypeEnum" : { - "type" : "string", - "enum" : [ "DEVICE_ACTIVITY_EVENT", "AUDIT_EVENT", "DIAGNOSTIC_EVENT", "ALERT_MONITORING_EVENT", "BADGE_INTEGRATION_EVENT", "SCHEDULED_EVENT", "VISION_LLM_EVENT", "RECURRING_EVENT", "LOCATION_LOCKDOWN_ACTIVATED_EVENT", "LOCATION_LOCKDOWN_DEACTIVATED_EVENT", "BUTTON_INTEGRATION_EVENT", "CUSTOM_LLM_EVENT", "SHELLY_INTEGRATION_EVENT", "UNKNOWN" ] - }, - "RuleType" : { - "type" : "object", - "description" : "Updated rule data", - "properties" : { - "action" : { - "$ref" : "#/components/schemas/RuleActionType" + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "nullable" : true }, - "conjunction" : { - "$ref" : "#/components/schemas/RuleTriggerConjunctionEnum" + "isMonitoringClip" : { + "type" : "boolean", + "nullable" : true }, - "name" : { - "type" : "string", + "isVendorClip" : { + "type" : "boolean", "nullable" : true }, + "mountingDirection" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + }, "orgUuid" : { "type" : "string", "format" : "RUUID", @@ -125062,24 +151670,49 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ownerUuid" : { + "placeholder" : { + "type" : "boolean", + "nullable" : true + }, + "sendToSharedStorage" : { + "type" : "boolean", + "nullable" : true + }, + "sha256Hex" : { + "type" : "string", + "nullable" : true + }, + "sourceAlertUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ruleFilters" : { - "$ref" : "#/components/schemas/RuleFilterType" + "status" : { + "$ref" : "#/components/schemas/ClipStatusEnum" }, - "ruleType" : { - "$ref" : "#/components/schemas/RuleTypeEnum" + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" }, - "triggers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BaseRuleTriggerType" - }, + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "title" : { + "type" : "string", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "uuid" : { @@ -125088,70 +151721,153 @@ "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "videoResolution" : { + "$ref" : "#/components/schemas/Resolution" } } }, - "RuleTypeEnum" : { - "type" : "string", - "enum" : [ "BUTTON_DEFINED", "USER_DEFINED", "DOORBELL_CAMERA_DEFINED", "DOOR_CONTROLLER_DEFINED", "LOCKDOWN_PLAN_DEFINED", "CUSTOM_LLM_DEFINED", "ROBOT_DEFINED" ] - }, - "RulesEventRecordType" : { + "SavedClipWithDetailsType" : { "type" : "object", - "description" : "List of rules event records", + "description" : "Detailed information about the saved clip", "properties" : { - "activatedLocationLockdownRecord" : { - "$ref" : "#/components/schemas/ActivateLocationLockdownActionRecordType" - }, - "alertActionRecord" : { - "$ref" : "#/components/schemas/AlertActionRecordType" + "accessSettings" : { + "$ref" : "#/components/schemas/ClipAccessSettings" }, - "alertMonitoringEventRecords" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlertMonitoringEventRecordType" + "alterMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AlteredView" + }, + "nullable" : true }, "nullable" : true }, - "audioPlaybackActionRecords" : { + "analyzed" : { + "type" : "boolean", + "nullable" : true + }, + "boundingBoxes" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/AudioPlaybackActionRecordType" + "$ref" : "#/components/schemas/ClipBoundingBoxType" }, "nullable" : true }, - "cancelLoopingAudioPlaybackActionRecordType" : { - "$ref" : "#/components/schemas/CancelLoopingAudioPlaybackActionRecordType" + "byteCount" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "changeComponentCompositeAccessStateRecords" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ChangeComponentCompositeAccessStateRecordType" + "clipLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "clipLocationV2" : { + "type" : "string", + "nullable" : true + }, + "consoleDelete" : { + "type" : "boolean", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "description" : { + "type" : "string", + "nullable" : true + }, + "deviceIntervalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true }, "nullable" : true }, - "deviceEventRecords" : { + "devicePresentationOrder" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/DeviceEventRecordType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "enableDisableAudioRecordActionRecords" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "deviceUuidMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "nullable" : true + }, + "deviceUuids" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/EnableDisableAudioRecordActionRecordType" + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true }, "nullable" : true }, - "integrationActionStatuses" : { + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "externalTransactionId" : { + "type" : "string", + "nullable" : true + }, + "fisheyeHardware" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "fisheyeMap" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/IntegrationActionStatusEnum" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DewarpedView" + }, + "nullable" : true }, "nullable" : true }, - "liveNotificationActionRecord" : { - "$ref" : "#/components/schemas/LiveNotificationActionRecordType" + "integrationUploadList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "nullable" : true + }, + "isMonitoringClip" : { + "type" : "boolean", + "nullable" : true + }, + "isVendorClip" : { + "type" : "boolean", + "nullable" : true + }, + "mountingDirection" : { + "$ref" : "#/components/schemas/CameraMountingDirectionEnum" }, "orgUuid" : { "type" : "string", @@ -125160,113 +151876,166 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "ruleUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "placeholder" : { + "type" : "boolean", "nullable" : true }, - "scheduledEventRecords" : { + "seekPoints" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/ScheduledEventRecordType" + "$ref" : "#/components/schemas/ClipSeekPointV2Type" }, "nullable" : true }, - "triggerComponentRelayRecords" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TriggerComponentRelayActionRecordType" - }, + "sendToSharedStorage" : { + "type" : "boolean", "nullable" : true }, - "triggeredTimestampMs" : { + "sha256Hex" : { + "type" : "string", + "nullable" : true + }, + "sourceAlertUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/ClipStatusEnum" + }, + "thumbnailLocation" : { + "$ref" : "#/components/schemas/MetaDataLocationType" + }, + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true + }, + "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true }, - "unlockDoorActionRecords" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UnlockDoorActionRecordType" - }, + "title" : { + "type" : "string", "nullable" : true }, - "uuid" : { + "userUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "visionLLMEventRecords" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/VisionLLMEventRecordType" - }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "webhookActionStatuses" : { - "type" : "object", - "additionalProperties" : { - "type" : "boolean", - "nullable" : true - }, - "nullable" : true + "videoResolution" : { + "$ref" : "#/components/schemas/Resolution" } } }, - "Rules_CreateRuleWSRequest" : { + "SceneQueryReport" : { "type" : "object", - "description" : "Request object for creating a rule.", + "description" : "List of time series data points", "properties" : { - "rule" : { - "$ref" : "#/components/schemas/RuleType" + "deviceFacetUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "events" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SceneQueryReportEvent" + }, + "nullable" : true + }, + "promptType" : { + "$ref" : "#/components/schemas/PromptTypeEnum" + }, + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, - "Rules_CreateRuleWSResponse" : { + "SceneQueryReportEvent" : { "type" : "object", - "description" : "Response object for creating a rule.", + "description" : "Scene query report event from the triggered prompt", "properties" : { - "error" : { + "checkCondition" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "image" : { "type" : "string", "nullable" : true }, - "ruleUuid" : { + "imageOffsets" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true + }, + "prompt" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "value" : { "type" : "string", "nullable" : true } } }, - "Rules_DeleteRulePauseSettingWSRequest" : { + "Scenequery_AdHocPromptWSRequest" : { "type" : "object", - "description" : "Request object for deleting a rule pause setting.", + "description" : "Request object for adhoc prompt.", "properties" : { - "uuid" : { + "deviceFacetUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds for the trigger", + "example" : 1640995200000, + "nullable" : true } } }, - "Rules_DeleteRulePauseSettingWSResponse" : { + "Scenequery_AdHocPromptWSResponse" : { "type" : "object", - "description" : "Response object for deleting a rule pause setting.", + "description" : "Response object for triggering a prompt.", "properties" : { "error" : { "type" : "boolean", @@ -125276,28 +152045,43 @@ "type" : "string", "nullable" : true }, + "event" : { + "$ref" : "#/components/schemas/SceneQueryReportEvent" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Rules_DeleteRuleWSRequest" : { + "Scenequery_ChatMessageType" : { "type" : "object", - "description" : "Request object for deleting a rule.", + "description" : "A single chat message with a role and text content.", "properties" : { - "ruleUuid" : { + "role" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "description" : "Role of the message sender (user or model)", + "nullable" : true + }, + "text" : { + "type" : "string", + "description" : "Text content of the message", "nullable" : true } } }, - "Rules_DeleteRuleWSResponse" : { + "Scenequery_CreatePromptConfigurationWSRequest" : { "type" : "object", - "description" : "Response object for deleting a rule.", + "description" : "Request object for creating a prompt configuration.", + "properties" : { + "promptConfiguration" : { + "$ref" : "#/components/schemas/PromptConfigurationType" + } + } + }, + "Scenequery_CreatePromptConfigurationWSResponse" : { + "type" : "object", + "description" : "Response object for creating a prompt configuration.", "properties" : { "error" : { "type" : "boolean", @@ -125307,15 +152091,31 @@ "type" : "string", "nullable" : true }, + "promptConfiguration" : { + "$ref" : "#/components/schemas/PromptConfigurationType" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Rules_GetRulePauseSettingsResponse" : { + "Scenequery_DeletePromptConfigurationWSRequest" : { "type" : "object", - "description" : "Response object for getting rule pause settings.", + "description" : "Request object for deleting a prompt configuration.", + "properties" : { + "promptUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Scenequery_DeletePromptConfigurationWSResponse" : { + "type" : "object", + "description" : "Response object for deleting a prompt configuration.", "properties" : { "error" : { "type" : "boolean", @@ -125325,36 +152125,19 @@ "type" : "string", "nullable" : true }, - "rulesPausedMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "description" : "Map of rule UUIDs to their pause settings", - "items" : { - "$ref" : "#/components/schemas/ScheduledIntervalType" - }, - "nullable" : true - }, - "description" : "Map of rule UUIDs to their pause settings", - "nullable" : true - }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Rules_GetRulePauseSettingsWSRequest" : { - "type" : "object", - "description" : "Request object for getting rule pause settings." - }, - "Rules_GetRulesForOrgWSRequest" : { + "Scenequery_FindAllPromptConfigurationsWSRequest" : { "type" : "object", - "description" : "Request object for getting rules for an organization." + "description" : "Request object for finding all prompt configurations." }, - "Rules_GetRulesForOrgWSResponse" : { + "Scenequery_FindAllPromptConfigurationsWSResponse" : { "type" : "object", - "description" : "Response object for getting rules for an organization.", + "description" : "Response object for finding all prompt configurations.", "properties" : { "error" : { "type" : "boolean", @@ -125364,11 +152147,11 @@ "type" : "string", "nullable" : true }, - "rules" : { + "promptConfigurations" : { "type" : "array", - "description" : "List of rules for the organization", + "description" : "List of all prompt configurations", "items" : { - "$ref" : "#/components/schemas/RuleType" + "$ref" : "#/components/schemas/PromptConfigurationType" }, "nullable" : true }, @@ -125378,36 +152161,22 @@ } } }, - "Rules_PauseRuleWSRequest" : { + "Scenequery_GetPromptConfigurationWSRequest" : { "type" : "object", - "description" : "Request object for pausing a rule.", + "description" : "Request object for getting a prompt configuration.", "properties" : { - "durationSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration to pause the rule in seconds", - "example" : 3600, - "nullable" : true - }, - "ruleUuid" : { + "promptUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "scheduledTimestampSec" : { - "type" : "integer", - "format" : "int64", - "description" : "Scheduled timestamp in seconds when the pause should take effect", - "example" : 1640995200, - "nullable" : true } } }, - "Rules_PauseRuleWSResponse" : { + "Scenequery_GetPromptConfigurationWSResponse" : { "type" : "object", - "description" : "Response object for pausing a rule.", + "description" : "Response object for getting a prompt configuration.", "properties" : { "error" : { "type" : "boolean", @@ -125417,24 +152186,82 @@ "type" : "string", "nullable" : true }, + "promptConfiguration" : { + "$ref" : "#/components/schemas/PromptConfigurationType" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Rules_UpdateRuleWSRequest" : { + "Scenequery_OptimizationContextType" : { "type" : "object", - "description" : "Request object for updating a rule.", + "description" : "Context for prompt optimization including the camera frame, original prompt, and expected answer.", "properties" : { - "ruleUpdate" : { - "$ref" : "#/components/schemas/RuleType" + "deviceFacetUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "expectedAnswer" : { + "type" : "string", + "description" : "Expected answer the prompt should produce", + "nullable" : true + }, + "optionalContext" : { + "type" : "string", + "description" : "Optional additional context for the optimization", + "nullable" : true + }, + "originalAnswer" : { + "type" : "string", + "description" : "Original answer produced by the LLM (must be a boolean, number, or percentage)", + "nullable" : true + }, + "originalPrompt" : { + "type" : "string", + "description" : "Original prompt that was used", + "nullable" : true + }, + "region" : { + "$ref" : "#/components/schemas/Scenequery_RegionPolygonType" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in milliseconds for the camera frame to use", + "nullable" : true } } }, - "Rules_UpdateRuleWSResponse" : { + "Scenequery_PromptOptimizationChatWSRequest" : { "type" : "object", - "description" : "Response object for updating a rule.", + "description" : "Request object for prompt optimization chat.", + "properties" : { + "context" : { + "$ref" : "#/components/schemas/Scenequery_OptimizationContextType" + }, + "currentMessage" : { + "type" : "string", + "description" : "Current user message", + "nullable" : true + }, + "history" : { + "type" : "array", + "description" : "Chat history messages", + "items" : { + "$ref" : "#/components/schemas/Scenequery_ChatMessageType" + }, + "nullable" : true + } + } + }, + "Scenequery_PromptOptimizationChatWSResponse" : { + "type" : "object", + "description" : "Response object for prompt optimization chat.", "properties" : { "error" : { "type" : "boolean", @@ -125444,53 +152271,124 @@ "type" : "string", "nullable" : true }, + "explanation" : { + "type" : "string", + "description" : "Explanation of the optimization", + "nullable" : true + }, + "optimizedPrompt" : { + "type" : "string", + "description" : "The optimized prompt", + "nullable" : true + }, + "questionForUser" : { + "type" : "string", + "description" : "Follow-up question for the user, if any", + "nullable" : true + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, - "Rules_records_DeleteRulesEventRecordWSRequest" : { + "Scenequery_PromptType" : { + "type" : "string", + "description" : "Optional prompt type for the configuration", + "enum" : [ "COUNT", "PERCENT", "BOOLEAN", "TEXT" ] + }, + "Scenequery_RegionCoordinateType" : { "type" : "object", - "description" : "Request object for deleting a rules event record.", "properties" : { - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "x" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "y" : { + "type" : "number", + "format" : "float", "nullable" : true } } }, - "Rules_records_DeleteRulesEventRecordWSResponse" : { + "Scenequery_RegionPolygonType" : { "type" : "object", - "description" : "Response object for deleting a rules event record." + "description" : "Optional region polygon to crop the camera frame", + "properties" : { + "coordinates" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Scenequery_RegionCoordinateType" + }, + "nullable" : true + } + } }, - "Rules_records_GetLatestRulesEventRecordsWSRequest" : { + "Scenequery_SelectiveUpdatePromptConfigurationWSRequest" : { "type" : "object", - "description" : "Request object for getting latest rules event records.", + "description" : "Request object for selectively updating a prompt configuration.", "properties" : { - "associatedUuids" : { + "active" : { + "type" : "boolean", + "description" : "Optional active status for the prompt configuration", + "nullable" : true + }, + "cameraConfigurations" : { "type" : "array", - "description" : "List of associated UUIDs to filter by", + "description" : "List of camera configurations for the prompt", "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true + "$ref" : "#/components/schemas/CameraConfiguration" }, "nullable" : true }, - "n" : { + "checkCondition" : { + "$ref" : "#/components/schemas/CheckCondition" + }, + "description" : { + "type" : "string", + "description" : "Optional description for the prompt configuration", + "nullable" : true + }, + "minuteTriggerRate" : { "type" : "integer", "format" : "int32", - "description" : "Number of latest records to retrieve", - "example" : 10, + "description" : "Optional minute trigger rate for the configuration", "nullable" : true }, - "ruleUuid" : { + "name" : { + "type" : "string", + "description" : "Optional name for the prompt configuration", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "prompt" : { + "type" : "string", + "description" : "Optional prompt text for the configuration", + "nullable" : true + }, + "promptType" : { + "$ref" : "#/components/schemas/Scenequery_PromptType" + }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "shortName" : { + "type" : "string", + "description" : "Optional short name for the prompt configuration", + "nullable" : true + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", @@ -125499,529 +152397,660 @@ } } }, - "Rules_records_GetLatestRulesEventRecordsWSResponse" : { + "Scenequery_SelectiveUpdatePromptConfigurationWSResponse" : { "type" : "object", - "description" : "Response object for getting latest rules event records.", + "description" : "Response object for selectively updating a prompt configuration.", "properties" : { - "rulesEventRecords" : { - "type" : "array", - "description" : "List of latest rules event records", - "items" : { - "$ref" : "#/components/schemas/RulesEventRecordType" - }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Rules_records_GetRulesEventRecordsWSRequest" : { + "Scenequery_TriggerPromptWSRequest" : { "type" : "object", - "description" : "Request object for getting rules event records.", + "description" : "Request object for triggering a prompt.", "properties" : { - "associatedUuids" : { + "deviceFacetUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "multiImageTimeDeltasSeconds" : { "type" : "array", - "description" : "Associated uuids for devices, components, locations and componenet composites. **Optional, can be null.", + "description" : "Optional list of time deltas in seconds (relative to timestampMs) for multi-image mode. Max 5 entries, each in range [-30, 3600]. When non-empty, the prompt runs against a set of frames: the base image at timestampMs (always included) plus one frame per distinct non-zero delta. Duplicates and 0 are deduped. Omit or send null/empty for single-image mode.", + "example" : [ -10, -5, 5 ], "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "type" : "integer", + "format" : "int32", + "description" : "Optional list of time deltas in seconds (relative to timestampMs) for multi-image mode. Max 5 entries, each in range [-30, 3600]. When non-empty, the prompt runs against a set of frames: the base image at timestampMs (always included) plus one frame per distinct non-zero delta. Duplicates and 0 are deduped. Omit or send null/empty for single-image mode.", "nullable" : true }, "nullable" : true }, - "endTime" : { - "type" : "integer", - "format" : "int64", - "description" : "End time for the query period", - "example" : 1640998800000, + "prompt" : { + "type" : "string", + "description" : "Prompt text to trigger", + "example" : "Count people in the scene", "nullable" : true }, - "startTime" : { + "promptType" : { + "$ref" : "#/components/schemas/PromptTypeEnum" + }, + "region" : { + "$ref" : "#/components/schemas/RegionPolygonType" + }, + "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Start time for the query period", + "description" : "Timestamp in milliseconds for the trigger", "example" : 1640995200000, "nullable" : true } } }, - "Rules_records_GetRulesEventRecordsWSResponse" : { + "Scenequery_TriggerPromptWSResponse" : { "type" : "object", - "description" : "Response object for getting rules event records.", + "description" : "Response object for triggering a prompt.", "properties" : { - "rulesEventRecords" : { - "type" : "array", - "description" : "List of rules event records", - "items" : { - "$ref" : "#/components/schemas/RulesEventRecordType" - }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "event" : { + "$ref" : "#/components/schemas/SceneQueryReportEvent" + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "Rules_records_GetRulesFilteredWSRequest" : { + "Scenequery_UpdatePromptConfigurationWSRequest" : { "type" : "object", - "description" : "Request object for getting filtered rules.", + "description" : "Request object for updating a prompt configuration.", "properties" : { - "associatedUuids" : { - "type" : "array", - "description" : "List of associated UUIDs to filter by", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "ruleTypeFilter" : { - "type" : "array", - "description" : "List of rule types to filter by", - "items" : { - "$ref" : "#/components/schemas/RuleTypeEnum" - }, - "nullable" : true + "promptConfiguration" : { + "$ref" : "#/components/schemas/PromptConfigurationType" } } }, - "SAMLSettingsType" : { + "Scenequery_UpdatePromptConfigurationWSResponse" : { "type" : "object", + "description" : "Response object for updating a prompt configuration.", "properties" : { - "addUsersOnRoleMismatch" : { - "type" : "boolean", - "nullable" : true - }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "idpMetaDataXml" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "justInTimeAccountProvisioningEnabled" : { - "type" : "boolean", + "promptConfiguration" : { + "$ref" : "#/components/schemas/PromptConfigurationType" + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "SCIMRolesFormatEnum" : { + "ScheduleStrategyEnum" : { "type" : "string", - "enum" : [ "LIST_OF_STRINGS", "LIST_OF_MULTI_VALUED_ATTRIBUTES" ] + "enum" : [ "WEEKLY_REPEATING_MINUTES", "ABSOLUTE_SECONDS", "REALTIME_RELATIVE_SECONDS", "RELATIVE_DATETIME_INTERVALS" ] }, - "SCIMSettingsType" : { + "ScheduleStrategyEnum_Minimal" : { + "type" : "string", + "enum" : [ "WEEKLY_REPEATING_MINUTES", "ABSOLUTE_SECONDS", "REALTIME_RELATIVE_SECONDS", "RELATIVE_DATETIME_INTERVALS" ] + }, + "Schedule_AccessStatefulComponentCompositeNextNearestSchedule" : { "type" : "object", + "description" : "Information about the next nearest schedule for access controlled doors.", "properties" : { - "addUsersOnRoleMismatch" : { + "currentlyActive" : { "type" : "boolean", + "description" : "Whether the schedule is currently active", "nullable" : true }, - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "forceRolesStrictSchemaFormat" : { - "type" : "boolean", - "nullable" : true + "doorState" : { + "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "orgUuid" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "rhombusKeyAppSettings" : { - "$ref" : "#/components/schemas/RhombusKeyAppSettingsType" - }, - "rolesFormat" : { - "$ref" : "#/components/schemas/SCIMRolesFormatEnum" - }, - "sendWelcomeEmailToNewRhombusKeyUsers" : { - "type" : "boolean", - "nullable" : true + "source" : { + "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" }, - "sendWelcomeEmailToNewUsers" : { - "type" : "boolean", + "startsAtMillisInclusive" : { + "type" : "integer", + "format" : "int64", + "description" : "Start time in milliseconds (inclusive)", + "example" : 1640995200000, "nullable" : true }, - "updatedAtMillis" : { + "stopsAtMillisInclusive" : { "type" : "integer", "format" : "int64", + "description" : "Stop time in milliseconds (inclusive)", + "example" : 1640998800000, "nullable" : true } } }, - "SalesforceLicenseStartDateTimeAndEndDateTime" : { + "Schedule_AccessStatefulComponentCompositeStateSourceEnum" : { + "type" : "string", + "description" : "Source of the door state", + "enum" : [ "DEFAULT_STATE", "DOOR_SCHEDULE", "DSE_DEFAULT_STATE", "DSE_SCHEDULE", "DOOR_STATE_OVERRIDE" ] + }, + "Schedule_CreateAbsoluteScheduleWSRequest" : { "type" : "object", - "nullable" : true, + "description" : "Request object for creating an absolute schedule.", "properties" : { - "contractEndDateTime" : { - "type" : "string", - "nullable" : true - }, - "contractStartDateTime" : { - "type" : "string", - "nullable" : true + "schedule" : { + "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" } } }, - "SaltoSettings" : { + "Schedule_CreateAbsoluteScheduleWSResponse" : { "type" : "object", + "description" : "Response object for creating an absolute schedule.", "properties" : { - "alertUnauthorizedFaces" : { - "type" : "boolean", - "nullable" : true - }, - "createSeekPoints" : { - "type" : "boolean", - "nullable" : true - }, - "enabled" : { + "error" : { "type" : "boolean", "nullable" : true }, - "identifyFacesFromBadge" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "saveClips" : { - "type" : "boolean", + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "tokenToCamerasMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true } } }, - "SavedClipV2Type" : { + "Schedule_CreateRelativeDateTimeIntervalsScheduleWSRequest" : { "type" : "object", - "description" : "List of saved clips", + "description" : "Request object for creating a relative datetime intervals schedule.", "properties" : { - "accessSettings" : { - "$ref" : "#/components/schemas/ClipAccessSettings" - }, - "alterMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlteredView" - }, - "nullable" : true - }, - "nullable" : true - }, - "analyzed" : { + "schedule" : { + "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" + } + } + }, + "Schedule_CreateRelativeDateTimeIntervalsScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for creating a relative datetime intervals schedule.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "byteCount" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "clipLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "clipLocationV2" : { + "scheduleUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "consoleDelete" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Schedule_CreateRelativeScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for creating a relative schedule.", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" + } + } + }, + "Schedule_CreateRelativeScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for creating a relative schedule.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "description" : { + "scheduleUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "devicePresentationOrder" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Schedule_CreateWeeklyScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for creating a weekly schedule.", + "properties" : { + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + } + } + }, + "Schedule_CreateWeeklyScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for creating a weekly schedule.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "deviceUuid" : { + "errorMsg" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, - "deviceUuidMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, + "scheduleUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "deviceUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "durationSec" : { - "type" : "integer", - "format" : "int32", + } + } + }, + "Schedule_FindAbsoluteScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for finding an absolute schedule.", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Schedule_FindAbsoluteScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for finding an absolute schedule.", + "properties" : { + "error" : { + "type" : "boolean", "nullable" : true }, - "externalTransactionId" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "fisheyeHardware" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" + "schedule" : { + "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" }, - "fisheyeMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DewarpedView" - }, - "nullable" : true - }, + "warningMsg" : { + "type" : "string", "nullable" : true - }, - "integrationUploadList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/IntegrationEnum" - }, + } + } + }, + "Schedule_FindRelativeDateTimeIntervalsScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for finding a relative datetime intervals schedule.", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "isMonitoringClip" : { + } + } + }, + "Schedule_FindRelativeDateTimeIntervalsScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for finding a relative datetime intervals schedule.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "isVendorClip" : { - "type" : "boolean", + "errorMsg" : { + "type" : "string", "nullable" : true }, - "mountingDirection" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + "schedule" : { + "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" }, - "orgUuid" : { + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Schedule_FindRelativeScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for finding a relative schedule.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "sendToSharedStorage" : { + } + } + }, + "Schedule_FindRelativeScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for finding a relative schedule.", + "properties" : { + "error" : { "type" : "boolean", "nullable" : true }, - "sha256Hex" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "sourceAlertUuid" : { + "schedule" : { + "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Schedule_FindWeeklyScheduleWSRequest" : { + "type" : "object", + "description" : "Request object for finding a weekly schedule.", + "properties" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Schedule_FindWeeklyScheduleWSResponse" : { + "type" : "object", + "description" : "Response object for finding a weekly schedule.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "status" : { - "$ref" : "#/components/schemas/ClipStatusEnum" - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "thumbnailLocationV2" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "schedule" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" }, - "title" : { + "warningMsg" : { "type" : "string", "nullable" : true - }, - "userUuid" : { + } + } + }, + "Schedule_GetScheduleDataV2WSRequest" : { + "type" : "object", + "description" : "Request object for getting schedule data v2.", + "properties" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "Schedule_GetScheduleDataV2WSResponse" : { + "type" : "object", + "description" : "Response object for getting schedule data v2.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true }, - "uuid" : { + "errorMsg" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "videoResolution" : { - "$ref" : "#/components/schemas/Resolution" + "warningMsg" : { + "type" : "string", + "nullable" : true + }, + "weeklyScheduleData" : { + "$ref" : "#/components/schemas/Schedule_WeeklyRepeatingScheduleDataType" } } }, - "SavedClipWithDetailsType" : { + "Schedule_GetScheduleDataWSResponse" : { "type" : "object", - "description" : "Detailed information about the saved clip", + "description" : "Response object for getting schedule data.", "properties" : { - "accessSettings" : { - "$ref" : "#/components/schemas/ClipAccessSettings" + "error" : { + "type" : "boolean", + "nullable" : true }, - "alterMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/AlteredView" - }, - "nullable" : true - }, + "errorMsg" : { + "type" : "string", "nullable" : true }, - "analyzed" : { - "type" : "boolean", + "warningMsg" : { + "type" : "string", "nullable" : true }, - "boundingBoxes" : { + "weeklyScheduleData" : { "type" : "array", + "description" : "List of weekly schedule data", "items" : { - "$ref" : "#/components/schemas/ClipBoundingBoxType" + "$ref" : "#/components/schemas/Schedule_WeeklyRepeatingScheduleDataType" }, "nullable" : true - }, - "byteCount" : { - "type" : "integer", - "format" : "int64", + } + } + }, + "Schedule_GetSchedulesWSRequest" : { + "type" : "object", + "description" : "Request object for getting all schedules." + }, + "Schedule_GetSchedulesWSResponse" : { + "type" : "object", + "description" : "Response object for getting all schedules.", + "properties" : { + "absoluteSchedules" : { + "type" : "array", + "description" : "List of absolute schedules", + "items" : { + "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" + }, "nullable" : true }, - "clipLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" + "error" : { + "type" : "boolean", + "nullable" : true }, - "clipLocationV2" : { + "errorMsg" : { "type" : "string", "nullable" : true }, - "consoleDelete" : { - "type" : "boolean", + "relativeDatetimeSchedules" : { + "type" : "array", + "description" : "List of relative datetime intervals schedules", + "items" : { + "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" + }, "nullable" : true }, - "createdAtMs" : { - "type" : "integer", - "format" : "int64", + "relativeSchedules" : { + "type" : "array", + "description" : "List of relative schedules", + "items" : { + "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" + }, "nullable" : true }, - "description" : { + "warningMsg" : { "type" : "string", "nullable" : true }, - "devicePresentationOrder" : { + "weeklySchedules" : { + "type" : "array", + "description" : "List of weekly repeating schedules", + "items" : { + "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + }, + "nullable" : true + } + } + }, + "Schedule_WeeklyRepeatingScheduleDataType" : { + "type" : "object", + "description" : "Weekly repeating schedule data type with usage information.", + "properties" : { + "accessGrantUuids" : { "type" : "array", + "description" : "Set of access grant UUIDs using this schedule", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "deviceUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true + "alarmMonitoringUuids" : { + "type" : "array", + "description" : "Set of alarm monitoring UUIDs using this schedule", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "deviceUuidMap" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/MetaDataLocationType" + "alertPolicyUuids" : { + "type" : "array", + "description" : "Set of alert policy UUIDs using this schedule", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "deviceUuids" : { + "customEventUuids" : { "type" : "array", + "description" : "Set of custom event UUIDs using this schedule", "items" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "durationSec" : { - "type" : "integer", - "format" : "int32", - "nullable" : true + "doorSettingUuids" : { + "type" : "array", + "description" : "Set of door setting UUIDs using this schedule", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "externalTransactionId" : { - "type" : "string", + "internalWriteOnly" : { + "type" : "boolean", "nullable" : true }, - "fisheyeHardware" : { - "$ref" : "#/components/schemas/HardwareVariationEnum" - }, - "fisheyeMap" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DewarpedView" - }, - "nullable" : true + "intervalList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" }, "nullable" : true }, - "integrationUploadList" : { + "locationsUsedIn" : { "type" : "array", + "description" : "Set of location UUIDs where this schedule is used", "items" : { - "$ref" : "#/components/schemas/IntegrationEnum" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "isMonitoringClip" : { + "mutable" : { "type" : "boolean", "nullable" : true }, - "isVendorClip" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "mountingDirection" : { - "$ref" : "#/components/schemas/CameraMountingDirectionEnum" + "oneTimeUse" : { + "type" : "boolean", + "nullable" : true }, "orgUuid" : { "type" : "string", @@ -126030,485 +153059,731 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "seekPoints" : { + "ruleUuids" : { "type" : "array", + "description" : "Set of rule UUIDs using this schedule", "items" : { - "$ref" : "#/components/schemas/ClipSeekPointV2Type" + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true }, - "nullable" : true + "nullable" : true, + "uniqueItems" : true }, - "sendToSharedStorage" : { - "type" : "boolean", - "nullable" : true + "sharedStreamUuids" : { + "type" : "array", + "description" : "Set of shared stream UUIDs using this schedule", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true }, - "sha256Hex" : { - "type" : "string", - "nullable" : true + "strategy" : { + "$ref" : "#/components/schemas/ScheduleStrategyEnum" }, - "sourceAlertUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + } + } + }, + "ScheduledAction" : { + "type" : "object", + "properties" : { + "action" : { + "$ref" : "#/components/schemas/RuleActionType" }, - "status" : { - "$ref" : "#/components/schemas/ClipStatusEnum" - }, - "thumbnailLocation" : { - "$ref" : "#/components/schemas/MetaDataLocationType" - }, - "thumbnailLocationV2" : { - "type" : "string", - "nullable" : true - }, - "timestampMs" : { + "backoffMinutes" : { "type" : "integer", - "format" : "int64", + "format" : "int32", "nullable" : true }, - "title" : { - "type" : "string", + "backoffSeconds" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "userUuid" : { + "ruleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "uuid" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "videoResolution" : { - "$ref" : "#/components/schemas/Resolution" } } }, - "SceneQueryReport" : { + "ScheduledAlarmPolicy" : { "type" : "object", - "description" : "List of time series data points", + "description" : "Threat-detection policies used during scheduled monitoring mode.", + "nullable" : true, "properties" : { - "deviceFacetUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "events" : { + "rules" : { "type" : "array", + "description" : "The rules governing threat detection and subsequent actions.", "items" : { - "$ref" : "#/components/schemas/SceneQueryReportEvent" + "$ref" : "#/components/schemas/AlarmRule" }, "nullable" : true }, - "promptType" : { - "$ref" : "#/components/schemas/PromptTypeEnum" - }, - "promptUuid" : { + "scheduleUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "SceneQueryReportEvent" : { - "type" : "object", - "description" : "Scene query report event from the triggered prompt", - "properties" : { - "checkCondition" : { - "type" : "boolean", - "nullable" : true - }, - "image" : { - "type" : "string", - "nullable" : true }, - "imageOffsets" : { - "type" : "array", - "items" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/MonitoringModeEnum" }, - "prompt" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "value" : { - "type" : "string", - "nullable" : true + "verifiedThreatSiren" : { + "$ref" : "#/components/schemas/AMSirenSettingsType" } - } + }, + "required" : [ "rules", "scheduleUuid" ] }, - "Scenequery_AdHocPromptWSRequest" : { + "ScheduledEventRecordType" : { "type" : "object", - "description" : "Request object for adhoc prompt.", "properties" : { - "deviceFacetUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "promptUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, "timestampMs" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp in milliseconds for the trigger", - "example" : 1640995200000, "nullable" : true } } }, - "Scenequery_AdHocPromptWSResponse" : { + "ScheduledIntervalType" : { "type" : "object", - "description" : "Response object for triggering a prompt.", + "description" : "Map of location UUIDs to snooze intervals", "properties" : { - "error" : { - "type" : "boolean", + "durationSecs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "timestampSec" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "event" : { - "$ref" : "#/components/schemas/SceneQueryReportEvent" - }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Scenequery_ChatMessageType" : { + "ScheduledRuleTriggerType" : { "type" : "object", - "description" : "A single chat message with a role and text content.", - "properties" : { - "role" : { - "type" : "string", - "description" : "Role of the message sender (user or model)", - "nullable" : true - }, - "text" : { - "type" : "string", - "description" : "Text content of the message", - "nullable" : true + "allOf" : [ { + "type" : "object", + "properties" : { + "locationUuids" : { + "type" : "array", + "description" : "List of locations to use for timezone evaluation and for display purposes", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "minOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "minute of the day for this trigger. note that it is dependent on the timezone of the devices in the rule actions or the timezone of the specified locations.", + "nullable" : true + } } - } - }, - "Scenequery_CreatePromptConfigurationWSRequest" : { - "type" : "object", - "description" : "Request object for creating a prompt configuration.", + } ], + "nullable" : true, "properties" : { - "promptConfiguration" : { - "$ref" : "#/components/schemas/PromptConfigurationType" + "type" : { + "$ref" : "#/components/schemas/RuleTriggerTypeEnum" } } }, - "Scenequery_CreatePromptConfigurationWSResponse" : { + "SchlageApmFamilyEnum" : { + "type" : "string", + "description" : "Which family of Schlage lock this is. Stated because the protocol cannot be asked: the OEM code reply has no address in it, so a reply cannot be attributed to one lock. It decides how the lock's status bits are read.", + "enum" : [ "AD_WIRED", "AD_WIRELESS", "ENGAGE", "RMRU" ] + }, + "SchlageBatteryStateEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "OK", "LOW", "CRITICAL" ] + }, + "SchlageDoorExtensionShadow" : { "type" : "object", - "description" : "Response object for creating a prompt configuration.", + "allOf" : [ { + "type" : "object", + "properties" : { + "batteryMillivolts" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "batteryState" : { + "$ref" : "#/components/schemas/SchlageBatteryStateEnum" + }, + "batteryStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "doorMode" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorModeProvenance" : { + "$ref" : "#/components/schemas/SchlageDoorModeProvenanceEnum" + }, + "doorModeUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "gatewayComponentId" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "insidePushbuttonState" : { + "$ref" : "#/components/schemas/SchlageInsidePushbuttonStateEnum" + }, + "insidePushbuttonStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "interpretedDoorMode" : { + "$ref" : "#/components/schemas/SchlageInterpretedDoorModeEnum" + }, + "keyOverrideState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "keyOverrideStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lithiumMillivolts" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "readerConfig" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "readerConfigUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "removed" : { + "type" : "boolean", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "tamperState" : { + "$ref" : "#/components/schemas/SchlageTamperStateEnum" + }, + "tamperStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "promptConfiguration" : { - "$ref" : "#/components/schemas/PromptConfigurationType" - }, - "warningMsg" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Scenequery_DeletePromptConfigurationWSRequest" : { - "type" : "object", - "description" : "Request object for deleting a prompt configuration.", - "properties" : { - "promptUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Scenequery_DeletePromptConfigurationWSResponse" : { - "type" : "object", - "description" : "Response object for deleting a prompt configuration.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true } } }, - "Scenequery_FindAllPromptConfigurationsWSRequest" : { - "type" : "object", - "description" : "Request object for finding all prompt configurations." - }, - "Scenequery_FindAllPromptConfigurationsWSResponse" : { + "SchlageDoorExtensionStateEvent" : { "type" : "object", - "description" : "Response object for finding all prompt configurations.", + "allOf" : [ { + "type" : "object", + "properties" : { + "batteryMillivolts" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "batteryState" : { + "$ref" : "#/components/schemas/SchlageBatteryStateEnum" + }, + "batteryStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "doorMode" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "doorModeProvenance" : { + "$ref" : "#/components/schemas/SchlageDoorModeProvenanceEnum" + }, + "doorModeUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "insidePushbuttonState" : { + "$ref" : "#/components/schemas/SchlageInsidePushbuttonStateEnum" + }, + "insidePushbuttonStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "interpretedDoorMode" : { + "$ref" : "#/components/schemas/SchlageInterpretedDoorModeEnum" + }, + "keyOverrideState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "keyOverrideStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lithiumMillivolts" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "readerConfig" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte", + "nullable" : true + }, + "nullable" : true + }, + "readerConfigUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "removed" : { + "type" : "boolean", + "nullable" : true + }, + "tamperState" : { + "$ref" : "#/components/schemas/SchlageTamperStateEnum" + }, + "tamperStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "componentUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "promptConfigurations" : { - "type" : "array", - "description" : "List of all prompt configurations", - "items" : { - "$ref" : "#/components/schemas/PromptConfigurationType" - }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Scenequery_GetPromptConfigurationWSRequest" : { - "type" : "object", - "description" : "Request object for getting a prompt configuration.", - "properties" : { - "promptUuid" : { + }, + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Scenequery_GetPromptConfigurationWSResponse" : { - "type" : "object", - "description" : "Response object for getting a prompt configuration.", - "properties" : { - "error" : { - "type" : "boolean", + }, + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "subLocationsHierarchyKey" : { "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "promptConfiguration" : { - "$ref" : "#/components/schemas/PromptConfigurationType" + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Scenequery_OptimizationContextType" : { + "SchlageDoorModeProvenanceEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "OBSERVED", "INFERRED" ] + }, + "SchlageGatewayShadow" : { "type" : "object", - "description" : "Context for prompt optimization including the camera frame, original prompt, and expected answer.", + "allOf" : [ { + "type" : "object", + "properties" : { + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "firmwareVersion" : { + "type" : "string", + "nullable" : true + }, + "hwVersion" : { + "type" : "string", + "nullable" : true + }, + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "model" : { + "type" : "string", + "nullable" : true + }, + "rawTamperState" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "serial" : { + "type" : "string", + "nullable" : true + }, + "stateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "tamperOrAppConnected" : { + "type" : "boolean", + "nullable" : true + }, + "tamperOrAppConnectedUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "deviceFacetUuid" : { - "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", - "nullable" : true - }, - "expectedAnswer" : { + "componentUuid" : { "type" : "string", - "description" : "Expected answer the prompt should produce", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "optionalContext" : { - "type" : "string", - "description" : "Optional additional context for the optimization", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "originalAnswer" : { + "orgUuid" : { "type" : "string", - "description" : "Original answer produced by the LLM (must be a boolean, number, or percentage)", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "originalPrompt" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Original prompt that was used", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "region" : { - "$ref" : "#/components/schemas/Scenequery_RegionPolygonType" + "type" : { + "$ref" : "#/components/schemas/ComponentShadowEnumType" }, - "timestampMs" : { + "updatedAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Timestamp in milliseconds for the camera frame to use", "nullable" : true } } }, - "Scenequery_PromptOptimizationChatWSRequest" : { + "SchlageInputButton" : { "type" : "object", - "description" : "Request object for prompt optimization chat.", + "allOf" : [ { + "type" : "object", + "properties" : { + "buttonType" : { + "$ref" : "#/components/schemas/ButtonEnumType" + }, + "gatewayRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "ipbFunction" : { + "$ref" : "#/components/schemas/SchlageIpbFunctionEnum" + }, + "mode" : { + "$ref" : "#/components/schemas/ButtonModeEnum" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "context" : { - "$ref" : "#/components/schemas/Scenequery_OptimizationContextType" + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "currentMessage" : { - "type" : "string", - "description" : "Current user message", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "history" : { - "type" : "array", - "description" : "Chat history messages", - "items" : { - "$ref" : "#/components/schemas/Scenequery_ChatMessageType" - }, - "nullable" : true - } - } - }, - "Scenequery_PromptOptimizationChatWSResponse" : { - "type" : "object", - "description" : "Response object for prompt optimization chat.", - "properties" : { - "error" : { - "type" : "boolean", + "name" : { + "type" : "string", "nullable" : true }, - "errorMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "explanation" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Explanation of the optimization", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "optimizedPrompt" : { - "type" : "string", - "description" : "The optimized prompt", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "questionForUser" : { - "type" : "string", - "description" : "Follow-up question for the user, if any", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "rs485Address" ] }, - "Scenequery_PromptType" : { + "SchlageInsidePushbuttonStateEnum" : { "type" : "string", - "description" : "Optional prompt type for the configuration", - "enum" : [ "COUNT", "PERCENT", "BOOLEAN", "TEXT" ] + "enum" : [ "UNKNOWN", "NOT_PRESSED", "PRESSED" ] }, - "Scenequery_RegionCoordinateType" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "float", - "nullable" : true - }, - "y" : { - "type" : "number", - "format" : "float", - "nullable" : true - } - } + "SchlageInterpretedDoorModeEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "ACCESS_CONTROLLED", "UNLOCKED_HELD", "SECURED", "PRIVACY" ] }, - "Scenequery_RegionPolygonType" : { + "SchlageIpbFunctionEnum" : { + "type" : "string", + "enum" : [ "NONE", "PRIVACY" ] + }, + "SchlageRs485DoorExtension" : { "type" : "object", - "description" : "Optional region polygon to crop the camera frame", - "properties" : { - "coordinates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Scenequery_RegionCoordinateType" + "allOf" : [ { + "type" : "object", + "properties" : { + "apmFamily" : { + "$ref" : "#/components/schemas/SchlageApmFamilyEnum" }, - "nullable" : true + "gatewayRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } } - } - }, - "Scenequery_SelectiveUpdatePromptConfigurationWSRequest" : { - "type" : "object", - "description" : "Request object for selectively updating a prompt configuration.", + } ], + "nullable" : true, "properties" : { - "active" : { - "type" : "boolean", - "description" : "Optional active status for the prompt configuration", - "nullable" : true - }, - "cameraConfigurations" : { - "type" : "array", - "description" : "List of camera configurations for the prompt", - "items" : { - "$ref" : "#/components/schemas/CameraConfiguration" - }, - "nullable" : true - }, - "checkCondition" : { - "$ref" : "#/components/schemas/CheckCondition" - }, - "description" : { - "type" : "string", - "description" : "Optional description for the prompt configuration", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "minuteTriggerRate" : { + "createdAtMillis" : { "type" : "integer", - "format" : "int32", - "description" : "Optional minute trigger rate for the configuration", + "format" : "int64", "nullable" : true }, "name" : { "type" : "string", - "description" : "Optional name for the prompt configuration", "nullable" : true }, "orgUuid" : { @@ -126518,24 +153793,26 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "prompt" : { - "type" : "string", - "description" : "Optional prompt text for the configuration", - "nullable" : true - }, - "promptType" : { - "$ref" : "#/components/schemas/Scenequery_PromptType" - }, - "scheduleUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "shortName" : { - "type" : "string", - "description" : "Optional short name for the prompt configuration", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, "uuid" : { @@ -126547,332 +153824,335 @@ } } }, - "Scenequery_SelectiveUpdatePromptConfigurationWSResponse" : { + "SchlageRs485DoorPositionIndicator" : { "type" : "object", - "description" : "Response object for selectively updating a prompt configuration.", + "allOf" : [ { + "type" : "object", + "properties" : { + "dpiType" : { + "$ref" : "#/components/schemas/DoorPositionIndicatorEnumType" + }, + "gatewayRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" }, - "errorMsg" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "warningMsg" : { + "name" : { "type" : "string", "nullable" : true - } - } - }, - "Scenequery_TriggerPromptWSRequest" : { - "type" : "object", - "description" : "Request object for triggering a prompt.", - "properties" : { - "deviceFacetUuid" : { + }, + "orgUuid" : { "type" : "string", - "format" : "DeviceFacetUuid", - "description" : "RUUID with optional appended facet information", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "prompt" : { + "ownerDeviceUuid" : { "type" : "string", - "description" : "Prompt text to trigger", - "example" : "Count people in the scene", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "promptType" : { - "$ref" : "#/components/schemas/PromptTypeEnum" - }, - "region" : { - "$ref" : "#/components/schemas/RegionPolygonType" + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "timestampMs" : { - "type" : "integer", - "format" : "int64", - "description" : "Timestamp in milliseconds for the trigger", - "example" : 1640995200000, - "nullable" : true - } - } - }, - "Scenequery_TriggerPromptWSResponse" : { - "type" : "object", - "description" : "Response object for triggering a prompt.", - "properties" : { - "error" : { + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" }, - "event" : { - "$ref" : "#/components/schemas/SceneQueryReportEvent" + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true }, - "warningMsg" : { + "uuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Scenequery_UpdatePromptConfigurationWSRequest" : { + "SchlageRs485DoorReader" : { "type" : "object", - "description" : "Request object for updating a prompt configuration.", - "properties" : { - "promptConfiguration" : { - "$ref" : "#/components/schemas/PromptConfigurationType" + "allOf" : [ { + "type" : "object", + "properties" : { + "disableCardReader" : { + "type" : "boolean", + "nullable" : true + }, + "disableKeypad" : { + "type" : "boolean", + "nullable" : true + }, + "disableWaveToUnlock" : { + "type" : "boolean", + "nullable" : true + }, + "disposition" : { + "$ref" : "#/components/schemas/ReaderDispositionEnum" + }, + "gatewayRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "otherReaderUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "readerType" : { + "$ref" : "#/components/schemas/DoorReaderEnumType" + }, + "remoteUnlockAudioFeedbackEnabled" : { + "type" : "boolean", + "nullable" : true + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } } - } - }, - "Scenequery_UpdatePromptConfigurationWSResponse" : { - "type" : "object", - "description" : "Response object for updating a prompt configuration.", + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "promptConfiguration" : { - "$ref" : "#/components/schemas/PromptConfigurationType" - }, - "warningMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ScheduleStrategyEnum" : { - "type" : "string", - "enum" : [ "WEEKLY_REPEATING_MINUTES", "ABSOLUTE_SECONDS", "REALTIME_RELATIVE_SECONDS", "RELATIVE_DATETIME_INTERVALS" ] - }, - "ScheduleStrategyEnum_Minimal" : { - "type" : "string", - "enum" : [ "WEEKLY_REPEATING_MINUTES", "ABSOLUTE_SECONDS", "REALTIME_RELATIVE_SECONDS", "RELATIVE_DATETIME_INTERVALS" ] - }, - "Schedule_AccessStatefulComponentCompositeNextNearestSchedule" : { - "type" : "object", - "description" : "Information about the next nearest schedule for access controlled doors.", - "properties" : { - "currentlyActive" : { - "type" : "boolean", - "description" : "Whether the schedule is currently active", - "nullable" : true - }, - "doorState" : { - "$ref" : "#/components/schemas/AccessControlledDoorStateEnumType" }, - "scheduleUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "source" : { - "$ref" : "#/components/schemas/Schedule_AccessStatefulComponentCompositeStateSourceEnum" + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" }, - "startsAtMillisInclusive" : { - "type" : "integer", - "format" : "int64", - "description" : "Start time in milliseconds (inclusive)", - "example" : 1640995200000, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "stopsAtMillisInclusive" : { + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { "type" : "integer", "format" : "int64", - "description" : "Stop time in milliseconds (inclusive)", - "example" : 1640998800000, - "nullable" : true - } - } - }, - "Schedule_AccessStatefulComponentCompositeStateSourceEnum" : { - "type" : "string", - "description" : "Source of the door state", - "enum" : [ "DEFAULT_STATE", "DOOR_SCHEDULE", "DSE_DEFAULT_STATE", "DSE_SCHEDULE", "DOOR_STATE_OVERRIDE" ] - }, - "Schedule_CreateAbsoluteScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for creating an absolute schedule.", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" - } - } - }, - "Schedule_CreateAbsoluteScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for creating an absolute schedule.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { - "type" : "string", "nullable" : true }, - "scheduleUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } - } + }, + "required" : [ "rs485Address" ] }, - "Schedule_CreateRelativeDateTimeIntervalsScheduleWSRequest" : { + "SchlageRs485DoorRelay" : { "type" : "object", - "description" : "Request object for creating a relative datetime intervals schedule.", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" + "allOf" : [ { + "type" : "object", + "properties" : { + "gatewayRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "relayType" : { + "$ref" : "#/components/schemas/DoorRelayEnumType" + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } } - } - }, - "Schedule_CreateRelativeDateTimeIntervalsScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for creating a relative datetime intervals schedule.", + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "scheduleUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "ownerDeviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Schedule_CreateRelativeScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for creating a relative schedule.", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" - } - } - }, - "Schedule_CreateRelativeScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for creating a relative schedule.", - "properties" : { - "error" : { + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "scheduleUuid" : { + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - }, - "warningMsg" : { - "type" : "string", - "nullable" : true } } }, - "Schedule_CreateWeeklyScheduleWSRequest" : { + "SchlageRs485DoorRequestToExit" : { "type" : "object", - "description" : "Request object for creating a weekly schedule.", - "properties" : { - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "allOf" : [ { + "type" : "object", + "properties" : { + "gatewayRs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "intentOnly" : { + "type" : "boolean", + "nullable" : true + }, + "intentOnlyEvents" : { + "type" : "boolean", + "nullable" : true + }, + "normalState" : { + "$ref" : "#/components/schemas/NormalStateEnumType" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "rexType" : { + "$ref" : "#/components/schemas/RequestToExitEnumType" + }, + "rs485Address" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } } - } - }, - "Schedule_CreateWeeklyScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for creating a weekly schedule.", + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "scheduleUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { - "type" : "string", - "nullable" : true - } - } - }, - "Schedule_FindAbsoluteScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for finding an absolute schedule.", - "properties" : { - "uuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Schedule_FindAbsoluteScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for finding an absolute schedule.", - "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true }, - "errorMsg" : { - "type" : "string", + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "portImmutable" : { + "type" : "boolean", "nullable" : true }, - "schedule" : { - "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" }, - "warningMsg" : { - "type" : "string", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Schedule_FindRelativeDateTimeIntervalsScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for finding a relative datetime intervals schedule.", - "properties" : { + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -126882,443 +154162,268 @@ } } }, - "Schedule_FindRelativeDateTimeIntervalsScheduleWSResponse" : { + "SchlageRs485Gateway" : { "type" : "object", - "description" : "Response object for finding a relative datetime intervals schedule.", "properties" : { - "error" : { - "type" : "boolean", + "baseType" : { + "$ref" : "#/components/schemas/ComponentBaseEnumType" + }, + "baud" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "schedule" : { - "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" + "frameCheck" : { + "$ref" : "#/components/schemas/Rs485FrameCheckEnum" }, - "warningMsg" : { + "hwVersion" : { "type" : "string", "nullable" : true - } - } - }, - "Schedule_FindRelativeScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for finding a relative schedule.", - "properties" : { - "uuid" : { + }, + "model" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - } - }, - "Schedule_FindRelativeScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for finding a relative schedule.", - "properties" : { - "error" : { - "type" : "boolean", "nullable" : true }, - "errorMsg" : { + "name" : { "type" : "string", "nullable" : true }, - "schedule" : { - "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" - }, - "warningMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Schedule_FindWeeklyScheduleWSRequest" : { - "type" : "object", - "description" : "Request object for finding a weekly schedule.", - "properties" : { - "uuid" : { + }, + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "Schedule_FindWeeklyScheduleWSResponse" : { - "type" : "object", - "description" : "Response object for finding a weekly schedule.", - "properties" : { - "error" : { + }, + "ownerHardwareType" : { + "$ref" : "#/components/schemas/HardwareVariationEnum" + }, + "port" : { + "$ref" : "#/components/schemas/GenericRs485Port" + }, + "portImmutable" : { "type" : "boolean", "nullable" : true }, - "errorMsg" : { - "type" : "string", + "rs485Address" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "schedule" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" + "type" : { + "$ref" : "#/components/schemas/ComponentEnumType" }, - "warningMsg" : { - "type" : "string", + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", "nullable" : true - } - } - }, - "Schedule_GetScheduleDataV2WSRequest" : { - "type" : "object", - "description" : "Request object for getting schedule data v2.", - "properties" : { - "scheduleUuid" : { + }, + "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } - } + }, + "required" : [ "rs485Address" ] }, - "Schedule_GetScheduleDataV2WSResponse" : { + "SchlageRs485GatewayConnectionStateChangeEvent" : { "type" : "object", - "description" : "Response object for getting schedule data v2.", + "allOf" : [ { + "type" : "object", + "properties" : { + "connected" : { + "type" : "boolean", + "nullable" : true + }, + "serial" : { + "type" : "string", + "nullable" : true + }, + "stateChangedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + } ], + "nullable" : true, "properties" : { - "error" : { - "type" : "boolean", - "nullable" : true - }, - "errorMsg" : { + "componentUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "correlationId" : { "type" : "string", "nullable" : true }, - "weeklyScheduleData" : { - "$ref" : "#/components/schemas/Schedule_WeeklyRepeatingScheduleDataType" - } - } - }, - "Schedule_GetScheduleDataWSResponse" : { - "type" : "object", - "description" : "Response object for getting schedule data.", - "properties" : { - "error" : { - "type" : "boolean", + "createdAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "errorMsg" : { + "locationUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "warningMsg" : { + "orgUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "weeklyScheduleData" : { - "type" : "array", - "description" : "List of weekly schedule data", - "items" : { - "$ref" : "#/components/schemas/Schedule_WeeklyRepeatingScheduleDataType" - }, - "nullable" : true - } - } - }, - "Schedule_GetSchedulesWSRequest" : { - "type" : "object", - "description" : "Request object for getting all schedules." - }, - "Schedule_GetSchedulesWSResponse" : { - "type" : "object", - "description" : "Response object for getting all schedules.", - "properties" : { - "absoluteSchedules" : { - "type" : "array", - "description" : "List of absolute schedules", - "items" : { - "$ref" : "#/components/schemas/AbsoluteSecondsScheduleType" - }, - "nullable" : true - }, - "error" : { - "type" : "boolean", + "ownerDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "errorMsg" : { + "subLocationsHierarchyKey" : { "type" : "string", - "nullable" : true + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, - "relativeDatetimeSchedules" : { - "type" : "array", - "description" : "List of relative datetime intervals schedules", - "items" : { - "$ref" : "#/components/schemas/RelativeDateTimeIntervalsScheduleType" - }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "relativeSchedules" : { - "type" : "array", - "description" : "List of relative schedules", - "items" : { - "$ref" : "#/components/schemas/RealtimeRelativeSecondsScheduleType" - }, - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, - "warningMsg" : { + "uuid" : { "type" : "string", - "nullable" : true - }, - "weeklySchedules" : { - "type" : "array", - "description" : "List of weekly repeating schedules", - "items" : { - "$ref" : "#/components/schemas/WeeklyRepeatingScheduleType" - }, + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true } } }, - "Schedule_WeeklyRepeatingScheduleDataType" : { + "SchlageRs485GatewayStateEvent" : { "type" : "object", - "description" : "Weekly repeating schedule data type with usage information.", - "properties" : { - "accessGrantUuids" : { - "type" : "array", - "description" : "Set of access grant UUIDs using this schedule", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "allOf" : [ { + "type" : "object", + "properties" : { + "connected" : { + "type" : "boolean", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "alarmMonitoringUuids" : { - "type" : "array", - "description" : "Set of alarm monitoring UUIDs using this schedule", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "connectionStateUpdatedAtMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "alertPolicyUuids" : { - "type" : "array", - "description" : "Set of alert policy UUIDs using this schedule", - "items" : { + "firmwareVersion" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "customEventUuids" : { - "type" : "array", - "description" : "Set of custom event UUIDs using this schedule", - "items" : { + "hwVersion" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "doorSettingUuids" : { - "type" : "array", - "description" : "Set of door setting UUIDs using this schedule", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "lastSeenMs" : { + "type" : "integer", + "format" : "int64", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "intervalList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/WeeklyMinuteIntervalType" - }, - "nullable" : true - }, - "locationsUsedIn" : { - "type" : "array", - "description" : "Set of location UUIDs where this schedule is used", - "items" : { + "model" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "mutable" : { - "type" : "boolean", - "nullable" : true - }, - "name" : { - "type" : "string", - "nullable" : true - }, - "oneTimeUse" : { - "type" : "boolean", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "ruleUuids" : { - "type" : "array", - "description" : "Set of rule UUIDs using this schedule", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "rawTamperState" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "sharedStreamUuids" : { - "type" : "array", - "description" : "Set of shared stream UUIDs using this schedule", - "items" : { + "serial" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "nullable" : true, - "uniqueItems" : true - }, - "strategy" : { - "$ref" : "#/components/schemas/ScheduleStrategyEnum" - }, - "uuid" : { + "tamperOrAppConnected" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "componentUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ScheduledAction" : { - "type" : "object", - "properties" : { - "action" : { - "$ref" : "#/components/schemas/RuleActionType" }, - "backoffMinutes" : { - "type" : "integer", - "format" : "int32", + "correlationId" : { + "type" : "string", "nullable" : true }, - "backoffSeconds" : { + "createdAtMs" : { "type" : "integer", - "format" : "int32", + "format" : "int64", "nullable" : true }, - "ruleUuid" : { + "locationUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "scheduleUuid" : { + "orgUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true - } - } - }, - "ScheduledAlarmPolicy" : { - "type" : "object", - "description" : "Threat-detection policies used during scheduled monitoring mode.", - "nullable" : true, - "properties" : { - "rules" : { - "type" : "array", - "description" : "The rules governing threat detection and subsequent actions.", - "items" : { - "$ref" : "#/components/schemas/AlarmRule" - }, - "nullable" : true }, - "scheduleUuid" : { + "ownerDeviceUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "type" : { - "$ref" : "#/components/schemas/MonitoringModeEnum" - }, - "uuid" : { + "subLocationsHierarchyKey" : { "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - } - }, - "required" : [ "rules", "scheduleUuid" ] - }, - "ScheduledEventRecordType" : { - "type" : "object", - "properties" : { + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, "timestampMs" : { "type" : "integer", "format" : "int64", "nullable" : true - } - } - }, - "ScheduledIntervalType" : { - "type" : "object", - "description" : "Map of location UUIDs to snooze intervals", - "properties" : { - "durationSecs" : { - "type" : "integer", - "format" : "int64", - "nullable" : true }, - "timestampSec" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "type" : { + "$ref" : "#/components/schemas/ComponentEventEnumType" }, "uuid" : { "type" : "string", @@ -127329,37 +154434,9 @@ } } }, - "ScheduledRuleTriggerType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "locationUuids" : { - "type" : "array", - "description" : "List of locations to use for timezone evaluation and for display purposes", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - }, - "minOfDay" : { - "type" : "integer", - "format" : "int32", - "description" : "minute of the day for this trigger. note that it is dependent on the timezone of the devices in the rule actions or the timezone of the specified locations.", - "nullable" : true - } - } - } ], - "nullable" : true, - "properties" : { - "type" : { - "$ref" : "#/components/schemas/RuleTriggerTypeEnum" - } - } + "SchlageTamperStateEnum" : { + "type" : "string", + "enum" : [ "UNKNOWN", "NONE", "READER", "APM", "GATEWAY", "MAGNETIC" ] }, "ScopedCloudArchivingConfig" : { "type" : "object", @@ -127425,6 +154502,125 @@ } } }, + "Search_GetReIdEquivalenceGraphWSRequest" : { + "type" : "object", + "description" : "Request for the reidentification equivalence graph at a location on a day.", + "properties" : { + "date" : { + "type" : "string", + "description" : "Local calendar day to return, ISO yyyy-MM-dd; defaults to today", + "example" : "2026-03-15", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "Search_GetReIdEquivalenceGraphWSResponse" : { + "type" : "object", + "description" : "Reidentification equivalence graph at a location, keyed by local date.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "graphByDate" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/Search_ReIdEquivalenceDayGraphWS" + }, + "description" : "ISO local date to that day's equivalence edges and same-person groups", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Search_GetReIdEquivalenceMapWSRequest" : { + "type" : "object", + "description" : "Request object for expanding reidentification stable track ids into same-person groups.", + "properties" : { + "endTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Window end time in milliseconds", + "example" : 1640995200000, + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "stableTrackIds" : { + "type" : "array", + "description" : "Stable track ids to expand", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Stable track ids to expand", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "startTimestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Window start time in milliseconds", + "example" : 1640995200000, + "nullable" : true + } + } + }, + "Search_GetReIdEquivalenceMapWSResponse" : { + "type" : "object", + "description" : "Response mapping each requested stable track id to its same-person group.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "groupsByTrackId" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Requested stable track id to its same-person equivalence group", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Requested stable track id to its same-person equivalence group", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "description" : "Requested stable track id to its same-person equivalence group", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, "Search_IndexVideoEmbeddingWSRequest" : { "type" : "object", "description" : "Request object for indexing video embeddings.", @@ -127591,6 +154787,18 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "stableTrackIds" : { + "type" : "array", + "description" : "Optional stable track IDs filter", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Optional stable track IDs filter", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, "startTimestampMs" : { "type" : "integer", "format" : "int64", @@ -127620,6 +154828,104 @@ "type" : "string", "nullable" : true }, + "resolvedStableTrackIds" : { + "type" : "array", + "description" : "Stable track ids queried after identity-equivalence expansion", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Stable track ids queried after identity-equivalence expansion", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, + "Search_ReIdEquivalenceDayGraphWS" : { + "type" : "object", + "description" : "One local day's reidentification edges and their connected-component groups.", + "properties" : { + "components" : { + "type" : "array", + "description" : "Same-person groups (connected components) of this day's edge graph", + "items" : { + "type" : "array", + "description" : "Same-person groups (connected components) of this day's edge graph", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "Same-person groups (connected components) of this day's edge graph", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "nullable" : true + }, + "edges" : { + "type" : "array", + "description" : "Raw equivalence edges recorded for this day", + "items" : { + "$ref" : "#/components/schemas/ReIdEquivalenceEdge" + }, + "nullable" : true + } + } + }, + "Search_ResolveReIdEquivalentTracksWSRequest" : { + "type" : "object", + "description" : "Request to expand a single reidentification stable track id into its same-person group.", + "properties" : { + "date" : { + "type" : "string", + "description" : "Location-local calendar day the id was observed, ISO yyyy-MM-dd", + "example" : "2026-03-15", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "stableTrackId" : { + "type" : "integer", + "format" : "int32", + "description" : "Stable track id to expand", + "nullable" : true + } + } + }, + "Search_ResolveReIdEquivalentTracksWSResponse" : { + "type" : "object", + "description" : "The same-person group for a single requested stable track id.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "resolvedStableTrackIds" : { + "type" : "array", + "description" : "The queried id's full same-person group; always includes the queried id", + "items" : { + "type" : "integer", + "format" : "int32", + "description" : "The queried id's full same-person group; always includes the queried id", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, "warningMsg" : { "type" : "string", "nullable" : true @@ -127796,6 +155102,9 @@ "nullable" : true, "uniqueItems" : true }, + "embeddingModel" : { + "$ref" : "#/components/schemas/ObjectSearchModelEnum" + }, "endTimestampMs" : { "type" : "integer", "format" : "int64", @@ -127884,14 +155193,19 @@ }, "objectTypeFilter" : { "type" : "array", - "description" : "Optional object type filter to narrow results to only vehicles or only humans.", + "description" : "Optional object type filter. Provide explicit type values to narrow results, or omit to search all object types. Pass the single value \"AUTO\" to have the server infer the object type (humans or vehicles) from the search text.", "items" : { "type" : "string", - "enum" : [ "MOTION_HUMAN", "MOTION_CAR" ], + "enum" : [ "MOTION_HUMAN", "MOTION_CAR", "AUTO" ], "nullable" : true }, "nullable" : true }, + "onlyMatches" : { + "type" : "boolean", + "description" : "Only applies to models that classify results as matches: when true (default) return only actual matches; when false return all results within the similarity threshold.", + "nullable" : true + }, "queryDeviceUuids" : { "type" : "array", "description" : "Optional list of device uuids to filter result set on.", @@ -128347,6 +155661,59 @@ } } }, + "Search_StreamReidentificationEmbeddingsWSRequest" : { + "type" : "object", + "description" : "Request object for streaming reidentification embeddings as NDJSON.", + "properties" : { + "deviceUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "embeddingModel" : { + "$ref" : "#/components/schemas/ObjectSearchModelEnum" + }, + "endTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "stableTrackIds" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "startTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, "SecureTokenAlgorithmEnum" : { "type" : "string", "enum" : [ "AN10922_AES128" ] @@ -128390,8 +155757,32 @@ }, "SeekpointIndexType" : { "type" : "object", - "description" : "List of custom footage seek points V2", + "description" : "Matching integration access events. Each carries timestamp, device/location, the event label (customDisplayName), the cardholder name, badge status/type, entering/exiting area, entryMade, and alert (anomaly) flag.", "properties" : { + "alert" : { + "type" : "boolean", + "nullable" : true + }, + "areaEntering" : { + "type" : "string", + "nullable" : true + }, + "areaExiting" : { + "type" : "string", + "nullable" : true + }, + "badgeStatus" : { + "type" : "string", + "nullable" : true + }, + "badgeType" : { + "type" : "string", + "nullable" : true + }, + "cardholderName" : { + "type" : "string", + "nullable" : true + }, "compositComponentUuid" : { "type" : "string", "format" : "RUUID", @@ -128414,6 +155805,10 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true }, + "entryMade" : { + "type" : "boolean", + "nullable" : true + }, "locationUuid" : { "type" : "string", "format" : "RUUID", @@ -128438,7 +155833,12 @@ "$ref" : "#/components/schemas/SeekpointTypeEnum" }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "timestampMs" : { "type" : "integer", @@ -128566,7 +155966,12 @@ "nullable" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "t" : { "type" : "integer", @@ -129487,6 +156892,36 @@ } } }, + "Share_GetSharedVideoWallClimateStatesWSRequest" : { + "type" : "object", + "description" : "Request object for getting live climate readings for a shared video wall." + }, + "Share_GetSharedVideoWallClimateStatesWSResponse" : { + "type" : "object", + "description" : "Response containing live climate readings for the cameras in a shared video wall.", + "properties" : { + "climateStates" : { + "type" : "array", + "description" : "Climate readings for sensors associated with cameras in the shared video wall", + "items" : { + "$ref" : "#/components/schemas/Share_SharedClimateStateType" + }, + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, "Share_GetSharedVideoWallInfoWSResponse" : { "type" : "object", "description" : "Response object containing shared video wall information.", @@ -129507,6 +156942,12 @@ "type" : "string", "nullable" : true }, + "hasClimateDevices" : { + "type" : "boolean", + "description" : "Whether an environmental sensor or gateway is associated with a device in the shared video wall", + "example" : true, + "nullable" : true + }, "name" : { "type" : "string", "description" : "Name of the shared video wall", @@ -129646,6 +157087,39 @@ } } }, + "Share_SharedClimateStateType" : { + "type" : "object", + "description" : "Live temperature and humidity readings for one sensor associated with a shared video wall camera.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the sensor is currently reporting", + "example" : true, + "nullable" : true + }, + "humidity" : { + "type" : "number", + "format" : "float", + "description" : "Relative humidity percentage", + "example" : 43.0, + "nullable" : true + }, + "tempC" : { + "type" : "number", + "format" : "float", + "description" : "Temperature in celsius", + "example" : 21.5, + "nullable" : true + } + } + }, "Share_SharedClipPublicType" : { "type" : "object", "description" : "Public type for shared clips with comprehensive metadata.", @@ -130029,6 +157503,10 @@ "clipLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, + "clipLocationV2" : { + "type" : "string", + "nullable" : true + }, "deviceUuidMap" : { "type" : "object", "additionalProperties" : { @@ -130049,6 +157527,10 @@ "thumbnailLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -130071,6 +157553,10 @@ "clipLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, + "clipLocationV2" : { + "type" : "string", + "nullable" : true + }, "description" : { "type" : "string", "nullable" : true @@ -130102,6 +157588,10 @@ "thumbnailLocation" : { "$ref" : "#/components/schemas/MetaDataLocationType" }, + "thumbnailLocationV2" : { + "type" : "string", + "nullable" : true + }, "uuid" : { "type" : "string", "format" : "RUUID", @@ -130246,11 +157736,11 @@ }, "ShellyDeviceTypeEnum" : { "type" : "string", - "enum" : [ "RELAY", "LIGHT", "ROLLER" ] + "enum" : [ "RELAY", "LIGHT", "ROLLER", "INPUT" ] }, "ShellyEventTypeEnum" : { "type" : "string", - "enum" : [ "SWITCH_ON", "SWITCH_OFF", "INPUT_ON", "INPUT_OFF" ] + "enum" : [ "SWITCH_ON", "SWITCH_OFF", "INPUT_ON", "INPUT_OFF", "BUTTON_PUSH", "BUTTON_LONG_PUSH", "BUTTON_DOUBLE_PUSH" ] }, "ShellyIntegrationRuleTriggerType" : { "type" : "object", @@ -130453,6 +157943,92 @@ } } }, + "SignatureApiType" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "apiToken" : { + "type" : "string", + "nullable" : true + }, + "refreshToken" : { + "type" : "string", + "nullable" : true + }, + "tokenValid" : { + "type" : "boolean", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "integration" : { + "$ref" : "#/components/schemas/IntegrationEnum" + }, + "integrationAuditMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/IntegrationAuditEvent" + }, + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "SignedDocument" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "signedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "storageKey" : { + "type" : "string", + "nullable" : true + } + } + }, + "SigningCadence" : { + "type" : "object", + "properties" : { + "intervalDays" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/SigningCadenceTypeEnum" + } + } + }, + "SigningCadenceTypeEnum" : { + "type" : "string", + "enum" : [ "EVERY_VISIT", "ONCE", "INTERVAL", "NEVER" ] + }, "SimpleAuditEventType" : { "type" : "object", "nullable" : true, @@ -130566,6 +158142,77 @@ } } }, + "SnapshotTimelineEntry" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "device" : { + "$ref" : "#/components/schemas/TimelineEntryDevice" + } + } + } ], + "description" : "A timeline entry containing a still image captured by the user from a device's video. The image is supplied by the caller, so it may be zoomed or otherwise adjusted rather than the raw frame.", + "nullable" : true, + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", + "nullable" : true + }, + "createdBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "imageKey" : { + "type" : "string", + "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", + "nullable" : true + }, + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "systemGenerated" : { + "type" : "boolean", + "description" : "Whether the entry was generated by the system rather than created by a user.", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/TimelineEntryTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, "SplicedClipProgress" : { "type" : "object", "properties" : { @@ -130606,6 +158253,11 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "completedSubClipCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "consoleDelete" : { "type" : "boolean", "nullable" : true @@ -130618,6 +158270,17 @@ "type" : "string", "nullable" : true }, + "deviceIntervalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true + }, + "nullable" : true + }, "deviceMap" : { "type" : "object", "additionalProperties" : { @@ -130677,6 +158340,11 @@ "format" : "int32", "nullable" : true }, + "expectedSubClipCount" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, "integrationUploadList" : { "type" : "array", "items" : { @@ -130699,6 +158367,25 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "parentClipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pendingConsumers" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "policyEventPipeline" : { + "$ref" : "#/components/schemas/PolicyEventPipelineEnum" + }, "saveClip" : { "type" : "boolean", "nullable" : true @@ -130793,6 +158480,16 @@ "allOf" : [ ], "nullable" : true, "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", @@ -130971,25 +158668,6 @@ "type" : "object", "nullable" : true }, - "SubLocationsHierarchyKey" : { - "type" : "object", - "format" : "SubLocationsHierarchyKey", - "description" : "A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).", - "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", - "properties" : { - "locationUuids" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "nullable" : true - } - } - }, "SubscriptionStatusEnum" : { "type" : "string", "enum" : [ "TRIAL", "PAID", "RESELLER", "LOST", "UNKNOWN" ] @@ -131855,6 +159533,9 @@ "ThirdPartyCameraSettings" : { "type" : "object", "properties" : { + "lens_role" : { + "$ref" : "#/components/schemas/LensRoleEnum" + }, "onvif_ip" : { "type" : "string", "nullable" : true @@ -131883,9 +159564,252 @@ }, "ptz_translation_space" : { "$ref" : "#/components/schemas/CameraPTZTranslationSpaceEnum" + }, + "zoom_max" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "zoom_min" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + } + }, + "ThirdPartyStrobeSirenActionType" : { + "type" : "object", + "properties" : { + "durationSec" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "ipAddress" : { + "type" : "string", + "nullable" : true + }, + "lightColors" : { + "type" : "array", + "items" : { + "type" : "string", + "nullable" : true + }, + "nullable" : true + }, + "lightIntensity" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "lightPattern" : { + "type" : "string", + "nullable" : true + }, + "lightSpeed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "password" : { + "type" : "string", + "nullable" : true + }, + "profileName" : { + "type" : "string", + "nullable" : true + }, + "proxyDeviceUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "sirenIntensity" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sirenPattern" : { + "type" : "string", + "nullable" : true + }, + "username" : { + "type" : "string", + "nullable" : true + } + } + }, + "ThreatCaseEventTimelineEntry" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "eventType" : { + "$ref" : "#/components/schemas/ThreatCaseEventTypeEnum" + }, + "externalReferenceId" : { + "type" : "string", + "description" : "Identifier of the corresponding entity in an external system, such as Noonlight, or null if the entry is not associated with an external entity.", + "nullable" : true + }, + "message" : { + "type" : "string", + "description" : "Human-readable description of the action.", + "nullable" : true + }, + "performedBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "threatCaseStatus" : { + "$ref" : "#/components/schemas/ThreatCaseStatusEnum" + } + } + } ], + "description" : "A timeline entry recording an action taken on the report's threat case.", + "nullable" : true, + "properties" : { + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp when the entry was added to the report, in milliseconds since the epoch. Populated by the service. Any caller-supplied value is ignored.", + "nullable" : true + }, + "createdBy" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "imageKey" : { + "type" : "string", + "description" : "Storage key of the entry's image. Assigned when image bytes are uploaded. Any caller-supplied value is ignored. Null if the entry has no image or has been redacted.", + "nullable" : true + }, + "location" : { + "$ref" : "#/components/schemas/TimelineEntryLocation" + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reportUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "systemGenerated" : { + "type" : "boolean", + "description" : "Whether the entry was generated by the system rather than created by a user.", + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp of the event/action recorded by this entry, in milliseconds since the epoch.", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/TimelineEntryTypeEnum" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, + "ThreatCaseEventTypeEnum" : { + "type" : "string", + "description" : "Type of actor or system that performed the threat case action.", + "enum" : [ "USER", "SERVICE_PROVIDER", "ERROR", "PANIC_BUTTON", "ACCESS_CONTROL_INTEGRATION", "ALARM_INTEGRATION", "UNKNOWN" ] + }, + "ThreatCaseIntervalStats" : { + "type" : "object", + "description" : "Threat case counts for a single reporting interval, keyed by the time the cases were created.", + "properties" : { + "dismissedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threat cases created in this interval that were dismissed.", + "nullable" : true + }, + "escalatedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threat cases created in this interval that were escalated.", + "nullable" : true + }, + "timeoutCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threat cases created in this interval that were neither dismissed nor escalated before they timed out.", + "nullable" : true + } + } + }, + "ThreatCaseReportIntervalEnum" : { + "type" : "string", + "description" : "Interval the threat case stats are bucketed by.", + "enum" : [ "HOURLY", "DAILY" ] + }, + "ThreatCaseReviewerStats" : { + "type" : "object", + "description" : "Threat case review counts and response time for a single reviewer.", + "properties" : { + "averageResponseSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Average time in seconds it took this reviewer to dismiss or escalate a threat case.", + "nullable" : true + }, + "dismissedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threat cases this reviewer dismissed.", + "nullable" : true + }, + "escalatedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threat cases this reviewer escalated.", + "nullable" : true + }, + "reviewerName" : { + "type" : "string", + "description" : "Current name of the reviewer. For a shared PIN, this is the PIN name. Null for external reviewers or when the reviewer name cannot be resolved.", + "nullable" : true + }, + "reviewerType" : { + "$ref" : "#/components/schemas/ThreatCaseReviewerTypeEnum" + }, + "reviewerUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "ThreatCaseReviewerTypeEnum" : { + "type" : "string", + "description" : "Type of reviewer who performed an action on a threat case.", + "enum" : [ "USER", "SHARED_PIN", "UNKNOWN" ] + }, "ThreatCaseStatusEnum" : { "type" : "string", "enum" : [ "INITIATED", "REQUESTED", "FOLLOW_ON", "ESCALATED", "PSAP_CONTACTED", "VERIFIED", "DISMISSED", "CANCELLED", "UNVERIFIABLE", "TIMEOUT", "ERROR", "CLOSED" ] @@ -131908,6 +159832,24 @@ "type" : "string", "nullable" : true }, + "reviewerName" : { + "type" : "string", + "description" : "Reviewer name at the time the action was taken. For a shared PIN, this is the PIN name. For a user, including a user acting through their own PIN, this is the user's name. The value is null for actions not taken by a reviewer or for events recorded before the name was stored.", + "nullable" : true + }, + "reviewerPinUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "reviewerType" : { + "$ref" : "#/components/schemas/ThreatCaseReviewerTypeEnum" + }, + "threatCaseStatus" : { + "$ref" : "#/components/schemas/ThreatCaseStatusEnum" + }, "timestampSec" : { "type" : "integer", "format" : "int64", @@ -131927,7 +159869,11 @@ }, "ThreatCaseTimelineEventTypeEnum" : { "type" : "string", - "enum" : [ "ALERT", "DELAYED_ALERT", "USER", "SERVICE_PROVIDER", "ERROR", "PANIC_BUTTON", "ACCESS_CONTROL_INTEGRATION", "UNKNOWN" ] + "enum" : [ "ALERT", "DELAYED_ALERT", "USER", "SERVICE_PROVIDER", "ERROR", "PANIC_BUTTON", "ACCESS_CONTROL_INTEGRATION", "ALARM_INTEGRATION", "UNKNOWN" ] + }, + "ThreatCaseVerificationModeEnum" : { + "type" : "string", + "enum" : [ "EXTERNAL", "INTERNAL" ] }, "ThreatQualifier" : { "type" : "object", @@ -131954,7 +159900,6 @@ }, "TimeInterval" : { "type" : "object", - "description" : "Time interval for filtering vehicle events", "properties" : { "endMs" : { "type" : "integer", @@ -132128,6 +160073,13 @@ "description" : "RUUID with optional appended facet information", "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", "nullable" : true + }, + "ranges" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true } } }, @@ -132148,6 +160100,87 @@ "type" : "string", "enum" : [ "INITIATED", "INPROGRESS", "COMPLETE", "FAILED" ] }, + "TimelineEntryComponentComposite" : { + "type" : "object", + "description" : "A component composite, such as an access-controlled door, associated with a timeline entry.", + "nullable" : true, + "properties" : { + "componentCompositeName" : { + "type" : "string", + "description" : "Component composite name at the time the entry was created. It may differ from the current name.", + "nullable" : true + }, + "componentCompositeType" : { + "$ref" : "#/components/schemas/PolicyAlertComponentCompositeTypeEnum" + }, + "componentCompositeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "TimelineEntryDevice" : { + "type" : "object", + "description" : "A device associated with a timeline entry.", + "nullable" : true, + "properties" : { + "deviceName" : { + "type" : "string", + "description" : "Device name at the time the entry was created. It may differ from the current name.", + "nullable" : true + }, + "deviceType" : { + "$ref" : "#/components/schemas/DeviceTypeEnum" + }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + } + } + }, + "TimelineEntryLocation" : { + "type" : "object", + "description" : "A location associated with a timeline entry.", + "nullable" : true, + "properties" : { + "locationName" : { + "type" : "string", + "description" : "Location name at the time the entry was created. It may differ from the current name.", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "subLocationName" : { + "type" : "string", + "description" : "Sub-location name at the time the entry was created. It may differ from the current name. Absent when the entry came from the location itself.", + "nullable" : true + }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + } + } + }, + "TimelineEntryTypeEnum" : { + "type" : "string", + "description" : "Type of timeline entry.", + "enum" : [ "SNAPSHOT", "POLICY_ALERT", "EVENT", "CLIP", "THREAT_CASE_EVENT" ] + }, "TimestampFilter" : { "type" : "object", "description" : "Optional filter by an event timestamp. If not specified, the filter defaults to the last 7 days.", @@ -132343,18 +160376,362 @@ }, "TokenUsageStats" : { "type" : "object", - "description" : "The current org's LLM token usage history.", + "description" : "The current org's LLM token usage history; one entry per (year, month, model) bucket.", "properties" : { + "costCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Total billed cost in cents for this period, computed per-request at the time usage was recorded (includes any long-context surcharge)", + "nullable" : true + }, "inputTokenUsage" : { "type" : "integer", "format" : "int64", - "description" : "Total LLM input tokens used in a month", + "description" : "Total LLM input tokens used in this period", + "nullable" : true + }, + "model" : { + "type" : "string", + "description" : "LLM model identifier; null for legacy rows recorded before per-model tracking", + "nullable" : true + }, + "month" : { + "type" : "string", + "description" : "Month name in uppercase, e.g. \"MARCH\"", "nullable" : true }, "outputTokenUsage" : { "type" : "integer", "format" : "int64", - "description" : "Total LLM output tokens used in a month", + "description" : "Total LLM output tokens used in this period", + "nullable" : true + }, + "year" : { + "type" : "string", + "description" : "Year, e.g. \"2026\"", + "nullable" : true + } + } + }, + "TrackPauseScopeEnum" : { + "type" : "string", + "description" : "Whether the snooze targets a single device or a whole location", + "enum" : [ "DEVICE", "LOCATION" ] + }, + "TrackedObjectSearch" : { + "type" : "object", + "properties" : { + "deviceFacetUuids" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "isArchived" : { + "type" : "boolean", + "nullable" : true + }, + "isPaused" : { + "type" : "boolean", + "nullable" : true + }, + "objectSearchQueryUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "TrackedObjectSearchMatch" : { + "type" : "object", + "description" : "Sightings, newest first", + "properties" : { + "bottom" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "deviceFacetUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "eventTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "eventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "isMatch" : { + "type" : "string", + "nullable" : true + }, + "left" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "locationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "matchUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "matchedTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "querySnapshot" : { + "type" : "string", + "nullable" : true + }, + "queryUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "relativeSecond" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "right" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "similarity" : { + "type" : "number", + "format" : "float", + "nullable" : true + }, + "sourceClipEndMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "sourceClipStartMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "textEmbeddingVersion" : { + "type" : "string", + "nullable" : true + }, + "top" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "trackedObjectSearchUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "videoEmbeddingVersion" : { + "type" : "string", + "nullable" : true + } + } + }, + "Transcript_ActivityTranscriptEventWS" : { + "type" : "object", + "description" : "A single motion/activity event within one transcript window.", + "properties" : { + "movement" : { + "type" : "string", + "description" : "Free-text description of the movement", + "nullable" : true + }, + "tsEndMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End of the event in epoch milliseconds", + "nullable" : true + }, + "tsStartMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start of the event in epoch milliseconds", + "nullable" : true + }, + "what" : { + "type" : "string", + "description" : "What was observed", + "nullable" : true + } + } + }, + "Transcript_ActivityTranscriptRecordWS" : { + "type" : "object", + "description" : "A single camera activity transcript record for one analyzed time window.", + "properties" : { + "category" : { + "type" : "string", + "description" : "VLM-assigned activity type: NO_ACTIVITY, PERSON, VEHICLE, PACKAGE, ANIMAL, CROWD, or OTHER. Null on records produced before classification shipped.", + "nullable" : true + }, + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "events" : { + "type" : "array", + "description" : "Discrete motion/activity events observed within the window", + "items" : { + "$ref" : "#/components/schemas/Transcript_ActivityTranscriptEventWS" + }, + "nullable" : true + }, + "kind" : { + "type" : "string", + "description" : "Kind of record: motion_window, still, or custom", + "nullable" : true + }, + "severity" : { + "type" : "string", + "description" : "VLM-assigned concern level: NONE, NORMAL, POSSIBLE, or CONCERNING. Null on records produced before classification shipped.", + "nullable" : true + }, + "summaryId" : { + "type" : "string", + "description" : "Opaque id of this summary record", + "nullable" : true + }, + "text" : { + "type" : "string", + "description" : "The transcript text — the scene-summary finding for this window", + "nullable" : true + }, + "windowEndMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End of the analyzed window in epoch milliseconds", + "nullable" : true + }, + "windowStartMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start of the analyzed window in epoch milliseconds", + "nullable" : true + } + } + }, + "Transcript_GetActivityTranscriptsWSRequest" : { + "type" : "object", + "description" : "Request object for getting camera activity transcript records within a time window.", + "properties" : { + "cameraUuids" : { + "type" : "array", + "description" : "Camera device facet UUIDs to get transcript records for. A bare device uuid searches its VIDEO_0 facet; a faceted uuid (e.g. \".v0\") searches just that facet. A location is expanded to its cameras before calling.", + "items" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "nullable" : true + }, + "endTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "End of the window in epoch milliseconds (inclusive)", + "example" : 1641081600000, + "nullable" : true + }, + "maxNumResults" : { + "type" : "integer", + "format" : "int32", + "description" : "Optional cap on the number of records returned; a service default is applied when null.", + "nullable" : true + }, + "startTimeMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Start of the window in epoch milliseconds (inclusive)", + "example" : 1640995200000, + "nullable" : true + } + }, + "required" : [ "cameraUuids", "endTimeMs", "startTimeMs" ] + }, + "Transcript_GetActivityTranscriptsWSResponse" : { + "type" : "object", + "description" : "Response object holding activity transcript records ordered by window start ascending.", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "records" : { + "type" : "array", + "description" : "Transcript records ordered by window start ascending. Records for cameras the caller cannot access are omitted.", + "items" : { + "$ref" : "#/components/schemas/Transcript_ActivityTranscriptRecordWS" + }, + "nullable" : true + }, + "warningMsg" : { + "type" : "string", "nullable" : true } } @@ -132373,7 +160750,7 @@ }, "TriggerActivityEnum" : { "type" : "string", - "enum" : [ "MOTION_HUMAN", "VISUAL_TAMPER", "MOTION", "FACE_ALERT", "POSE_ANOMALOUS", "MOTION_CAR", "LICENSEPLATE_ALERT", "HELMET_MISSING", "MASK_MISSING", "TAMPER", "PEOPLECOUNT_HIGH", "GUN_DETECT_EVENT", "HUMAN_ENTER", "HUMAN_EXIT", "CAR_ENTER", "CAR_EXIT", "RECURRING_INTERVAL" ] + "enum" : [ "MOTION_HUMAN", "VISUAL_TAMPER", "MOTION", "FACE_ALERT", "POSE_ANOMALOUS", "MOTION_CAR", "LICENSEPLATE_ALERT", "HELMET_MISSING", "MASK_MISSING", "TAMPER", "PEOPLECOUNT_HIGH", "GUN_DETECT_EVENT", "HUMAN_ENTER", "HUMAN_EXIT", "CAR_ENTER", "CAR_EXIT", "AC_DB_TRIGGERED", "LOITER_HUMAN", "RECURRING_INTERVAL" ] }, "TriggerComponentRelayActionRecordType" : { "type" : "object", @@ -132522,8 +160899,6 @@ }, "TripwireSettings" : { "type" : "object", - "description" : "Optional threshold condition requiring a certain number of activity events to occur within a\ndefined time window before triggering a threat.\n", - "nullable" : true, "properties" : { "intervalSeconds" : { "type" : "integer", @@ -132542,6 +160917,103 @@ }, "required" : [ "intervalSeconds", "threshold" ] }, + "TritonSettings" : { + "type" : "object", + "properties" : { + "alertAggression" : { + "type" : "boolean", + "nullable" : true + }, + "alertCO" : { + "type" : "boolean", + "nullable" : true + }, + "alertCO2" : { + "type" : "boolean", + "nullable" : true + }, + "alertGunshot" : { + "type" : "boolean", + "nullable" : true + }, + "alertHelp" : { + "type" : "boolean", + "nullable" : true + }, + "alertMasking" : { + "type" : "boolean", + "nullable" : true + }, + "alertTHC" : { + "type" : "boolean", + "nullable" : true + }, + "alertTamper" : { + "type" : "boolean", + "nullable" : true + }, + "alertVOC" : { + "type" : "boolean", + "nullable" : true + }, + "alertVape" : { + "type" : "boolean", + "nullable" : true + }, + "enabled" : { + "type" : "boolean", + "nullable" : true + }, + "enabledTimestampMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "enablingUser" : { + "type" : "string", + "nullable" : true + }, + "enablingUserUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "saveClips" : { + "type" : "boolean", + "nullable" : true + }, + "savedClipDurationMs" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "sensorToCamerasMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "nullable" : true + }, + "triggerNotification" : { + "type" : "boolean", + "nullable" : true + }, + "url" : { + "type" : "string", + "nullable" : true + } + } + }, "TvOsConfigType" : { "type" : "object", "description" : "tvOs configuration to update", @@ -132729,6 +161201,54 @@ "type" : "string", "enum" : [ "POLICY_NOT_ASSIGNED", "DOWN", "SLOW_INTERNET" ] }, + "UnarchivedPolicyAlertFilter" : { + "type" : "object", + "description" : "Filtering criteria for unarchived policy alerts.", + "properties" : { + "accessControlledDoorUuids" : { + "type" : "array", + "description" : "Filters unarchived policy alerts by access controlled door. Alerts raised by any of the specified doors match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "deviceUuids" : { + "type" : "array", + "description" : "Filters unarchived policy alerts by device. Alerts raised by any of the specified devices match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "locationUuids" : { + "type" : "array", + "description" : "Filters unarchived policy alerts by location. Alerts at any of the specified locations match.", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true, + "uniqueItems" : true + }, + "timestampFilter" : { + "$ref" : "#/components/schemas/EventTimestampFilter" + } + } + }, "UnlockDoorActionRecordType" : { "type" : "object", "properties" : { @@ -132750,11 +161270,49 @@ } } }, + "UpdateCoOccurrenceRuleRequest" : { + "type" : "object", + "properties" : { + "orgUuid" : { + "type" : "string", + "nullable" : true + }, + "rule" : { + "$ref" : "#/components/schemas/IntelliGuardCoOccurrenceRule" + } + } + }, + "UpdateCoOccurrenceRuleResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + } + } + }, "UpdatePasswordFailureReasonEnumType" : { "type" : "string", "description" : "Structured failure reason type for programmatic handling", "enum" : [ "RHOMBUS_USER_NOT_FOUND", "RHOMBUS_ORG_USER_NOT_FOUND", "PASSWORD_RESET_TOKEN_EXPIRED", "INVALID_CURRENT_PASSWORD" ] }, + "UpdateTailgatingRuleResponse" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + } + } + }, "UploadTargetEnum" : { "type" : "string", "enum" : [ "0", "1", "2" ] @@ -133094,6 +161652,14 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "receiveHealthNotifications" : { + "type" : "boolean", + "nullable" : true + }, + "smsNotificationIncludesLinks" : { + "type" : "boolean", + "nullable" : true + }, "smsPhoneNumbers" : { "type" : "array", "items" : { @@ -133180,6 +161746,14 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "receiveHealthNotifications" : { + "type" : "boolean", + "nullable" : true + }, + "smsNotificationIncludesLinks" : { + "type" : "boolean", + "nullable" : true + }, "smsPhoneNumbers" : { "type" : "array", "items" : { @@ -133243,6 +161817,17 @@ "nullable" : true, "uniqueItems" : true }, + "componentCompositeGranularAccessMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PermissionEnum" + }, + "nullable" : true + }, + "nullable" : true + }, "defaultAccessControlPermissionForNewLocations" : { "$ref" : "#/components/schemas/PermissionEnum" }, @@ -133308,6 +161893,10 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "restrictMobileSignIn" : { + "type" : "boolean", + "nullable" : true + }, "storedInS3" : { "type" : "boolean", "nullable" : true @@ -134154,6 +162743,10 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "smsNotificationIncludesLinks" : { + "type" : "boolean", + "nullable" : true + }, "smsPhoneNumbers" : { "type" : "array", "items" : { @@ -134215,9 +162808,6 @@ "type" : "string", "nullable" : true }, - "notificationSettings" : { - "$ref" : "#/components/schemas/PartnerNotificationSettingsType" - }, "notificationSettingsV2" : { "$ref" : "#/components/schemas/PartnerNotificationSettingsV2" }, @@ -134356,6 +162946,14 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "receiveHealthNotifications" : { + "type" : "boolean", + "nullable" : true + }, + "smsNotificationIncludesLinks" : { + "type" : "boolean", + "nullable" : true + }, "smsPhoneNumbers" : { "type" : "array", "items" : { @@ -134438,6 +163036,14 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "restrictMobileSignInOverride" : { + "type" : "boolean", + "nullable" : true + }, + "restrictToAllowedLoginIps" : { + "type" : "boolean", + "nullable" : true + }, "smsPhoneNumbers" : { "type" : "array", "items" : { @@ -134500,6 +163106,12 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "restrictToAllowedLoginIps" : { + "type" : "boolean", + "description" : "When true the user's web console sessions are restricted to the org-wide login IP allowlist.", + "example" : true, + "nullable" : true + }, "smsPhoneNumbers" : { "type" : "array", "description" : "List of SMS phone numbers for the user", @@ -134653,6 +163265,32 @@ } } }, + "User_metadata_FindAllUserMetadataFieldsByOrgWSRequest" : { + "type" : "object" + }, + "User_metadata_FindAllUserMetadataFieldsByOrgWSResponse" : { + "type" : "object", + "properties" : { + "templateMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/UserMetadataFieldTemplate" + }, + "nullable" : true + }, + "userFieldValueMapByUser" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/UserMetadataField" + }, + "nullable" : true + }, + "nullable" : true + } + } + }, "User_metadata_FindUserMetadataFieldTemplatesWSRequest" : { "type" : "object" }, @@ -134830,7 +163468,12 @@ "uniqueItems" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "thumbnailS3Key" : { "type" : "string", @@ -134914,7 +163557,12 @@ "nullable" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" }, "thumbnailS3Key" : { "type" : "string", @@ -135628,7 +164276,12 @@ "nullable" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } }, @@ -136069,6 +164722,81 @@ } } }, + "Video_ExactFrameAvailabilityWSStatus" : { + "type" : "string", + "description" : "Outcome of an exact frame request. AVAILABLE is the only value under which a frame URI or frame data is returned; every other value explains why the frame cannot be served.", + "enum" : [ "AVAILABLE", "FUTURE_TIMESTAMP", "CAMERA_DELETED", "CAMERA_STATE_UNAVAILABLE", "CAMERA_NOT_CONNECTED", "MEDIA_STORAGE_DEVICE_NOT_CONNECTED", "NOT_RECORDING_AT_TIMESTAMP", "NO_FOOTAGE_AT_TIMESTAMP", "MEDIA_ADDRESS_UNAVAILABLE", "FRAME_RETRIEVAL_FAILED" ] + }, + "Video_GenerateRangedTimelapseClipWSRequest" : { + "type" : "object", + "description" : "Request for generating a timelapse where each facet contributes footage only during its own time ranges.", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description for the timelapse", + "nullable" : true + }, + "drawCameraDetails" : { + "type" : "boolean", + "description" : "Whether to draw camera details on the video", + "example" : true, + "nullable" : true + }, + "drawTimestamp" : { + "type" : "boolean", + "description" : "Whether to draw timestamps on the video", + "example" : true, + "nullable" : true + }, + "sources" : { + "type" : "array", + "description" : "One entry per device facet. Each carries its own list of time ranges.", + "items" : { + "$ref" : "#/components/schemas/Video_RangedTimelapseSource" + }, + "nullable" : true + }, + "title" : { + "type" : "string", + "description" : "Title for the timelapse", + "example" : "Subject Tour 2026-04-21", + "nullable" : true + }, + "videoDuration" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in seconds for the output video", + "example" : 60, + "nullable" : true + } + }, + "required" : [ "sources", "videoDuration" ] + }, + "Video_GenerateRangedTimelapseClipWSResponse" : { + "type" : "object", + "description" : "Response from generating a ranged timelapse clip.", + "properties" : { + "clipUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, "Video_GenerateTimelapseClipWSRequest" : { "type" : "object", "description" : "Request object for generating a timelapse clip.", @@ -136175,6 +164903,103 @@ } } }, + "Video_GetExactFrameDataWSRequest" : { + "type" : "object", + "description" : "Request object for fetching the bytes of an exact frame from a camera.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "downscaleFactor" : { + "type" : "integer", + "format" : "int32", + "description" : "Ratio to shrink the image pixels by. Defaults to 1 (full resolution).", + "minimum" : 1, + "nullable" : true + }, + "permyriadCropHeight" : { + "type" : "integer", + "format" : "int32", + "description" : "Precise ratio to crop the height by. Capped at 10000, which is 100.00% of the image", + "maximum" : 10000, + "minimum" : 0, + "nullable" : true + }, + "permyriadCropWidth" : { + "type" : "integer", + "format" : "int32", + "description" : "Precise ratio to crop the width by. Capped at 10000, which is 100.00% of the image", + "maximum" : 10000, + "minimum" : 0, + "nullable" : true + }, + "permyriadCropX" : { + "type" : "integer", + "format" : "int32", + "description" : "Proportional location to start horizontal crop at. Where 10000 is 100.00% of, or the end of the image", + "maximum" : 10000, + "minimum" : 0, + "nullable" : true + }, + "permyriadCropY" : { + "type" : "integer", + "format" : "int32", + "description" : "Proportional location to start vertical crop at. Where 10000 is 100.00% of, or the end of the image", + "maximum" : 10000, + "minimum" : 0, + "nullable" : true + }, + "timestampMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp in epoch milliseconds", + "nullable" : true + } + }, + "required" : [ "cameraUuid", "timestampMs" ] + }, + "Video_GetExactFrameDataWSResponse" : { + "type" : "object", + "description" : "Response object containing the bytes of the requested frame data in base64 format", + "properties" : { + "error" : { + "type" : "boolean", + "nullable" : true + }, + "errorMsg" : { + "type" : "string", + "nullable" : true + }, + "frameData" : { + "type" : "string", + "description" : "Base64-encoded image bytes for the requested frame. Null if no frame could be retrieved.", + "nullable" : true + }, + "mimeType" : { + "type" : "string", + "description" : "MIME type of the encoded frame data", + "example" : "image/jpeg", + "nullable" : true + }, + "responseMessage" : { + "type" : "string", + "description" : "Human-readable message describing the result", + "example" : "Frame retrieved successfully", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/Video_ExactFrameAvailabilityWSStatus" + }, + "warningMsg" : { + "type" : "string", + "nullable" : true + } + } + }, "Video_GetExactFrameUriWSRequest" : { "type" : "object", "description" : "Request object for generating URL to get an exact frame with optional crop from a camera.", @@ -136266,12 +165091,29 @@ "example" : "Frame generated successfully", "nullable" : true }, + "status" : { + "$ref" : "#/components/schemas/Video_ExactFrameAvailabilityWSStatus" + }, "warningMsg" : { "type" : "string", "nullable" : true } } }, + "Video_GetLiveImageWSRequest" : { + "type" : "object", + "description" : "Request object for pulling the most recent snapshot image from a camera.", + "properties" : { + "cameraUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + } + }, + "required" : [ "cameraUuid" ] + }, "Video_GetMaxSpliceDurationWSRequest" : { "type" : "object", "description" : "Request object for getting the max splice duration an organization can set." @@ -136437,6 +165279,28 @@ } } }, + "Video_RangedTimelapseSource" : { + "type" : "object", + "description" : "A single device-facet input to a ranged timelapse, with one or more time ranges during which this facet should contribute footage.", + "properties" : { + "deviceUuid" : { + "type" : "string", + "format" : "DeviceFacetUuid", + "description" : "RUUID with optional appended facet information", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.v0", + "nullable" : true + }, + "ranges" : { + "type" : "array", + "description" : "List of time ranges (milliseconds) during which this facet should appear in the timelapse. Must be non-empty.", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true + } + }, + "required" : [ "deviceUuid", "ranges" ] + }, "Video_RetrySpliceWSRequest" : { "type" : "object", "description" : "Request object for retrying a spliced clip.", @@ -136682,6 +165546,19 @@ "example" : "Review of security incident from main entrance", "nullable" : true }, + "deviceIntervalMap" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Optional map of device facet UUIDs to a list of time intervals (start/end millis) for multi-interval splicing. When provided and non-empty, the request is treated as multi-interval and the top-level startTimeMillis/durationSec are ignored. The sum of all interval durations across all devices is capped at 60 minutes, and each interval must be at least 1 second long.", + "items" : { + "$ref" : "#/components/schemas/TimeInterval" + }, + "nullable" : true + }, + "description" : "Optional map of device facet UUIDs to a list of time intervals (start/end millis) for multi-interval splicing. When provided and non-empty, the request is treated as multi-interval and the top-level startTimeMillis/durationSec are ignored. The sum of all interval durations across all devices is capped at 60 minutes, and each interval must be at least 1 second long.", + "nullable" : true + }, "deviceUuids" : { "type" : "array", "description" : "List of device facet UUIDs to splice video from", @@ -137104,6 +165981,14 @@ "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, + "subLocationsHierarchyKey" : { + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" + }, "timestampMs" : { "type" : "integer", "format" : "int64", @@ -137164,21 +166049,100 @@ }, "Waypoint" : { "type" : "object", + "description" : "The updated waypoint", "properties" : { - "actionReferences" : { - "type" : "array", - "items" : { - "type" : "string", - "nullable" : true + "mapUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "pose" : { + "$ref" : "#/components/schemas/Pose" + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + } + } + }, + "WaypointActionProgress" : { + "type" : "object", + "properties" : { + "status" : { + "$ref" : "#/components/schemas/WaypointActionStatusEnum" + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + } + } + }, + "WaypointActionStatusEnum" : { + "type" : "string", + "enum" : [ "NOT_STARTED", "COMPLETED", "ABORTED", "UNKNOWN" ] + }, + "WaypointRun" : { + "type" : "object", + "description" : "List of waypoint runs for the route run", + "properties" : { + "actionStatusMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/WaypointActionProgress" }, "nullable" : true }, - "dwellEventId" : { + "arrivedAtEventUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "dwellEventType" : { + "arrivedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "completedAtEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "completedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "createdAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "deviceUuid" : { "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, "dwellStrategy" : { @@ -137189,15 +166153,93 @@ "format" : "int64", "nullable" : true }, - "pose" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "ordinal" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "parentRouteRunUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "parentRouteUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "poseAchieved" : { "$ref" : "#/components/schemas/Pose" }, + "poseTarget" : { + "$ref" : "#/components/schemas/Pose" + }, + "routeWaypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "ruleReferences" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "nullable" : true + }, + "startedAtEventUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "status" : { + "$ref" : "#/components/schemas/RunStatusEnum" + }, + "updatedAtMs" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, "uuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true + }, + "waypointUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true } } }, @@ -137237,6 +166279,10 @@ "type" : "string", "nullable" : true }, + "webhookSecret" : { + "type" : "string", + "nullable" : true + }, "webhookUrl" : { "type" : "string", "nullable" : true @@ -137375,6 +166421,21 @@ } } }, + "WeeklyMinuteInterval" : { + "type" : "object", + "properties" : { + "minuteOfWeekStart" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "minuteOfWeekStop" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + } + }, "WeeklyMinuteIntervalType" : { "type" : "object", "properties" : { @@ -137406,6 +166467,10 @@ } ], "nullable" : true, "properties" : { + "internalWriteOnly" : { + "type" : "boolean", + "nullable" : true + }, "mutable" : { "type" : "boolean", "nullable" : true @@ -137476,6 +166541,136 @@ } ], "nullable" : true, "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastUsedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "managedCredUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "Wiegand48BitCorp1000Credential" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "companyId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "format" : { + "$ref" : "#/components/schemas/WiegandFormatEnumType" + } + } + } ], + "nullable" : true, + "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", @@ -137564,7 +166759,7 @@ } } }, - "Wiegand48BitCorp1000Credential" : { + "Wiegand64BitRawCredentialType" : { "type" : "object", "allOf" : [ { "type" : "object", @@ -137574,11 +166769,6 @@ "format" : "int64", "nullable" : true }, - "companyId" : { - "type" : "integer", - "format" : "int32", - "nullable" : true - }, "format" : { "$ref" : "#/components/schemas/WiegandFormatEnumType" } @@ -137586,111 +166776,16 @@ } ], "nullable" : true, "properties" : { - "createdAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "endDateEpochSecExclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" }, - "lastUsedAccessControlledDoorUuid" : { + "assigneeUuid" : { "type" : "string", "format" : "RUUID", "description" : "base 64 (url-safe) uuid string", "example" : "AAAAAAAAAAAAAAAAAAAAAA", "nullable" : true }, - "lastUsedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "lastUsedLocationUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "lowercaseHexValue" : { - "type" : "string", - "nullable" : true, - "readOnly" : true - }, - "managedCredUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "note" : { - "type" : "string", - "nullable" : true - }, - "orgUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "startDateEpochSecInclusive" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "type" : { - "$ref" : "#/components/schemas/AccessControlCredentialEnumType" - }, - "updatedAtMillis" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "userUuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "uuid" : { - "type" : "string", - "format" : "RUUID", - "description" : "base 64 (url-safe) uuid string", - "example" : "AAAAAAAAAAAAAAAAAAAAAA", - "nullable" : true - }, - "value" : { - "type" : "string", - "nullable" : true - }, - "workflowStatus" : { - "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" - } - } - }, - "Wiegand64BitRawCredentialType" : { - "type" : "object", - "allOf" : [ { - "type" : "object", - "properties" : { - "cardNumber" : { - "type" : "integer", - "format" : "int64", - "nullable" : true - }, - "format" : { - "$ref" : "#/components/schemas/WiegandFormatEnumType" - } - } - } ], - "nullable" : true, - "properties" : { "createdAtMillis" : { "type" : "integer", "format" : "int64", @@ -137809,6 +166904,16 @@ } ], "nullable" : true, "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", @@ -137954,6 +167059,9 @@ "type" : "boolean", "nullable" : true }, + "disposition" : { + "$ref" : "#/components/schemas/ReaderDispositionEnum" + }, "gledPort" : { "$ref" : "#/components/schemas/WiegandOutputPortType" }, @@ -138018,7 +167126,7 @@ }, "WiegandFormatEnumType" : { "type" : "string", - "enum" : [ "H10301", "D10202", "H10304", "HID_CORP1000_STD_35", "HID_CORP1000_STD_48", "WIEGAND_64BIT_RAW", "CUSTOM" ] + "enum" : [ "H10301", "D10202", "H10304", "H10302", "HID_CORP1000_STD_35", "HID_CORP1000_STD_48", "WIEGAND_64BIT_RAW", "CUSTOM" ] }, "WiegandH10301CredentialType" : { "type" : "object", @@ -138046,6 +167154,135 @@ } ], "nullable" : true, "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "createdAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "endDateEpochSecExclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedAccessControlledDoorUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lastUsedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "lastUsedLocationUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "lowercaseHexValue" : { + "type" : "string", + "nullable" : true, + "readOnly" : true + }, + "managedCredUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "note" : { + "type" : "string", + "nullable" : true + }, + "orgUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "startDateEpochSecInclusive" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "type" : { + "$ref" : "#/components/schemas/AccessControlCredentialEnumType" + }, + "updatedAtMillis" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "userUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "uuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, + "value" : { + "type" : "string", + "nullable" : true + }, + "workflowStatus" : { + "$ref" : "#/components/schemas/AccessControlCredentialWorkflowStatusEnumType" + } + } + }, + "WiegandH10302Credential" : { + "type" : "object", + "allOf" : [ { + "type" : "object", + "properties" : { + "cardNumber" : { + "type" : "integer", + "format" : "int64", + "nullable" : true + }, + "format" : { + "$ref" : "#/components/schemas/WiegandFormatEnumType" + }, + "nonParityValue" : { + "type" : "string", + "nullable" : true + } + } + } ], + "nullable" : true, + "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", @@ -138160,6 +167397,16 @@ } ], "nullable" : true, "properties" : { + "assigneeType" : { + "$ref" : "#/components/schemas/AccessControlCredentialAssigneeTypeEnum" + }, + "assigneeUuid" : { + "type" : "string", + "format" : "RUUID", + "description" : "base 64 (url-safe) uuid string", + "example" : "AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true + }, "createdAtMillis" : { "type" : "integer", "format" : "int64", @@ -138375,6 +167622,14 @@ "type" : "boolean", "nullable" : true }, + "restrictMobileSignInOverride" : { + "type" : "boolean", + "nullable" : true + }, + "restrictToAllowedLoginIps" : { + "type" : "boolean", + "nullable" : true + }, "rhombusUserUuid" : { "type" : "string", "format" : "RUUID", @@ -138514,6 +167769,12 @@ "description" : "Indication of whether badge authentication can disable monitoring at this zone.", "nullable" : true }, + "badgeAuthRearmAfterMinutes" : { + "type" : "integer", + "format" : "int64", + "description" : "If configured, monitoring is re-armed after X minutes following badge authentication. The zone will\nonly be re-armed if it was armed to begin with. Badge authentication to disable monitoring must be\nenabled for this feature to work.\n", + "nullable" : true + }, "emergencyContactPolicies" : { "type" : "array", "description" : "Emergency contacts that may be notified after threat detection occurs at this zone.\n", @@ -138539,12 +167800,12 @@ "nullable" : true }, "subLocationsHierarchyKey" : { - "$ref" : "#/components/schemas/SubLocationsHierarchyKey" - }, - "talkdownEnabled" : { - "type" : "boolean", - "description" : "Indication of whether talk-down is enabled for this zone.", - "nullable" : true + "type" : "string", + "format" : "SubLocationsHierarchyKey", + "description" : "A sequence of one or more base 64 (url-safe) uuid substrings.\nThese substrings are separated by dots (.).\n", + "example" : "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", + "nullable" : true, + "pattern" : "^([A-Za-z0-9\\-_]{22})([.][A-Za-z0-9\\-_]{22})*$" } } } ], diff --git a/plugins/developer/skills/rhombus-edge-streaming/SKILL.md b/plugins/developer/skills/rhombus-edge-streaming/SKILL.md index bb4b8e9..5c67099 100644 --- a/plugins/developer/skills/rhombus-edge-streaming/SKILL.md +++ b/plugins/developer/skills/rhombus-edge-streaming/SKILL.md @@ -1,38 +1,42 @@ --- name: rhombus-edge-streaming -description: Implement edge streaming and third-party camera integration with Rhombus — RTSP bridging via edgecaster, ONVIF camera ingestion via rhombus-libonvif, custom analytics seekpoint generation, and embedded player usage. Use whenever the user mentions RTSP, ONVIF, "edge ingest", "secure raw streams", "seekpoint", "third-party camera", "non-Rhombus camera", "NVR integration", "edgecaster", "Jetson", "roboflow", or asks to stream video out of or into the Rhombus platform via a non-standard path. Also trigger for questions about the Player-example repo and lightweight web camera embeds. +description: Implement edge streaming and third-party camera integration with Rhombus — re-streaming Rhombus cameras as RTSP via EdgeCaster, adding third-party RTSP/ONVIF cameras through a Rhombus Relay, local ONVIF tooling via rhombus-libonvif, custom analytics seekpoint generation, LAN streaming with federated tokens, and embedded player usage. Use whenever the user mentions RTSP, ONVIF, "edge ingest", "secure raw streams", "seekpoint", "third-party camera", "non-Rhombus camera", "NVR integration", "edgecaster", "Jetson", "roboflow", or asks to stream video out of or into the Rhombus platform via a non-standard path. Also trigger for questions about the Player-example repo and lightweight web camera embeds. argument-hint: "[rtsp|onvif|seekpoint|player] [question]" --- # Rhombus Edge Streaming -Rhombus supports four edge-streaming scenarios beyond the standard in-platform camera experience. This skill covers the right tool and repo for each. +Rhombus supports several edge-streaming scenarios beyond the standard in-platform camera experience. This skill covers the right tool and repo for each. -## 1. RTSP bridging — edgecaster-stream-converter +## 1. Rhombus cameras out as RTSP — EdgeCaster -**Scenario:** You have a non-Rhombus camera that speaks RTSP and want its feed visible inside the Rhombus platform, or you want a Rhombus camera's feed available as RTSP for a third-party NVR. +**Scenario:** You want Rhombus camera feeds available as standard RTSP streams for a third-party VMS, NVR, or AI system. -**Tool:** `edgecaster-stream-converter` — Python-based edge gateway that bridges RTSP ↔ Rhombus Secure Raw Streams. +**Tool:** EdgeCaster (`edgecaster-stream-converter`) — a small box (Raspberry Pi 5, mini-PC, or Linux VM) that pulls each Rhombus camera's Secure Raw Stream (H.264 over HTTPS) with FFmpeg and re-broadcasts it as RTSP on the local network. One direction only: Rhombus → RTSP. **Repo:** `https://github.com/RhombusSystems/edgecaster-stream-converter` **Architecture:** ``` -[Third-party camera] --RTSP--> [edgecaster gateway] --Secure Raw Stream--> [Rhombus platform] - OR -[Rhombus camera] <--RTSP-- [edgecaster gateway] <--Secure Raw Stream-- [Rhombus platform] +[Rhombus cameras] --Secure Raw Stream--> [EdgeCaster] --RTSP (rtsp://:8554/)--> [VMS / NVR / AI system] ``` -**When to recommend:** The user has cameras that can't be replaced, or needs to integrate a legacy NVR that only speaks RTSP. +**When to recommend:** The user needs Rhombus video inside an existing VMS/NVR or an AI pipeline that only speaks RTSP. -**Alternative first:** Check if the user's camera is ONVIF-compliant. If yes, `rhombus-libonvif` may be simpler than edgecaster. See section 2. +## 2. Third-party cameras into Rhombus — Rhombus Relay -## 2. ONVIF ingestion — rhombus-libonvif +**Scenario:** You have non-Rhombus RTSP or ONVIF cameras and want their video in the Rhombus platform. -**Scenario:** You want to pull video from an ONVIF camera using Rhombus's ML pipeline (YOLOX object detection) without routing through edgecaster. +**Tool:** A Rhombus Relay (NVR) on the camera network. Discover and add the cameras in the Console, or with the Relay Webservice: `POST /api/relay/executeThirdPartyCameraDiscovery`, `POST /api/relay/addThirdPartyCameraViaOnvif`, `POST /api/relay/assignThirdPartyCameraToNVR`, `POST /api/relay/getMinimalThirdPartyCameraStateList`. -**Tool:** `rhombus-libonvif` — C++ library for ONVIF discovery and streaming, combined with YOLOX for on-device inference. LGPL 2.1. +**When to recommend:** The user has cameras that can't be replaced and wants them managed and recorded in Rhombus. + +## 2b. Local ONVIF tooling — rhombus-libonvif + +**Scenario:** You want to discover and view ONVIF cameras locally, with on-device object detection, outside the Rhombus platform. + +**Tool:** `rhombus-libonvif` — a client-side ONVIF implementation (command-line `onvif-util` and a GUI) with built-in YOLOX object detection. LGPL 2.1. **Repo:** `https://github.com/RhombusSystems/rhombus-libonvif` @@ -44,19 +48,19 @@ Rhombus supports four edge-streaming scenarios beyond the standard in-platform c **Scenario:** You have a third-party AI model (object detection, LPR, pose estimation) producing events, and want those events to appear as seekpoints/markers on the Rhombus video timeline. -**Tool:** `rhombus-seekpoint-generator-example` — Python reference for posting custom events to the Event Webservice. +**Tool:** `rhombus-seekpoint-generator-example` — Python reference for posting custom seekpoints to a camera's timeline. **Repo:** `https://github.com/RhombusSystems/rhombus-seekpoint-generator-example` **Architecture:** ``` -[Your model] --detections--> [seekpoint generator] --POST /event/createEvent--> [Rhombus timeline] +[Your model] --detections--> [seekpoint generator] --POST /api/camera/createCustomFootageSeekpoints--> [Rhombus timeline] ``` **When to recommend:** The user has their own AI model (e.g., PPE detection, forklift safety, queue counting) and wants its output first-class in the Rhombus UI. -**Key endpoints:** Event Webservice — `createEvent`, `createSeekpoint`, and the Search Webservice for retrieval. +**Key endpoints:** `POST /api/camera/createCustomFootageSeekpoints` (create, many per call), `POST /api/camera/getCustomFootageSeekpointsV2` (read back), `POST /api/camera/deleteCustomFootageSeekpoints`. ## 4. Lightweight embedded player @@ -69,33 +73,45 @@ Rhombus supports four edge-streaming scenarios beyond the standard in-platform c **Architecture:** ``` -[Browser] --federated session token--> [Your server] --API key--> [Rhombus /camera/getMediaUris] -[Browser] --MPEG-DASH via DashJS--> [media.rhombussystems.com] +[Browser] --asks for token + URIs--> [Your server] --API key--> [Rhombus POST /api/org/generateFederatedSessionToken, POST /api/camera/getMediaUris] +[Browser] --MPEG-DASH via DashJS, ?x-auth-scheme=federated-token&x-auth-ft=--> [Rhombus media URLs] ``` **Why not iframe:** Iframe share-stream (`createSharedLiveVideoStream`) is simpler but has less control over UX. Use `Player-example` when you need custom overlays, multi-camera grids, or integration with third-party identity. -**Never:** embed API keys in browser code. Always use federated session tokens with a server-side proxy. +**Never:** embed API keys in browser code. Mint a federated token on your server and send it as `x-auth-scheme: federated-token` + `x-auth-ft` (headers, or query parameters on media URLs). The scheme value is exactly `federated-token`, and the token never goes in `x-auth-apikey`. + +## 5. LAN streaming + +**Scenario:** You want live or recorded video, or two-way audio, straight from cameras on the customer's network instead of through the cloud. + +- `POST /api/camera/getMediaUris` returns LAN URIs (`lanLiveH264Uris`, `lanLiveMpdUris`, `lanLiveM3u8Uris`, `lanVodMpdUrisTemplates`, `lanVodM3u8UrisTemplates`, `lanCheckUrls`). +- Devices on the LAN **never accept API keys**. Mint a device-scoped federated token (`deviceUUid`) and send it on every request, including each segment and the WebSocket upgrade, as headers or query parameters. +- In VOD templates, replace `{START_TIME}` (Unix seconds) and `{DURATION}` (seconds). +- Guide: `https://developer.rhombus.com/implementations/lan-streaming` ## Decision tree ``` Non-Rhombus camera needs to be IN Rhombus? - → Is it ONVIF? → rhombus-libonvif (or rhombus-jetson-roboflow on Jetson) - → RTSP only? → edgecaster-stream-converter + → RTSP or ONVIF → Rhombus Relay (Relay Webservice third-party camera endpoints) + +Local ONVIF discovery or edge AI outside Rhombus? + → rhombus-libonvif (or rhombus-jetson-roboflow on Jetson) Rhombus camera needs to be OUT of Rhombus? - → Need RTSP? → edgecaster-stream-converter (reverse direction) - → Need MPEG-DASH in a browser? → player-example + federated session tokens + → Need RTSP? → EdgeCaster (edgecaster-stream-converter) + → Need MPEG-DASH in a browser? → player-example + federated tokens + → Need it straight from the LAN? → LAN URIs from getMediaUris + device-scoped federated tokens Custom AI events on Rhombus timeline? - → rhombus-seekpoint-generator-example + Event Webservice + → rhombus-seekpoint-generator-example + POST /api/camera/createCustomFootageSeekpoints ``` ## Reference sheet See `references/rtsp-onvif.md` for: -- edgecaster install + config walkthrough +- EdgeCaster install and setup - ONVIF discovery gotchas (multicast, firewall, auth) - Seekpoint payload shape - Player-example server-side token proxy snippet diff --git a/plugins/developer/skills/rhombus-edge-streaming/references/rtsp-onvif.md b/plugins/developer/skills/rhombus-edge-streaming/references/rtsp-onvif.md index 31accb4..f83119d 100644 --- a/plugins/developer/skills/rhombus-edge-streaming/references/rtsp-onvif.md +++ b/plugins/developer/skills/rhombus-edge-streaming/references/rtsp-onvif.md @@ -1,32 +1,20 @@ # RTSP / ONVIF / Edge Streaming Reference -Implementation notes for the four edge-streaming scenarios in the `rhombus-edge-streaming` skill. +Implementation notes for the edge-streaming scenarios in the `rhombus-edge-streaming` skill. -## edgecaster-stream-converter +## EdgeCaster (edgecaster-stream-converter) -**Install:** +EdgeCaster re-streams Rhombus cameras as RTSP. It does not bring third-party cameras into Rhombus (use a Rhombus Relay for that). + +**Install** (Ubuntu or Debian on a Raspberry Pi 5, mini-PC, or VM), or flash the EdgeCaster Raspberry Pi image: ```bash -git clone https://github.com/RhombusSystems/edgecaster-stream-converter -cd edgecaster-stream-converter -pip install -r requirements.txt +curl -fsSL https://raw.githubusercontent.com/RhombusSystems/edgecaster-stream-converter/main/scripts/bootstrap.sh | sudo bash ``` -**Minimal config (RTSP → Rhombus):** - -```yaml -# config.yaml -source: - type: rtsp - url: rtsp://user:pass@192.168.1.100:554/stream1 - -destination: - type: rhombus-secure-raw-stream - api_key: ${RHOMBUS_API_KEY} - target_camera_uuid: AAAAAAAAAAAAAAAAAAAAAA -``` +**Set up:** open `http://edgecaster.local` (or `http://`), paste a Rhombus API key, switch on the cameras to stream, and copy each camera's RTSP link (`rtsp://:8554/`) into the VMS, NVR, or AI system. -**Deployment:** Run as a systemd service on a small edge host (RPi 5, mini PC, NUC). One gateway can multiplex several streams; check repo README for resource guidance. +**Deployment:** Wired Gigabit network recommended. There is no fixed stream limit; capacity depends on the host's network and CPU. See the repo README for details. ## ONVIF discovery gotchas @@ -38,21 +26,24 @@ destination: ## Seekpoint payload shape ```json -POST /api/event/createSeekpoint +POST /api/camera/createCustomFootageSeekpoints { "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA", - "timestamp": 1712345678000, - "durationMs": 3000, - "title": "Forklift in aisle 3", - "tags": ["forklift", "aisle-3"], - "metadata": { - "confidence": 0.94, - "model": "custom-forklift-v1" - } + "footageSeekPoints": [ + { + "name": "Forklift aisle 3", + "timestampMs": 1712345678000, + "description": "custom-forklift-v1, confidence 0.94", + "color": "BLUE", + "displayOverlay": true + } + ] } ``` -Response includes a `seekpointUuid` you can reference when linking back to the event from your system. +- `name` (max 32 characters) and `timestampMs` are required; `description` (max 100 characters), `color` and `displayOverlay` are optional. +- Send many seekpoints in one call rather than one request per detection. +- The response carries only `error` / `errorMsg` / `warningMsg`, not seekpoint IDs. Read seekpoints back with `POST /api/camera/getCustomFootageSeekpointsV2`. ## Player-example server-side token proxy @@ -71,17 +62,18 @@ app.post('/api/rhombus-session', async (req, res) => { 'x-auth-apikey': process.env.RHOMBUS_API_KEY!, 'content-type': 'application/json', }, - body: JSON.stringify({ ttlSec: 3600 }), + body: JSON.stringify({ durationSec: 3600 }), }); const { federatedSessionToken } = await r.json(); res.json({ token: federatedSessionToken }); }); ``` -Browser calls `/api/rhombus-session`, receives the short-lived token, then uses it with `x-auth-scheme: federated-session-token` to fetch media URIs. +`/api/rhombus-session` is a route on your own server. Your server also calls `POST /api/camera/getMediaUris` with its API key and returns the URIs. The browser then sends the token on every media request as `x-auth-scheme: federated-token` + `x-auth-ft: `, or as `?x-auth-scheme=federated-token&x-auth-ft=` when the player can't set headers. The scheme value is exactly `federated-token`, and the token never goes in `x-auth-apikey`. For LAN device URLs, mint a device-scoped token by adding `deviceUUid` to the request body. ## Rate-limit considerations for seekpoint posting -- Hard cap: 1,000 req/hr per API key. -- If your model emits >1,000 events/hour, batch before posting or request a higher rate limit via `api@rhombus.com`. -- For bursty workloads (e.g., LPR at rush hour), implement exponential backoff on 429 responses. +- Limits are per organization: every API key and OAuth token in the org shares one token bucket that refills at a per-second rate and allows bursts of roughly 10x that rate. Extra API keys don't add throughput. See `https://developer.rhombus.com/rate-limits`. +- Batch detections into one `createCustomFootageSeekpoints` call per camera instead of one request per detection. +- On `429`, wait the `Retry-After` seconds, then retry with exponential backoff and jitter. +- To request a higher limit, contact `support@rhombus.com`. diff --git a/plugins/developer/skills/rhombus-sdk-codegen/SKILL.md b/plugins/developer/skills/rhombus-sdk-codegen/SKILL.md index e38a873..74c40d4 100644 --- a/plugins/developer/skills/rhombus-sdk-codegen/SKILL.md +++ b/plugins/developer/skills/rhombus-sdk-codegen/SKILL.md @@ -46,7 +46,8 @@ The generated client handles request serialization but not Rhombus-specific auth client.configuration.api_key['x-auth-apikey'] = os.environ['RHOMBUS_API_KEY'] client.configuration.api_key['x-auth-scheme'] = 'api-token' ``` -- **Federated session flow (browser):** Generate a short-lived token via the `/org/generateFederatedSessionToken` endpoint on a server, pass it to the client, and set `x-auth-scheme: federated-session-token`. +- **Federated token flow (browser, video players, LAN devices):** On a server, mint a short-lived token with `POST /api/org/generateFederatedSessionToken` (`{"durationSec": 3600}`, optional `deviceUUid`) and pass `federatedSessionToken` to the client. The client sends `x-auth-scheme: federated-token` and `x-auth-ft: ` (headers, or query parameters on media URLs). The scheme value is exactly `federated-token`, and the token never goes in `x-auth-apikey`. +- **Region:** the spec's `servers` entry is the US host. For EU organizations, set the client's base URL to `https://api2.eu.rhombussystems.com`. See `references/codegen-matrix.md` for language-specific auth helper snippets and known gotchas (e.g., TypeScript-fetch's handling of optional fields, Go's pointer-vs-value generation for nullable types). diff --git a/plugins/developer/skills/rhombus-sdk-codegen/references/codegen-matrix.md b/plugins/developer/skills/rhombus-sdk-codegen/references/codegen-matrix.md index 6a16b17..7f38019 100644 --- a/plugins/developer/skills/rhombus-sdk-codegen/references/codegen-matrix.md +++ b/plugins/developer/skills/rhombus-sdk-codegen/references/codegen-matrix.md @@ -16,6 +16,8 @@ Reference tables for generating and using Rhombus API clients in each supported ## Auth helper snippets +The snippets use the US base URL. For EU organizations, use `https://api2.eu.rhombussystems.com` (API keys only work in their own region). + ### Python ```python @@ -73,15 +75,15 @@ client := rhombus.NewAPIClient(cfg) - **TypeScript optional fields**: the fetch generator emits `field?: T`. Node 18's `fetch` serializes `undefined` fields as absent — don't `JSON.stringify` manually. - **Python package name collision**: by default the generated package is `openapi_client`, which collides across multiple generated SDKs. Always use `--package-name rhombus` for disambiguation. -## Federated session token pattern (browser apps) +## Federated token pattern (browser apps) For browser-based apps, never embed the API key. Instead, run a small server that: 1. Holds `RHOMBUS_API_KEY` securely. -2. Exposes an endpoint like `POST /api/rhombus-session` that calls `generateFederatedSessionToken` via the SDK. -3. Returns the short-lived token to the browser. +2. Exposes an endpoint like `POST /api/rhombus-session` that calls `generateFederatedSessionToken` (`POST /api/org/generateFederatedSessionToken`, body `{"durationSec": 3600}`) via the SDK. +3. Returns `federatedSessionToken` to the browser. -Browser uses `x-auth-scheme: federated-session-token` with the token in `x-auth-apikey`. See `player-example` repo for a full implementation. +The browser sends `x-auth-scheme: federated-token` and `x-auth-ft: ` as headers, or appends `?x-auth-scheme=federated-token&x-auth-ft=` to media URLs. The scheme value is exactly `federated-token`, and the token never goes in `x-auth-apikey`. For streaming from devices on the LAN, mint device-scoped tokens with `deviceUUid`; LAN devices never accept API keys. See `player-example` repo for a full implementation. ## Regeneration diff --git a/plugins/developer/skills/rhombus-webhook-receiver/SKILL.md b/plugins/developer/skills/rhombus-webhook-receiver/SKILL.md index 6131b2d..21d0af7 100644 --- a/plugins/developer/skills/rhombus-webhook-receiver/SKILL.md +++ b/plugins/developer/skills/rhombus-webhook-receiver/SKILL.md @@ -21,51 +21,55 @@ Scaffold a production-ready webhook listener for Rhombus events. The scaffold in Every scaffold includes these files: 1. **HTTP entry point** — receives `POST /webhook` with a raw body reader (critical for signature verification). -2. **Signature verifier** — HMAC-SHA256 of the raw body using the webhook secret from env, constant-time compared to the `X-Rhombus-Signature` header. -3. **Idempotency layer** — dedupes by event UUID using an in-memory LRU for dev; swap to Redis/DynamoDB for prod. -4. **Event router** — switches on event type and dispatches to a handler. Default handlers are stubs that log the payload. -5. **Structured logger** — logs every attempt with event UUID, type, signature-ok flag, duplicate flag, outcome. +2. **Signature verifier** — lowercase-hex HMAC of the raw body keyed with the webhook secret from env (the secret string as-is, UTF-8), compared in constant time. Check `x-rhombus-signature-sha256` (HMAC-SHA256, rule webhook actions) first, then `x-rhombus-signature-sha1` (HMAC-SHA1, organization webhooks). Reject with `401` when the header is missing or doesn't match. +3. **Idempotency layer** — dedupes by `alertUuid` (organization webhooks) or `uuid` (rule webhook actions) using an in-memory LRU for dev; swap to Redis/DynamoDB for prod. +4. **Event router** — for organization webhooks, switches on `activityTrigger` / `diagnosticTrigger`; for rule webhook actions, on `ruleUuid` and each `deviceEvents[].activities`. Default handlers are stubs that log the payload. +5. **Structured logger** — logs every attempt with the dedupe key, trigger, signature-ok flag, duplicate flag, outcome. -## Known payload shapes +## Two kinds of Rhombus webhooks + +| | Organization webhooks | Rule webhook actions | +|---|---|---| +| Set up in | Console **Settings → Integrations & Developer Resources → Webhooks** (Trigger Type **Activity** or **Diagnostic**), or `POST /api/integrations/webhooks/updateWebhookIntegrationV2` | A rule's webhook action (`POST /api/rules/createRule`, `POST /api/rules/updateRule`) | +| Secret | **Webhook Secret** column in the Console; `webhookSecret` in the API response when you add a URL | `webhookSecrets` (URL → secret) in the createRule / updateRule response | +| Signature header | `x-rhombus-signature-sha1` | `x-rhombus-signature-sha256` | +| Body | `version`, `activityTrigger` or `diagnosticTrigger`, `summary`, `deviceUuid`, `location` (location UUID), `deviceType`, `timestampMs`, `alertUuid`, ... | `uuid`, `orgUuid`, `ruleUuid`, `triggeredTimestampMs`, `deviceEvents`, `ruleTriggers`, ... | -See `references/webhook-payloads.md` for sample JSON for each event category: +Each webhook URL has its own secret. There is no delivery-ID header and no signed timestamp. -- Camera events (motion, person detection, custom analytics) -- Alert events (with linked `alertUuid`, `cameraUuid`, and media URIs) -- Door events (door unlocked/locked, access granted/denied) -- LPR / vehicle events (with matched plate text and confidence) -- User / access control events (credential issued, granted, revoked) -- IoT sensor events (threshold violations) +## Known payload shapes + +See `references/webhook-payloads.md` for the full field list of both bodies, sample JSON, a test vector, and verified Node and Python verification code. -**Important:** payload shapes vary by event type. Identifier fields differ — don't assume every event has `cameraUuid`. The reference sheet shows the minimum required fields per type. +**Important:** don't assume every event comes from a camera. Check `deviceType`, and treat absent fields as normal: Rhombus omits fields that don't apply. ## Signature verification — the pitfall -Rhombus computes the signature over the **raw request body bytes**, not a re-serialized JSON. If your framework auto-parses JSON before you can access the raw body, signature verification will fail on any payload with non-canonical whitespace. +Rhombus computes the signature over the **raw request body bytes**, not a re-serialized JSON. If your framework auto-parses JSON before you can access the raw body, signature verification will fail. Framework-specific fixes: - **Express:** use `express.raw({ type: 'application/json' })` on the webhook route; parse JSON *after* verification. -- **FastAPI:** use `await request.body()` (returns bytes) before `await request.json()`. -- **Lambda:** use the raw `event.body` (base64-decode if `isBase64Encoded`). +- **FastAPI:** use `await request.body()` (returns bytes) before parsing. +- **Lambda:** use the raw `event.body` (base64-decode if `isBase64Encoded`). API Gateway may change header-name casing, so look headers up case-insensitively. -## Idempotency +Compare with `crypto.timingSafeEqual` (Node, after checking equal lengths) or `hmac.compare_digest` (Python), never `==`. -Rhombus may retry a delivery if your listener: -- Returns a non-2xx status. -- Takes >5s to respond. -- Times out the TCP connection. +## Delivery and idempotency -Always: -1. Dedupe by the event UUID (top-level `uuid` or `eventUuid`). -2. Respond 2xx within 1s — enqueue heavy work to a background worker. +- Organization webhooks count any `2xx` as delivered; rule webhook actions count only `200` or `202`. Return `200`. +- Respond within a second or two and enqueue heavy work to a background worker. Rhombus gives up quickly if it can't connect to your URL. +- A failed delivery is recorded as a webhook-failure diagnostic in the organization and is not retried, so log every request you receive. +- Dedupe anyway, by `alertUuid` (organization webhooks) or `uuid` (rule webhook actions). ## Next steps after scaffolding -1. Set `RHOMBUS_WEBHOOK_SECRET` in your `.env` (obtained when creating the webhook via the Developer Webservice or `mcp__rhombus__*` tools). +1. Get the webhook secret: copy it from **Settings → Integrations & Developer Resources → Webhooks** (organization webhooks) or from the `webhookSecrets` map returned by `createRule` / `updateRule` (rule webhook actions). Set it as `RHOMBUS_WEBHOOK_SECRET` in your `.env`; if you register several URLs, store one secret per URL. 2. Expose your listener publicly (ngrok/cloudflared for dev, a real host for prod). -3. Register the webhook with Rhombus, pointing at your URL, selecting the event types you care about. -4. Send a test event and confirm you see it in the logs with `sig_ok=true, duplicate=false`. -5. Fill in handler logic for each event type you actually care about. +3. Register the URL with Rhombus: add an organization webhook (Activity or Diagnostic) in the Console, or add a webhook action to a rule. +4. Trigger a test event and confirm you see it in the logs with `sig_ok=true, duplicate=false`. +5. Fill in handler logic for each trigger you actually care about. + +Docs: https://developer.rhombus.com/webhooks and https://developer.rhombus.com/implementations/webhook-listener If deliveries aren't arriving, invoke the `rhombus-webhook-debugger` agent. diff --git a/plugins/developer/skills/rhombus-webhook-receiver/references/webhook-payloads.md b/plugins/developer/skills/rhombus-webhook-receiver/references/webhook-payloads.md index 40e5b60..0b32a22 100644 --- a/plugins/developer/skills/rhombus-webhook-receiver/references/webhook-payloads.md +++ b/plugins/developer/skills/rhombus-webhook-receiver/references/webhook-payloads.md @@ -1,132 +1,162 @@ # Rhombus Webhook Payload Reference -Example payloads for each event category. These are illustrative — the exact fields on your webhook depend on which event types you subscribed to and which feature flags your org has enabled. Use `mcp__rhombus-docs__search-documentation webhook payloads` for authoritative, version-current shapes. +Rhombus sends two kinds of webhooks. They differ in how you configure them, the body they send, and the signature header. Docs: https://developer.rhombus.com/webhooks -## Envelope (common to all events) +| | Organization webhooks | Rule webhook actions | +|---|---|---| +| Configured in | Console **Settings → Integrations & Developer Resources → Webhooks** (Trigger Type **Activity** or **Diagnostic**), or `POST /api/integrations/webhooks/updateWebhookIntegrationV2` | The webhook action on a rule (`POST /api/rules/createRule`, `POST /api/rules/updateRule`) | +| Secret | One per URL. Shown in the Console's **Webhook Secret** column; returned as `webhookSecret` when you add a `webhookUrl`; listed by `POST /api/integrations/webhooks/getWebhookIntegration` under `orgIntegrationV2.activityWebhooksV2` / `diagnosticWebhooksV2` | One per URL, generated by Rhombus. Returned as `webhookSecrets` (URL → secret) by `createRule` / `updateRule`. A secret sent in the request is ignored. | +| Signature header | `x-rhombus-signature-sha1` | `x-rhombus-signature-sha256` (only when the action has a secret; actions without one are sent unsigned) | +| Algorithm | HMAC-SHA1 | HMAC-SHA256 | +| Counts as delivered | Any `2xx` | `200` or `202` only | -Every Rhombus webhook request has: +## Envelope (both kinds) - HTTP method: `POST` -- Headers: `Content-Type: application/json`, `X-Rhombus-Signature: `, `X-Rhombus-Delivery-Id: ` -- Body: a JSON object with at minimum `type`, `uuid` (event uuid), `timestamp` (ms epoch), and event-specific fields. - -## Camera motion event - -```json -{ - "type": "cameraMotion", - "uuid": "AAAAAAAAAAAAAAAAAAAAAA", - "timestamp": 1712345678000, - "cameraUuid": "BBBBBBBBBBBBBBBBBBBBBB", - "locationUuid": "CCCCCCCCCCCCCCCCCCCCCC", - "motionZones": ["front-door"], - "durationMs": 4200, - "confidence": 0.92, - "mediaUri": "https://media.rhombussystems.com/..." -} -``` - -## Alert event +- Headers: `Content-Type: application/json`, plus the signature header above. There is no delivery-ID header. +- Body: compact UTF-8 JSON. +- Signature: lowercase hex HMAC of the **raw request body bytes**, keyed with the webhook secret string used as-is (its UTF-8 bytes; the secret is a 22-character base64url string, so don't decode it). Only the body is signed; there is no signed timestamp. +- Don't count on redelivery. A failed delivery (non-success status, connection error, or timeout) is recorded as a webhook-failure diagnostic in the organization, not retried. Still de-duplicate by `alertUuid` (organization webhooks) or `uuid` (rule actions). + +## Organization webhook body + +Fields, in the order Rhombus writes them. Fields that don't apply to an event are omitted. + +| Field | Type | Meaning | +|---|---|---| +| `version` | string | Always `"2"` | +| `activityTrigger` | string | Comma-separated activity names that fired an Activity webhook, e.g. `"MOTION_HUMAN"` | +| `diagnosticTrigger` | string | Diagnostic activity that fired a Diagnostic webhook, e.g. `"CAMERA_DISCONNECTED"` | +| `summary` | string | One-line human-readable description (English) | +| `deviceUuid` | string | Device that produced the event | +| `location` | string | **UUID** of the device's location (not a name) | +| `deviceType` | string | Device type name, e.g. `"CAMERA"` | +| `timestampMs` | number | Event time, Unix epoch milliseconds | +| `alertUuid` | string | Alert (policy alert) UUID, when the event created one | +| `diagnosticUuid` | string | Diagnostic event UUID, for diagnostic events | +| `durationSec` | number | Event duration in seconds | +| `thumbnailLocation` | string | Storage region of the alert thumbnail, e.g. `"us-west-2"` | +| `clipLocationMap` | object | Device ID → storage region of each device's clip | + +Activity example: ```json { - "type": "alert", - "uuid": "AAAAAAAAAAAAAAAAAAAAAA", + "version": "2", + "activityTrigger": "MOTION_HUMAN", + "summary": "Human motion detected on Front Door", + "deviceUuid": "BBBBBBBBBBBBBBBBBBBBBB", + "location": "CCCCCCCCCCCCCCCCCCCCCC", + "deviceType": "CAMERA", + "timestampMs": 1712345678000, "alertUuid": "DDDDDDDDDDDDDDDDDDDDDD", - "timestamp": 1712345678000, - "cameraUuid": "BBBBBBBBBBBBBBBBBBBBBB", - "ruleUuid": "EEEEEEEEEEEEEEEEEEEEEE", - "severity": "high", - "title": "Parking lot — after hours motion", - "mediaUris": { - "still": "https://media.rhombussystems.com/.../still.jpg", - "clip": "https://media.rhombussystems.com/.../clip.mp4" - } + "durationSec": 12, + "thumbnailLocation": "us-west-2", + "clipLocationMap": { "BBBBBBBBBBBBBBBBBBBBBB": "us-west-2" } } ``` -## Door event +Diagnostic example: ```json { - "type": "doorAccess", - "uuid": "AAAAAAAAAAAAAAAAAAAAAA", - "timestamp": 1712345678000, - "doorUuid": "FFFFFFFFFFFFFFFFFFFFFF", - "doorControllerUuid": "GGGGGGGGGGGGGGGGGGGGGG", - "action": "unlocked", - "credentialUuid": "HHHHHHHHHHHHHHHHHHHHHH", - "userUuid": "IIIIIIIIIIIIIIIIIIIIII", - "granted": true + "version": "2", + "diagnosticTrigger": "CAMERA_DISCONNECTED", + "summary": "Front Door went offline", + "deviceUuid": "BBBBBBBBBBBBBBBBBBBBBB", + "location": "CCCCCCCCCCCCCCCCCCCCCC", + "deviceType": "CAMERA", + "timestampMs": 1712345678000, + "diagnosticUuid": "EEEEEEEEEEEEEEEEEEEEEE" } ``` -Note: `cameraUuid` is **not** on door events. Identifier is `doorUuid`. +The `summary` strings above are illustrative. Activity names come from `ActivityEnum` and diagnostic names from `DiagnosticActivityEnum` in the OpenAPI spec (`../../rhombus-api/references/rhombus-api.json`). To fetch the alert's details, clip or thumbnail, call the API with `alertUuid` (for example `POST /api/event/getPolicyAlertDetails`). -## LPR / vehicle event +## Rule webhook action body + +The body describes the rule run. Keys are written in alphabetical order; which event lists are present depends on the rule's triggers. ```json { - "type": "vehicleDetection", - "uuid": "AAAAAAAAAAAAAAAAAAAAAA", - "timestamp": 1712345678000, - "cameraUuid": "BBBBBBBBBBBBBBBBBBBBBB", - "plateText": "ABC1234", - "plateConfidence": 0.98, - "matchedKnownPlate": true, - "knownPlateUuid": "JJJJJJJJJJJJJJJJJJJJJJ", - "vehicleImage": "https://media.rhombussystems.com/..." + "deviceEvents": [ + { + "activities": ["MOTION_HUMAN"], + "deviceType": "CAMERA", + "deviceUuid": "BBBBBBBBBBBBBBBBBBBBBB", + "eventUuid": "FFFFFFFFFFFFFFFFFFFFFF", + "locationUuid": "CCCCCCCCCCCCCCCCCCCCCC", + "timestampMs": 1712345678000 + } + ], + "orgUuid": "GGGGGGGGGGGGGGGGGGGGGG", + "ruleTriggers": [ { "type": "DEVICE_ACTIVITY_EVENT" } ], + "ruleUuid": "HHHHHHHHHHHHHHHHHHHHHH", + "triggeredTimestampMs": 1712345678000, + "uuid": "AAAAAAAAAAAAAAAAAAAAAA" } ``` -## Access credential event +- `uuid` identifies this rule run; use it for de-duplication. +- `deviceEvents` entries can carry more fields depending on the device (for example `durationSec`, sensor readings, or identified faces and vehicles). +- Other triggers populate other lists instead of, or as well as, `deviceEvents` (for example scheduled, lockdown or incoming-webhook events). +- Not every event comes from a camera: check `deviceType` before assuming what `deviceUuid` refers to. -```json -{ - "type": "credentialIssued", - "uuid": "AAAAAAAAAAAAAAAAAAAAAA", - "timestamp": 1712345678000, - "credentialUuid": "HHHHHHHHHHHHHHHHHHHHHH", - "userUuid": "IIIIIIIIIIIIIIIIIIIIII", - "credentialType": "standardCsn", - "issuedBy": "KKKKKKKKKKKKKKKKKKKKKK" -} -``` +## Signature verification -## IoT sensor threshold event +Read the raw body, pick the header that's present, compute the HMAC with that URL's secret, and compare in constant time. Respond `401` on a missing or bad signature; otherwise return `200` quickly and process asynchronously. -```json -{ - "type": "sensorThreshold", - "uuid": "AAAAAAAAAAAAAAAAAAAAAA", - "timestamp": 1712345678000, - "sensorUuid": "LLLLLLLLLLLLLLLLLLLLLL", - "sensorType": "climate", - "metric": "temperature", - "value": 32.4, - "thresholdType": "above", - "thresholdValue": 30.0, - "units": "celsius" -} -``` +Test vector: secret `AAAAAAAAAAAAAAAAAAAAAA`, body `{"version":"2","summary":"Test webhook"}` → HMAC-SHA1 `7c67f32d7b1320f76fa6d171a1a54dd6808570b6`, HMAC-SHA256 `5d3808f7c72ed8b6e52c12cf3ae13e72667d316178c6110081d58282828b2482`. -## Signature verification snippet (Node) +### Node (TypeScript) ```typescript import crypto from 'crypto'; -export function verifySignature(rawBody: Buffer, signature: string, secret: string): boolean { - const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex'); - return crypto.timingSafeEqual(Buffer.from(expected, 'hex'), Buffer.from(signature, 'hex')); +const SIGNATURE_HEADERS: Array<[string, 'sha256' | 'sha1']> = [ + ['x-rhombus-signature-sha256', 'sha256'], // rule webhook actions + ['x-rhombus-signature-sha1', 'sha1'], // organization webhooks +]; + +export function verifyRhombusSignature( + rawBody: Buffer, + headers: Record, + secret: string, +): boolean { + for (const [name, algorithm] of SIGNATURE_HEADERS) { + const value = headers[name]; + const received = Array.isArray(value) ? value[0] : value; + if (received) { + const expected = crypto.createHmac(algorithm, secret).update(rawBody).digest('hex'); + const a = Buffer.from(expected, 'utf8'); + const b = Buffer.from(received.trim().toLowerCase(), 'utf8'); + return a.length === b.length && crypto.timingSafeEqual(a, b); + } + } + return false; // unsigned request } ``` -## Signature verification snippet (Python) +Node lowercases incoming header names, so look them up in lowercase. Use `express.raw({ type: 'application/json' })` on the route so `req.body` is the raw `Buffer`. -```python -import hmac, hashlib +### Python -def verify_signature(raw_body: bytes, signature: str, secret: str) -> bool: - expected = hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest() - return hmac.compare_digest(expected, signature) +```python +import hashlib +import hmac + +SIGNATURE_HEADERS = ( + ("x-rhombus-signature-sha256", hashlib.sha256), # rule webhook actions + ("x-rhombus-signature-sha1", hashlib.sha1), # organization webhooks +) + + +def verify_rhombus_signature(raw_body: bytes, headers, secret: str) -> bool: + """headers: a case-insensitive mapping (Flask/Starlette request.headers).""" + for name, digestmod in SIGNATURE_HEADERS: + received = headers.get(name) + if received: + expected = hmac.new(secret.encode("utf-8"), raw_body, digestmod).hexdigest() + return hmac.compare_digest(expected, received.strip().lower()) + return False # unsigned request ``` diff --git a/plugins/partner/.claude-plugin/plugin.json b/plugins/partner/.claude-plugin/plugin.json index 815f96a..de3b6f0 100644 --- a/plugins/partner/.claude-plugin/plugin.json +++ b/plugins/partner/.claude-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "rhombus-partner", "description": "MSP and reseller tooling for managing multiple Rhombus client organizations. Provides a client-selector agent, fleet-ops agent, and client-onboarding agent; a partner CLI skill, cross-client reporting skill, and onboarding skill; six /rhombus-* multi-org commands (clients, client-switch, audit-clients, client-alerts, client-devices, fleet-report); active-client session state via .claude/rhombus-partner.local.md; partner-aware command validation and session-init hooks; and the shared CLI auto-installer.", - "version": "2.0.0", + "version": "2.0.1", "author": { "name": "Rhombus" }, "hooks": { "SessionStart": [ diff --git a/plugins/partner/skills/rhombus-partner-cli/references/commands.md b/plugins/partner/skills/rhombus-partner-cli/references/commands.md index 3927bbb..c7b7c17 100644 --- a/plugins/partner/skills/rhombus-partner-cli/references/commands.md +++ b/plugins/partner/skills/rhombus-partner-cli/references/commands.md @@ -11,7 +11,7 @@ Browser-based OAuth2 PKCE authentication flow. 1. Opens browser to `https://console.rhombussystems.com/login` 2. Local callback server on `localhost:11434/callback` 3. Exchanges authorization code for OAuth token -4. Creates permanent API key via `/api/integrations/org/submitApiTokenApplication` +4. Creates a permanent API key for this machine through the OAuth session 5. Attempts cert-based auth first (ECDSA P-256), falls back to token-based 6. Detects partner accounts and saves `is_partner` flag 7. Saves credentials to active profile in `~/.rhombus/credentials` @@ -124,7 +124,6 @@ Interactive AI chat with Rhombus MIND (backed by Claude). - Sends tool definitions so MIND can execute CLI commands locally - Handles tool-use loops: submit query → poll for response → execute tool calls → return results - Color-coded terminal output: blue (user), green (MIND) -- APIs used: `/api/chatbot/submitChat`, `/api/chatbot/getChatRecord` ### rhombus voice diff --git a/plugins/user/.claude-plugin/plugin.json b/plugins/user/.claude-plugin/plugin.json index b85b9ee..c9d4317 100644 --- a/plugins/user/.claude-plugin/plugin.json +++ b/plugins/user/.claude-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "rhombus-user", "description": "Day-to-day Rhombus platform tools. CLI reference (skill split into CLI, deployment-context, and MIND AI), curated support-article link directory, plus agents for CLI assistance, alert monitoring, device management, and footage investigation. Five /rhombus-* workflow commands (alerts, status, watch, analyze, context-refresh). CLI auto-install on session start and command validation on every bash call.", - "version": "2.0.0", + "version": "2.0.1", "author": { "name": "Rhombus" }, "hooks": { "SessionStart": [ diff --git a/plugins/user/skills/rhombus-cli/SKILL.md b/plugins/user/skills/rhombus-cli/SKILL.md index 85d76ec..c54c946 100644 --- a/plugins/user/skills/rhombus-cli/SKILL.md +++ b/plugins/user/skills/rhombus-cli/SKILL.md @@ -180,7 +180,7 @@ See `references/workflows.md` for common recipes. ## API base URL -Default: `https://api2.rhombussystems.com`. Override per-command with `--endpoint-url` or globally via `rhombus configure`. +Default: `https://api2.rhombussystems.com` (US). EU organizations use `https://api2.eu.rhombussystems.com`: answer `eu` at the `Region (us/eu)` prompt in `rhombus configure`, or override per-command with `--endpoint-url` or per shell with `RHOMBUS_ENDPOINT_URL`. API keys only work in their own region. ## Relationship to the `rhombus-developer` plugin diff --git a/plugins/user/skills/rhombus-cli/references/commands.md b/plugins/user/skills/rhombus-cli/references/commands.md index e65f9f6..1442f4c 100644 --- a/plugins/user/skills/rhombus-cli/references/commands.md +++ b/plugins/user/skills/rhombus-cli/references/commands.md @@ -11,7 +11,7 @@ Browser-based OAuth2 PKCE authentication flow. 1. Opens browser to `https://console.rhombussystems.com/login` 2. Local callback server on `localhost:11434/callback` 3. Exchanges authorization code for OAuth token -4. Creates permanent API key via `/api/integrations/org/submitApiTokenApplication` +4. Creates a permanent API key for this machine through the OAuth session 5. Attempts cert-based auth first (ECDSA P-256), falls back to token-based 6. Detects partner accounts and saves `is_partner` flag 7. Saves credentials to active profile in `~/.rhombus/credentials` @@ -124,7 +124,6 @@ Interactive AI chat with Rhombus MIND (backed by Claude). - Sends tool definitions so MIND can execute CLI commands locally - Handles tool-use loops: submit query → poll for response → execute tool calls → return results - Color-coded terminal output: blue (user), green (MIND) -- APIs used: `/api/chatbot/submitChat`, `/api/chatbot/getChatRecord` ### rhombus voice diff --git a/plugins/user/skills/rhombus-support-links/SKILL.md b/plugins/user/skills/rhombus-support-links/SKILL.md index b58a826..f204b1b 100644 --- a/plugins/user/skills/rhombus-support-links/SKILL.md +++ b/plugins/user/skills/rhombus-support-links/SKILL.md @@ -31,7 +31,8 @@ See `references/support-articles.md` for the full, categorized link sheet. The m | Alert rule configuration | https://support.rhombussystems.com/hc/en-us — "alert rules" | | User + role management | https://support.rhombussystems.com/hc/en-us — "users" / "roles" | | License management | https://support.rhombussystems.com/hc/en-us — "license" | -| Community forum | https://rhombus.community | +| Developer docs (API, webhooks, SDKs) | https://developer.rhombus.com | +| Contact Rhombus Support | support@rhombus.com | ## How to respond diff --git a/plugins/user/skills/rhombus-support-links/references/community-channels.md b/plugins/user/skills/rhombus-support-links/references/community-channels.md index d63fde9..a607a96 100644 --- a/plugins/user/skills/rhombus-support-links/references/community-channels.md +++ b/plugins/user/skills/rhombus-support-links/references/community-channels.md @@ -1,18 +1,17 @@ -# Rhombus Community Channels +# Rhombus Support and Developer Channels -## Developer community forum +## Developer documentation -- URL: https://rhombus.community -- What's there: discussion threads, integration ideas, Q&A between Rhombus engineers and partners/developers, announcements. -- No public API / RSS feed is documented — read it in a browser. +- URL: https://developer.rhombus.com +- What's there: API reference, implementation guides (streaming, webhooks, access control, LAN streaming), rate limits, regions, the CLI, and the MCP server. ## Direct support - General questions: the help center contact form at https://support.rhombussystems.com/hc/en-us -- Developer / API questions: `api@rhombus.com` +- Developer / API questions: `support@rhombus.com` ## GitHub (public repos) - Org: https://github.com/orgs/RhombusSystems/ - Notable public repos: `rhombus-cli`, `rhombus-node-mcp`, `player-example`, `rhombus-api-examples-python`, `rhombus-api-examples-javascript`, `low-code-no-code`, `edgecaster-stream-converter`, `rhombus-libonvif`. -- File issues on a specific repo if the question is repo-scoped; otherwise use the forum or email. +- File issues on a specific repo if the question is repo-scoped; otherwise email `support@rhombus.com`. diff --git a/plugins/user/skills/rhombus-support-links/references/support-articles.md b/plugins/user/skills/rhombus-support-links/references/support-articles.md index ccd72cd..fd84819 100644 --- a/plugins/user/skills/rhombus-support-links/references/support-articles.md +++ b/plugins/user/skills/rhombus-support-links/references/support-articles.md @@ -64,10 +64,10 @@ Maintenance note: This list needs a quarterly refresh (support.rhombussystems.co ## Developer -- **API key generation** — search "API key". Developers should prefer the Rhombus Console API Key Settings page directly. -- **Federated session tokens** — search "federated session token". +- **API key generation** — in the Rhombus Console, **Settings → Integrations & Developer Resources → API Tokens → Add API Key** (partner organizations: **Settings → API Management**). Developer docs: https://developer.rhombus.com +- **Federated tokens** (for browsers, video players and LAN streaming) — https://developer.rhombus.com/implementations/lan-streaming -## Community +## Developer resources and support -- **Developer community forum:** https://rhombus.community (also see `community-channels.md`) -- **Support contact:** `api@rhombus.com` for dev questions, or file a ticket via the help center. +- **Developer docs:** https://developer.rhombus.com (also see `community-channels.md`) +- **Support contact:** `support@rhombus.com`, or file a ticket via the help center.