[ { "_id": "61a8190ccafa44214e6cd77c", "identity": [], "scope": "auth", "version": "1", "args": { "properties": { "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "loginPassToken": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "loginPassToken", "userId" ], "type": "object" }, "data": { "type": "object", "properties": { "authToken": { "type": "string" } } }, "description": "Get an \"authToken\" for a specific User", "procedure": "authenticate-as-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "undefined", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd77c", "identity": [], "scope": "auth", "version": "2", "args": { "properties": { "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "loginPassToken": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "loginPassToken", "userId" ], "type": "object" }, "data": { "type": "object", "properties": { "authToken": { "type": "string" } } }, "description": "Get an \"authToken\" for a specific User", "procedure": "authenticate-as-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "undefined", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd77c", "identity": [], "scope": "auth", "version": "3", "args": { "properties": { "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "loginPassToken": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "loginPassToken", "userId" ], "type": "object" }, "data": { "type": "object", "properties": { "authToken": { "type": "string" } } }, "description": "Get an \"authToken\" for a specific User", "procedure": "authenticate-as-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd77d", "identity": [], "scope": "auth", "version": "1", "args": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "required": [ "email", "password" ] }, "data": { "type": "object", "properties": { "loginPassToken": { "type": "string" }, "users": { "default": [], "items": { "properties": { "organization": { "id": { "type": "string" }, "name": { "type": "string" } }, "user": { "properties": { "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "id": { "type": "string" }, "status": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": [ "null", "object" ] }, "title": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" } } }, "description": "Authenticate with email/password to get a loginToken and list of Users found", "procedure": "authenticate", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd77e", "identity": [ "Identity/UserModel Auth is required" ], "scope": "auth", "version": "1", "description": "De-authenticate a Users Identity authToken", "procedure": "de-authenticate", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd77f", "identity": [], "scope": "auth", "version": "1", "data": { "type": "object", "properties": { "organization": { "id": { "type": "string" }, "name": { "type": "string" } }, "regions": { "items": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "array" }, "user": { "properties": { "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "status": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "label": { "type": "string" }, "setAtDate": { "type": "string" }, "title": { "type": "string" } }, "type": [ "null", "object" ] }, "title": { "type": "string" } }, "type": "object" }, "users": { "description": "A list of all associated Users (any User that has the same email address)", "type": "array", "items": { "organization": { "id": { "type": "string" }, "name": { "type": "string" } }, "user": { "properties": { "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "status": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "label": { "type": "string" }, "setAtDate": { "type": "string" }, "title": { "type": "string" } }, "type": [ "null", "object" ] }, "title": { "type": "string" } }, "type": "object" } } } } }, "description": "Get the Organization, User and associated Users with the request's Identity.authorization (authToken)", "procedure": "get-identity-info", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd780", "identity": [], "scope": "auth", "version": "1", "args": { "type": "object", "properties": { "device": { "description": "Device with details", "properties": { "battery": { "type": "number" }, "name": { "description": "Example: \"Cory's iPhone\", \"Tom's Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "permissions": { "default": { "backgroundSync": false, "bluetooth": false, "camera": false, "geolocation": false, "backgroundGeolocation": false, "microphone": false, "nfc": false, "notifications": false }, "properties": { "backgroundSync": { "type": "boolean" }, "bluetooth": { "type": "boolean" }, "camera": { "type": "boolean" }, "geolocation": { "type": "boolean" }, "backgroundGeolocation": { "type": "boolean" }, "microphone": { "type": "boolean" }, "nfc": { "type": "boolean" }, "notifications": { "type": "boolean" } }, "type": "object" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "fcmToken": { "description": "Optional - The Firebase Cloud Messaging token for the device.", "type": "string" } }, "required": [ "device" ] }, "description": "Save the device information for an authenticated User.", "procedure": "save-device-info", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd781", "identity": [ "Identity/UserModel Auth is required" ], "scope": "auth", "version": "1", "description": "For dev/testing purposes, returns a 401 code", "procedure": "simulate-401", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd782", "identity": [], "scope": "dispatch", "version": "1", "args": { "type": "object", "properties": { "idFilter": { "items": { "type": "string" }, "type": "array" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "statusCodeFilter": { "description": "Optionally provide a filter for the Dispatch status code", "items": { "enum": [ -1, 0, 1 ], "type": "number" }, "type": "array" }, "searchText": { "description": "Optionally provided text to filter returned results", "type": "string" } } }, "data": { "properties": { "total": { "type": "number" }, "dispatches": { "type": "object", "properties": { "id": { "type": "string" }, "assignees": { "items": { "description": "A User who assigned to a Dispatch", "properties": { "displayName": { "type": "string" }, "id": { "type": "string" }, "status": { "description": "The User status - if \"null\" then the User has no status", "properties": { "color": { "type": "string" } }, "type": [ "null", "object" ] } }, "type": "object" }, "type": "array" }, "date": { "description": "The date/time of the Dispatch", "type": "string" }, "description": { "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "lastUpdated": { "description": "The timestamp when the Report was last updated", "type": "string" }, "title": { "type": "string" }, "dispatchType": { "properties": { "icon": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "status": { "description": "The status of the Dispatch, ie: \"acknowledged\", \"in-route\", \"waiting for backup\", etc.", "properties": { "code": { "description": "A numeric code for representing 1 of 3 states: -1=pending, 0=active, 1=closed", "type": "number" }, "color": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } } } } }, "description": "Get Dispatches and the info needed to display in a list", "procedure": "get-dispatches-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd783", "identity": [], "scope": "files", "version": "1", "args": { "type": "object", "properties": { "contentType": { "type": "string" }, "fileName": { "type": "string" }, "metadata": { "additionalProperties": true, "description": "Any key/value properties to describe the file upload", "type": "object" } }, "required": [ "contentType", "fileName" ] }, "data": { "properties": { "accessUrl": { "type": "string" }, "uploadMethod": { "enum": [ "POST", "PUT" ], "type": "string" }, "uploadUrl": { "type": "string" } }, "type": "object" }, "description": "Get a file upload url and access url", "procedure": "get-file-upload-url", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd784", "identity": [], "scope": "locations", "version": "1", "args": { "properties": { "locationId": { "type": "string" } }, "required": [ "locationId" ], "type": "object" }, "description": "Activate a Location", "procedure": "activate-location", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd785", "identity": [], "scope": "locations", "version": "1", "args": { "properties": { "location": { "properties": { "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "regionId": { "type": "string" } }, "required": [ "name", "regionId" ] } }, "required": [ "location" ], "type": "object" }, "data": { "locationId": { "type": "string" } }, "description": "Create a Location", "procedure": "create-location", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd786", "identity": [], "scope": "locations", "version": "1", "args": { "properties": { "locationId": { "type": "string" } }, "required": [ "locationId" ], "type": "object" }, "description": "Deactivate a Location", "procedure": "deactivate-location", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd787", "identity": [], "scope": "locations", "version": "1", "args": { "properties": { "locationId": { "type": "string" } }, "required": [ "locationId" ], "type": "object" }, "data": { "properties": { "location": { "type": "object", "properties": { "active": { "type": "boolean" }, "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "organizationId": { "type": "string" }, "patrolRoutes": { "items": { "properties": { "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "primaryImageUrl": { "type": "string" }, "regionId": { "type": "string" } } } }, "type": "object" }, "description": "Get Organization profile info for a Location", "procedure": "get-location-profile", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd788", "identity": [], "scope": "locations", "version": "1", "args": { "type": "object", "properties": { "active": { "type": "boolean" }, "idFilter": { "items": { "type": "string" }, "type": "array" }, "pagination": { "description": "Optional - default limits apply if no props provided", "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "searchText": { "description": "Optionally provided text to search in Records", "type": "string" } } }, "data": { "properties": { "total": { "type": "number" }, "locations": { "default": [], "items": { "description": "A list of Locations", "type": "object", "properties": { "active": { "type": "boolean" }, "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "patrolRoutes": { "items": { "properties": { "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "primaryImageUrl": { "type": "string" }, "regionId": { "type": "string" } } }, "type": "array" } }, "type": "object" }, "description": "Get all Locations info to display in a list", "procedure": "get-locations-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd789", "identity": [], "scope": "locations", "version": "1", "args": { "properties": { "location": { "properties": { "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "primaryImageUrl": { "type": "string" } }, "required": [ "id", "name" ] } }, "required": [ "location" ], "type": "object" }, "data": { "locationId": { "type": "string" } }, "description": "Update a Location", "procedure": "update-location", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78a", "identity": [], "scope": "notifications", "version": "1", "args": { "properties": { "androidClickAction": { "type": "string" }, "apnsCategory": { "type": "string" }, "notificationBody": { "type": "string" }, "notificationData": { "additionalProperties": true, "description": "If only notificationData is passed, the notification will be a \"data-only\" notification. This object can be any shape as long as it's expected from the client in the push-notification.", "type": "object" }, "notificationTitle": { "type": "string" }, "token": { "type": "string" }, "type": { "enum": [ "fcm" ], "type": "string" }, "webLink": { "type": "string" } }, "required": [ "token", "type" ], "type": "object" }, "description": "Send a push-notification to a specific registration token/device", "procedure": "send-push-notification", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78b", "identity": [], "scope": "organizations", "version": "1", "args": { "type": "object", "properties": { "organizationId": { "type": "string" } }, "required": [ "organizationId" ] }, "data": { "properties": { "organization": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "type": "object" }, "description": "Get an Organization", "procedure": "get-organization-profile", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78c", "identity": [], "scope": "organizations", "version": "1", "args": { "type": "object", "properties": { "active": { "type": "boolean" }, "organizationIds": { "items": { "type": "string" }, "type": "array" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "searchText": { "type": "string" } } }, "data": { "properties": { "organizations": { "items": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "total": { "type": "boolean" } }, "type": "object" }, "description": "Get a list of Organizations", "procedure": "get-organizations-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78d", "identity": [], "scope": "organizations", "version": "1", "args": { "type": "object", "properties": { "organization": { "properties": { "id": { "type": "string" }, "logoUrl": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "required": [ "organization" ] }, "description": "Update an Organization", "procedure": "update-organization", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "undefined", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78d", "identity": [], "scope": "organizations", "version": "2", "args": { "type": "object", "properties": { "organization": { "properties": { "id": { "type": "string" }, "logoUrl": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "required": [ "organization" ] }, "description": "Update an Organization", "procedure": "update-organization", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78e", "identity": [], "scope": "public", "version": "1", "args": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "city": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "name", "timezone" ] }, "user": { "type": "object", "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "title": { "type": "string" } }, "required": [ "displayName", "email" ] } }, "required": [ "organization", "user" ] }, "description": "Register a new Organization and create the \"admin\" User", "procedure": "register-organization", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd78f", "identity": [], "scope": "records", "version": "1", "args": { "properties": { "record": { "properties": { "fields": { "properties": { "additional": { "type": "string" }, "color": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "brand": { "type": "string" }, "style": { "type": "string" }, "size": { "type": "string" }, "status": { "type": "string" }, "gender": { "type": "string" }, "race": { "type": "string" }, "height": { "type": "string" }, "weight": { "type": "number" }, "eyes": { "type": "string" }, "hair": { "type": "string" }, "age": { "type": "number" }, "approxAge": { "type": "boolean" }, "alias": { "type": "string" }, "dob": { "type": "string" }, "idNumber": { "type": "string" }, "idAuthority": { "type": "string" }, "ss": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "criminalId": { "type": "string" }, "criminalAuthority": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "plate": { "type": "string" }, "type": { "type": "string" }, "vin": { "type": "string" } }, "type": "object" }, "fileUrls": { "items": { "type": "string" }, "type": "array" }, "organizationId": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "regionId": { "type": "string" }, "tags": { "description": "A list of Tags", "items": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" }, "type": "array" }, "type": { "enum": [ "item", "person", "vehicle" ], "type": "string" } }, "required": [ "fields", "type" ], "type": "object" } }, "required": [ "record" ], "type": "object" }, "data": { "properties": { "recordId": { "type": "string" } }, "type": "object" }, "description": "Create a Record", "procedure": "create-record", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd790", "identity": [], "scope": "records", "version": "1", "args": { "properties": { "recordId": { "type": "string" } }, "required": [ "recordId" ], "type": "object" }, "data": { "properties": { "recordId": { "type": "string" } }, "type": "object" }, "description": "Delete a Record", "procedure": "delete-record", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd791", "identity": [], "scope": "records", "version": "1", "args": { "type": "object", "properties": { "recordId": { "type": "string" } }, "required": [ "recordId" ] }, "data": { "properties": { "record": { "type": "object", "properties": { "id": { "type": "string" }, "fields": { "description": "Props are unique per \"type\", ie: Vehicle type has \"plate\", \"vin\", etc. & Person type has \"name\", \"age\", etc.", "type": "object" }, "imageUrl": { "description": "deprecated - use \"primaryImageUrl\" instead", "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "lastActivity": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "tags": { "description": "A list of Tags", "items": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" }, "type": "array" }, "title": { "type": "string" }, "type": { "enum": [ "person", "item", "vehicle" ], "type": "string" } } } }, "type": "object" }, "description": "Get profile info for a Record", "procedure": "get-record-profile", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd792", "identity": [], "scope": "records", "version": "1", "args": { "type": "object", "properties": { "idFilter": { "items": { "type": "string" }, "type": "array" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "searchText": { "description": "Optionally provided text to search in Records", "type": "string" }, "typeFilter": { "description": "Optionally provide a filter for the Record \"type\" to be returned", "items": { "enum": [ "person", "item", "vehicle" ], "type": "string" }, "type": "array" } } }, "data": { "properties": { "total": { "type": "number" }, "records": { "default": [], "items": { "description": "A list of Records", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "deprecated - use \"primaryImageUrl\" instead", "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "lastActivity": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "tags": { "description": "A list of Tags", "items": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" }, "type": "array" }, "title": { "type": "string" }, "type": { "enum": [ "person", "item", "vehicle" ], "type": "string" } } }, "type": "array" } }, "type": "object" }, "description": "Get all Records info to display in a list", "procedure": "get-records-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd793", "identity": [], "scope": "records", "version": "1", "args": { "properties": { "record": { "properties": { "id": { "type": "string" }, "tags": { "description": "A list of Tags", "items": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" }, "type": "array" } }, "required": [ "id", "tags" ], "type": "object" } }, "required": [ "record" ], "type": "object" }, "data": { "properties": { "recordId": { "type": "string" } }, "type": "object" }, "description": "Set Tags on a Record", "procedure": "set-record-tags", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd794", "identity": [], "scope": "records", "version": "1", "args": { "properties": { "record": { "properties": { "id": { "type": "string" }, "fields": { "properties": { "additional": { "type": "string" }, "color": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "brand": { "type": "string" }, "style": { "type": "string" }, "size": { "type": "string" }, "status": { "type": "string" }, "gender": { "type": "string" }, "race": { "type": "string" }, "height": { "type": "string" }, "weight": { "type": "number" }, "eyes": { "type": "string" }, "hair": { "type": "string" }, "age": { "type": "number" }, "approxAge": { "type": "boolean" }, "alias": { "type": "string" }, "dob": { "type": "string" }, "idNumber": { "type": "string" }, "idAuthority": { "type": "string" }, "ss": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "criminalId": { "type": "string" }, "criminalAuthority": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "plate": { "type": "string" }, "type": { "type": "string" }, "vin": { "type": "string" } }, "type": "object" }, "fileUrls": { "items": { "type": "string" }, "type": "array" }, "primaryImageUrl": { "type": "string" }, "tags": { "description": "A list of Tags", "items": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" }, "type": "array" } }, "required": [ "id" ], "type": "object" } }, "required": [ "record" ], "type": "object" }, "data": { "properties": { "recordId": { "type": "string" } }, "type": "object" }, "description": "Update a Record", "procedure": "update-record", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd795", "identity": [], "scope": "regions", "version": "1", "args": { "properties": { "regionId": { "type": "string" } }, "required": [ "regionId" ], "type": "object" }, "description": "Activate a Region", "procedure": "activate-region", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd796", "identity": [], "scope": "regions", "version": "1", "args": { "properties": { "region": { "properties": { "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "name", "timezone" ] } }, "required": [ "region" ], "type": "object" }, "data": { "regionId": { "type": "string" } }, "description": "Create a Region", "procedure": "create-region", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd797", "identity": [], "scope": "regions", "version": "1", "args": { "properties": { "regionId": { "type": "string" } }, "required": [ "regionId" ], "type": "object" }, "description": "Deactivate a Region", "procedure": "deactivate-region", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd798", "identity": [], "scope": "regions", "version": "1", "args": { "type": "object", "properties": { "regionId": { "type": "string" } }, "required": [ "regionId" ] }, "data": { "properties": { "region": { "properties": { "active": { "type": "boolean" }, "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "type": "object" }, "description": "Get a Region", "procedure": "get-region-profile", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd799", "identity": [ "Identity/UserModel Auth is required" ], "scope": "regions", "version": "1", "args": { "type": "object", "properties": { "active": { "type": "boolean" }, "idFilter": { "items": { "type": "string" }, "type": "array" }, "organizationId": { "type": "string" }, "searchText": { "description": "Optionally provided text to filter returned results", "type": "string" }, "timezone": { "type": "string" } } }, "data": { "properties": { "regions": { "items": { "properties": { "active": { "type": "boolean" }, "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "type": "array" }, "total": { "type": "boolean" } }, "type": "object" }, "description": "Get a list of Regions.ts", "procedure": "get-regions-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd79a", "identity": [], "scope": "regions", "version": "1", "args": { "properties": { "region": { "properties": { "address": { "properties": { "country": { "type": "string" }, "locality": { "description": "The locality in which the street address is, and which is in the region. For example, Mountain View.", "type": "string" }, "region": { "description": "The region in which the locality is, and which is in the country. For example, California.", "type": "string" }, "postalCode": { "description": "The postal code. For example, 94043.", "type": "string" }, "streetAddress": { "description": "The street address. For example, 1600 Amphitheatre Pkwy.", "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "primaryImageUrl": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "id", "name", "timezone" ] } }, "required": [ "region" ], "type": "object" }, "data": { "regionId": { "type": "string" } }, "description": "Update a Region", "procedure": "update-region", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd79b", "identity": [], "scope": "reports", "version": "1", "args": { "type": "object", "properties": { "contributorsFilter": { "description": "Optionally provided User ID to filter Reports that the User contributed to", "items": { "type": "string" }, "type": "array" }, "idFilter": { "items": { "type": "string" }, "type": "array" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "statusCodeFilter": { "description": "Optionally provide a filter for the Report status code", "items": { "enum": [ -1, 0, 1 ], "type": "number" }, "type": "array" } } }, "data": { "properties": { "total": { "type": "number" }, "reports": { "type": "object", "properties": { "id": { "type": "string" }, "contributors": { "items": { "description": "A User who has contributed to the Report", "properties": { "displayName": { "type": "string" }, "id": { "type": "string" }, "status": { "description": "The User status - if \"null\" then the User has no status", "properties": { "color": { "type": "string" } }, "type": [ "null", "object" ] } }, "type": "object" }, "type": "array" }, "date": { "description": "The date of the Report", "type": "string" }, "description": { "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "lastUpdated": { "description": "The timestamp when the Report was last updated", "type": "string" }, "title": { "type": "string" }, "reportType": { "properties": { "icon": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "status": { "description": "The status of the Report, ie: \"in-progress\", \"needs attention\", etc.", "properties": { "code": { "description": "A numeric code for representing 1 of 3 states: -1=editable, 0=pending, 1=closed", "type": "number" }, "color": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } } } } }, "description": "Get Reports and the info needed to display in a list", "procedure": "get-reports-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd79c", "identity": [], "scope": "tags", "version": "1", "args": { "properties": { "tag": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "organizationId": { "type": "string" }, "regionId": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" } }, "required": [ "tag" ], "type": "object" }, "data": { "properties": { "tagId": { "type": "string" } }, "type": "object" }, "description": "Create a Tag", "procedure": "create-tag", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd79d", "identity": [], "scope": "tags", "version": "1", "args": { "properties": { "tagId": { "type": "string" } }, "required": [ "tagId" ], "type": "object" }, "data": { "properties": { "tagId": { "type": "string" } }, "type": "object" }, "description": "Delete a Tag", "procedure": "delete-tag", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd79e", "identity": [], "scope": "tags", "version": "1", "args": { "type": "object", "properties": { "categoryFilter": { "description": "Optionally provide a filter for the Tag \"category\" to be returned", "items": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "type": "array" }, "idFilter": { "items": { "type": "string" }, "type": "array" }, "organizationId": { "type": "string" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "regionId": { "type": "string" }, "searchText": { "description": "Optionally provided text to search in the Tags", "type": "string" } } }, "data": { "properties": { "total": { "type": "number" }, "tags": { "description": "A list of Tags", "items": { "properties": { "category": { "enum": [ "activity", "locations", "records", "users" ], "type": "string" }, "color": { "type": "string" }, "level": { "type": "number" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" }, "type": "array" } }, "type": "object" }, "description": "Get Tags list", "procedure": "get-tags-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd79f", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userId": { "type": "string" } }, "required": [ "userId" ], "type": "object" }, "description": "Activate a User", "procedure": "activate-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a0", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userStatusOption": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "organizationId": { "type": "string" }, "title": { "type": "string" } }, "required": [ "color", "title" ], "type": "object" } }, "required": [ "userStatusOption" ], "type": "object" }, "data": { "properties": { "userStatusOptionId": { "type": "string" } }, "type": "object" }, "description": "Create User status option", "procedure": "create-user-status-option", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a1", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "user": { "properties": { "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "idNumber": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" } }, "required": [ "displayName", "email" ], "type": "object" } }, "required": [ "user" ], "type": "object" }, "data": { "properties": { "userId": { "type": "string" } }, "type": "object" }, "description": "Create an User", "procedure": "create-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a2", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userId": { "type": "string" } }, "required": [ "userId" ], "type": "object" }, "description": "Deactivate a User", "procedure": "deactivate-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a3", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userStatusOptionIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "userStatusOptionIds" ], "type": "object" }, "description": "Delete User status option", "procedure": "delete-user-status-options", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a4", "identity": [], "scope": "users", "version": "1", "args": { "type": "object", "properties": { "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "userId": { "type": "string" } }, "required": [ "userId" ] }, "data": { "properties": { "user": { "properties": { "id": { "type": "string" } }, "type": "object" }, "userAuthSessions": { "items": { "properties": { "createdAt": { "type": "string" }, "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "expire": { "type": "string" }, "hasNotificationToken": { "type": "boolean" }, "id": { "type": "string" }, "publicId": { "type": "string" } }, "type": "object" }, "type": "array" }, "total": { "type": "number" } }, "type": "object" }, "description": "Get a list of auth sessions for a specific User", "procedure": "get-user-auth-sessions-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a5", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "fromDate": { "type": "string" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "toDate": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "fromDate", "toDate", "userDate" ], "type": "object" }, "data": { "properties": { "userGeoLocationHistory": { "items": { "properties": { "properties": { "accuracy": { "type": "number" }, "coords": { "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "type": "object" }, "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "timestamp": { "type": "string" } }, "required": [ "accuracy", "coords", "device", "timestamp" ], "type": "object", "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "total": { "type": "number" } }, "type": "object" }, "description": "Get a single User's geo location history (see RPC \"users::save-user-device-geo\")", "procedure": "get-user-geo-location-history", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a6", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userId": { "type": "string" } }, "required": [ "userId" ], "type": "object" }, "data": { "properties": { "user": { "type": "object", "properties": { "active": { "type": "boolean" }, "avatarUrl": { "type": "string" }, "connected": { "type": "boolean" }, "contactInfo": { "items": { "properties": { "value": { "type": "string" }, "type": { "enum": [ "email", "phone" ], "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "type": "string" }, "id": { "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "lastDisconnectDate": { "type": "string" }, "lastSeen": { "properties": { "accuracy": { "type": "number" }, "coords": { "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "type": "object" }, "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "timestamp": { "type": "string" } }, "required": [ "accuracy", "coords", "device", "timestamp" ], "type": "object" }, "status": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "label": { "type": "string" }, "setAtDate": { "type": "string" }, "title": { "type": "string" } }, "type": [ "null", "object" ] }, "title": { "type": "string" } } } }, "type": "object" }, "description": "Get an Organization User profile info", "procedure": "get-user-profile", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a7", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "userId": { "type": "string" } }, "required": [ "userId" ], "type": "object" }, "data": { "properties": { "user": { "properties": { "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "userStatusHistory": { "items": { "properties": { "setAtDate": { "type": "string" }, "status": { "oneOf": [ { "type": "null" }, { "properties": { "color": { "type": "string" }, "setAtDate": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } ] } }, "type": "object" }, "type": "array" } }, "type": "object" }, "description": "Get a User's status change history", "procedure": "get-user-status-history", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a8", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userStatusOptionId": { "type": "string" } }, "required": [ "userStatusOptionId" ], "type": "object" }, "data": { "properties": { "userStatusOption": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } }, "type": "object" }, "description": "Get a single User status option", "procedure": "get-user-status-option", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7a9", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "organizationId": { "type": "string" } }, "type": "object" }, "data": { "properties": { "userStatusOptions": { "items": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "total": { "type": "number" } }, "type": "object" }, "description": "Get all User status options for a specific Organization", "procedure": "get-user-status-options-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7aa", "identity": [], "scope": "users", "version": "1", "args": { "type": "object", "properties": { "active": { "type": "boolean" }, "hasStatus": { "type": "boolean" }, "idFilter": { "items": { "type": "string" }, "type": "array" }, "pagination": { "properties": { "skip": { "type": "number" }, "limit": { "type": "number" } }, "type": "object" }, "searchText": { "description": "Optionally provided text to filter returned results", "type": "string" } } }, "data": { "properties": { "total": { "type": "number" }, "users": { "default": [], "items": { "description": "A list of Users", "type": "object", "properties": { "active": { "type": "boolean" }, "avatarUrl": { "type": "string" }, "connected": { "type": "boolean" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "labels": { "description": "deprecated - use \"tags\" instead", "items": { "properties": { "color": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" }, "lastDisconnectDate": { "type": "string" }, "lastSeen": { "properties": { "accuracy": { "type": "number" }, "coords": { "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "type": "object" }, "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "timestamp": { "type": "string" } }, "required": [ "accuracy", "coords", "device", "timestamp" ], "type": "object" }, "status": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "label": { "type": "string" }, "setAtDate": { "type": "string" }, "title": { "type": "string" } }, "type": [ "null", "object" ] }, "title": { "type": "string" } } }, "type": "array" } }, "type": "object" }, "description": "Get all Users info to display in a list", "procedure": "get-users-list", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7ab", "identity": [], "scope": "users", "version": "1", "args": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] }, "description": "Kill all auth sessions for a specific User", "procedure": "kill-all-user-auth-sessions", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7ac", "identity": [], "scope": "users", "version": "1", "args": { "type": "object", "properties": { "authSessionPublicIds": { "items": { "type": "string" }, "type": "array" }, "userId": { "type": "string" } }, "required": [ "authSessionPublicIds", "userId" ] }, "description": "Kill 1 or more auth sessions for a specific User", "procedure": "kill-user-auth-sessions", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7ad", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "deviceGeo": { "properties": { "accuracy": { "type": "number" }, "coords": { "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "type": "object" }, "device": { "description": "Device information", "properties": { "name": { "description": "Example: \"Corys iPhone\", \"Toms Samsung Galaxy\"", "type": "string" }, "mac": { "type": "string" }, "os": { "description": "Example: \"Android 8.1\", \"iOS 14.2\", \"Windows 10\"", "type": "string" }, "type": { "enum": [ "browser", "mobile", "tablet", "other", "unknown" ], "type": "string" }, "uuid": { "description": "Can be the MAC address if available", "type": "string" } }, "required": [ "name", "type", "uuid" ], "type": "object" }, "timestamp": { "type": "string" } }, "required": [ "accuracy", "coords", "device", "timestamp" ], "type": "object" }, "userId": { "type": "string" } }, "required": [ "deviceGeo" ], "type": "object" }, "description": "Save a User's Device GEO information", "procedure": "save-user-device-geo", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7ae", "identity": [], "scope": "users", "version": "1", "args": { "description": "If \"status\" is undefined or null the User status will be cleared", "properties": { "status": { "oneOf": [ { "type": "null" }, { "properties": { "endDate": { "type": "string" }, "color": { "type": "string" }, "expireDate": { "type": "string" }, "geoTracking": { "type": "boolean" }, "priority": { "type": "number" }, "title": { "type": "string" } }, "required": [ "color", "title" ], "type": "object" } ] }, "userId": { "type": "string" } }, "required": [ "userId" ], "type": "object" }, "description": "Set a User's status", "procedure": "set-user-status", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7af", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "userStatusOption": { "properties": { "color": { "type": "string" }, "geoTracking": { "type": "boolean" }, "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "userStatusOption" ], "type": "object" }, "description": "Update User status option", "procedure": "update-user-status-option", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 }, { "_id": "61a8190ccafa44214e6cd7b0", "identity": [], "scope": "users", "version": "1", "args": { "properties": { "user": { "properties": { "avatarUrl": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "idNumber": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "user" ], "type": "object" }, "data": { "properties": { "userId": { "type": "string" } }, "type": "object" }, "description": "Update an User", "procedure": "update-user", "createdAt": "2021-12-02T00:53:31.582Z", "serverDisplayName": "therms-rpc-gateway", "__v": 0 } ]