{ "openapi": "3.0.0", "info": { "title": "Seam Connect", "version": "1.0.0" }, "servers": [ { "url": "https://connect.getseam.com" } ], "tags": [ { "name": "/access_codes", "description": "access_codes" }, { "name": "/acs", "description": "acs" }, { "name": "/action_attempts", "description": "action_attempts" }, { "name": "/client_sessions", "description": "client_sessions" }, { "name": "/connected_accounts", "description": "connected_accounts" }, { "name": "/connect_webviews", "description": "connect_webviews" }, { "name": "/devices", "description": "devices" }, { "name": "/events", "description": "events" }, { "name": "/health", "description": "health" }, { "name": "/locks", "description": "locks" }, { "name": "/networks", "description": "networks" }, { "name": "/noise_sensors", "description": "noise_sensors" }, { "name": "/phones", "description": "phones" }, { "name": "/thermostats", "description": "thermostats" }, { "name": "/user_identities", "description": "user_identities" }, { "name": "/webhooks", "description": "webhooks" }, { "name": "/workspaces", "description": "workspaces" } ], "paths": { "/access_methods/delete": { "delete": { "x-title": "Delete an Access Method", "x-response-key": null, "x-draft": "Early access.", "summary": "/access_methods/delete", "description": "Deletes an access method.", "operationId": "accessMethodsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Access Method", "x-response-key": null, "x-draft": "Early access.", "summary": "/access_methods/delete", "description": "Deletes an access method.", "operationId": "accessMethodsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid", "description": "ID of access method to delete." } }, "required": ["access_method_id"] }, { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of access grant whose access methods should be deleted." } }, "required": ["access_grant_id"] }, { "type": "object", "properties": { "reservation_key": { "type": "string", "description": "Reservation key of the access grant whose access methods should be deleted." } }, "required": ["reservation_key"] } ] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "delete" } }, "/access_methods/encode": { "post": { "x-title": "Encode an Access Method", "x-response-key": "action_attempt", "x-action-attempt-type": "ENCODE_CREDENTIAL", "summary": "/access_methods/encode", "description": "Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).", "operationId": "accessMethodsEncodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` to use to encode the `access_method`." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the `access_method` to encode onto a card." } }, "required": ["acs_encoder_id", "access_method_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "encode", "x-fern-sdk-return-value": "action_attempt" } }, "/access_methods/get": { "get": { "x-title": "Get an Access Method", "x-response-key": "access_method", "x-draft": "Early access.", "summary": "/access_methods/get", "description": "Gets an access method.", "operationId": "accessMethodsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method": { "$ref": "#/components/schemas/access_method" }, "ok": { "type": "boolean" } }, "required": ["access_method", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "access_method_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of access method to get." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_method" }, "post": { "x-title": "Get an Access Method", "x-response-key": "access_method", "x-draft": "Early access.", "summary": "/access_methods/get", "description": "Gets an access method.", "operationId": "accessMethodsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method": { "$ref": "#/components/schemas/access_method" }, "ok": { "type": "boolean" } }, "required": ["access_method", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid", "description": "ID of access method to get." } }, "required": ["access_method_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_method" } }, "/access_methods/get_related": { "get": { "x-title": "Get related Access Method resources", "x-response-key": "batch", "x-batch-keys": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "x-draft": "Early access.", "summary": "/access_methods/get_related", "description": "Gets all related resources for one or more Access Methods.", "operationId": "accessMethodsGetRelatedGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_method_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods that you want to get along with their related resources." }, "required": true }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ] } }, "required": false }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ] } }, "required": false } ], "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch" }, "post": { "x-title": "Get related Access Method resources", "x-response-key": "batch", "x-batch-keys": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "x-draft": "Early access.", "summary": "/access_methods/get_related", "description": "Gets all related resources for one or more Access Methods.", "operationId": "accessMethodsGetRelatedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods that you want to get along with their related resources." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ] } }, "exclude": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ] } } }, "required": ["access_method_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch" } }, "/access_methods/list": { "get": { "x-title": "List Access Methods", "x-response-key": "access_methods", "x-draft": "Early access.", "summary": "/access_methods/list", "description": "Lists all access methods, usually filtered by Access Grant.", "operationId": "accessMethodsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "ok": { "type": "boolean" } }, "required": ["access_methods", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_grant_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of Access Grant to list access methods for." } }, { "name": "access_grant_key", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "Key of Access Grant to list access methods for." } }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to retrieve all access methods." } }, { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the entrance for which you want to retrieve all access methods." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to retrieve all access methods." } }, { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access code for which you want to retrieve all access methods." } } ], "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_methods" }, "post": { "x-title": "List Access Methods", "x-response-key": "access_methods", "x-draft": "Early access.", "summary": "/access_methods/list", "description": "Lists all access methods, usually filtered by Access Grant.", "operationId": "accessMethodsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "ok": { "type": "boolean" } }, "required": ["access_methods", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of Access Grant to list access methods for." }, "access_grant_key": { "type": "string", "minLength": 1, "description": "Key of Access Grant to list access methods for." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to retrieve all access methods." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance for which you want to retrieve all access methods." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to retrieve all access methods." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code for which you want to retrieve all access methods." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_methods" } }, "/access_grants/create": { "post": { "x-title": "Create an Access Grant", "x-response-key": "access_grant", "x-draft": "Early access.", "summary": "/access_grants/create", "description": "Creates a new Access Grant.", "operationId": "accessGrantsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "ok": { "type": "boolean" } }, "required": ["access_grant", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity for whom access is being granted." } }, "required": ["user_identity_id"] }, { "type": "object", "properties": { "user_identity": { "type": "object", "properties": { "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "user_identity_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Unique key for the user identity." } }, "description": "When used, creates a new user identity with the given details, and grants them access." } }, "required": ["user_identity"] } ] }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name for the access grant." }, "access_grant_key": { "type": "string", "minLength": 1, "description": "Unique key for the access grant within the workspace." }, "reservation_key": { "type": "string", "description": "Reservation key for the access grant." }, "location_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `space_ids`." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Set of IDs of existing spaces to which access is being granted." }, "space_keys": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Set of keys of existing spaces to which access is being granted." }, "location": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the location." }, "acs_entrance_ids": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `acs_entrance_ids` at the top level." }, "device_ids": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `device_ids` at the top level." } }, "description": "When used, creates a new location with the given entrances and devices, and gives the user access to this location." }, "acs_entrance_ids": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted." }, "device_ids": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." } }, "required": ["mode"] } }, "starts_at": { "description": "Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "default": null, "type": "string", "nullable": true, "description": "Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "ID of the customization profile to apply to the Access Grant and its access methods." } }, "required": ["requested_access_methods"] } ] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "access_grant" } }, "/access_grants/delete": { "delete": { "x-title": "Delete an Access Grant", "x-response-key": null, "x-draft": "Early access.", "summary": "/access_grants/delete", "description": "Delete an Access Grant.", "operationId": "accessGrantsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_grant_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of Access Grant to delete." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Access Grant", "x-response-key": null, "x-draft": "Early access.", "summary": "/access_grants/delete", "description": "Delete an Access Grant.", "operationId": "accessGrantsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of Access Grant to delete." } }, "required": ["access_grant_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "delete" } }, "/access_grants/get": { "get": { "x-title": "Get an Access Grant", "x-response-key": "access_grant", "x-draft": "Early access.", "summary": "/access_grants/get", "description": "Get an Access Grant.", "operationId": "accessGrantsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "ok": { "type": "boolean" } }, "required": ["access_grant", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_grant" }, "post": { "x-title": "Get an Access Grant", "x-response-key": "access_grant", "x-draft": "Early access.", "summary": "/access_grants/get", "description": "Get an Access Grant.", "operationId": "accessGrantsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "ok": { "type": "boolean" } }, "required": ["access_grant", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of Access Grant to get." } }, "required": ["access_grant_id"] }, { "type": "object", "properties": { "access_grant_key": { "type": "string", "description": "Unique key of Access Grant to get." } }, "required": ["access_grant_key"] } ] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_grant" } }, "/access_grants/get_related": { "get": { "x-title": "Get related Access Grant resources", "x-response-key": "batch", "x-batch-keys": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "x-draft": "Early access.", "summary": "/access_grants/get_related", "description": "Gets all related resources for one or more Access Grants.", "operationId": "accessGrantsGetRelatedGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "access_grant_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants that you want to get along with their related resources." } }, { "name": "access_grant_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants that you want to get along with their related resources." } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ] } } }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ] } } } ], "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch" }, "post": { "x-title": "Get related Access Grant resources", "x-response-key": "batch", "x-batch-keys": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "x-draft": "Early access.", "summary": "/access_grants/get_related", "description": "Gets all related resources for one or more Access Grants.", "operationId": "accessGrantsGetRelatedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants that you want to get along with their related resources." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants that you want to get along with their related resources." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ] } }, "exclude": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ] } } } } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch" } }, "/access_grants/list": { "get": { "x-title": "List Access Grants", "x-response-key": "access_grants", "x-draft": "Early access.", "summary": "/access_grants/list", "description": "Gets an Access Grant.", "operationId": "accessGrantsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_grants", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_grant_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants to retrieve." } }, { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list access grants." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of access grants to return." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of user identity by which you want to filter the list of Access Grants." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system by which you want to filter the list of Access Grants." } }, { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the entrance by which you want to filter the list of Access Grants." } }, { "name": "location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space by which you want to filter the list of Access Grants." } }, { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access code by which you want to filter the list of Access Grants." } }, { "name": "access_grant_key", "in": "query", "schema": { "type": "string", "nullable": true, "description": "Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key." } }, { "name": "reservation_key", "in": "query", "schema": { "type": "string", "description": "Filter Access Grants by reservation_key." } } ], "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants" }, "post": { "x-title": "List Access Grants", "x-response-key": "access_grants", "x-draft": "Early access.", "summary": "/access_grants/list", "description": "Gets an Access Grant.", "operationId": "accessGrantsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_grants", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants to retrieve." }, "customer_key": { "type": "string", "description": "Customer key for which you want to list access grants." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of access grants to return." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity by which you want to filter the list of Access Grants." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system by which you want to filter the list of Access Grants." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance by which you want to filter the list of Access Grants." }, "location_id": { "type": "string", "format": "uuid", "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space by which you want to filter the list of Access Grants." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code by which you want to filter the list of Access Grants." }, "access_grant_key": { "type": "string", "nullable": true, "description": "Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key." }, "reservation_key": { "type": "string", "description": "Filter Access Grants by reservation_key." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants" } }, "/access_grants/request_access_methods": { "post": { "x-title": "Add Requested Access Methods to Access Grant", "x-response-key": "access_grant", "x-draft": "Early access.", "summary": "/access_grants/request_access_methods", "description": "Adds additional requested access methods to an existing Access Grant.", "operationId": "accessGrantsRequestAccessMethodsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "ok": { "type": "boolean" } }, "required": ["access_grant", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant to add access methods to." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." } }, "required": ["mode"] }, "minItems": 1, "description": "Array of requested access methods to add to the access grant." } }, "required": ["access_grant_id", "requested_access_methods"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "request_access_methods", "x-fern-sdk-return-value": "access_grant" } }, "/access_grants/update": { "post": { "x-title": "Update an Access Grant", "x-draft": "Early access.", "x-response-key": null, "summary": "/access_grants/update", "description": "Updates an existing Access Grant's time window.", "operationId": "accessGrantsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Display name for the access grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant to update." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." } }, "required": ["access_grant_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update an Access Grant", "x-draft": "Early access.", "x-response-key": null, "summary": "/access_grants/update", "description": "Updates an existing Access Grant's time window.", "operationId": "accessGrantsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Display name for the access grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant to update." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." } }, "required": ["access_grant_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants"], "x-fern-sdk-method-name": "update" } }, "/action_attempts/get": { "get": { "x-title": "Get an Action Attempt", "x-response-key": "action_attempt", "summary": "/action_attempts/get", "description": "Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).", "operationId": "actionAttemptsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "action_attempt_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the action attempt that you want to get." }, "required": true } ], "tags": ["/action_attempts"], "x-fern-sdk-group-name": ["action_attempts"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "action_attempt" }, "post": { "x-title": "Get an Action Attempt", "x-response-key": "action_attempt", "summary": "/action_attempts/get", "description": "Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).", "operationId": "actionAttemptsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt that you want to get." } }, "required": ["action_attempt_id"] } } } }, "tags": ["/action_attempts"], "x-fern-sdk-group-name": ["action_attempts"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "action_attempt" } }, "/action_attempts/list": { "get": { "x-title": "List Action Attempts", "x-response-key": "action_attempts", "summary": "/action_attempts/list", "description": "Returns a list of the [action attempts](https://docs.seam.co/latest/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.", "operationId": "actionAttemptsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempts": { "type": "array", "items": { "$ref": "#/components/schemas/action_attempt" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["action_attempts", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "action_attempt_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the action attempts that you want to retrieve." } }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device to filter action attempts by." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "page_cursor", "in": "query", "schema": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } ], "tags": ["/action_attempts"], "x-fern-sdk-group-name": ["action_attempts"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "action_attempts" }, "post": { "x-title": "List Action Attempts", "x-response-key": "action_attempts", "summary": "/action_attempts/list", "description": "Returns a list of the [action attempts](https://docs.seam.co/latest/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.", "operationId": "actionAttemptsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempts": { "type": "array", "items": { "$ref": "#/components/schemas/action_attempt" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["action_attempts", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the action attempts that you want to retrieve." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device to filter action attempts by." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "page_cursor": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } } } } }, "tags": ["/action_attempts"], "x-fern-sdk-group-name": ["action_attempts"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "action_attempts" } }, "/bridges/get": { "get": { "x-title": "Get a Seam Bridge", "x-undocumented": "Not yet for customer use.", "x-response-key": "bridge", "summary": "/bridges/get", "description": "Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "operationId": "bridgesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge": { "type": "object", "properties": { "bridge_id": { "type": "string", "format": "uuid", "description": "ID of Seam Bridge." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains Seam Bridge." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam Bridge was created." } }, "required": ["bridge_id", "workspace_id", "created_at"], "description": "Represents [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "x-undocumented": "Unreleased.", "x-route-path": "/bridges" }, "ok": { "type": "boolean" } }, "required": ["bridge", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "bridge_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Seam Bridge that you want to get." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["bridges"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "bridge" }, "post": { "x-title": "Get a Seam Bridge", "x-undocumented": "Not yet for customer use.", "x-response-key": "bridge", "summary": "/bridges/get", "description": "Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "operationId": "bridgesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge": { "type": "object", "properties": { "bridge_id": { "type": "string", "format": "uuid", "description": "ID of Seam Bridge." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains Seam Bridge." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam Bridge was created." } }, "required": ["bridge_id", "workspace_id", "created_at"], "description": "Represents [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "x-undocumented": "Unreleased.", "x-route-path": "/bridges" }, "ok": { "type": "boolean" } }, "required": ["bridge", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_id": { "type": "string", "format": "uuid", "description": "ID of the Seam Bridge that you want to get." } }, "required": ["bridge_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["bridges"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "bridge" } }, "/bridges/list": { "get": { "x-title": "List Seam Bridges", "x-undocumented": "Not yet for customer use.", "x-response-key": "bridges", "summary": "/bridges/list", "description": "Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).", "operationId": "bridgesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridges": { "type": "array", "items": { "type": "object", "properties": { "bridge_id": { "type": "string", "format": "uuid", "description": "ID of Seam Bridge." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains Seam Bridge." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam Bridge was created." } }, "required": ["bridge_id", "workspace_id", "created_at"], "description": "Represents [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "x-undocumented": "Unreleased.", "x-route-path": "/bridges" } }, "ok": { "type": "boolean" } }, "required": ["bridges", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [], "tags": [], "x-fern-sdk-group-name": ["bridges"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "bridges" }, "post": { "x-title": "List Seam Bridges", "x-undocumented": "Not yet for customer use.", "x-response-key": "bridges", "summary": "/bridges/list", "description": "Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).", "operationId": "bridgesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridges": { "type": "array", "items": { "type": "object", "properties": { "bridge_id": { "type": "string", "format": "uuid", "description": "ID of Seam Bridge." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains Seam Bridge." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam Bridge was created." } }, "required": ["bridge_id", "workspace_id", "created_at"], "description": "Represents [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "x-undocumented": "Unreleased.", "x-route-path": "/bridges" } }, "ok": { "type": "boolean" } }, "required": ["bridges", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [], "x-fern-sdk-group-name": ["bridges"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "bridges" } }, "/connect_webviews/create": { "post": { "x-title": "Create a Connect Webview", "x-response-key": "connect_webview", "summary": "/connect_webviews/create", "description": "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).", "operationId": "connectWebviewsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webview": { "$ref": "#/components/schemas/connect_webview" }, "ok": { "type": "boolean" } }, "required": ["connect_webview", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_selection_mode": { "type": "string", "enum": ["none", "single", "multiple"], "x-undocumented": "Not supported." }, "custom_redirect_url": { "type": "string", "description": "URL that you want to redirect the user to after the provider login is complete." }, "custom_redirect_failure_url": { "type": "string", "description": "Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`." }, "customer_key": { "type": "string", "minLength": 1, "description": "Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error." }, "accepted_providers": { "type": "array", "items": { "type": "string", "enum": [ "hotek", "dormakaba_community", "legic_connect", "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "schlage", "smartthings", "yale", "genie", "doorking", "salto", "salto_ks", "lockly", "ttlock", "linear", "noiseaware", "nuki", "igloo", "kwikset", "minut", "my_2n", "controlbyweb", "nest", "igloohome", "ecobee", "four_suites", "dormakaba_oracode", "pti", "wyze", "seam_passport", "visionline", "assa_abloy_credential_service", "tedee", "honeywell_resideo", "latch", "akiles", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "tado", "salto_space", "sensi", "keynest", "korelock", "dormakaba_ambiance", "ultraloq", "ring", "yale_access", "hid_cm", "google_nest" ] }, "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters." }, "provider_category": { "type": "string", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras", "internal_beta" ], "description": "Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } }, "automatically_manage_new_devices": { "type": "boolean", "description": "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews)." }, "wait_for_device_creation": { "default": false, "type": "boolean", "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews)." }, "accepted_capabilities": { "type": "array", "items": { "type": "string", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n" }, "description": "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers." }, "excluded_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account." } } } } } }, "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "connect_webview" } }, "/connect_webviews/delete": { "delete": { "x-title": "Delete a Connect Webview", "x-response-key": null, "summary": "/connect_webviews/delete", "description": "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "operationId": "connectWebviewsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview that you want to delete." } }, "required": ["connect_webview_id"] } } } }, "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Connect Webview", "x-response-key": null, "summary": "/connect_webviews/delete", "description": "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "operationId": "connectWebviewsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview that you want to delete." } }, "required": ["connect_webview_id"] } } } }, "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "delete" } }, "/connect_webviews/get": { "get": { "x-title": "Get a Connect Webview", "x-response-key": "connect_webview", "summary": "/connect_webviews/get", "description": "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "operationId": "connectWebviewsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webview": { "$ref": "#/components/schemas/connect_webview" }, "ok": { "type": "boolean" } }, "required": ["connect_webview", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview that you want to get." }, "required": true } ], "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "connect_webview" }, "post": { "x-title": "Get a Connect Webview", "x-response-key": "connect_webview", "summary": "/connect_webviews/get", "description": "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "operationId": "connectWebviewsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webview": { "$ref": "#/components/schemas/connect_webview" }, "ok": { "type": "boolean" } }, "required": ["connect_webview", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview that you want to get." } }, "required": ["connect_webview_id"] } } } }, "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "connect_webview" } }, "/connect_webviews/list": { "get": { "x-title": "List Connect Webviews", "x-response-key": "connect_webviews", "summary": "/connect_webviews/list", "description": "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).", "operationId": "connectWebviewsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webviews": { "type": "array", "items": { "$ref": "#/components/schemas/connect_webview" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["connect_webviews", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list connect webviews." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your user ID for the user by which you want to filter Connect Webviews." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Maximum number of records to return per page." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connect_webviews" }, "post": { "x-title": "List Connect Webviews", "x-response-key": "connect_webviews", "summary": "/connect_webviews/list", "description": "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).", "operationId": "connectWebviewsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connect_webviews": { "type": "array", "items": { "$ref": "#/components/schemas/connect_webview" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["connect_webviews", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list connect webviews." }, "user_identifier_key": { "type": "string", "description": "Your user ID for the user by which you want to filter Connect Webviews." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Maximum number of records to return per page." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/connect_webviews"], "x-fern-sdk-group-name": ["connect_webviews"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connect_webviews" } }, "/client_sessions/create": { "post": { "x-title": "Create a Client Session", "x-response-key": "client_session", "summary": "/client_sessions/create", "description": "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "publishable_key": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_id": { "type": "string", "description": "Customer ID that you want to associate with the new client session." }, "customer_key": { "type": "string", "minLength": 1, "description": "Customer key that you want to associate with the new client session." }, "user_identifier_key": { "type": "string", "minLength": 1, "description": "Your user ID for the user for whom you want to create a client session." }, "connect_webview_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session." }, "connected_account_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session." }, "user_identity_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1, "description": "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "deprecated": true, "x-deprecated": "Use `user_identity_id` instead." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session." }, "expires_at": { "description": "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string", "format": "date-time" } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "client_session" }, "put": { "x-title": "Create a Client Session", "x-response-key": "client_session", "summary": "/client_sessions/create", "description": "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsCreatePut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "publishable_key": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_id": { "type": "string", "description": "Customer ID that you want to associate with the new client session." }, "customer_key": { "type": "string", "minLength": 1, "description": "Customer key that you want to associate with the new client session." }, "user_identifier_key": { "type": "string", "minLength": 1, "description": "Your user ID for the user for whom you want to create a client session." }, "connect_webview_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session." }, "connected_account_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session." }, "user_identity_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1, "description": "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "deprecated": true, "x-deprecated": "Use `user_identity_id` instead." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session." }, "expires_at": { "description": "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string", "format": "date-time" } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "client_session" } }, "/client_sessions/delete": { "delete": { "x-title": "Delete a Client Session", "x-response-key": null, "summary": "/client_sessions/delete", "description": "Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "client_session_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the client session that you want to delete." }, "required": true } ], "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Client Session", "x-response-key": null, "summary": "/client_sessions/delete", "description": "Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session_id": { "type": "string", "format": "uuid", "description": "ID of the client session that you want to delete." } }, "required": ["client_session_id"] } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "delete" } }, "/client_sessions/get": { "get": { "x-title": "Get a Client Session", "x-response-key": "client_session", "summary": "/client_sessions/get", "description": "Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "client_session_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the client session that you want to get." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "User identifier key associated with the client session that you want to get." } } ], "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "client_session" }, "post": { "x-title": "Get a Client Session", "x-response-key": "client_session", "summary": "/client_sessions/get", "description": "Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session_id": { "type": "string", "format": "uuid", "description": "ID of the client session that you want to get." }, "user_identifier_key": { "type": "string", "description": "User identifier key associated with the client session that you want to get." } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "client_session" } }, "/client_sessions/get_or_create": { "post": { "x-title": "Get or Create a Client Session", "x-response-key": "client_session", "summary": "/client_sessions/get_or_create", "description": "Returns a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.", "operationId": "clientSessionsGetOrCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "publishable_key": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identifier_key": { "type": "string", "minLength": 1, "description": "Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session)." }, "connect_webview_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session)." }, "connected_account_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session)." }, "user_identity_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1, "description": "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "deprecated": true, "x-deprecated": "Use `user_identity_id`." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session)." }, "expires_at": { "description": "Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it.", "type": "string", "format": "date-time" } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "get_or_create", "x-fern-sdk-return-value": "client_session" } }, "/client_sessions/grant_access": { "patch": { "x-title": "Grant Access to a Client Session", "x-response-key": null, "summary": "/client_sessions/grant_access", "description": "Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.", "operationId": "clientSessionsGrantAccessPatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session_id": { "type": "string", "description": "ID of the client session to which you want to grant access to resources." }, "user_identifier_key": { "type": "string", "description": "Your user ID for the user that you want to associate with the client session." }, "connected_account_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session." }, "connect_webview_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session." }, "user_identity_ids": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 1, "description": "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "deprecated": true, "x-deprecated": "Use `user_identity_id`." }, "user_identity_id": { "type": "string", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session." } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "grant_access" }, "post": { "x-title": "Grant Access to a Client Session", "x-response-key": null, "summary": "/client_sessions/grant_access", "description": "Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.", "operationId": "clientSessionsGrantAccessPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session_id": { "type": "string", "description": "ID of the client session to which you want to grant access to resources." }, "user_identifier_key": { "type": "string", "description": "Your user ID for the user that you want to associate with the client session." }, "connected_account_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session." }, "connect_webview_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session." }, "user_identity_ids": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 1, "description": "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "deprecated": true, "x-deprecated": "Use `user_identity_id`." }, "user_identity_id": { "type": "string", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session." } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "grant_access" } }, "/client_sessions/list": { "get": { "x-title": "List Client Sessions", "x-response-key": "client_sessions", "summary": "/client_sessions/list", "description": "Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "ok": { "type": "boolean" } }, "required": ["client_sessions", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "client_session_id", "in": "query", "schema": { "type": "string", "description": "ID of the client session that you want to retrieve." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your user ID for the user by which you want to filter client sessions." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions." } }, { "name": "without_user_identifier_key", "in": "query", "schema": { "type": "boolean", "description": "Indicates whether to retrieve only client sessions without associated user identifier keys." } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions." } } ], "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "client_sessions" }, "post": { "x-title": "List Client Sessions", "x-response-key": "client_sessions", "summary": "/client_sessions/list", "description": "Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "ok": { "type": "boolean" } }, "required": ["client_sessions", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session_id": { "type": "string", "description": "ID of the client session that you want to retrieve." }, "user_identifier_key": { "type": "string", "description": "Your user ID for the user by which you want to filter client sessions." }, "connect_webview_id": { "type": "string", "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions." }, "without_user_identifier_key": { "type": "boolean", "description": "Indicates whether to retrieve only client sessions without associated user identifier keys." }, "user_identity_id": { "type": "string", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions." } } } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "client_sessions" } }, "/client_sessions/revoke": { "post": { "x-title": "Revoke a Client Session", "x-response-key": null, "summary": "/client_sessions/revoke", "description": "Revokes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).\n\nNote that [deleting a client session](https://docs.seam.co/latest/api/client_sessions/delete) is a separate action.", "operationId": "clientSessionsRevokePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session_id": { "type": "string", "format": "uuid", "description": "ID of the client session that you want to revoke." } }, "required": ["client_session_id"] } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": ["client_sessions"], "x-fern-sdk-method-name": "revoke" } }, "/access_codes/create": { "post": { "x-title": "Create an Access Code", "x-response-key": "access_code", "x-action-attempt-type": "CREATE_ACCESS_CODE", "summary": "/access_codes/create", "description": "Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "operationId": "accessCodesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "access_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to create the new access code." }, "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Code to be used for access." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "common_code_key": { "type": "string", "description": "Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes)." }, "prefer_native_scheduling": { "type": "boolean", "description": "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`." }, "use_backup_access_code_pool": { "type": "boolean", "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code)." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "preferred_code_length": { "type": "number", "format": "float", "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length." }, "use_offline_access_code": { "type": "boolean", "deprecated": true, "x-deprecated": "Use `is_offline_access_code` instead." }, "is_offline_access_code": { "type": "boolean", "description": "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code." }, "max_time_rounding": { "default": "1hour", "type": "string", "enum": ["1hour", "1day", "1h", "1d"], "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`." } }, "required": ["device_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "access_code" } }, "/access_codes/create_multiple": { "post": { "x-title": "Create Multiple Linked Access Codes", "x-response-key": "access_codes", "summary": "/access_codes/create_multiple", "description": "Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).", "operationId": "accessCodesCreateMultiplePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "ok": { "type": "boolean" } }, "required": ["access_codes", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_ids": { "description": "IDs of the devices for which you want to create the new access codes.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "behavior_when_code_cannot_be_shared": { "default": "throw", "type": "string", "enum": ["throw", "create_random_code"], "description": "Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code." }, "preferred_code_length": { "type": "number", "format": "float", "description": "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length." }, "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Code to be used for access." }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "prefer_native_scheduling": { "type": "boolean", "description": "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." } }, "required": ["device_ids"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "create_multiple", "x-fern-sdk-return-value": "access_codes" }, "put": { "x-title": "Create Multiple Linked Access Codes", "x-response-key": "access_codes", "summary": "/access_codes/create_multiple", "description": "Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).", "operationId": "accessCodesCreateMultiplePut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "ok": { "type": "boolean" } }, "required": ["access_codes", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_ids": { "description": "IDs of the devices for which you want to create the new access codes.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "behavior_when_code_cannot_be_shared": { "default": "throw", "type": "string", "enum": ["throw", "create_random_code"], "description": "Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code." }, "preferred_code_length": { "type": "number", "format": "float", "description": "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length." }, "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Code to be used for access." }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "prefer_native_scheduling": { "type": "boolean", "description": "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." } }, "required": ["device_ids"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "create_multiple", "x-fern-sdk-return-value": "access_codes" } }, "/access_codes/delete": { "delete": { "x-title": "Delete an Access Code", "x-response-key": null, "x-action-attempt-type": "DELETE_ACCESS_CODE", "summary": "/access_codes/delete", "description": "Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "operationId": "accessCodesDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to delete the access code." }, "required": false }, { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to delete." }, "required": true }, { "name": "sync", "in": "query", "schema": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "required": false } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Access Code", "x-response-key": null, "x-action-attempt-type": "DELETE_ACCESS_CODE", "summary": "/access_codes/delete", "description": "Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "operationId": "accessCodesDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to delete the access code." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to delete." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "delete" } }, "/access_codes/generate_code": { "get": { "x-title": "Generate a Code", "x-response-key": "generated_code", "summary": "/access_codes/generate_code", "description": "Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.", "operationId": "accessCodesGenerateCodeGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": ["generated_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to generate a code." }, "required": true } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "generate_code", "x-fern-sdk-return-value": "generated_code" }, "post": { "x-title": "Generate a Code", "x-response-key": "generated_code", "summary": "/access_codes/generate_code", "description": "Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.", "operationId": "accessCodesGenerateCodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": ["generated_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to generate a code." } }, "required": ["device_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "generate_code", "x-fern-sdk-return-value": "generated_code" } }, "/access_codes/get": { "get": { "x-title": "Get an Access Code", "x-response-key": "access_code", "summary": "/access_codes/get", "description": "Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": ["access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "access_token": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } }, { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } }, { "name": "code", "in": "query", "schema": { "type": "string", "description": "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_code" }, "post": { "x-title": "Get an Access Code", "x-response-key": "access_code", "summary": "/access_codes/get", "description": "Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": ["access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "access_token": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." }, "code": { "type": "string", "description": "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } } } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_code" } }, "/access_codes/get_timeline": { "get": { "x-title": "Get Access Code Timeline", "x-response-key": "timeline_events", "x-undocumented": "Unreleased.", "summary": "/access_codes/get_timeline", "description": "Returns a chronological timeline of events for an access code.\n\nThe timeline includes state changes (create, update, delete), delivery lifecycle events\n(programming attempts, success/failure), and related device events.", "operationId": "accessCodesGetTimelineGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeline_events": { "type": "array", "items": { "type": "object", "properties": { "timeline_event_id": { "type": "string", "format": "uuid", "description": "Unique identifier for this timeline event." }, "event_type": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.deleted", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "internal.access_code.programming_started", "internal.access_code.programming_finished", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed" ], "description": "The type of timeline event.", "x-undocumented": "Unreleased." }, "occurred_at": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp when the event occurred." }, "description": { "type": "string", "description": "Human-readable description of what happened." }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "api_key", "console_user", "system", "external" ], "description": "The type of actor that triggered this event." }, "id": { "type": "string", "description": "The ID of the actor (API key ID, user ID, etc.)." }, "display_name": { "type": "string", "description": "Human-readable name for the actor." } }, "required": ["type"], "description": "Information about who or what triggered this event." }, "details": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" }, "description": "Event-specific details and payload data." }, "related_resource_ids": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid" }, "connected_account_id": { "type": "string", "format": "uuid" }, "action_attempt_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" } }, "description": "IDs of related resources for cross-referencing." } }, "required": [ "timeline_event_id", "event_type", "occurred_at", "description", "actor" ], "description": "Timeline event for access code lifecycle activity.", "x-undocumented": "Unreleased." } }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "type": "string", "nullable": true }, "prev_cursor": { "type": "string", "nullable": true } }, "required": ["has_more", "next_cursor", "prev_cursor"] }, "ok": { "type": "boolean" } }, "required": ["timeline_events", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access code for which to retrieve the timeline." }, "required": true }, { "name": "limit", "in": "query", "schema": { "default": 50, "type": "number", "format": "float", "minimum": 1, "maximum": 200, "description": "Maximum number of timeline events to return (default 50, max 200)." }, "required": false }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Only return events that occurred before this timestamp (ISO 8601 format)." }, "required": false }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Only return events that occurred after this timestamp (ISO 8601 format)." }, "required": false }, { "name": "event_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.deleted", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "internal.access_code.programming_started", "internal.access_code.programming_finished", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed" ] }, "description": "Filter to only return specific event types." }, "required": false } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "get_timeline", "x-fern-sdk-return-value": "timeline_events" }, "post": { "x-title": "Get Access Code Timeline", "x-response-key": "timeline_events", "x-undocumented": "Unreleased.", "summary": "/access_codes/get_timeline", "description": "Returns a chronological timeline of events for an access code.\n\nThe timeline includes state changes (create, update, delete), delivery lifecycle events\n(programming attempts, success/failure), and related device events.", "operationId": "accessCodesGetTimelinePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeline_events": { "type": "array", "items": { "type": "object", "properties": { "timeline_event_id": { "type": "string", "format": "uuid", "description": "Unique identifier for this timeline event." }, "event_type": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.deleted", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "internal.access_code.programming_started", "internal.access_code.programming_finished", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed" ], "description": "The type of timeline event.", "x-undocumented": "Unreleased." }, "occurred_at": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp when the event occurred." }, "description": { "type": "string", "description": "Human-readable description of what happened." }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "api_key", "console_user", "system", "external" ], "description": "The type of actor that triggered this event." }, "id": { "type": "string", "description": "The ID of the actor (API key ID, user ID, etc.)." }, "display_name": { "type": "string", "description": "Human-readable name for the actor." } }, "required": ["type"], "description": "Information about who or what triggered this event." }, "details": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" }, "description": "Event-specific details and payload data." }, "related_resource_ids": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid" }, "connected_account_id": { "type": "string", "format": "uuid" }, "action_attempt_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" } }, "description": "IDs of related resources for cross-referencing." } }, "required": [ "timeline_event_id", "event_type", "occurred_at", "description", "actor" ], "description": "Timeline event for access code lifecycle activity.", "x-undocumented": "Unreleased." } }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "type": "string", "nullable": true }, "prev_cursor": { "type": "string", "nullable": true } }, "required": ["has_more", "next_cursor", "prev_cursor"] }, "ok": { "type": "boolean" } }, "required": ["timeline_events", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code for which to retrieve the timeline." }, "limit": { "default": 50, "type": "number", "format": "float", "minimum": 1, "maximum": 200, "description": "Maximum number of timeline events to return (default 50, max 200)." }, "before": { "type": "string", "format": "date-time", "description": "Only return events that occurred before this timestamp (ISO 8601 format)." }, "after": { "type": "string", "format": "date-time", "description": "Only return events that occurred after this timestamp (ISO 8601 format)." }, "event_types": { "type": "array", "items": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.deleted", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "internal.access_code.programming_started", "internal.access_code.programming_finished", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed" ] }, "description": "Filter to only return specific event types." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "get_timeline", "x-fern-sdk-return-value": "timeline_events" } }, "/access_codes/list": { "get": { "x-title": "List Access Codes", "x-response-key": "access_codes", "summary": "/access_codes/list", "description": "Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.", "operationId": "accessCodesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_codes", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list access codes." } }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." } }, { "name": "access_code_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." } }, { "name": "access_method_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." } }, { "name": "access_grant_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your user ID for the user by which to filter access codes." } }, { "name": "limit", "in": "query", "schema": { "default": 55000, "type": "number", "format": "float", "description": "Numerical limit on the number of access codes to return." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_codes" }, "post": { "x-title": "List Access Codes", "x-response-key": "access_codes", "summary": "/access_codes/list", "description": "Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.", "operationId": "accessCodesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_codes", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list access codes." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." }, "access_code_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`." }, "user_identifier_key": { "type": "string", "description": "Your user ID for the user by which to filter access codes." }, "limit": { "default": 55000, "type": "number", "format": "float", "description": "Numerical limit on the number of access codes to return." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_codes" } }, "/access_codes/pull_backup_access_code": { "post": { "x-title": "Pull a Backup Access Code", "x-response-key": "access_code", "summary": "/access_codes/pull_backup_access_code", "description": "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.", "operationId": "accessCodesPullBackupAccessCodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "backup_access_code": { "$ref": "#/components/schemas/access_code" }, "access_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": ["backup_access_code", "access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code for which you want to pull a backup access code." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "pull_backup_access_code", "x-fern-sdk-return-value": "access_code" } }, "/access_codes/report_device_constraints": { "post": { "x-title": "Report Device Access Code Constraints", "x-response-key": null, "summary": "/access_codes/report_device_constraints", "description": "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.", "operationId": "accessCodesReportDeviceConstraintsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to report constraints." }, "supported_code_lengths": { "type": "array", "items": { "type": "integer", "minimum": 4, "maximum": 20 }, "minItems": 1, "description": "Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`." }, "min_code_length": { "type": "integer", "minimum": 4, "maximum": 20, "description": "Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`." }, "max_code_length": { "type": "integer", "minimum": 4, "maximum": 20, "description": "Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`." } }, "required": ["device_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "report_device_constraints" } }, "/access_codes/update": { "post": { "x-title": "Update an Access Code", "x-response-key": null, "x-action-attempt-type": "UPDATE_ACCESS_CODE", "summary": "/access_codes/update", "description": "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).", "operationId": "accessCodesUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Code to be used for access." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "prefer_native_scheduling": { "type": "boolean", "description": "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`." }, "use_backup_access_code_pool": { "type": "boolean", "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code)." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "preferred_code_length": { "type": "number", "format": "float", "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length." }, "use_offline_access_code": { "type": "boolean", "deprecated": true, "x-deprecated": "Use `is_offline_access_code` instead." }, "is_offline_access_code": { "type": "boolean", "description": "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code." }, "max_time_rounding": { "default": "1hour", "type": "string", "enum": ["1hour", "1day", "1h", "1d"], "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to update." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device containing the access code that you want to update." }, "type": { "type": "string", "enum": ["ongoing", "time_bound"], "description": "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access)." }, "is_managed": { "type": "boolean", "description": "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update an Access Code", "x-response-key": null, "x-action-attempt-type": "UPDATE_ACCESS_CODE", "summary": "/access_codes/update", "description": "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).", "operationId": "accessCodesUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Code to be used for access." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "prefer_native_scheduling": { "type": "boolean", "description": "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`." }, "use_backup_access_code_pool": { "type": "boolean", "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code)." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "preferred_code_length": { "type": "number", "format": "float", "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length." }, "use_offline_access_code": { "type": "boolean", "deprecated": true, "x-deprecated": "Use `is_offline_access_code` instead." }, "is_offline_access_code": { "type": "boolean", "description": "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code." }, "max_time_rounding": { "default": "1hour", "type": "string", "enum": ["1hour", "1day", "1h", "1d"], "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to update." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device containing the access code that you want to update." }, "type": { "type": "string", "enum": ["ongoing", "time_bound"], "description": "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access)." }, "is_managed": { "type": "boolean", "description": "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "update" }, "put": { "x-title": "Update an Access Code", "x-response-key": null, "x-action-attempt-type": "UPDATE_ACCESS_CODE", "summary": "/access_codes/update", "description": "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).", "operationId": "accessCodesUpdatePut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Code to be used for access." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "prefer_native_scheduling": { "type": "boolean", "description": "Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`." }, "use_backup_access_code_pool": { "type": "boolean", "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code)." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`." }, "preferred_code_length": { "type": "number", "format": "float", "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length." }, "use_offline_access_code": { "type": "boolean", "deprecated": true, "x-deprecated": "Use `is_offline_access_code` instead." }, "is_offline_access_code": { "type": "boolean", "description": "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code." }, "max_time_rounding": { "default": "1hour", "type": "string", "enum": ["1hour", "1day", "1h", "1d"], "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that you want to update." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device containing the access code that you want to update." }, "type": { "type": "string", "enum": ["ongoing", "time_bound"], "description": "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access)." }, "is_managed": { "type": "boolean", "description": "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "update" } }, "/access_codes/update_multiple": { "post": { "x-title": "Update Multiple Linked Access Codes", "x-response-key": null, "summary": "/access_codes/update_multiple", "description": "Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).", "operationId": "accessCodesUpdateMultiplePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "common_code_key": { "type": "string", "description": "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`." } }, "required": ["common_code_key"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "update_multiple" }, "patch": { "x-title": "Update Multiple Linked Access Codes", "x-response-key": null, "summary": "/access_codes/update_multiple", "description": "Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).", "operationId": "accessCodesUpdateMultiplePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "name": { "type": "string", "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "common_code_key": { "type": "string", "description": "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`." } }, "required": ["common_code_key"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes"], "x-fern-sdk-method-name": "update_multiple" } }, "/connected_accounts/delete": { "delete": { "x-title": "Delete a Connected Account", "x-response-key": null, "summary": "/connected_accounts/delete", "description": "Deletes a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.", "operationId": "connectedAccountsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account that you want to delete." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["connected_account_id"] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Connected Account", "x-response-key": null, "summary": "/connected_accounts/delete", "description": "Deletes a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.", "operationId": "connectedAccountsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account that you want to delete." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["connected_account_id"] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "delete" } }, "/connected_accounts/get": { "get": { "x-title": "Get a Connected Account", "x-response-key": "connected_account", "summary": "/connected_accounts/get", "description": "Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).", "operationId": "connectedAccountsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" }, "ok": { "type": "boolean" } }, "required": ["connected_account", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "connected_account" }, "post": { "x-title": "Get a Connected Account", "x-response-key": "connected_account", "summary": "/connected_accounts/get", "description": "Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).", "operationId": "connectedAccountsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" }, "ok": { "type": "boolean" } }, "required": ["connected_account", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account that you want to get." } }, "required": ["connected_account_id"] }, { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Email address associated with the connected account that you want to get." } }, "required": ["email"] } ] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "connected_account" } }, "/connected_accounts/list": { "get": { "x-title": "List Connected Accounts", "x-response-key": "connected_accounts", "summary": "/connected_accounts/list", "description": "Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).", "operationId": "connectedAccountsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["connected_accounts", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your user ID for the user by which you want to filter connected accounts." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs." } }, { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key by which you want to filter connected accounts." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`." } }, { "name": "limit", "in": "query", "schema": { "default": 11000, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connected_accounts" }, "post": { "x-title": "List Connected Accounts", "x-response-key": "connected_accounts", "summary": "/connected_accounts/list", "description": "Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).", "operationId": "connectedAccountsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["connected_accounts", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identifier_key": { "type": "string", "description": "Your user ID for the user by which you want to filter connected accounts." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs." }, "customer_key": { "type": "string", "description": "Customer key by which you want to filter connected accounts." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`." }, "limit": { "default": 11000, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connected_accounts" } }, "/connected_accounts/sync": { "post": { "x-title": "Sync a Connected Account", "x-response-key": null, "summary": "/connected_accounts/sync", "description": "Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.", "operationId": "connectedAccountsSyncPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account that you want to sync." } }, "required": ["connected_account_id"] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "sync" } }, "/connected_accounts/update": { "patch": { "x-title": "Update a Connected Account", "x-response-key": null, "summary": "/connected_accounts/update", "description": "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).", "operationId": "connectedAccountsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" }, "ok": { "type": "boolean" } }, "required": ["connected_account", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account that you want to update." }, "automatically_manage_new_devices": { "type": "boolean", "description": "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices)." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } }, "accepted_capabilities": { "type": "array", "items": { "type": "string", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n" }, "description": "List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`." }, "customer_key": { "type": "string", "minLength": 1, "description": "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer." } }, "required": ["connected_account_id"] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update a Connected Account", "x-response-key": null, "summary": "/connected_accounts/update", "description": "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).", "operationId": "connectedAccountsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" }, "ok": { "type": "boolean" } }, "required": ["connected_account", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account that you want to update." }, "automatically_manage_new_devices": { "type": "boolean", "description": "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices)." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } }, "accepted_capabilities": { "type": "array", "items": { "type": "string", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n" }, "description": "List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`." }, "customer_key": { "type": "string", "minLength": 1, "description": "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer." } }, "required": ["connected_account_id"] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts"], "x-fern-sdk-method-name": "update" } }, "/customers/create_portal": { "post": { "x-title": "Create Customer Portal", "x-response-key": "magic_link", "summary": "/customers/create_portal", "description": "Creates a new customer portal magic link with configurable features.", "operationId": "customersCreatePortalPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "default": { "features": { "connect": { "exclude": false }, "organize": { "exclude": false }, "manage": { "exclude": false, "exclude_reservation_management": false, "exclude_reservation_technical_details": false, "exclude_staff_management": false }, "manage_devices": { "exclude": false }, "configure": { "exclude": false, "allow_instant_key_customization": false, "allow_access_automation_rule_customization": false, "allow_climate_automation_rule_customization": false } }, "is_embedded": false, "exclude_locale_picker": false }, "type": "object", "properties": { "features": { "default": {}, "type": "object", "properties": { "connect": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "accepted_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account." }, "excluded_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account." } }, "description": "Configuration for the connect accounts feature." }, "manage": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "exclude_reservation_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage reservations for their properties." }, "exclude_reservation_technical_details": { "default": false, "type": "boolean", "description": "Indicates whether to exclude technical details from reservation views." }, "exclude_staff_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage staff for their properties." }, "events": { "type": "object", "properties": { "allowed_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events." }, "default_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types that are pre-selected in the events filter when the user first loads the events tab." } }, "description": "Configuration for event type filtering in the manage feature." } }, "description": "Configuration for the manage feature." }, "manage_devices": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---" }, "organize": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the organize feature." }, "configure": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "allow_access_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the access automation rules for their properties." }, "allow_climate_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the climate automation rules for their properties." }, "allow_instant_key_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the Instant Key profile for their properties." } }, "description": "Configuration for the configure feature." } } }, "is_embedded": { "default": false, "type": "boolean", "description": "Whether the portal is embedded in another application." }, "landing_page": { "type": "object", "properties": { "manage": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "space_key": { "type": "string" } }, "required": ["space_key"] }, { "type": "object", "properties": { "property_key": { "type": "string" } }, "required": ["property_key"] }, { "type": "object", "properties": { "room_key": { "type": "string" } }, "required": ["room_key"] }, { "type": "object", "properties": { "common_area_key": { "type": "string" } }, "required": ["common_area_key"] }, { "type": "object", "properties": { "unit_key": { "type": "string" } }, "required": ["unit_key"] }, { "type": "object", "properties": { "facility_key": { "type": "string" } }, "required": ["facility_key"] }, { "type": "object", "properties": { "building_key": { "type": "string" } }, "required": ["building_key"] }, { "type": "object", "properties": { "listing_key": { "type": "string" } }, "required": ["listing_key"] }, { "type": "object", "properties": { "property_listing_key": { "type": "string" } }, "required": ["property_listing_key"] }, { "type": "object", "properties": { "site_key": { "type": "string" } }, "required": ["site_key"] } ] }, { "oneOf": [ { "type": "object", "properties": { "reservation_key": { "type": "string" } }, "required": ["reservation_key"] }, { "type": "object", "properties": { "booking_key": { "type": "string" } }, "required": ["booking_key"] }, { "type": "object", "properties": { "access_grant_key": { "type": "string" } }, "required": ["access_grant_key"] } ] } ] } }, "description": "Configuration for the landing page when the portal loads." }, "locale": { "type": "string", "enum": ["en-US", "pt-PT", "fr-FR", "it-IT", "es-ES"], "description": "The locale to use for the portal." }, "exclude_locale_picker": { "default": false, "type": "boolean", "description": "Whether to exclude the option to select a locale within the portal UI." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "The ID of the customization profile to use for the portal." }, "customer_resources_filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[a-zA-Z_]\\w*$", "description": "The custom_metadata field name to filter on." }, "operation": { "type": "string", "enum": ["="], "description": "The comparison operation. Currently only '=' is supported." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "The value to compare against." } }, "required": ["field", "operation", "value"] }, "description": "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata." }, "navigation_mode": { "default": "full", "type": "string", "enum": ["full", "restricted"], "description": "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links." }, "deep_link": { "type": "object", "properties": { "resource_type": { "type": "string", "enum": ["reservation", "space"] }, "resource_key": { "type": "string" } }, "required": ["resource_type", "resource_key"], "description": "Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.", "x-undocumented": "Internal endpoint for customer portals." }, "_dev": { "default": false, "type": "boolean", "description": "Whether the portal is in developer mode. Only available for Seam employees.", "x-undocumented": "Internal developer mode flag." } }, "description": "Configuration for a customer portal" }, { "type": "object", "properties": { "customer_data": { "type": "object", "properties": { "customer_key": { "description": "Your unique identifier for the customer.", "type": "string", "minLength": 1 }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "space_key": { "description": "Your unique identifier for the space.", "type": "string", "minLength": 1 }, "parent_site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "space_key"] }, "description": "List of general spaces or areas." }, "sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "site_key"] }, "description": "List of general sites or areas." }, "properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "property_key": { "description": "Your unique identifier for the property.", "type": "string", "minLength": 1 } }, "required": ["name", "property_key"] }, "description": "List of short-term rental properties." }, "rooms": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "room_key": { "description": "Your unique identifier for the room.", "type": "string", "minLength": 1 }, "parent_site_key": { "type": "string", "minLength": 1, "description": "Your unique identifier for the site." } }, "required": ["name", "room_key"] }, "description": "List of hotel or hospitality rooms." }, "common_areas": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "common_area_key": { "description": "Your unique identifier for the common area.", "type": "string", "minLength": 1 }, "parent_site_key": { "type": "string", "minLength": 1, "description": "Your unique identifier for the site." } }, "required": ["name", "common_area_key"] }, "description": "List of shared common areas." }, "units": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "unit_key": { "description": "Your unique identifier for the unit.", "type": "string", "minLength": 1 }, "parent_site_key": { "type": "string", "minLength": 1, "description": "Your unique identifier for the site." } }, "required": ["name", "unit_key"] }, "description": "List of multi-family residential units." }, "facilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "facility_key": { "description": "Your unique identifier for the facility.", "type": "string", "minLength": 1 } }, "required": ["name", "facility_key"] }, "description": "List of gym or fitness facilities." }, "buildings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "building_key": { "description": "Your unique identifier for the building.", "type": "string", "minLength": 1 } }, "required": ["name", "building_key"] }, "description": "List of buildings." }, "listings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "listing_key": { "description": "Your unique identifier for the listing.", "type": "string", "minLength": 1 } }, "required": ["name", "listing_key"] }, "description": "List of property listings." }, "property_listings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "property_listing_key": { "description": "Your unique identifier for the property listing.", "type": "string", "minLength": 1 }, "custom_metadata": { "description": "Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } } }, "required": ["name", "property_listing_key"] }, "description": "List of property listings." }, "guests": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "guest_key": { "description": "Your unique identifier for the guest.", "type": "string", "minLength": 1 } }, "required": ["name", "guest_key"] }, "description": "List of guests." }, "tenants": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "tenant_key": { "description": "Your unique identifier for the tenant.", "type": "string", "minLength": 1 } }, "required": ["name", "tenant_key"] }, "description": "List of tenants." }, "residents": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "resident_key": { "description": "Your unique identifier for the resident.", "type": "string", "minLength": 1 } }, "required": ["name", "resident_key"] }, "description": "List of residents." }, "users": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "user_key": { "description": "Your unique identifier for the user.", "type": "string", "minLength": 1 } }, "required": ["name", "user_key"] }, "description": "List of users." }, "user_identities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "user_identity_key": { "description": "Your unique identifier for the user identity.", "type": "string", "minLength": 1 } }, "required": ["name", "user_identity_key"] }, "description": "List of user identities." }, "staff_members": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the properties the staff member is associated with." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the rooms the staff member is associated with." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the common areas the staff member is associated with." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the units the staff member is associated with." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the facilities the staff member is associated with." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the buildings the staff member is associated with." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the listings the staff member is associated with." }, "property_listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the property listings the staff member is associated with." }, "site_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the sites the staff member is associated with." } }, "required": ["name", "staff_member_key"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." }, "description": "List of staff members." }, "reservations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your name for this access grant resource." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starting date and time for the access grant." }, "ends_at": { "type": "string", "format": "date-time", "description": "Ending date and time for the access grant." }, "preferred_code": { "type": "string", "description": "Preferred PIN code to use when creating access for this reservation." }, "reservation_key": { "description": "Your unique identifier for the reservation.", "type": "string", "minLength": 1 }, "custom_metadata": { "description": "Set key:value pairs for filtering reservations by custom criteria.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } }, "guest_key": { "type": "string", "description": "Guest key associated with the access grant." }, "tenant_key": { "type": "string", "description": "Tenant key associated with the access grant." }, "resident_key": { "type": "string", "description": "Resident key associated with the access grant." }, "user_key": { "type": "string", "description": "User key associated with the access grant." }, "user_identity_key": { "type": "string", "description": "User identity key associated with the access grant." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Space keys associated with the access grant." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "Property keys associated with the access grant." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "Room keys associated with the access grant." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "Common area keys associated with the access grant." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "Unit keys associated with the access grant." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "Facility keys associated with the access grant." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "Building keys associated with the access grant." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "Listing keys associated with the access grant." } }, "required": ["reservation_key"] }, "description": "List of reservations." }, "bookings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your name for this access grant resource." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starting date and time for the access grant." }, "ends_at": { "type": "string", "format": "date-time", "description": "Ending date and time for the access grant." }, "preferred_code": { "type": "string", "description": "Preferred PIN code to use when creating access for this reservation." }, "booking_key": { "description": "Your unique identifier for the booking.", "type": "string", "minLength": 1 }, "guest_key": { "type": "string", "description": "Guest key associated with the access grant." }, "tenant_key": { "type": "string", "description": "Tenant key associated with the access grant." }, "resident_key": { "type": "string", "description": "Resident key associated with the access grant." }, "user_key": { "type": "string", "description": "User key associated with the access grant." }, "user_identity_key": { "type": "string", "description": "User identity key associated with the access grant." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Space keys associated with the access grant." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "Property keys associated with the access grant." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "Room keys associated with the access grant." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "Common area keys associated with the access grant." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "Unit keys associated with the access grant." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "Facility keys associated with the access grant." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "Building keys associated with the access grant." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "Listing keys associated with the access grant." } }, "required": ["booking_key"] }, "description": "List of bookings." }, "access_grants": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your name for this access grant resource." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starting date and time for the access grant." }, "ends_at": { "type": "string", "format": "date-time", "description": "Ending date and time for the access grant." }, "preferred_code": { "type": "string", "description": "Preferred PIN code to use when creating access for this reservation." }, "access_grant_key": { "description": "Your unique identifier for the access grant.", "type": "string", "minLength": 1 }, "guest_key": { "type": "string", "description": "Guest key associated with the access grant." }, "tenant_key": { "type": "string", "description": "Tenant key associated with the access grant." }, "resident_key": { "type": "string", "description": "Resident key associated with the access grant." }, "user_key": { "type": "string", "description": "User key associated with the access grant." }, "user_identity_key": { "type": "string", "description": "User identity key associated with the access grant." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Space keys associated with the access grant." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "Property keys associated with the access grant." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "Room keys associated with the access grant." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "Common area keys associated with the access grant." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "Unit keys associated with the access grant." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "Facility keys associated with the access grant." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "Building keys associated with the access grant." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "Listing keys associated with the access grant." } }, "required": ["access_grant_key"] }, "description": "List of access grants." } }, "required": ["customer_key"] } } } ] } } } }, "tags": [], "x-fern-sdk-group-name": ["customers"], "x-fern-sdk-method-name": "create_portal", "x-fern-sdk-return-value": "magic_link" } }, "/customers/delete_data": { "delete": { "x-title": "Delete Customer Data", "x-response-key": null, "summary": "/customers/delete_data", "description": "Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).", "operationId": "customersDeleteDataDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of customer keys to delete all data for." } }, { "name": "space_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of space keys to delete." } }, { "name": "property_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of property keys to delete." } }, { "name": "room_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of room keys to delete." } }, { "name": "common_area_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of common area keys to delete." } }, { "name": "unit_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of unit keys to delete." } }, { "name": "facility_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of facility keys to delete." } }, { "name": "building_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of building keys to delete." } }, { "name": "listing_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of listing keys to delete." } }, { "name": "property_listing_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of property listing keys to delete." } }, { "name": "guest_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of guest keys to delete." } }, { "name": "tenant_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of tenant keys to delete." } }, { "name": "resident_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of resident keys to delete." } }, { "name": "user_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of user keys to delete." } }, { "name": "user_identity_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of user identity keys to delete." } }, { "name": "reservation_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of reservation keys to delete." } }, { "name": "booking_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of booking keys to delete." } }, { "name": "access_grant_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of access grant keys to delete." } }, { "name": "staff_member_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of staff member keys to delete." } } ], "tags": [], "x-fern-sdk-group-name": ["customers"], "x-fern-sdk-method-name": "delete_data" }, "post": { "x-title": "Delete Customer Data", "x-response-key": null, "summary": "/customers/delete_data", "description": "Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).", "operationId": "customersDeleteDataPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_keys": { "type": "array", "items": { "type": "string" }, "description": "List of customer keys to delete all data for." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of space keys to delete." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "List of property keys to delete." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "List of room keys to delete." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "List of common area keys to delete." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unit keys to delete." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "List of facility keys to delete." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "List of building keys to delete." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of listing keys to delete." }, "property_listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of property listing keys to delete." }, "guest_keys": { "type": "array", "items": { "type": "string" }, "description": "List of guest keys to delete." }, "tenant_keys": { "type": "array", "items": { "type": "string" }, "description": "List of tenant keys to delete." }, "resident_keys": { "type": "array", "items": { "type": "string" }, "description": "List of resident keys to delete." }, "user_keys": { "type": "array", "items": { "type": "string" }, "description": "List of user keys to delete." }, "user_identity_keys": { "type": "array", "items": { "type": "string" }, "description": "List of user identity keys to delete." }, "reservation_keys": { "type": "array", "items": { "type": "string" }, "description": "List of reservation keys to delete." }, "booking_keys": { "type": "array", "items": { "type": "string" }, "description": "List of booking keys to delete." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "List of access grant keys to delete." }, "staff_member_keys": { "type": "array", "items": { "type": "string" }, "description": "List of staff member keys to delete." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["customers"], "x-fern-sdk-method-name": "delete_data" } }, "/customers/push_data": { "post": { "x-title": "Push Customer Data", "x-response-key": null, "summary": "/customers/push_data", "description": "Pushes customer data including resources like spaces, properties, rooms, users, etc.", "operationId": "customersPushDataPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "description": "Your unique identifier for the customer.", "type": "string", "minLength": 1 }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "space_key": { "description": "Your unique identifier for the space.", "type": "string", "minLength": 1 }, "parent_site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "space_key"] }, "description": "List of general spaces or areas." }, "sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "site_key"] }, "description": "List of general sites or areas." }, "properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "property_key": { "description": "Your unique identifier for the property.", "type": "string", "minLength": 1 } }, "required": ["name", "property_key"] }, "description": "List of short-term rental properties." }, "rooms": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "room_key": { "description": "Your unique identifier for the room.", "type": "string", "minLength": 1 }, "parent_site_key": { "type": "string", "minLength": 1, "description": "Your unique identifier for the site." } }, "required": ["name", "room_key"] }, "description": "List of hotel or hospitality rooms." }, "common_areas": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "common_area_key": { "description": "Your unique identifier for the common area.", "type": "string", "minLength": 1 }, "parent_site_key": { "type": "string", "minLength": 1, "description": "Your unique identifier for the site." } }, "required": ["name", "common_area_key"] }, "description": "List of shared common areas." }, "units": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "unit_key": { "description": "Your unique identifier for the unit.", "type": "string", "minLength": 1 }, "parent_site_key": { "type": "string", "minLength": 1, "description": "Your unique identifier for the site." } }, "required": ["name", "unit_key"] }, "description": "List of multi-family residential units." }, "facilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "facility_key": { "description": "Your unique identifier for the facility.", "type": "string", "minLength": 1 } }, "required": ["name", "facility_key"] }, "description": "List of gym or fitness facilities." }, "buildings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "building_key": { "description": "Your unique identifier for the building.", "type": "string", "minLength": 1 } }, "required": ["name", "building_key"] }, "description": "List of buildings." }, "listings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "listing_key": { "description": "Your unique identifier for the listing.", "type": "string", "minLength": 1 } }, "required": ["name", "listing_key"] }, "description": "List of property listings." }, "property_listings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "property_listing_key": { "description": "Your unique identifier for the property listing.", "type": "string", "minLength": 1 }, "custom_metadata": { "description": "Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } } }, "required": ["name", "property_listing_key"] }, "description": "List of property listings." }, "guests": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "guest_key": { "description": "Your unique identifier for the guest.", "type": "string", "minLength": 1 } }, "required": ["name", "guest_key"] }, "description": "List of guests." }, "tenants": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "tenant_key": { "description": "Your unique identifier for the tenant.", "type": "string", "minLength": 1 } }, "required": ["name", "tenant_key"] }, "description": "List of tenants." }, "residents": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "resident_key": { "description": "Your unique identifier for the resident.", "type": "string", "minLength": 1 } }, "required": ["name", "resident_key"] }, "description": "List of residents." }, "users": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "user_key": { "description": "Your unique identifier for the user.", "type": "string", "minLength": 1 } }, "required": ["name", "user_key"] }, "description": "List of users." }, "user_identities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "user_identity_key": { "description": "Your unique identifier for the user identity.", "type": "string", "minLength": 1 } }, "required": ["name", "user_identity_key"] }, "description": "List of user identities." }, "staff_members": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the properties the staff member is associated with." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the rooms the staff member is associated with." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the common areas the staff member is associated with." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the units the staff member is associated with." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the facilities the staff member is associated with." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the buildings the staff member is associated with." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the listings the staff member is associated with." }, "property_listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the property listings the staff member is associated with." }, "site_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the sites the staff member is associated with." } }, "required": ["name", "staff_member_key"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." }, "description": "List of staff members." }, "reservations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your name for this access grant resource." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starting date and time for the access grant." }, "ends_at": { "type": "string", "format": "date-time", "description": "Ending date and time for the access grant." }, "preferred_code": { "type": "string", "description": "Preferred PIN code to use when creating access for this reservation." }, "reservation_key": { "description": "Your unique identifier for the reservation.", "type": "string", "minLength": 1 }, "custom_metadata": { "description": "Set key:value pairs for filtering reservations by custom criteria.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } }, "guest_key": { "type": "string", "description": "Guest key associated with the access grant." }, "tenant_key": { "type": "string", "description": "Tenant key associated with the access grant." }, "resident_key": { "type": "string", "description": "Resident key associated with the access grant." }, "user_key": { "type": "string", "description": "User key associated with the access grant." }, "user_identity_key": { "type": "string", "description": "User identity key associated with the access grant." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Space keys associated with the access grant." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "Property keys associated with the access grant." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "Room keys associated with the access grant." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "Common area keys associated with the access grant." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "Unit keys associated with the access grant." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "Facility keys associated with the access grant." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "Building keys associated with the access grant." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "Listing keys associated with the access grant." } }, "required": ["reservation_key"] }, "description": "List of reservations." }, "bookings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your name for this access grant resource." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starting date and time for the access grant." }, "ends_at": { "type": "string", "format": "date-time", "description": "Ending date and time for the access grant." }, "preferred_code": { "type": "string", "description": "Preferred PIN code to use when creating access for this reservation." }, "booking_key": { "description": "Your unique identifier for the booking.", "type": "string", "minLength": 1 }, "guest_key": { "type": "string", "description": "Guest key associated with the access grant." }, "tenant_key": { "type": "string", "description": "Tenant key associated with the access grant." }, "resident_key": { "type": "string", "description": "Resident key associated with the access grant." }, "user_key": { "type": "string", "description": "User key associated with the access grant." }, "user_identity_key": { "type": "string", "description": "User identity key associated with the access grant." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Space keys associated with the access grant." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "Property keys associated with the access grant." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "Room keys associated with the access grant." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "Common area keys associated with the access grant." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "Unit keys associated with the access grant." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "Facility keys associated with the access grant." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "Building keys associated with the access grant." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "Listing keys associated with the access grant." } }, "required": ["booking_key"] }, "description": "List of bookings." }, "access_grants": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your name for this access grant resource." }, "starts_at": { "type": "string", "format": "date-time", "description": "Starting date and time for the access grant." }, "ends_at": { "type": "string", "format": "date-time", "description": "Ending date and time for the access grant." }, "preferred_code": { "type": "string", "description": "Preferred PIN code to use when creating access for this reservation." }, "access_grant_key": { "description": "Your unique identifier for the access grant.", "type": "string", "minLength": 1 }, "guest_key": { "type": "string", "description": "Guest key associated with the access grant." }, "tenant_key": { "type": "string", "description": "Tenant key associated with the access grant." }, "resident_key": { "type": "string", "description": "Resident key associated with the access grant." }, "user_key": { "type": "string", "description": "User key associated with the access grant." }, "user_identity_key": { "type": "string", "description": "User identity key associated with the access grant." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Space keys associated with the access grant." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "Property keys associated with the access grant." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "Room keys associated with the access grant." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "Common area keys associated with the access grant." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "Unit keys associated with the access grant." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "Facility keys associated with the access grant." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "Building keys associated with the access grant." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "Listing keys associated with the access grant." } }, "required": ["access_grant_key"] }, "description": "List of access grants." } }, "required": ["customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["customers"], "x-fern-sdk-method-name": "push_data" } }, "/devices/delete": { "delete": { "x-title": "Delete a Device", "x-response-key": null, "x-undocumented": "Deleting a device is no longer supported and will be removed.", "x-deprecated": "Deleting a device is no longer supported and will be removed.", "summary": "/devices/delete", "description": "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).", "operationId": "devicesDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device that you want to delete." }, "required": true } ], "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Device", "x-response-key": null, "x-undocumented": "Deleting a device is no longer supported and will be removed.", "x-deprecated": "Deleting a device is no longer supported and will be removed.", "summary": "/devices/delete", "description": "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).", "operationId": "devicesDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to delete." } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "delete" } }, "/devices/get": { "get": { "x-title": "Get a Device", "x-response-key": "device", "summary": "/devices/get", "description": "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": ["device", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device that you want to get." } }, { "name": "name", "in": "query", "schema": { "type": "string", "description": "Name of the device that you want to get." } } ], "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device" }, "post": { "x-title": "Get a Device", "x-response-key": "device", "summary": "/devices/get", "description": "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": ["device", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to get." }, "name": { "type": "string", "description": "Name of the device that you want to get." } } } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device" } }, "/devices/list": { "get": { "x-title": "List Devices", "x-response-key": "devices", "summary": "/devices/list", "description": "Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).", "operationId": "devicesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["devices", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list devices." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." } }, { "name": "connected_account_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." } }, { "name": "device_type", "in": "query", "schema": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ], "description": "Device type for which you want to list devices." } }, { "name": "device_types", "in": "query", "schema": { "type": "array", "items": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ] }, "description": "Array of device types for which you want to list devices." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "korelock", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring" ], "description": "Manufacturer for which you want to list devices." } }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, { "name": "include_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "exclude_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "unstable_location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } ], "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" }, "post": { "x-title": "List Devices", "x-response-key": "devices", "summary": "/devices/list", "description": "Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).", "operationId": "devicesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["devices", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list devices." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." }, "device_type": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ], "description": "Device type for which you want to list devices." }, "device_types": { "type": "array", "items": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ] }, "description": "Array of device types for which you want to list devices." }, "manufacturer": { "type": "string", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "korelock", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring" ], "description": "Manufacturer for which you want to list devices." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." }, "user_identifier_key": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "include_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "exclude_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "unstable_location_id": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" } }, "/devices/list_device_providers": { "get": { "x-title": "List Device Providers", "x-response-key": "device_providers", "summary": "/devices/list_device_providers", "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "operationId": "devicesListDeviceProvidersGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "device_providers": { "type": "array", "items": { "$ref": "#/components/schemas/device_provider" } }, "ok": { "type": "boolean" } }, "required": ["device_providers", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "provider_category", "in": "query", "schema": { "type": "string", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras" ], "description": "Category for which you want to list providers." } } ], "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "list_device_providers", "x-fern-sdk-return-value": "device_providers" }, "post": { "x-title": "List Device Providers", "x-response-key": "device_providers", "summary": "/devices/list_device_providers", "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "operationId": "devicesListDeviceProvidersPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "device_providers": { "type": "array", "items": { "$ref": "#/components/schemas/device_provider" } }, "ok": { "type": "boolean" } }, "required": ["device_providers", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "provider_category": { "type": "string", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras" ], "description": "Category for which you want to list providers." } } } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "list_device_providers", "x-fern-sdk-return-value": "device_providers" } }, "/devices/report_provider_metadata": { "post": { "x-title": "Report Provider Metadata", "x-response-key": null, "summary": "/devices/report_provider_metadata", "description": "Updates provider-specific metadata for devices.", "operationId": "devicesReportProviderMetadataPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device to update" }, "ultraloq_metadata": { "type": "object", "properties": { "time_zone": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/La_Rioja", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Katmandu", "Asia/Khandyga", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis" ], "description": "IANA timezone for the Ultraloq device" } }, "required": ["time_zone"], "description": "Ultraloq-specific metadata to update" } }, "required": ["device_id"] }, "minItems": 1, "description": "Array of devices with provider metadata to update" } }, "required": ["devices"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "report_provider_metadata" } }, "/devices/update": { "post": { "x-title": "Update a Device", "x-response-key": null, "summary": "/devices/update", "description": "Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).", "operationId": "devicesUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to update." }, "properties": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name for the device." } } }, "name": { "type": "string", "nullable": true, "description": "Name for the device." }, "is_managed": { "default": true, "type": "boolean", "description": "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update a Device", "x-response-key": null, "summary": "/devices/update", "description": "Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).", "operationId": "devicesUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to update." }, "properties": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name for the device." } } }, "name": { "type": "string", "nullable": true, "description": "Name for the device." }, "is_managed": { "default": true, "type": "boolean", "description": "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices"], "x-fern-sdk-method-name": "update" } }, "/events/get": { "get": { "x-title": "Get an Event", "x-response-key": "event", "summary": "/events/get", "description": "Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to retrieve an event that already took place.", "operationId": "eventsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/event" }, "message": { "type": "string" }, "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "event_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the event that you want to get." } }, { "name": "event_type", "in": "query", "schema": { "type": "string", "description": "Type of the event that you want to get." } }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the device that triggered the event that you want to get." } } ], "tags": ["/events"], "x-fern-sdk-group-name": ["events"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "event" }, "post": { "x-title": "Get an Event", "x-response-key": "event", "summary": "/events/get", "description": "Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to retrieve an event that already took place.", "operationId": "eventsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/event" }, "message": { "type": "string" }, "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the event that you want to get." }, "event_type": { "type": "string", "description": "Type of the event that you want to get." }, "device_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the device that triggered the event that you want to get." } } } } } }, "tags": ["/events"], "x-fern-sdk-group-name": ["events"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "event" } }, "/events/list": { "get": { "x-title": "List Events", "x-response-key": "events", "summary": "/events/list", "description": "Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.", "operationId": "eventsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "ok": { "type": "boolean" } }, "required": ["events", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list events." } }, { "name": "unstable_offset", "in": "query", "schema": { "type": "number", "format": "float", "description": "Offset for the events that you want to list." } }, { "name": "since", "in": "query", "schema": { "type": "string", "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`." } }, { "name": "between", "in": "query", "schema": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "minItems": 2, "maxItems": 2, "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`." } }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list events." } }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices for which you want to list events." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to list events." } }, { "name": "acs_system_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access systems for which you want to list events." } }, { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access code for which you want to list events." } }, { "name": "access_code_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access codes for which you want to list events." } }, { "name": "event_type", "in": "query", "schema": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "description": "Type of the events that you want to list." } }, { "name": "event_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ] }, "description": "Types of the events that you want to list." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list events." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list events." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of events to return." } }, { "name": "event_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the events that you want to list." } }, { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the ACS entrance for which you want to list events." } }, { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the ACS user for which you want to list events." } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to list events." } }, { "name": "access_grant_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access grant for which you want to list events." } }, { "name": "access_grant_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "description": "IDs of the access grants for which you want to list events." } }, { "name": "access_method_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access method for which you want to list events." } }, { "name": "access_method_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "description": "IDs of the access methods for which you want to list events." } }, { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the ACS credential for which you want to list events." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list events." } }, { "name": "space_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "description": "IDs of the spaces for which you want to list events." } }, { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the ACS access group for which you want to list events." } }, { "name": "acs_encoder_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the ACS encoder for which you want to list events." } } ], "tags": ["/events"], "x-fern-sdk-group-name": ["events"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "events" }, "post": { "x-title": "List Events", "x-response-key": "events", "summary": "/events/list", "description": "Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.", "operationId": "eventsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "ok": { "type": "boolean" } }, "required": ["events", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list events." }, "unstable_offset": { "type": "number", "format": "float", "description": "Offset for the events that you want to list." }, "since": { "type": "string", "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`." }, "between": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "minItems": 2, "maxItems": 2, "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list events." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices for which you want to list events." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to list events." }, "acs_system_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access systems for which you want to list events." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code for which you want to list events." }, "access_code_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access codes for which you want to list events." }, "event_type": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "description": "Type of the events that you want to list." }, "event_types": { "type": "array", "items": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ] }, "description": "Types of the events that you want to list." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list events." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list events." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of events to return." }, "event_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the events that you want to list." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the ACS entrance for which you want to list events." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the ACS user for which you want to list events." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to list events." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the access grant for which you want to list events." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "description": "IDs of the access grants for which you want to list events." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method for which you want to list events." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "description": "IDs of the access methods for which you want to list events." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the ACS credential for which you want to list events." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list events." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100, "description": "IDs of the spaces for which you want to list events." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the ACS access group for which you want to list events." }, "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the ACS encoder for which you want to list events." } } } } } }, "tags": ["/events"], "x-fern-sdk-group-name": ["events"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "events" } }, "/instant_keys/delete": { "delete": { "x-title": "Delete an Instant Key", "x-response-key": null, "summary": "/instant_keys/delete", "description": "Deletes a specified [Instant Key](https://docs.seam.co/latest/capability-guides/instant-keys).", "operationId": "instantKeysDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "instant_key_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Instant Key that you want to delete." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["instant_keys"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Instant Key", "x-response-key": null, "summary": "/instant_keys/delete", "description": "Deletes a specified [Instant Key](https://docs.seam.co/latest/capability-guides/instant-keys).", "operationId": "instantKeysDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key_id": { "type": "string", "format": "uuid", "description": "ID of the Instant Key that you want to delete." } }, "required": ["instant_key_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["instant_keys"], "x-fern-sdk-method-name": "delete" } }, "/instant_keys/get": { "get": { "x-title": "Get an Instant Key", "x-response-key": "instant_key", "summary": "/instant_keys/get", "description": "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).", "operationId": "instantKeysGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key": { "$ref": "#/components/schemas/instant_key" }, "ok": { "type": "boolean" } }, "required": ["instant_key", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "instant_key_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the instant key to get." } }, { "name": "instant_key_url", "in": "query", "schema": { "type": "string", "format": "uri", "description": "URL of the instant key to get." } } ], "tags": [], "x-fern-sdk-group-name": ["instant_keys"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "instant_key" }, "post": { "x-title": "Get an Instant Key", "x-response-key": "instant_key", "summary": "/instant_keys/get", "description": "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).", "operationId": "instantKeysGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key": { "$ref": "#/components/schemas/instant_key" }, "ok": { "type": "boolean" } }, "required": ["instant_key", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key_id": { "type": "string", "format": "uuid", "description": "ID of the instant key to get." }, "instant_key_url": { "type": "string", "format": "uri", "description": "URL of the instant key to get." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["instant_keys"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "instant_key" } }, "/instant_keys/list": { "get": { "x-title": "List Instant Keys", "x-response-key": "instant_keys", "summary": "/instant_keys/list", "description": "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).", "operationId": "instantKeysListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "ok": { "type": "boolean" } }, "required": ["instant_keys", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity by which you want to filter the list of Instant Keys." } } ], "tags": [], "x-fern-sdk-group-name": ["instant_keys"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "instant_keys" }, "post": { "x-title": "List Instant Keys", "x-response-key": "instant_keys", "summary": "/instant_keys/list", "description": "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).", "operationId": "instantKeysListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "ok": { "type": "boolean" } }, "required": ["instant_keys", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity by which you want to filter the list of Instant Keys." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["instant_keys"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "instant_keys" } }, "/locks/configure_auto_lock": { "post": { "x-title": "Configure Auto-Lock", "x-response-key": "action_attempt", "x-action-attempt-type": "CONFIGURE_AUTO_LOCK", "summary": "/locks/configure_auto_lock", "description": "Configures the auto-lock setting for a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).", "operationId": "locksConfigureAutoLockPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the lock for which you want to configure the auto-lock." }, "auto_lock_enabled": { "type": "boolean", "description": "Whether to enable or disable auto-lock." }, "auto_lock_delay_seconds": { "type": "number", "format": "float", "minimum": 1, "maximum": 60, "description": "Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60." } }, "required": ["device_id", "auto_lock_enabled"] } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "configure_auto_lock", "x-fern-sdk-return-value": "action_attempt" } }, "/locks/get": { "get": { "x-title": "Get a Lock", "x-deprecated": "Use `/devices/get` instead.", "x-response-key": "device", "summary": "/locks/get", "description": "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).", "operationId": "locksGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "lock": { "$ref": "#/components/schemas/device" }, "device": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": ["lock", "device", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the lock that you want to get." } }, { "name": "name", "in": "query", "schema": { "type": "string", "description": "Name of the lock that you want to get." } } ], "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device" }, "post": { "x-title": "Get a Lock", "x-deprecated": "Use `/devices/get` instead.", "x-response-key": "device", "summary": "/locks/get", "description": "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).", "operationId": "locksGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "lock": { "$ref": "#/components/schemas/device" }, "device": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": ["lock", "device", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the lock that you want to get." }, "name": { "type": "string", "description": "Name of the lock that you want to get." } } } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device" } }, "/locks/list": { "get": { "x-title": "List Locks", "x-response-key": "devices", "summary": "/locks/list", "description": "Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).", "operationId": "locksListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "locks": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "ok": { "type": "boolean" } }, "required": ["locks", "devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list devices." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." } }, { "name": "connected_account_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." } }, { "name": "device_type", "in": "query", "schema": { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type of the locks that you want to list." } }, { "name": "device_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, "description": "Device types of the locks that you want to list." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "enum": [ "akuvox", "august", "brivo", "butterflymx", "avigilon_alta", "doorking", "genie", "igloo", "linear", "lockly", "kwikset", "nuki", "salto", "schlage", "seam", "wyze", "yale", "two_n", "controlbyweb", "ttlock", "igloohome", "four_suites", "dormakaba_oracode", "tedee", "korelock", "akiles", "korelock", "smartthings", "ultraloq" ], "description": "Manufacturer of the locks that you want to list." } }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, { "name": "include_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "exclude_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "unstable_location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } ], "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" }, "post": { "x-title": "List Locks", "x-response-key": "devices", "summary": "/locks/list", "description": "Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).", "operationId": "locksListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "locks": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "ok": { "type": "boolean" } }, "required": ["locks", "devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list devices." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." }, "device_type": { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type of the locks that you want to list." }, "device_types": { "type": "array", "items": { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, "description": "Device types of the locks that you want to list." }, "manufacturer": { "type": "string", "enum": [ "akuvox", "august", "brivo", "butterflymx", "avigilon_alta", "doorking", "genie", "igloo", "linear", "lockly", "kwikset", "nuki", "salto", "schlage", "seam", "wyze", "yale", "two_n", "controlbyweb", "ttlock", "igloohome", "four_suites", "dormakaba_oracode", "tedee", "korelock", "akiles", "korelock", "smartthings", "ultraloq" ], "description": "Manufacturer of the locks that you want to list." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." }, "user_identifier_key": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "include_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "exclude_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "unstable_location_id": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" } }, "/locks/lock_door": { "post": { "x-title": "Lock a Lock", "x-response-key": "action_attempt", "x-action-attempt-type": "LOCK_DOOR", "summary": "/locks/lock_door", "description": "Locks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).", "operationId": "locksLockDoorPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the lock that you want to lock." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "lock_door", "x-fern-sdk-return-value": "action_attempt" } }, "/locks/unlock_door": { "post": { "x-title": "Unlock a Lock", "x-response-key": "action_attempt", "x-action-attempt-type": "UNLOCK_DOOR", "summary": "/locks/unlock_door", "description": "Unlocks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).", "operationId": "locksUnlockDoorPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the lock that you want to unlock." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks"], "x-fern-sdk-method-name": "unlock_door", "x-fern-sdk-return-value": "action_attempt" } }, "/noise_sensors/list": { "get": { "x-title": "List Noise Sensors", "x-response-key": "devices", "summary": "/noise_sensors/list", "description": "Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_sensors": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "ok": { "type": "boolean" } }, "required": ["noise_sensors", "devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list devices." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." } }, { "name": "connected_account_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." } }, { "name": "device_type", "in": "query", "schema": { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type of the noise sensors that you want to list." } }, { "name": "device_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, "description": "Device types of the noise sensors that you want to list." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "enum": ["minut", "noiseaware"], "description": "Manufacturers of the noise sensors that you want to list." } }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, { "name": "include_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "exclude_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "unstable_location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } ], "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" }, "post": { "x-title": "List Noise Sensors", "x-response-key": "devices", "summary": "/noise_sensors/list", "description": "Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_sensors": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "ok": { "type": "boolean" } }, "required": ["noise_sensors", "devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list devices." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." }, "device_type": { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type of the noise sensors that you want to list." }, "device_types": { "type": "array", "items": { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, "description": "Device types of the noise sensors that you want to list." }, "manufacturer": { "type": "string", "enum": ["minut", "noiseaware"], "description": "Manufacturers of the noise sensors that you want to list." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." }, "user_identifier_key": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "include_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "exclude_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "unstable_location_id": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" } }, "/phones/deactivate": { "delete": { "x-response-key": null, "x-title": "Deactivate a Phone", "summary": "/phones/deactivate", "description": "Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).", "operationId": "phonesDeactivateDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID of the phone that you want to deactivate." } }, "required": ["device_id"] } } } }, "tags": ["/phones"], "x-fern-sdk-group-name": ["phones"], "x-fern-sdk-method-name": "deactivate" }, "post": { "x-response-key": null, "x-title": "Deactivate a Phone", "summary": "/phones/deactivate", "description": "Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).", "operationId": "phonesDeactivatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID of the phone that you want to deactivate." } }, "required": ["device_id"] } } } }, "tags": ["/phones"], "x-fern-sdk-group-name": ["phones"], "x-fern-sdk-method-name": "deactivate" } }, "/phones/get": { "get": { "x-response-key": "phone", "x-title": "Get a Phone", "summary": "/phones/get", "description": "Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).", "operationId": "phonesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "$ref": "#/components/schemas/phone" }, "ok": { "type": "boolean" } }, "required": ["phone", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Device ID of the phone that you want to get." }, "required": true } ], "tags": ["/phones"], "x-fern-sdk-group-name": ["phones"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "phone" }, "post": { "x-response-key": "phone", "x-title": "Get a Phone", "summary": "/phones/get", "description": "Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).", "operationId": "phonesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "$ref": "#/components/schemas/phone" }, "ok": { "type": "boolean" } }, "required": ["phone", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "Device ID of the phone that you want to get." } }, "required": ["device_id"] } } } }, "tags": ["/phones"], "x-fern-sdk-group-name": ["phones"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "phone" } }, "/phones/list": { "get": { "x-response-key": "phones", "x-title": "List Phones", "summary": "/phones/list", "description": "Returns a list of all [phones](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.", "operationId": "phonesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "phones": { "type": "array", "items": { "$ref": "#/components/schemas/phone" } }, "ok": { "type": "boolean" } }, "required": ["phones", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "owner_user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity that represents the owner by which you want to filter the list of returned phones." } }, { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones." } } ], "tags": ["/phones"], "x-fern-sdk-group-name": ["phones"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "phones" }, "post": { "x-response-key": "phones", "x-title": "List Phones", "summary": "/phones/list", "description": "Returns a list of all [phones](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.", "operationId": "phonesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "phones": { "type": "array", "items": { "$ref": "#/components/schemas/phone" } }, "ok": { "type": "boolean" } }, "required": ["phones", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owner_user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that represents the owner by which you want to filter the list of returned phones." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones." } } } } } }, "tags": ["/phones"], "x-fern-sdk-group-name": ["phones"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "phones" } }, "/spaces/add_acs_entrances": { "post": { "x-title": "Add Entrances to a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/add_acs_entrances", "description": "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.", "operationId": "spacesAddAcsEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space to which you want to add entrances." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "IDs of the entrances that you want to add to the space." } }, "required": ["space_id", "acs_entrance_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "add_acs_entrances" }, "put": { "x-title": "Add Entrances to a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/add_acs_entrances", "description": "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.", "operationId": "spacesAddAcsEntrancesPut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space to which you want to add entrances." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "IDs of the entrances that you want to add to the space." } }, "required": ["space_id", "acs_entrance_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "add_acs_entrances" } }, "/spaces/add_devices": { "post": { "x-title": "Add Devices to a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/add_devices", "description": "Adds devices to a specific space.", "operationId": "spacesAddDevicesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space to which you want to add devices." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "IDs of the devices that you want to add to the space." } }, "required": ["space_id", "device_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "add_devices" }, "put": { "x-title": "Add Devices to a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/add_devices", "description": "Adds devices to a specific space.", "operationId": "spacesAddDevicesPut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space to which you want to add devices." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "IDs of the devices that you want to add to the space." } }, "required": ["space_id", "device_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "add_devices" } }, "/spaces/create": { "post": { "x-title": "Create a Space", "x-response-key": "space", "x-draft": "Early access.", "summary": "/spaces/create", "description": "Creates a new space.", "operationId": "spacesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "$ref": "#/components/schemas/space" }, "ok": { "type": "boolean" } }, "required": ["space", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the space that you want to create." }, "space_key": { "type": "string", "description": "Unique key for the space within the workspace." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices that you want to add to the new space." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances that you want to add to the new space." }, "customer_key": { "type": "string", "minLength": 1, "description": "Customer key for which you want to create the space." } }, "required": ["name"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "space" } }, "/spaces/delete": { "delete": { "x-title": "Delete a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/delete", "description": "Deletes a space.", "operationId": "spacesDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space that you want to delete." } }, "required": ["space_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/delete", "description": "Deletes a space.", "operationId": "spacesDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space that you want to delete." } }, "required": ["space_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "delete" } }, "/spaces/get": { "get": { "x-title": "Get a Space", "x-response-key": "space", "x-draft": "Early access.", "summary": "/spaces/get", "description": "Gets a space.", "operationId": "spacesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "$ref": "#/components/schemas/space" }, "ok": { "type": "boolean" } }, "required": ["space", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "space" }, "post": { "x-title": "Get a Space", "x-response-key": "space", "x-draft": "Early access.", "summary": "/spaces/get", "description": "Gets a space.", "operationId": "spacesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "$ref": "#/components/schemas/space" }, "ok": { "type": "boolean" } }, "required": ["space", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space that you want to get." } }, "required": ["space_id"] }, { "type": "object", "properties": { "space_key": { "type": "string", "description": "Unique key of the space that you want to get." } }, "required": ["space_key"] } ] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "space" } }, "/spaces/get_related": { "get": { "x-title": "Get related Space resources", "x-response-key": "batch", "x-batch-keys": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "x-draft": "Early access.", "summary": "/spaces/get_related", "description": "Gets all related resources for one or more Spaces.", "operationId": "spacesGetRelatedGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "space_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces that you want to get along with their related resources." } }, { "name": "space_keys", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "Keys of the spaces that you want to get along with their related resources." } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ] } } }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ] } } } ], "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch" }, "post": { "x-title": "Get related Space resources", "x-response-key": "batch", "x-batch-keys": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "x-draft": "Early access.", "summary": "/spaces/get_related", "description": "Gets all related resources for one or more Spaces.", "operationId": "spacesGetRelatedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces that you want to get along with their related resources." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the spaces that you want to get along with their related resources." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ] } }, "exclude": { "type": "array", "items": { "type": "string", "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ] } } } } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch" } }, "/spaces/list": { "get": { "x-title": "List Spaces", "x-response-key": "spaces", "x-draft": "Early access.", "summary": "/spaces/list", "description": "Returns a list of all spaces.", "operationId": "spacesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["spaces", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list spaces." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.", "x-undocumented": "Only used internally.", "x-draft": "Needs review." } }, { "name": "space_key", "in": "query", "schema": { "type": "string", "description": "Filter spaces by space_key." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Maximum number of records to return per page." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "spaces" }, "post": { "x-title": "List Spaces", "x-response-key": "spaces", "x-draft": "Early access.", "summary": "/spaces/list", "description": "Returns a list of all spaces.", "operationId": "spacesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["spaces", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list spaces." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.", "x-undocumented": "Only used internally.", "x-draft": "Needs review." }, "space_key": { "type": "string", "description": "Filter spaces by space_key." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Maximum number of records to return per page." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "spaces" } }, "/spaces/remove_acs_entrances": { "post": { "x-title": "Remove Entrances from a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/remove_acs_entrances", "description": "Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.", "operationId": "spacesRemoveAcsEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space from which you want to remove entrances." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances that you want to remove from the space." } }, "required": ["space_id", "acs_entrance_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "remove_acs_entrances" }, "delete": { "x-title": "Remove Entrances from a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/remove_acs_entrances", "description": "Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.", "operationId": "spacesRemoveAcsEntrancesDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space from which you want to remove entrances." }, "required": true }, { "name": "acs_entrance_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances that you want to remove from the space." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "remove_acs_entrances" } }, "/spaces/remove_devices": { "post": { "x-title": "Remove Devices from a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/remove_devices", "description": "Removes devices from a specific space.", "operationId": "spacesRemoveDevicesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space from which you want to remove devices." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices that you want to remove from the space." } }, "required": ["space_id", "device_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "remove_devices" }, "delete": { "x-title": "Remove Devices from a Space", "x-response-key": null, "x-draft": "Early access.", "summary": "/spaces/remove_devices", "description": "Removes devices from a specific space.", "operationId": "spacesRemoveDevicesDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space from which you want to remove devices." }, "required": true }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices that you want to remove from the space." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "remove_devices" } }, "/spaces/update": { "post": { "x-title": "Update a Space", "x-response-key": "space", "x-draft": "Early access.", "summary": "/spaces/update", "description": "Updates an existing space.", "operationId": "spacesUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "$ref": "#/components/schemas/space" }, "ok": { "type": "boolean" } }, "required": ["space", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the space." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space that you want to update." }, "space_key": { "type": "string", "description": "Unique key of the space that you want to update." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices that you want to set for the space. If specified, this will replace all existing devices." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances." }, "customer_key": { "type": "string", "minLength": 1, "description": "Customer key for which you want to update the space." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "space" }, "patch": { "x-title": "Update a Space", "x-response-key": "space", "x-draft": "Early access.", "summary": "/spaces/update", "description": "Updates an existing space.", "operationId": "spacesUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "$ref": "#/components/schemas/space" }, "ok": { "type": "boolean" } }, "required": ["space", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the space." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space that you want to update." }, "space_key": { "type": "string", "description": "Unique key of the space that you want to update." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices that you want to set for the space. If specified, this will replace all existing devices." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances." }, "customer_key": { "type": "string", "minLength": 1, "description": "Customer key for which you want to update the space." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["spaces"], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "space" } }, "/thermostats/activate_climate_preset": { "post": { "x-title": "Activate a Climate Preset", "x-response-key": "action_attempt", "x-action-attempt-type": "ACTIVATE_CLIMATE_PRESET", "summary": "/thermostats/activate_climate_preset", "description": "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsActivateClimatePresetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to activate a climate preset." }, "climate_preset_key": { "type": "string", "description": "Climate preset key of the climate preset that you want to activate." } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "activate_climate_preset", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/cool": { "post": { "x-title": "Set to Cool Mode", "x-response-key": "action_attempt", "x-action-attempt-type": "SET_HVAC_MODE", "summary": "/thermostats/cool", "description": "Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsCoolPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to set to cool mode." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "cool", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/create_climate_preset": { "post": { "x-title": "Create a Climate Preset", "x-response-key": null, "summary": "/thermostats/create_climate_preset", "description": "Creates a [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsCreateClimatePresetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want create a climate preset." }, "manual_override_allowed": { "default": true, "type": "boolean", "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.", "deprecated": true, "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" }, "climate_preset_key": { "type": "string", "description": "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "name": { "default": null, "type": "string", "nullable": true, "description": "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "climate_preset_mode": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n " }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "ecobee_metadata": { "type": "object", "properties": { "climate_ref": { "type": "string", "description": "Reference to the Ecobee climate, if applicable." }, "is_optimized": { "type": "boolean", "description": "Indicates if the climate preset is optimized by Ecobee." }, "owner": { "type": "string", "enum": ["user", "system"], "description": "Indicates whether the climate preset is owned by the user or the system." } }, "required": ["climate_ref", "is_optimized", "owner"], "description": "\n Metadata specific to the Ecobee climate, if applicable.\n " } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "create_climate_preset" } }, "/thermostats/delete_climate_preset": { "post": { "x-title": "Delete a Climate Preset", "x-response-key": null, "summary": "/thermostats/delete_climate_preset", "description": "Deletes a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsDeleteClimatePresetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to delete a climate preset." }, "climate_preset_key": { "type": "string", "description": "Climate preset key of the climate preset that you want to delete." } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "delete_climate_preset" }, "delete": { "x-title": "Delete a Climate Preset", "x-response-key": null, "summary": "/thermostats/delete_climate_preset", "description": "Deletes a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsDeleteClimatePresetDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to delete a climate preset." }, "climate_preset_key": { "type": "string", "description": "Climate preset key of the climate preset that you want to delete." } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "delete_climate_preset" } }, "/thermostats/get": { "get": { "x-title": "Get a Thermostat", "x-deprecated": "Use `/devices/get` instead.", "x-undocumented": "Will be removed.", "x-response-key": "thermostat", "summary": "/thermostats/get", "description": "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.", "operationId": "thermostatsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": ["thermostat", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to get." } }, { "name": "name", "in": "query", "schema": { "type": "string", "description": "Name of the thermostat device that you want to retrieve." } } ], "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "thermostat" }, "post": { "x-title": "Get a Thermostat", "x-deprecated": "Use `/devices/get` instead.", "x-undocumented": "Will be removed.", "x-response-key": "thermostat", "summary": "/thermostats/get", "description": "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.", "operationId": "thermostatsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": ["thermostat", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to get." }, "name": { "type": "string", "description": "Name of the thermostat device that you want to retrieve." } } } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "thermostat" } }, "/thermostats/heat": { "post": { "x-title": "Set to Heat Mode", "x-response-key": "action_attempt", "x-action-attempt-type": "SET_HVAC_MODE", "summary": "/thermostats/heat", "description": "Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsHeatPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to set to heat mode." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "heat", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/heat_cool": { "post": { "x-title": "Set to Heat-Cool (Auto) Mode", "x-response-key": "action_attempt", "x-action-attempt-type": "SET_HVAC_MODE", "summary": "/thermostats/heat_cool", "description": "Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool (\"auto\") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsHeatCoolPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to set to heat-cool mode." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "heat_cool", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/list": { "get": { "x-title": "List Thermostats", "x-response-key": "devices", "summary": "/thermostats/list", "description": "Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostats": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "ok": { "type": "boolean" } }, "required": ["thermostats", "devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list devices." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." } }, { "name": "connected_account_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." } }, { "name": "device_type", "in": "query", "schema": { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type by which you want to filter thermostat devices." } }, { "name": "device_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, "description": "Array of device types by which you want to filter thermostat devices." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "enum": [ "ecobee", "honeywell_resideo", "nest", "sensi", "smartthings", "tado" ], "description": "Manufacturer by which you want to filter thermostat devices." } }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, { "name": "include_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "exclude_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "unstable_location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } ], "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" }, "post": { "x-title": "List Thermostats", "x-response-key": "devices", "summary": "/thermostats/list", "description": "Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostats": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "ok": { "type": "boolean" } }, "required": ["thermostats", "devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list devices." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." }, "device_type": { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type by which you want to filter thermostat devices." }, "device_types": { "type": "array", "items": { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, "description": "Array of device types by which you want to filter thermostat devices." }, "manufacturer": { "type": "string", "enum": [ "ecobee", "honeywell_resideo", "nest", "sensi", "smartthings", "tado" ], "description": "Manufacturer by which you want to filter thermostat devices." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." }, "user_identifier_key": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "include_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "exclude_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "unstable_location_id": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } } } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" } }, "/thermostats/off": { "post": { "x-title": "Set to Off Mode", "x-response-key": "action_attempt", "x-action-attempt-type": "SET_HVAC_MODE", "summary": "/thermostats/off", "description": "Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [\"off\" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsOffPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to set to off mode." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "off", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/set_fallback_climate_preset": { "post": { "x-title": "Set the Fallback Climate Preset", "x-response-key": null, "summary": "/thermostats/set_fallback_climate_preset", "description": "Sets a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) as the [\"fallback\"](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSetFallbackClimatePresetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the fallback climate preset." }, "climate_preset_key": { "type": "string", "description": "Climate preset key of the climate preset that you want to set as the fallback climate preset." } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "set_fallback_climate_preset" } }, "/thermostats/set_fan_mode": { "post": { "x-title": "Set the Fan Mode Setting", "x-response-key": "action_attempt", "x-action-attempt-type": "SET_FAN_MODE", "summary": "/thermostats/set_fan_mode", "description": "Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSetFanModePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the fan mode." }, "fan_mode": { "type": "string", "enum": ["auto", "on", "circulate"], "deprecated": true, "x-deprecated": "Use `fan_mode_setting` instead." }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "[Fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "set_fan_mode", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/set_hvac_mode": { "post": { "x-title": "Set the HVAC Mode", "x-response-key": "action_attempt", "x-action-attempt-type": "SET_HVAC_MODE", "summary": "/thermostats/set_hvac_mode", "description": "Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSetHvacModePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "propertyName": "hvac_mode_setting" }, "oneOf": [ { "type": "object", "properties": { "hvac_mode_setting": { "type": "string", "enum": ["off"] }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the HVAC mode." } }, "required": ["hvac_mode_setting", "device_id"] }, { "type": "object", "properties": { "hvac_mode_setting": { "type": "string", "enum": ["cool"] }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the HVAC mode." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." } }, "required": ["hvac_mode_setting", "device_id"] }, { "type": "object", "properties": { "hvac_mode_setting": { "type": "string", "enum": ["heat"] }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the HVAC mode." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." } }, "required": ["hvac_mode_setting", "device_id"] }, { "type": "object", "properties": { "hvac_mode_setting": { "type": "string", "enum": ["heat_cool"] }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the HVAC mode." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters." } }, "required": ["hvac_mode_setting", "device_id"] }, { "type": "object", "properties": { "hvac_mode_setting": { "type": "string", "enum": ["eco"] }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set the HVAC mode." } }, "required": ["hvac_mode_setting", "device_id"] } ] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "set_hvac_mode", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/set_temperature_threshold": { "post": { "x-title": "Set a Temperature Threshold", "x-response-key": null, "summary": "/thermostats/set_temperature_threshold", "description": "Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.", "operationId": "thermostatsSetTemperatureThresholdPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set a temperature threshold." }, "lower_limit_celsius": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both." }, "lower_limit_fahrenheit": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both." }, "upper_limit_celsius": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both." }, "upper_limit_fahrenheit": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "set_temperature_threshold" }, "patch": { "x-title": "Set a Temperature Threshold", "x-response-key": null, "summary": "/thermostats/set_temperature_threshold", "description": "Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.", "operationId": "thermostatsSetTemperatureThresholdPatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to set a temperature threshold." }, "lower_limit_celsius": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both." }, "lower_limit_fahrenheit": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both." }, "upper_limit_celsius": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both." }, "upper_limit_fahrenheit": { "default": null, "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "set_temperature_threshold" } }, "/thermostats/update_climate_preset": { "post": { "x-title": "Update a Climate Preset", "x-response-key": null, "summary": "/thermostats/update_climate_preset", "description": "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsUpdateClimatePresetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to update a climate preset." }, "climate_preset_key": { "type": "string", "description": "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "name": { "default": null, "type": "string", "nullable": true, "description": "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "climate_preset_mode": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n " }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "manual_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "deprecated": true, "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" }, "ecobee_metadata": { "type": "object", "properties": { "climate_ref": { "type": "string", "description": "Reference to the Ecobee climate, if applicable." }, "is_optimized": { "type": "boolean", "description": "Indicates if the climate preset is optimized by Ecobee." }, "owner": { "type": "string", "enum": ["user", "system"], "description": "Indicates whether the climate preset is owned by the user or the system." } }, "required": ["climate_ref", "is_optimized", "owner"], "description": "\n Metadata specific to the Ecobee climate, if applicable.\n " } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "update_climate_preset" }, "patch": { "x-title": "Update a Climate Preset", "x-response-key": null, "summary": "/thermostats/update_climate_preset", "description": "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsUpdateClimatePresetPatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to update a climate preset." }, "climate_preset_key": { "type": "string", "description": "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "name": { "default": null, "type": "string", "nullable": true, "description": "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "climate_preset_mode": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n " }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "manual_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "deprecated": true, "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" }, "ecobee_metadata": { "type": "object", "properties": { "climate_ref": { "type": "string", "description": "Reference to the Ecobee climate, if applicable." }, "is_optimized": { "type": "boolean", "description": "Indicates if the climate preset is optimized by Ecobee." }, "owner": { "type": "string", "enum": ["user", "system"], "description": "Indicates whether the climate preset is owned by the user or the system." } }, "required": ["climate_ref", "is_optimized", "owner"], "description": "\n Metadata specific to the Ecobee climate, if applicable.\n " } }, "required": ["device_id", "climate_preset_key"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "update_climate_preset" } }, "/thermostats/update_weekly_program": { "post": { "x-title": "Update the Thermostat Weekly Program", "x-response-key": "action_attempt", "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS", "summary": "/thermostats/update_weekly_program", "description": "Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.", "operationId": "thermostatsUpdateWeeklyProgramPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to update the weekly program." }, "monday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Mondays." }, "tuesday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Tuesdays." }, "wednesday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Wednesdays." }, "thursday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Thursdays." }, "friday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Fridays." }, "saturday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Saturdays." }, "sunday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Sundays." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats"], "x-fern-sdk-method-name": "update_weekly_program", "x-fern-sdk-return-value": "action_attempt" } }, "/user_identities/add_acs_user": { "post": { "x-title": "Add an ACS User to a User Identity", "x-response-key": null, "summary": "/user_identities/add_acs_user", "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).\n\nYou must specify either `user_identity_id` or `user_identity_key` to identify the user identity.\n\nIf `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.", "operationId": "userIdentitiesAddAcsUserPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity to which you want to add an access system user." }, "user_identity_key": { "type": "string", "description": "Key of the user identity to which you want to add an access system user." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to add to the user identity." } }, "required": ["acs_user_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "add_acs_user" }, "put": { "x-title": "Add an ACS User to a User Identity", "x-response-key": null, "summary": "/user_identities/add_acs_user", "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).\n\nYou must specify either `user_identity_id` or `user_identity_key` to identify the user identity.\n\nIf `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.", "operationId": "userIdentitiesAddAcsUserPut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity to which you want to add an access system user." }, "user_identity_key": { "type": "string", "description": "Key of the user identity to which you want to add an access system user." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to add to the user identity." } }, "required": ["acs_user_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "add_acs_user" } }, "/user_identities/create": { "post": { "x-title": "Create a User Identity", "x-response-key": "user_identity", "summary": "/user_identities/create", "description": "Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity": { "$ref": "#/components/schemas/user_identity" }, "ok": { "type": "boolean" } }, "required": ["user_identity", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Unique key for the new user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the new user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the new user identity in E.164 format (for example, +15555550100)." }, "full_name": { "type": "string", "minLength": 1, "nullable": true, "description": "Full name of the user associated with the new user identity." }, "acs_system_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity." } } } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "user_identity" } }, "/user_identities/delete": { "delete": { "x-title": "Delete a User Identity", "x-response-key": null, "summary": "/user_identities/delete", "description": "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).", "operationId": "userIdentitiesDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to delete." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a User Identity", "x-response-key": null, "summary": "/user_identities/delete", "description": "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).", "operationId": "userIdentitiesDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to delete." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "delete" } }, "/user_identities/generate_instant_key": { "post": { "x-title": "Generate an Instant Key", "x-response-key": "instant_key", "summary": "/user_identities/generate_instant_key", "description": "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesGenerateInstantKeyPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key": { "$ref": "#/components/schemas/instant_key" }, "ok": { "type": "boolean" } }, "required": ["instant_key", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile_id": { "type": "string", "format": "uuid" }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to generate an instant key." }, "max_use_count": { "default": 1, "type": "number", "format": "float", "description": "Maximum number of times the instant key can be used. Default: 1." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "generate_instant_key", "x-fern-sdk-return-value": "instant_key" } }, "/user_identities/get": { "get": { "x-title": "Get a User Identity", "x-response-key": "user_identity", "summary": "/user_identities/get", "description": "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity": { "$ref": "#/components/schemas/user_identity" }, "ok": { "type": "boolean" } }, "required": ["user_identity", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "user_identity" }, "post": { "x-title": "Get a User Identity", "x-response-key": "user_identity", "summary": "/user_identities/get", "description": "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity": { "$ref": "#/components/schemas/user_identity" }, "ok": { "type": "boolean" } }, "required": ["user_identity", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to get." } }, "required": ["user_identity_id"] }, { "type": "object", "properties": { "user_identity_key": { "type": "string" } }, "required": ["user_identity_key"] } ] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "user_identity" } }, "/user_identities/grant_access_to_device": { "put": { "x-title": "Grant a User Identity Access to a Device", "x-response-key": null, "summary": "/user_identities/grant_access_to_device", "description": "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).", "operationId": "userIdentitiesGrantAccessToDevicePut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to grant access to a device." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the managed device to which you want to grant access to the user identity." } }, "required": ["user_identity_id", "device_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "grant_access_to_device" }, "post": { "x-title": "Grant a User Identity Access to a Device", "x-response-key": null, "summary": "/user_identities/grant_access_to_device", "description": "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).", "operationId": "userIdentitiesGrantAccessToDevicePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to grant access to a device." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the managed device to which you want to grant access to the user identity." } }, "required": ["user_identity_id", "device_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "grant_access_to_device" } }, "/user_identities/list": { "get": { "x-title": "List User Identities", "x-response-key": "user_identities", "summary": "/user_identities/list", "description": "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["user_identities", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of user identity IDs by which to filter the list of user identities." } }, { "name": "search", "in": "query", "schema": { "type": "string", "description": "String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`." } }, { "name": "credential_manager_acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "`acs_system_id` of the credential manager by which you want to filter the list of user identities." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned user identities. Returns user identities created before this timestamp." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "user_identities" }, "post": { "x-title": "List User Identities", "x-response-key": "user_identities", "summary": "/user_identities/list", "description": "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["user_identities", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of user identity IDs by which to filter the list of user identities." }, "search": { "type": "string", "description": "String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`." }, "credential_manager_acs_system_id": { "type": "string", "format": "uuid", "description": "`acs_system_id` of the credential manager by which you want to filter the list of user identities." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned user identities. Returns user identities created before this timestamp." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "user_identities" } }, "/user_identities/list_accessible_devices": { "get": { "x-title": "List Accessible Devices for a User Identity", "x-response-key": "devices", "summary": "/user_identities/list_accessible_devices", "description": "Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListAccessibleDevicesGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "accessible_devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" }, "deprecated": true, "x-deprecated": "Use devices." }, "ok": { "type": "boolean" } }, "required": ["devices", "accessible_devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all accessible devices." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_accessible_devices", "x-fern-sdk-return-value": "devices" }, "post": { "x-title": "List Accessible Devices for a User Identity", "x-response-key": "devices", "summary": "/user_identities/list_accessible_devices", "description": "Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListAccessibleDevicesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "accessible_devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" }, "deprecated": true, "x-deprecated": "Use devices." }, "ok": { "type": "boolean" } }, "required": ["devices", "accessible_devices", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all accessible devices." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_accessible_devices", "x-fern-sdk-return-value": "devices" } }, "/user_identities/list_accessible_entrances": { "get": { "x-title": "List Accessible Entrances for a User Identity", "x-response-key": "acs_entrances", "summary": "/user_identities/list_accessible_entrances", "description": "Returns a list of all [ACS entrances](https://docs.seam.co/latest/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.", "operationId": "userIdentitiesListAccessibleEntrancesGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all accessible entrances." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" }, "post": { "x-title": "List Accessible Entrances for a User Identity", "x-response-key": "acs_entrances", "summary": "/user_identities/list_accessible_entrances", "description": "Returns a list of all [ACS entrances](https://docs.seam.co/latest/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.", "operationId": "userIdentitiesListAccessibleEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all accessible entrances." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" } }, "/user_identities/list_acs_systems": { "get": { "x-title": "List ACS Systems Associated with a User Identity", "x-response-key": "acs_systems", "summary": "/user_identities/list_acs_systems", "description": "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListAcsSystemsGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "ok": { "type": "boolean" } }, "required": ["acs_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access systems." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_acs_systems", "x-fern-sdk-return-value": "acs_systems" }, "post": { "x-title": "List ACS Systems Associated with a User Identity", "x-response-key": "acs_systems", "summary": "/user_identities/list_acs_systems", "description": "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListAcsSystemsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "ok": { "type": "boolean" } }, "required": ["acs_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access systems." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_acs_systems", "x-fern-sdk-return-value": "acs_systems" } }, "/user_identities/list_acs_users": { "get": { "x-title": "List ACS Users Associated with a User Identity", "x-response-key": "acs_users", "summary": "/user_identities/list_acs_users", "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListAcsUsersGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "ok": { "type": "boolean" } }, "required": ["acs_users", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access system users." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_acs_users", "x-fern-sdk-return-value": "acs_users" }, "post": { "x-title": "List ACS Users Associated with a User Identity", "x-response-key": "acs_users", "summary": "/user_identities/list_acs_users", "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListAcsUsersPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "ok": { "type": "boolean" } }, "required": ["acs_users", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access system users." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "list_acs_users", "x-fern-sdk-return-value": "acs_users" } }, "/user_identities/remove_acs_user": { "delete": { "x-title": "Remove an ACS User from a User Identity", "x-response-key": null, "summary": "/user_identities/remove_acs_user", "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesRemoveAcsUserDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity from which you want to remove an access system user." }, "required": true }, { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to remove from the user identity.." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "remove_acs_user" }, "post": { "x-title": "Remove an ACS User from a User Identity", "x-response-key": null, "summary": "/user_identities/remove_acs_user", "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesRemoveAcsUserPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity from which you want to remove an access system user." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to remove from the user identity.." } }, "required": ["user_identity_id", "acs_user_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "remove_acs_user" } }, "/user_identities/revoke_access_to_device": { "delete": { "x-title": "Revoke Access to a Device from a User Identity", "x-response-key": null, "summary": "/user_identities/revoke_access_to_device", "description": "Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesRevokeAccessToDeviceDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity from which you want to revoke access to a device." }, "required": true }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the managed device to which you want to revoke access from the user identity." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "revoke_access_to_device" }, "post": { "x-title": "Revoke Access to a Device from a User Identity", "x-response-key": null, "summary": "/user_identities/revoke_access_to_device", "description": "Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesRevokeAccessToDevicePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity from which you want to revoke access to a device." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the managed device to which you want to revoke access from the user identity." } }, "required": ["user_identity_id", "device_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "revoke_access_to_device" } }, "/user_identities/update": { "patch": { "x-title": "Update a User Identity", "x-response-key": null, "summary": "/user_identities/update", "description": "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to update." }, "user_identity_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Unique key for the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity." }, "full_name": { "type": "string", "minLength": 1, "nullable": true, "description": "Full name of the user associated with the user identity." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update a User Identity", "x-response-key": null, "summary": "/user_identities/update", "description": "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to update." }, "user_identity_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Unique key for the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity." }, "full_name": { "type": "string", "minLength": 1, "nullable": true, "description": "Full name of the user associated with the user identity." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities"], "x-fern-sdk-method-name": "update" } }, "/webhooks/create": { "post": { "x-title": "Create a Webhook", "x-response-key": "webhook", "summary": "/webhooks/create", "description": "Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/webhook" }, "ok": { "type": "boolean" } }, "required": ["webhook", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "URL for the new webhook." }, "event_types": { "default": ["*"], "type": "array", "items": { "type": "string" }, "description": "Types of events that you want the new webhook to receive." } }, "required": ["url"] } } } }, "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "webhook" } }, "/webhooks/delete": { "delete": { "x-title": "Delete a Webhook", "x-response-key": null, "summary": "/webhooks/delete", "description": "Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "webhook_id", "in": "query", "schema": { "type": "string", "description": "ID of the webhook that you want to delete." }, "required": true } ], "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Webhook", "x-response-key": null, "summary": "/webhooks/delete", "description": "Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook_id": { "type": "string", "description": "ID of the webhook that you want to delete." } }, "required": ["webhook_id"] } } } }, "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "delete" } }, "/webhooks/get": { "get": { "x-title": "Get a Webhook", "x-response-key": "webhook", "summary": "/webhooks/get", "description": "Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/webhook" }, "ok": { "type": "boolean" } }, "required": ["webhook", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "webhook_id", "in": "query", "schema": { "type": "string", "description": "ID of the webhook that you want to get." }, "required": true } ], "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "webhook" }, "post": { "x-title": "Get a Webhook", "x-response-key": "webhook", "summary": "/webhooks/get", "description": "Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/webhook" }, "ok": { "type": "boolean" } }, "required": ["webhook", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook_id": { "type": "string", "description": "ID of the webhook that you want to get." } }, "required": ["webhook_id"] } } } }, "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "webhook" } }, "/webhooks/list": { "get": { "x-title": "List Webhooks", "x-response-key": "webhooks", "summary": "/webhooks/list", "description": "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/webhook" } }, "ok": { "type": "boolean" } }, "required": ["webhooks", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "webhooks" }, "post": { "x-title": "List Webhooks", "x-response-key": "webhooks", "summary": "/webhooks/list", "description": "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/webhook" } }, "ok": { "type": "boolean" } }, "required": ["webhooks", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "webhooks" } }, "/webhooks/update": { "put": { "x-title": "Update a Webhook", "x-response-key": null, "summary": "/webhooks/update", "description": "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksUpdatePut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook_id": { "type": "string", "description": "ID of the webhook that you want to update." }, "event_types": { "type": "array", "items": { "type": "string" }, "description": "Types of events that you want the webhook to receive." } }, "required": ["webhook_id", "event_types"] } } } }, "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update a Webhook", "x-response-key": null, "summary": "/webhooks/update", "description": "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).", "operationId": "webhooksUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook_id": { "type": "string", "description": "ID of the webhook that you want to update." }, "event_types": { "type": "array", "items": { "type": "string" }, "description": "Types of events that you want the webhook to receive." } }, "required": ["webhook_id", "event_types"] } } } }, "tags": ["/webhooks"], "x-fern-sdk-group-name": ["webhooks"], "x-fern-sdk-method-name": "update" } }, "/workspaces/create": { "post": { "x-title": "Create a Workspace", "x-response-key": "workspace", "summary": "/workspaces/create", "description": "Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).", "operationId": "workspacesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "$ref": "#/components/schemas/workspace" }, "ok": { "type": "boolean" } }, "required": ["workspace", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_without_workspace": [] }, { "console_session_with_workspace": [] }, { "console_session_without_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the new workspace." }, "organization_id": { "type": "string", "format": "uuid", "description": "ID of the organization to associate with the new workspace." }, "company_name": { "type": "string", "description": "Company name for the new workspace." }, "connect_partner_name": { "type": "string", "nullable": true, "deprecated": true, "x-deprecated": "Use `company_name` instead.", "description": "Connect partner name for the new workspace." }, "is_sandbox": { "default": false, "type": "boolean", "description": "Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces)." }, "webview_primary_button_color": { "type": "string", "deprecated": true, "x-deprecated": "Use `connect_webview_customization.webview_primary_button_color` instead." }, "webview_primary_button_text_color": { "type": "string", "deprecated": true, "x-deprecated": "Use `connect_webview_customization.webview_primary_button_text_color` instead." }, "webview_logo_shape": { "type": "string", "enum": ["circle", "square"], "deprecated": true, "x-deprecated": "Use `connect_webview_customization.webview_logo_shape` instead." }, "webview_success_message": { "type": "string", "deprecated": true, "x-deprecated": "Use `connect_webview_customization.webview_success_message` instead." }, "connect_webview_customization": { "type": "object", "properties": { "primary_button_color": { "type": "string", "nullable": true, "description": "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "primary_button_text_color": { "type": "string", "nullable": true, "description": "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "success_message": { "type": "string", "nullable": true, "description": "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "logo_shape": { "type": "string", "enum": ["circle", "square"], "nullable": true, "description": "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." } }, "description": "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." } }, "required": ["name"] } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "workspace" } }, "/workspaces/find_anything": { "get": { "x-title": "Find Resources", "x-response-key": "batch", "x-batch-keys": [ "user_identities", "workspaces", "devices", "acs_entrances", "acs_systems", "acs_users", "acs_access_groups", "acs_encoders", "action_attempts", "client_sessions", "unmanaged_acs_users", "unmanaged_acs_access_groups", "unmanaged_devices", "connect_webviews", "spaces", "access_methods", "access_grants", "connected_accounts", "events", "instant_keys", "acs_credentials", "unmanaged_acs_credentials", "unmanaged_access_codes", "access_codes", "thermostat_daily_programs", "thermostat_schedules", "noise_thresholds", "customization_profiles" ], "x-undocumented": "Unreleased.", "summary": "/workspaces/find_anything", "description": "Search for resources inside a workspace.", "operationId": "workspacesFindAnythingGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/workspace" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "acs_encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "action_attempts": { "type": "array", "items": { "$ref": "#/components/schemas/action_attempt" } }, "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "unmanaged_acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_user" } }, "unmanaged_acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_access_group" } }, "unmanaged_devices": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_device" } }, "connect_webviews": { "type": "array", "items": { "$ref": "#/components/schemas/connect_webview" } }, "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "unmanaged_acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_credential" } }, "unmanaged_access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "thermostat_daily_programs": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_daily_program" } }, "thermostat_schedules": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_schedule" } }, "noise_thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/noise_threshold" } }, "customization_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/customization_profile" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "find_anything", "x-fern-sdk-return-value": "batch" }, "post": { "x-title": "Find Resources", "x-response-key": "batch", "x-batch-keys": [ "user_identities", "workspaces", "devices", "acs_entrances", "acs_systems", "acs_users", "acs_access_groups", "acs_encoders", "action_attempts", "client_sessions", "unmanaged_acs_users", "unmanaged_acs_access_groups", "unmanaged_devices", "connect_webviews", "spaces", "access_methods", "access_grants", "connected_accounts", "events", "instant_keys", "acs_credentials", "unmanaged_acs_credentials", "unmanaged_access_codes", "access_codes", "thermostat_daily_programs", "thermostat_schedules", "noise_thresholds", "customization_profiles" ], "x-undocumented": "Unreleased.", "summary": "/workspaces/find_anything", "description": "Search for resources inside a workspace.", "operationId": "workspacesFindAnythingPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/workspace" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "acs_encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "action_attempts": { "type": "array", "items": { "$ref": "#/components/schemas/action_attempt" } }, "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "unmanaged_acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_user" } }, "unmanaged_acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_access_group" } }, "unmanaged_devices": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_device" } }, "connect_webviews": { "type": "array", "items": { "$ref": "#/components/schemas/connect_webview" } }, "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "unmanaged_acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_credential" } }, "unmanaged_access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "thermostat_daily_programs": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_daily_program" } }, "thermostat_schedules": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_schedule" } }, "noise_thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/noise_threshold" } }, "customization_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/customization_profile" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": ["batch", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": "string", "format": "uuid" } }, "required": ["search"] } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "find_anything", "x-fern-sdk-return-value": "batch" } }, "/workspaces/get": { "get": { "x-title": "Get a Workspace", "x-response-key": "workspace", "summary": "/workspaces/get", "description": "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "$ref": "#/components/schemas/workspace" }, "ok": { "type": "boolean" } }, "required": ["workspace", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "workspace" }, "post": { "x-title": "Get a Workspace", "x-response-key": "workspace", "summary": "/workspaces/get", "description": "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "$ref": "#/components/schemas/workspace" }, "ok": { "type": "boolean" } }, "required": ["workspace", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "workspace" } }, "/workspaces/list": { "get": { "x-title": "List Workspaces", "x-response-key": "workspaces", "summary": "/workspaces/list", "description": "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/workspace" } }, "ok": { "type": "boolean" } }, "required": ["workspaces", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "pat_without_workspace": [] }, { "api_key": [] }, { "client_session": [] }, { "console_session_with_workspace": [] }, { "console_session_without_workspace": [] } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "workspaces" }, "post": { "x-title": "List Workspaces", "x-response-key": "workspaces", "summary": "/workspaces/list", "description": "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/workspace" } }, "ok": { "type": "boolean" } }, "required": ["workspaces", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "pat_without_workspace": [] }, { "api_key": [] }, { "client_session": [] }, { "console_session_with_workspace": [] }, { "console_session_without_workspace": [] } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "workspaces" } }, "/workspaces/reset_sandbox": { "post": { "x-title": "Reset a Sandbox Workspace", "x-response-key": "action_attempt", "x-action-attempt-type": "RESET_SANDBOX_WORKSPACE", "summary": "/workspaces/reset_sandbox", "description": "Resets the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.", "operationId": "workspacesResetSandboxPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "reset_sandbox", "x-fern-sdk-return-value": "action_attempt" } }, "/workspaces/update": { "post": { "x-title": "Update a Workspace", "x-response-key": null, "summary": "/workspaces/update", "description": "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesUpdatePost", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "pat_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the workspace." }, "connect_partner_name": { "type": "string", "description": "Connect partner name for the workspace." }, "connect_webview_customization": { "type": "object", "properties": { "primary_button_color": { "type": "string", "nullable": true, "description": "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "primary_button_text_color": { "type": "string", "nullable": true, "description": "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "success_message": { "type": "string", "nullable": true, "description": "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "logo_shape": { "type": "string", "enum": ["circle", "square"], "nullable": true, "description": "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." } }, "description": "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "is_publishable_key_auth_enabled": { "type": "boolean", "description": "Indicates whether publishable key authentication is enabled for this workspace." }, "is_suspended": { "type": "boolean", "description": "Indicates whether the workspace is suspended." } } } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update a Workspace", "x-response-key": null, "summary": "/workspaces/update", "description": "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesUpdatePatch", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "pat_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the workspace." }, "connect_partner_name": { "type": "string", "description": "Connect partner name for the workspace." }, "connect_webview_customization": { "type": "object", "properties": { "primary_button_color": { "type": "string", "nullable": true, "description": "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "primary_button_text_color": { "type": "string", "nullable": true, "description": "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "success_message": { "type": "string", "nullable": true, "description": "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "logo_shape": { "type": "string", "enum": ["circle", "square"], "nullable": true, "description": "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." } }, "description": "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "is_publishable_key_auth_enabled": { "type": "boolean", "description": "Indicates whether publishable key authentication is enabled for this workspace." }, "is_suspended": { "type": "boolean", "description": "Indicates whether the workspace is suspended." } } } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces"], "x-fern-sdk-method-name": "update" } }, "/access_methods/unmanaged/get": { "get": { "x-title": "Get an Unmanaged Access Method", "x-response-key": "access_method", "x-draft": "Early access.", "summary": "/access_methods/unmanaged/get", "description": "Gets an unmanaged access method (where is_managed = false).", "operationId": "accessMethodsUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the access method." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method." }, "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access method was created." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the access method was issued." }, "is_issued": { "type": "boolean", "description": "Indicates whether the access method has been issued." }, "is_encoding_required": { "type": "boolean", "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method." }, "is_ready_for_encoding": { "type": "boolean", "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued." }, "code": { "type": "string", "nullable": true, "description": "The actual PIN code for code access methods." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["pulled_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "original_access_method_id": { "type": "string", "format": "uuid", "description": "ID of the original access method from which this backup access method was split, if applicable." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time." } ], "description": "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "description": "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["provisioning_access"], "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access was provisioned." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access is being provisioned." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of provisioning access for this access method on new devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["revoking_access"], "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access existed." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access should remain." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of revoking access for this access method from devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the access times for this access method." } ] }, "description": "Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress." } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_methods/unmanaged" }, "ok": { "type": "boolean" } }, "required": ["access_method", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "access_method_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of unmanaged access method to get." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["access_methods", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_method" }, "post": { "x-title": "Get an Unmanaged Access Method", "x-response-key": "access_method", "x-draft": "Early access.", "summary": "/access_methods/unmanaged/get", "description": "Gets an unmanaged access method (where is_managed = false).", "operationId": "accessMethodsUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the access method." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method." }, "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access method was created." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the access method was issued." }, "is_issued": { "type": "boolean", "description": "Indicates whether the access method has been issued." }, "is_encoding_required": { "type": "boolean", "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method." }, "is_ready_for_encoding": { "type": "boolean", "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued." }, "code": { "type": "string", "nullable": true, "description": "The actual PIN code for code access methods." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["pulled_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "original_access_method_id": { "type": "string", "format": "uuid", "description": "ID of the original access method from which this backup access method was split, if applicable." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time." } ], "description": "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "description": "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["provisioning_access"], "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access was provisioned." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access is being provisioned." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of provisioning access for this access method on new devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["revoking_access"], "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access existed." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access should remain." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of revoking access for this access method from devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the access times for this access method." } ] }, "description": "Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress." } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_methods/unmanaged" }, "ok": { "type": "boolean" } }, "required": ["access_method", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid", "description": "ID of unmanaged access method to get." } }, "required": ["access_method_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_method" } }, "/access_methods/unmanaged/list": { "get": { "x-title": "List Unmanaged Access Methods", "x-response-key": "access_methods", "x-draft": "Early access.", "summary": "/access_methods/unmanaged/list", "description": "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.", "operationId": "accessMethodsUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the access method." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method." }, "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access method was created." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the access method was issued." }, "is_issued": { "type": "boolean", "description": "Indicates whether the access method has been issued." }, "is_encoding_required": { "type": "boolean", "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method." }, "is_ready_for_encoding": { "type": "boolean", "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued." }, "code": { "type": "string", "nullable": true, "description": "The actual PIN code for code access methods." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["pulled_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "original_access_method_id": { "type": "string", "format": "uuid", "description": "ID of the original access method from which this backup access method was split, if applicable." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time." } ], "description": "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "description": "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["provisioning_access"], "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access was provisioned." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access is being provisioned." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of provisioning access for this access method on new devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["revoking_access"], "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access existed." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access should remain." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of revoking access for this access method from devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the access times for this access method." } ] }, "description": "Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress." } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_methods/unmanaged" } }, "ok": { "type": "boolean" } }, "required": ["access_methods", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_grant_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of Access Grant to list unmanaged access methods for." }, "required": true }, { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to retrieve all unmanaged access methods." }, "required": false }, { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the entrance for which you want to retrieve all unmanaged access methods." }, "required": false }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to retrieve all unmanaged access methods." }, "required": false } ], "tags": [], "x-fern-sdk-group-name": ["access_methods", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_methods" }, "post": { "x-title": "List Unmanaged Access Methods", "x-response-key": "access_methods", "x-draft": "Early access.", "summary": "/access_methods/unmanaged/list", "description": "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.", "operationId": "accessMethodsUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the access method." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method." }, "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access method was created." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the access method was issued." }, "is_issued": { "type": "boolean", "description": "Indicates whether the access method has been issued." }, "is_encoding_required": { "type": "boolean", "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method." }, "is_ready_for_encoding": { "type": "boolean", "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued." }, "code": { "type": "string", "nullable": true, "description": "The actual PIN code for code access methods." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["pulled_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "original_access_method_id": { "type": "string", "format": "uuid", "description": "ID of the original access method from which this backup access method was split, if applicable." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time." } ], "description": "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "description": "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["provisioning_access"], "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access was provisioned." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access is being provisioned." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of provisioning access for this access method on new devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["revoking_access"], "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access existed." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access should remain." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of revoking access for this access method from devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the access times for this access method." } ] }, "description": "Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress." } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_methods/unmanaged" } }, "ok": { "type": "boolean" } }, "required": ["access_methods", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of Access Grant to list unmanaged access methods for." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to retrieve all unmanaged access methods." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance for which you want to retrieve all unmanaged access methods." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to retrieve all unmanaged access methods." } }, "required": ["access_grant_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_methods", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_methods" } }, "/access_grants/unmanaged/get": { "get": { "x-title": "Get an Unmanaged Access Grant", "x-response-key": "access_grant", "x-draft": "Early access.", "summary": "/access_grants/unmanaged/get", "description": "Get an unmanaged Access Grant (where is_managed = false).", "operationId": "accessGrantsUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the Access Grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant." }, "reservation_key": { "type": "string", "description": "Reservation key for the access grant." }, "location_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `space_ids`." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces to which the Access Grant gives access." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the requested access method was added to the Access Grant." }, "created_access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the requested access method." } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ] }, "description": "Access methods that the user requested for the Access Grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the Access Grant." }, "name": { "type": "string", "nullable": true, "description": "Name of the Access Grant. If not provided, the display name will be computed." }, "display_name": { "type": "string", "description": "Display name of the Access Grant." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant was created." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant starts." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the Access Grant ends." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["underprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["overprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "description": "Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["requested_code_unavailable"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device where the requested code was unavailable." }, "original_code": { "type": "string", "description": "The originally requested PIN code that was unavailable." }, "new_code": { "type": "string", "description": "The new PIN code that was assigned instead." } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "device_does_not_support_access_codes" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that does not support access codes." } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization." } ], "description": "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "description": "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": [ "cannot_create_requested_access_methods" ], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "error_code" ] } ] }, "description": "Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_spaces"], "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access codes existed." } }, "required": ["device_ids"], "description": "Previous location configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access codes should be created." }, "common_code_key": { "type": "string", "nullable": true, "description": "Common code key to ensure PIN code reuse across devices." } }, "required": ["device_ids"], "description": "New location configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the devices/spaces associated with this access grant." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "description": "Seam is in the process of updating the access times for this access grant." } ] }, "description": "List of pending mutations for the access grant. This shows updates that are in progress." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity to which the Access Grant gives access." } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_grants/unmanaged" }, "ok": { "type": "boolean" } }, "required": ["access_grant", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "access_grant_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of unmanaged Access Grant to get." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["access_grants", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_grant" }, "post": { "x-title": "Get an Unmanaged Access Grant", "x-response-key": "access_grant", "x-draft": "Early access.", "summary": "/access_grants/unmanaged/get", "description": "Get an unmanaged Access Grant (where is_managed = false).", "operationId": "accessGrantsUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the Access Grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant." }, "reservation_key": { "type": "string", "description": "Reservation key for the access grant." }, "location_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `space_ids`." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces to which the Access Grant gives access." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the requested access method was added to the Access Grant." }, "created_access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the requested access method." } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ] }, "description": "Access methods that the user requested for the Access Grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the Access Grant." }, "name": { "type": "string", "nullable": true, "description": "Name of the Access Grant. If not provided, the display name will be computed." }, "display_name": { "type": "string", "description": "Display name of the Access Grant." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant was created." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant starts." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the Access Grant ends." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["underprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["overprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "description": "Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["requested_code_unavailable"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device where the requested code was unavailable." }, "original_code": { "type": "string", "description": "The originally requested PIN code that was unavailable." }, "new_code": { "type": "string", "description": "The new PIN code that was assigned instead." } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "device_does_not_support_access_codes" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that does not support access codes." } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization." } ], "description": "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "description": "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": [ "cannot_create_requested_access_methods" ], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "error_code" ] } ] }, "description": "Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_spaces"], "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access codes existed." } }, "required": ["device_ids"], "description": "Previous location configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access codes should be created." }, "common_code_key": { "type": "string", "nullable": true, "description": "Common code key to ensure PIN code reuse across devices." } }, "required": ["device_ids"], "description": "New location configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the devices/spaces associated with this access grant." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "description": "Seam is in the process of updating the access times for this access grant." } ] }, "description": "List of pending mutations for the access grant. This shows updates that are in progress." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity to which the Access Grant gives access." } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_grants/unmanaged" }, "ok": { "type": "boolean" } }, "required": ["access_grant", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of unmanaged Access Grant to get." } }, "required": ["access_grant_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_grant" } }, "/access_grants/unmanaged/list": { "get": { "x-title": "List Unmanaged Access Grants", "x-response-key": "access_grants", "x-draft": "Early access.", "summary": "/access_grants/unmanaged/list", "description": "Gets unmanaged Access Grants (where is_managed = false).", "operationId": "accessGrantsUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the Access Grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant." }, "reservation_key": { "type": "string", "description": "Reservation key for the access grant." }, "location_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `space_ids`." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces to which the Access Grant gives access." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the requested access method was added to the Access Grant." }, "created_access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the requested access method." } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ] }, "description": "Access methods that the user requested for the Access Grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the Access Grant." }, "name": { "type": "string", "nullable": true, "description": "Name of the Access Grant. If not provided, the display name will be computed." }, "display_name": { "type": "string", "description": "Display name of the Access Grant." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant was created." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant starts." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the Access Grant ends." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["underprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["overprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "description": "Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["requested_code_unavailable"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device where the requested code was unavailable." }, "original_code": { "type": "string", "description": "The originally requested PIN code that was unavailable." }, "new_code": { "type": "string", "description": "The new PIN code that was assigned instead." } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "device_does_not_support_access_codes" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that does not support access codes." } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization." } ], "description": "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "description": "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": [ "cannot_create_requested_access_methods" ], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "error_code" ] } ] }, "description": "Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_spaces"], "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access codes existed." } }, "required": ["device_ids"], "description": "Previous location configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access codes should be created." }, "common_code_key": { "type": "string", "nullable": true, "description": "Common code key to ensure PIN code reuse across devices." } }, "required": ["device_ids"], "description": "New location configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the devices/spaces associated with this access grant." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "description": "Seam is in the process of updating the access times for this access grant." } ] }, "description": "List of pending mutations for the access grant. This shows updates that are in progress." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity to which the Access Grant gives access." } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_grants/unmanaged" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_grants", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of user identity by which you want to filter the list of unmanaged Access Grants." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system by which you want to filter the list of unmanaged Access Grants." } }, { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the entrance by which you want to filter the list of unmanaged Access Grants." } }, { "name": "reservation_key", "in": "query", "schema": { "type": "string", "description": "Filter unmanaged Access Grants by reservation_key." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of unmanaged access grants to return." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": [], "x-fern-sdk-group-name": ["access_grants", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants" }, "post": { "x-title": "List Unmanaged Access Grants", "x-response-key": "access_grants", "x-draft": "Early access.", "summary": "/access_grants/unmanaged/list", "description": "Gets unmanaged Access Grants (where is_managed = false).", "operationId": "accessGrantsUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the Access Grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant." }, "reservation_key": { "type": "string", "description": "Reservation key for the access grant." }, "location_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `space_ids`." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces to which the Access Grant gives access." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the requested access method was added to the Access Grant." }, "created_access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the requested access method." } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ] }, "description": "Access methods that the user requested for the Access Grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the Access Grant." }, "name": { "type": "string", "nullable": true, "description": "Name of the Access Grant. If not provided, the display name will be computed." }, "display_name": { "type": "string", "description": "Display name of the Access Grant." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant was created." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant starts." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the Access Grant ends." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["underprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["overprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "description": "Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["requested_code_unavailable"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device where the requested code was unavailable." }, "original_code": { "type": "string", "description": "The originally requested PIN code that was unavailable." }, "new_code": { "type": "string", "description": "The new PIN code that was assigned instead." } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "device_does_not_support_access_codes" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that does not support access codes." } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization." } ], "description": "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "description": "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": [ "cannot_create_requested_access_methods" ], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "error_code" ] } ] }, "description": "Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_spaces"], "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access codes existed." } }, "required": ["device_ids"], "description": "Previous location configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access codes should be created." }, "common_code_key": { "type": "string", "nullable": true, "description": "Common code key to ensure PIN code reuse across devices." } }, "required": ["device_ids"], "description": "New location configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the devices/spaces associated with this access grant." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "description": "Seam is in the process of updating the access times for this access grant." } ] }, "description": "List of pending mutations for the access grant. This shows updates that are in progress." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity to which the Access Grant gives access." } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "x-draft": "Early access.", "x-route-path": "/access_grants/unmanaged" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_grants", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity by which you want to filter the list of unmanaged Access Grants." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system by which you want to filter the list of unmanaged Access Grants." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance by which you want to filter the list of unmanaged Access Grants." }, "reservation_key": { "type": "string", "description": "Filter unmanaged Access Grants by reservation_key." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of unmanaged access grants to return." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants" } }, "/access_grants/unmanaged/update": { "patch": { "x-title": "Update an Unmanaged Access Grant", "x-response-key": null, "x-draft": "Early access.", "summary": "/access_grants/unmanaged/update", "description": "Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.", "operationId": "accessGrantsUnmanagedUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged Access Grant to update." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Must be set to true to convert the unmanaged access grant to managed." }, "access_grant_key": { "type": "string", "description": "Unique key for the access grant. If not provided, the existing key will be preserved." } }, "required": ["access_grant_id", "is_managed"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants", "unmanaged"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update an Unmanaged Access Grant", "x-response-key": null, "x-draft": "Early access.", "summary": "/access_grants/unmanaged/update", "description": "Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.", "operationId": "accessGrantsUnmanagedUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged Access Grant to update." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Must be set to true to convert the unmanaged access grant to managed." }, "access_grant_key": { "type": "string", "description": "Unique key for the access grant. If not provided, the existing key will be preserved." } }, "required": ["access_grant_id", "is_managed"] } } } }, "tags": [], "x-fern-sdk-group-name": ["access_grants", "unmanaged"], "x-fern-sdk-method-name": "update" } }, "/acs/credential_pools/list": { "get": { "x-title": "List Credential Pools", "x-deprecated": "Use `/user_identities/enrollment_automations/list` instead.", "x-undocumented": "Replaced by enrollment automations.", "x-response-key": "acs_credential_pools", "summary": "/acs/credential_pools/list", "description": "Returns a list of all credential pools.", "operationId": "acsCredentialPoolsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_pools": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential_pool" } }, "ok": { "type": "boolean" } }, "required": ["acs_credential_pools", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to list credential pools." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credential_pools"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credential_pools" }, "post": { "x-title": "List Credential Pools", "x-deprecated": "Use `/user_identities/enrollment_automations/list` instead.", "x-undocumented": "Replaced by enrollment automations.", "x-response-key": "acs_credential_pools", "summary": "/acs/credential_pools/list", "description": "Returns a list of all credential pools.", "operationId": "acsCredentialPoolsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_pools": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential_pool" } }, "ok": { "type": "boolean" } }, "required": ["acs_credential_pools", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to list credential pools." } }, "required": ["acs_system_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credential_pools"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credential_pools" } }, "/acs/access_groups/add_user": { "put": { "x-title": "Add an ACS User to an Access Group", "x-response-key": null, "summary": "/acs/access_groups/add_user", "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsAddUserPut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group to which you want to add an access system user." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "add_user" }, "post": { "x-title": "Add an ACS User to an Access Group", "x-response-key": null, "summary": "/acs/access_groups/add_user", "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsAddUserPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group to which you want to add an access system user." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "add_user" } }, "/acs/access_groups/delete": { "delete": { "x-title": "Delete an Access Group", "x-response-key": null, "summary": "/acs/access_groups/delete", "description": "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access group that you want to delete." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Access Group", "x-response-key": null, "summary": "/acs/access_groups/delete", "description": "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group that you want to delete." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "delete" } }, "/acs/access_groups/get": { "get": { "x-title": "Get an Access Group", "x-response-key": "acs_access_group", "summary": "/acs/access_groups/get", "description": "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group": { "$ref": "#/components/schemas/acs_access_group" }, "ok": { "type": "boolean" } }, "required": ["acs_access_group", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access group that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_access_group" }, "post": { "x-title": "Get an Access Group", "x-response-key": "acs_access_group", "summary": "/acs/access_groups/get", "description": "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group": { "$ref": "#/components/schemas/acs_access_group" }, "ok": { "type": "boolean" } }, "required": ["acs_access_group", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group that you want to get." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_access_group" } }, "/acs/access_groups/list": { "get": { "x-title": "List Access Groups", "x-response-key": "acs_access_groups", "summary": "/acs/access_groups/list", "description": "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "ok": { "type": "boolean" } }, "required": ["acs_access_groups", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all access groups." } }, { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all access groups." } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access groups." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_access_groups" }, "post": { "x-title": "List Access Groups", "x-response-key": "acs_access_groups", "summary": "/acs/access_groups/list", "description": "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "ok": { "type": "boolean" } }, "required": ["acs_access_groups", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all access groups." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all access groups." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access groups." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_access_groups" } }, "/acs/access_groups/list_accessible_entrances": { "get": { "x-title": "List Entrances Accessible to an Access Group", "x-response-key": "acs_entrances", "summary": "/acs/access_groups/list_accessible_entrances", "description": "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListAccessibleEntrancesGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access group for which you want to retrieve all accessible entrances." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" }, "post": { "x-title": "List Entrances Accessible to an Access Group", "x-response-key": "acs_entrances", "summary": "/acs/access_groups/list_accessible_entrances", "description": "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListAccessibleEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group for which you want to retrieve all accessible entrances." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" } }, "/acs/access_groups/list_users": { "get": { "x-title": "List ACS Users in an Access Group", "x-response-key": "acs_users", "summary": "/acs/access_groups/list_users", "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListUsersGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "ok": { "type": "boolean" } }, "required": ["acs_users", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access group for which you want to retrieve all access system users." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "list_users", "x-fern-sdk-return-value": "acs_users" }, "post": { "x-title": "List ACS Users in an Access Group", "x-response-key": "acs_users", "summary": "/acs/access_groups/list_users", "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListUsersPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "ok": { "type": "boolean" } }, "required": ["acs_users", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group for which you want to retrieve all access system users." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "list_users", "x-fern-sdk-return-value": "acs_users" } }, "/acs/access_groups/remove_user": { "delete": { "x-title": "Remove an ACS User from an Access Group", "x-response-key": null, "summary": "/acs/access_groups/remove_user", "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsRemoveUserDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access group from which you want to remove an access system user." }, "required": true }, { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to remove from an access group." }, "required": false }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity associated with the user that you want to remove from an access group." }, "required": false } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "remove_user" }, "post": { "x-title": "Remove an ACS User from an Access Group", "x-response-key": null, "summary": "/acs/access_groups/remove_user", "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsRemoveUserPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group from which you want to remove an access system user." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to remove from an access group." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity associated with the user that you want to remove from an access group." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups"], "x-fern-sdk-method-name": "remove_user" } }, "/acs/credential_provisioning_automations/launch": { "post": { "x-title": "Launch a Credential Provisioning Automation", "x-deprecated": "Use `/user_identities/enrollment_automations/launch` instead.", "x-undocumented": "Replaced by enrollment automations.", "x-response-key": "acs_credential_provisioning_automation", "summary": "/acs/credential_provisioning_automations/launch", "description": "Launches a credential provisioning automation.", "operationId": "acsCredentialProvisioningAutomationsLaunchPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_provisioning_automation": { "$ref": "#/components/schemas/acs_credential_provisioning_automation" }, "ok": { "type": "boolean" } }, "required": ["acs_credential_provisioning_automation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to launch a credential provisioning automation." }, "credential_manager_acs_system_id": { "type": "string", "format": "uuid", "description": "Access system ID of the credential manager for which you want to launch a credential provisioning automation." }, "acs_credential_pool_id": { "type": "string", "format": "uuid", "description": "ID of the credential pool for which you want to launch a credential provisioning automation." }, "create_credential_manager_user": { "type": "boolean", "description": "Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`." }, "credential_manager_acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`." } }, "required": [ "user_identity_id", "credential_manager_acs_system_id" ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credential_provisioning_automations"], "x-fern-sdk-method-name": "launch", "x-fern-sdk-return-value": "acs_credential_provisioning_automation" } }, "/acs/credentials/assign": { "patch": { "x-title": "Assign a Credential to an ACS User", "x-response-key": null, "summary": "/acs/credentials/assign", "description": "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsCredentialsAssignPatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to assign to an access system user." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "assign" }, "post": { "x-title": "Assign a Credential to an ACS User", "x-response-key": null, "summary": "/acs/credentials/assign", "description": "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsCredentialsAssignPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to assign to an access system user." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "assign" } }, "/acs/credentials/create": { "post": { "x-title": "Create a Credential for an ACS User", "x-response-key": "acs_credential", "summary": "/acs/credentials/create", "description": "Creates a new [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsCredentialsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "credential_manager_acs_system_id": { "type": "string", "format": "uuid", "description": "ACS system ID of the credential manager for the new credential." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "pattern": "^\\d+$", "description": "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview)." }, "is_multi_phone_sync_credential": { "default": false, "type": "boolean", "description": "Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "allowed_acs_entrance_ids": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Set of IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access." }, "visionline_metadata": { "type": "object", "properties": { "assa_abloy_credential_service_mobile_endpoint_id": { "type": "string", "format": "uuid", "deprecated": true, "x-deprecated": "Read-only endpoint references moved to `endpoint`.", "x-undocumented": "Deprecated. Read-only endpoint references moved to `endpoint`." }, "card_format": { "type": "string", "enum": ["TLCode", "rfid48"] }, "card_function_type": { "default": "guest", "type": "string", "enum": ["guest", "staff"] }, "is_override_key": { "type": "boolean", "deprecated": true, "x-deprecated": "Use `override` instead.", "x-undocumented": "Use `override` instead." }, "override": { "type": "boolean" }, "auto_join": { "type": "boolean" }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "description": "Visionline-specific metadata for the new credential." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean" }, "override_all_guest_acs_entrances": { "type": "boolean" }, "join_all_guest_acs_entrances": { "type": "boolean" }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "description": "Vostio-specific metadata for the new credential." }, "hotek_metadata": { "type": "object", "properties": { "override": { "type": "boolean" }, "auto_join": { "type": "boolean" } }, "x-undocumented": "in development" }, "salto_space_metadata": { "type": "object", "properties": { "assign_new_key": { "type": "boolean", "description": "Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials)." }, "update_current_key": { "type": "boolean", "description": "Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).", "x-undocumented": "Not used. Will be deprecated." } }, "description": "Salto Space-specific metadata for the new credential." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." } }, "required": ["access_method"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "acs_credential" } }, "/acs/credentials/create_offline_code": { "post": { "x-title": "Create an Offline Credential for an ACS User", "x-undocumented": "Unreleased.", "x-response-key": "acs_credential", "summary": "/acs/credentials/create_offline_code", "description": "Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsCredentialsCreateOfflineCodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user to whom the new credential belongs." }, "allowed_acs_entrance_id": { "type": "string", "format": "uuid", "description": "IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access." }, "is_one_time_use": { "default": false, "type": "boolean", "description": "Indicates whether the code is one-time-use or reusable." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." } }, "required": ["acs_user_id", "allowed_acs_entrance_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "create_offline_code", "x-fern-sdk-return-value": "acs_credential" } }, "/acs/credentials/delete": { "delete": { "x-title": "Delete a Credential", "x-response-key": null, "summary": "/acs/credentials/delete", "description": "Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to delete." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Credential", "x-response-key": null, "summary": "/acs/credentials/delete", "description": "Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to delete." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "delete" } }, "/acs/credentials/get": { "get": { "x-title": "Get a Credential", "x-response-key": "acs_credential", "summary": "/acs/credentials/get", "description": "Returns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_credential" }, "post": { "x-title": "Get a Credential", "x-response-key": "acs_credential", "summary": "/acs/credentials/get", "description": "Returns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to get." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_credential" } }, "/acs/credentials/list": { "get": { "x-title": "List Credentials", "x-response-key": "acs_credentials", "summary": "/acs/credentials/list", "description": "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials" }, "post": { "x-title": "List Credentials", "x-response-key": "acs_credentials", "summary": "/acs/credentials/list", "description": "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all credentials." } }, "required": ["acs_user_id"] }, { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all credentials." } }, "required": ["acs_system_id"] }, { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all credentials." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all credentials." } }, "required": ["acs_user_id", "acs_system_id"] }, { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all credentials." } }, "required": ["user_identity_id"] }, { "type": "object", "properties": {} } ] }, { "type": "object", "properties": { "limit": { "default": 500, "type": "number", "format": "float", "description": "Number of credentials to return." }, "created_before": { "type": "string", "format": "date-time", "description": "Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials" } }, "/acs/credentials/list_accessible_entrances": { "get": { "x-title": "List Accessible Entrances", "x-response-key": "acs_entrances", "summary": "/acs/credentials/list_accessible_entrances", "description": "Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.", "operationId": "acsCredentialsListAccessibleEntrancesGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the credential for which you want to retrieve all entrances to which the credential grants access." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" }, "post": { "x-title": "List Accessible Entrances", "x-response-key": "acs_entrances", "summary": "/acs/credentials/list_accessible_entrances", "description": "Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.", "operationId": "acsCredentialsListAccessibleEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential for which you want to retrieve all entrances to which the credential grants access." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" } }, "/acs/credentials/unassign": { "patch": { "x-title": "Unassign a Credential from an ACS User", "x-response-key": null, "summary": "/acs/credentials/unassign", "description": "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsCredentialsUnassignPatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to unassign from an access system user." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "unassign" }, "post": { "x-title": "Unassign a Credential from an ACS User", "x-response-key": null, "summary": "/acs/credentials/unassign", "description": "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsCredentialsUnassignPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential that you want to unassign from an access system user." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "unassign" } }, "/acs/credentials/update": { "patch": { "x-title": "Update a Credential", "x-response-key": null, "summary": "/acs/credentials/update", "description": "Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "description": "ID of the credential that you want to update." }, "code": { "type": "string", "pattern": "^\\d+$", "description": "Replacement access (PIN) code for the credential that you want to update." }, "ends_at": { "type": "string", "format": "date-time", "description": "Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update a Credential", "x-response-key": null, "summary": "/acs/credentials/update", "description": "Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "description": "ID of the credential that you want to update." }, "code": { "type": "string", "pattern": "^\\d+$", "description": "Replacement access (PIN) code for the credential that you want to update." }, "ends_at": { "type": "string", "format": "date-time", "description": "Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials"], "x-fern-sdk-method-name": "update" } }, "/acs/encoders/encode_credential": { "post": { "x-title": "Encode a Credential", "x-response-key": "action_attempt", "x-action-attempt-type": "ENCODE_CREDENTIAL", "summary": "/acs/encoders/encode_credential", "description": "Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`", "operationId": "acsEncodersEncodeCredentialPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` to use to encode the `acs_credential`." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_credential` to encode onto a card." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the `access_method` to encode onto a card." } }, "required": ["acs_encoder_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders"], "x-fern-sdk-method-name": "encode_credential", "x-fern-sdk-return-value": "action_attempt" } }, "/acs/encoders/get": { "get": { "x-title": "Get an Encoder", "x-response-key": "acs_encoder", "summary": "/acs/encoders/get", "description": "Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder": { "$ref": "#/components/schemas/acs_encoder" }, "ok": { "type": "boolean" } }, "required": ["acs_encoder", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_encoder_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the encoder that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_encoder" }, "post": { "x-title": "Get an Encoder", "x-response-key": "acs_encoder", "summary": "/acs/encoders/get", "description": "Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder": { "$ref": "#/components/schemas/acs_encoder" }, "ok": { "type": "boolean" } }, "required": ["acs_encoder", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the encoder that you want to get." } }, "required": ["acs_encoder_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_encoder" } }, "/acs/encoders/list": { "get": { "x-title": "List Encoders", "x-response-key": "acs_encoders", "summary": "/acs/encoders/list", "description": "Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_encoders", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_encoders" }, "post": { "x-title": "List Encoders", "x-response-key": "acs_encoders", "summary": "/acs/encoders/list", "description": "Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_encoders", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all encoders." } }, "required": ["acs_system_id"] }, { "type": "object", "properties": { "acs_system_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access systems for which you want to retrieve all encoders." } }, "required": ["acs_system_ids"] }, { "type": "object", "properties": { "acs_encoder_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the encoders that you want to retrieve." } }, "required": ["acs_encoder_ids"] } ] }, { "type": "object", "properties": { "limit": { "default": 500, "type": "number", "format": "float", "description": "Number of encoders to return." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_encoders" } }, "/acs/encoders/scan_credential": { "post": { "x-title": "Scan a Credential", "x-response-key": "action_attempt", "x-action-attempt-type": "SCAN_CREDENTIAL", "summary": "/acs/encoders/scan_credential", "description": "Scans an encoded [acs_credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersScanCredentialPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the encoder to use for the scan." } }, "required": ["acs_encoder_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders"], "x-fern-sdk-method-name": "scan_credential", "x-fern-sdk-return-value": "action_attempt" } }, "/acs/systems/get": { "get": { "x-title": "Get an ACS System", "x-response-key": "acs_system", "summary": "/acs/systems/get", "description": "Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).", "operationId": "acsSystemsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system": { "$ref": "#/components/schemas/acs_system" }, "ok": { "type": "boolean" } }, "required": ["acs_system", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_system" }, "post": { "x-title": "Get an ACS System", "x-response-key": "acs_system", "summary": "/acs/systems/get", "description": "Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).", "operationId": "acsSystemsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system": { "$ref": "#/components/schemas/acs_system" }, "ok": { "type": "boolean" } }, "required": ["acs_system", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to get." } }, "required": ["acs_system_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_system" } }, "/acs/systems/list": { "get": { "x-title": "List ACS Systems", "x-response-key": "acs_systems", "summary": "/acs/systems/list", "description": "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.", "operationId": "acsSystemsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "ok": { "type": "boolean" } }, "required": ["acs_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list access systems." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account by which you want to filter the list of access systems." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access systems to include all records that satisfy a partial match using `name` or `acs_system_id`." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_systems" }, "post": { "x-title": "List ACS Systems", "x-response-key": "acs_systems", "summary": "/acs/systems/list", "description": "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.", "operationId": "acsSystemsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "ok": { "type": "boolean" } }, "required": ["acs_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list access systems." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account by which you want to filter the list of access systems." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access systems to include all records that satisfy a partial match using `name` or `acs_system_id`." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_systems" } }, "/acs/systems/list_compatible_credential_manager_acs_systems": { "get": { "x-title": "List Compatible Credential Manager ACS Systems", "x-response-key": "acs_systems", "summary": "/acs/systems/list_compatible_credential_manager_acs_systems", "description": "Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.", "operationId": "acsSystemsListCompatibleCredentialManagerAcsSystemsGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "ok": { "type": "boolean" } }, "required": ["acs_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all compatible credential manager systems." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "list_compatible_credential_manager_acs_systems", "x-fern-sdk-return-value": "acs_systems" }, "post": { "x-title": "List Compatible Credential Manager ACS Systems", "x-response-key": "acs_systems", "summary": "/acs/systems/list_compatible_credential_manager_acs_systems", "description": "Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.", "operationId": "acsSystemsListCompatibleCredentialManagerAcsSystemsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "ok": { "type": "boolean" } }, "required": ["acs_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all compatible credential manager systems." } }, "required": ["acs_system_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "list_compatible_credential_manager_acs_systems", "x-fern-sdk-return-value": "acs_systems" } }, "/acs/systems/report_devices": { "post": { "x-title": "Report Devices", "x-response-key": null, "summary": "/acs/systems/report_devices", "description": "Reports ACS system device status including encoders and entrances.", "operationId": "acsSystemsReportDevicesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the ACS system to report resources for" }, "acs_encoders": { "default": [], "type": "array", "items": { "type": "object", "properties": { "is_removed": { "default": false, "type": "boolean", "description": "Whether the encoder is removed" }, "hotek_metadata": { "type": "object", "properties": { "encoder_number": { "type": "string", "description": "The encoder number determined by the USB port connection." } }, "required": ["encoder_number"], "description": "Hotek-specific metadata associated with the entrance." } }, "required": ["hotek_metadata"] }, "description": "Array of ACS encoders to report" }, "acs_entrances": { "default": [], "type": "array", "items": { "type": "object", "properties": { "is_removed": { "default": false, "type": "boolean", "description": "Whether the entrance is removed" }, "hotek_metadata": { "description": "Hotek-specific metadata associated with the entrance.", "type": "object", "properties": { "room_number": { "type": "string", "description": "The room number identifier" }, "common_area_name": { "type": "string", "description": "The common area name" }, "common_area_number": { "type": "string", "description": "The room number identifier" } } } }, "required": ["hotek_metadata"] }, "description": "Array of ACS entrances to report" } }, "required": ["acs_system_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "systems"], "x-fern-sdk-method-name": "report_devices" } }, "/acs/entrances/get": { "get": { "x-title": "Get an Entrance", "x-response-key": "acs_entrance", "summary": "/acs/entrances/get", "description": "Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrance": { "$ref": "#/components/schemas/acs_entrance" }, "ok": { "type": "boolean" } }, "required": ["acs_entrance", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "access_token": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "client_session": [] } ], "parameters": [ { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the entrance that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_entrance" }, "post": { "x-title": "Get an Entrance", "x-response-key": "acs_entrance", "summary": "/acs/entrances/get", "description": "Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrance": { "$ref": "#/components/schemas/acs_entrance" }, "ok": { "type": "boolean" } }, "required": ["acs_entrance", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "access_token": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance that you want to get." } }, "required": ["acs_entrance_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_entrance" } }, "/acs/entrances/grant_access": { "post": { "x-title": "Grant an ACS User Access to an Entrance", "x-response-key": null, "summary": "/acs/entrances/grant_access", "description": "Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesGrantAccessPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance to which you want to grant an access system user access." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id." } }, "required": ["acs_entrance_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "grant_access" } }, "/acs/entrances/list": { "get": { "x-title": "List Entrances", "x-response-key": "acs_entrances", "summary": "/acs/entrances/list", "description": "Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list entrances." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all entrances." } }, { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the credential for which you want to retrieve all entrances." } }, { "name": "location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list entrances." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to retrieve all entrances." } }, { "name": "acs_entrance_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances for which you want to retrieve all entrances." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`." } }, { "name": "limit", "in": "query", "schema": { "default": 900, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_entrances" }, "post": { "x-title": "List Entrances", "x-response-key": "acs_entrances", "summary": "/acs/entrances/list", "description": "Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list entrances." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all entrances." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the credential for which you want to retrieve all entrances." }, "location_id": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list entrances." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to retrieve all entrances." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances for which you want to retrieve all entrances." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`." }, "limit": { "default": 900, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_entrances" } }, "/acs/entrances/list_credentials_with_access": { "get": { "x-title": "List Credentials with Access to an Entrance", "x-response-key": "acs_credentials", "summary": "/acs/entrances/list_credentials_with_access", "description": "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesListCredentialsWithAccessGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_entrance_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the entrance for which you want to list all credentials that grant access." }, "required": true }, { "name": "include_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["visionline_metadata.is_valid"] }, "description": "Conditions that credentials must meet to be included in the returned list." }, "required": false } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "list_credentials_with_access", "x-fern-sdk-return-value": "acs_credentials" }, "post": { "x-title": "List Credentials with Access to an Entrance", "x-response-key": "acs_credentials", "summary": "/acs/entrances/list_credentials_with_access", "description": "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesListCredentialsWithAccessPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance for which you want to list all credentials that grant access." }, "include_if": { "type": "array", "items": { "type": "string", "enum": ["visionline_metadata.is_valid"] }, "description": "Conditions that credentials must meet to be included in the returned list." } }, "required": ["acs_entrance_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "list_credentials_with_access", "x-fern-sdk-return-value": "acs_credentials" } }, "/acs/entrances/unlock": { "post": { "x-title": "Unlock an Entrance", "x-response-key": "action_attempt", "x-action-attempt-type": "UNLOCK_DOOR", "summary": "/acs/entrances/unlock", "description": "Remotely unlocks a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.", "operationId": "acsEntrancesUnlockPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the entrance to unlock." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the cloud_key credential to use for the unlock operation." } }, "required": ["acs_entrance_id", "acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "entrances"], "x-fern-sdk-method-name": "unlock", "x-fern-sdk-return-value": "action_attempt" } }, "/acs/users/add_to_access_group": { "put": { "x-title": "Add an ACS User to an Access Group", "x-response-key": null, "summary": "/acs/users/add_to_access_group", "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsUsersAddToAccessGroupPut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to add to an access group." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group to which you want to add an access system user." } }, "required": ["acs_user_id", "acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "add_to_access_group" }, "post": { "x-title": "Add an ACS User to an Access Group", "x-response-key": null, "summary": "/acs/users/add_to_access_group", "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsUsersAddToAccessGroupPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to add to an access group." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group to which you want to add an access system user." } }, "required": ["acs_user_id", "acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "add_to_access_group" } }, "/acs/users/create": { "post": { "x-title": "Create an ACS User", "x-response-key": "acs_user", "summary": "/acs/users/create", "description": "Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user": { "$ref": "#/components/schemas/acs_user" }, "ok": { "type": "boolean" } }, "required": ["acs_user", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "full_name": { "type": "string", "description": "Full name of the new access system user." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system to which you want to add the new access system user." }, "acs_access_group_ids": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access group IDs to indicate the access groups to which you want to add the new access system user." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity with which you want to associate the new access system user." }, "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Starting timestamp for the new access system user's access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Ending timestamp for the new access system user's access." } }, "description": "`starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`." }, "email": { "type": "string", "format": "email", "deprecated": true, "x-deprecated": "use email_address." }, "phone_number": { "type": "string", "description": "Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "email_address": { "type": "string", "format": "email", "description": "Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." } }, "required": ["full_name", "acs_system_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "acs_user" } }, "/acs/users/delete": { "delete": { "x-title": "Delete an ACS User", "x-response-key": null, "summary": "/acs/users/delete", "description": "Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsUsersDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id" } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an ACS User", "x-response-key": null, "summary": "/acs/users/delete", "description": "Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsUsersDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id" }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "delete" } }, "/acs/users/get": { "get": { "x-title": "Get an ACS User", "x-response-key": "acs_user", "summary": "/acs/users/get", "description": "Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user": { "$ref": "#/components/schemas/acs_user" }, "ok": { "type": "boolean" } }, "required": ["acs_user", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id." } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_user" }, "post": { "x-title": "Get an ACS User", "x-response-key": "acs_user", "summary": "/acs/users/get", "description": "Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user": { "$ref": "#/components/schemas/acs_user" }, "ok": { "type": "boolean" } }, "required": ["acs_user", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_user" } }, "/acs/users/list": { "get": { "x-title": "List ACS Users", "x-response-key": "acs_users", "summary": "/acs/users/list", "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_users", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access system users." } }, { "name": "user_identity_phone_number", "in": "query", "schema": { "type": "string", "description": "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`)." } }, { "name": "user_identity_email_address", "in": "query", "schema": { "type": "string", "description": "Email address of the user identity for which you want to retrieve all access system users." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the `acs_system` for which you want to retrieve all access system users." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned access system users. Returns users created before this timestamp." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_users" }, "post": { "x-title": "List ACS Users", "x-response-key": "acs_users", "summary": "/acs/users/list", "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["acs_users", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all access system users." }, "user_identity_phone_number": { "type": "string", "description": "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`)." }, "user_identity_email_address": { "type": "string", "description": "Email address of the user identity for which you want to retrieve all access system users." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_system` for which you want to retrieve all access system users." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned access system users. Returns users created before this timestamp." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_users" } }, "/acs/users/list_accessible_entrances": { "get": { "x-title": "List ACS User-Accessible Entrances", "x-response-key": "acs_entrances", "summary": "/acs/users/list_accessible_entrances", "description": "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.", "operationId": "acsUsersListAccessibleEntrancesGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id." } }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" }, "post": { "x-title": "List ACS User-Accessible Entrances", "x-response-key": "acs_entrances", "summary": "/acs/users/list_accessible_entrances", "description": "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.", "operationId": "acsUsersListAccessibleEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "ok": { "type": "boolean" } }, "required": ["acs_entrances", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances" } }, "/acs/users/remove_from_access_group": { "delete": { "x-title": "Remove an ACS User from an Access Group", "x-response-key": null, "summary": "/acs/users/remove_from_access_group", "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsUsersRemoveFromAccessGroupDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id." }, "required": false }, { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id." }, "required": false }, { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access group from which you want to remove an access system user." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "remove_from_access_group" }, "post": { "x-title": "Remove an ACS User from an Access Group", "x-response-key": null, "summary": "/acs/users/remove_from_access_group", "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsUsersRemoveFromAccessGroupPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group from which you want to remove an access system user." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "remove_from_access_group" } }, "/acs/users/revoke_access_to_all_entrances": { "post": { "x-title": "Revoke ACS User Access to All Entrances", "x-response-key": null, "summary": "/acs/users/revoke_access_to_all_entrances", "description": "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersRevokeAccessToAllEntrancesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "revoke_access_to_all_entrances" } }, "/acs/users/suspend": { "post": { "x-title": "Suspend an ACS User", "x-response-key": null, "summary": "/acs/users/suspend", "description": "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.", "operationId": "acsUsersSuspendPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "suspend" } }, "/acs/users/unsuspend": { "post": { "x-title": "Unsuspend an ACS User", "x-response-key": null, "summary": "/acs/users/unsuspend", "description": "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.", "operationId": "acsUsersUnsuspendPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "unsuspend" } }, "/acs/users/update": { "patch": { "x-title": "Update an ACS User", "x-response-key": null, "summary": "/acs/users/update", "description": "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Starting timestamp for the access system user's access." }, "ends_at": { "description": "Ending timestamp for the access system user's access.", "type": "string", "format": "date-time" } }, "required": ["starts_at", "ends_at"], "nullable": true, "description": "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id." }, "full_name": { "type": "string", "minLength": 1, "description": "Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "email": { "type": "string", "format": "email", "deprecated": true, "x-deprecated": "use email_address." }, "phone_number": { "type": "string", "description": "Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "email_address": { "type": "string", "format": "email", "description": "Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "hid_acs_system_id": { "type": "string", "format": "uuid" } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update an ACS User", "x-response-key": null, "summary": "/acs/users/update", "description": "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Starting timestamp for the access system user's access." }, "ends_at": { "description": "Ending timestamp for the access system user's access.", "type": "string", "format": "date-time" } }, "required": ["starts_at", "ends_at"], "nullable": true, "description": "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id." }, "full_name": { "type": "string", "minLength": 1, "description": "Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "email": { "type": "string", "format": "email", "deprecated": true, "x-deprecated": "use email_address." }, "phone_number": { "type": "string", "description": "Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "email_address": { "type": "string", "format": "email", "description": "Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "hid_acs_system_id": { "type": "string", "format": "uuid" } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users"], "x-fern-sdk-method-name": "update" } }, "/access_codes/simulate/create_unmanaged_access_code": { "post": { "x-title": "Simulate Creating an Unmanaged Access Code", "x-response-key": "access_code", "summary": "/access_codes/simulate/create_unmanaged_access_code", "description": "Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "accessCodesSimulateCreateUnmanagedAccessCodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code": { "$ref": "#/components/schemas/unmanaged_access_code" }, "ok": { "type": "boolean" } }, "required": ["access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to simulate the creation of an unmanaged access code." }, "name": { "type": "string", "description": "Name of the simulated unmanaged access code." }, "code": { "type": "string", "minLength": 4, "maxLength": 8, "pattern": "^\\d+$", "description": "Code of the simulated unmanaged access code." } }, "required": ["device_id", "name", "code"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "simulate"], "x-fern-sdk-method-name": "create_unmanaged_access_code", "x-fern-sdk-return-value": "access_code" } }, "/connected_accounts/simulate/disconnect": { "post": { "x-title": "Simulate Connected Account Disconnection", "x-response-key": null, "summary": "/connected_accounts/simulate/disconnect", "description": "Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "connectedAccountsSimulateDisconnectPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account you want to simulate as disconnected." } }, "required": ["connected_account_id"] } } } }, "tags": ["/connected_accounts"], "x-fern-sdk-group-name": ["connected_accounts", "simulate"], "x-fern-sdk-method-name": "disconnect" } }, "/access_codes/unmanaged/convert_to_managed": { "post": { "x-title": "Convert an Unmanaged Access Code", "x-response-key": null, "x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED", "summary": "/access_codes/unmanaged/convert_to_managed", "description": "Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.", "operationId": "accessCodesUnmanagedConvertToManagedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to convert to a managed access code." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed." }, "force": { "type": "boolean", "description": "Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "convert_to_managed" }, "patch": { "x-title": "Convert an Unmanaged Access Code", "x-response-key": null, "x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED", "summary": "/access_codes/unmanaged/convert_to_managed", "description": "Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.", "operationId": "accessCodesUnmanagedConvertToManagedPatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to convert to a managed access code." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed." }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed." }, "force": { "type": "boolean", "description": "Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "convert_to_managed" } }, "/access_codes/unmanaged/delete": { "delete": { "x-title": "Delete an Unmanaged Access Code", "x-response-key": null, "x-action-attempt-type": "DELETE_ACCESS_CODE", "summary": "/access_codes/unmanaged/delete", "description": "Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to delete." }, "required": true }, { "name": "sync", "in": "query", "schema": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "required": false } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Unmanaged Access Code", "x-response-key": null, "x-action-attempt-type": "DELETE_ACCESS_CODE", "summary": "/access_codes/unmanaged/delete", "description": "Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to delete." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["access_code_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "delete" } }, "/access_codes/unmanaged/get": { "get": { "x-title": "Get an Unmanaged Access Code", "x-response-key": "access_code", "summary": "/access_codes/unmanaged/get", "description": "Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code": { "$ref": "#/components/schemas/unmanaged_access_code" }, "ok": { "type": "boolean" } }, "required": ["access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } }, { "name": "access_code_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } }, { "name": "code", "in": "query", "schema": { "type": "string", "description": "Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_code" }, "post": { "x-title": "Get an Unmanaged Access Code", "x-response-key": "access_code", "summary": "/access_codes/unmanaged/get", "description": "Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code": { "$ref": "#/components/schemas/unmanaged_access_code" }, "ok": { "type": "boolean" } }, "required": ["access_code", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." }, "code": { "type": "string", "description": "Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`." } } } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_code" } }, "/access_codes/unmanaged/list": { "get": { "x-title": "List Unmanaged Access Codes", "x-response-key": "access_codes", "summary": "/access_codes/unmanaged/list", "description": "Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_codes", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list unmanaged access codes." }, "required": true }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your user ID for the user by which to filter unmanaged access codes." }, "required": false }, { "name": "limit", "in": "query", "schema": { "default": 300000, "type": "number", "format": "float", "description": "Numerical limit on the number of unmanaged access codes to return." }, "required": false }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`." }, "required": false }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "required": false } ], "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_codes" }, "post": { "x-title": "List Unmanaged Access Codes", "x-response-key": "access_codes", "summary": "/access_codes/unmanaged/list", "description": "Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["access_codes", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list unmanaged access codes." }, "user_identifier_key": { "type": "string", "description": "Your user ID for the user by which to filter unmanaged access codes." }, "limit": { "default": 300000, "type": "number", "format": "float", "description": "Numerical limit on the number of unmanaged access codes to return." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, "required": ["device_id"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_codes" } }, "/access_codes/unmanaged/update": { "patch": { "x-title": "Update an Unmanaged Access Code", "x-response-key": null, "summary": "/access_codes/unmanaged/update", "description": "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to update." }, "is_managed": { "type": "boolean" }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed." }, "force": { "type": "boolean", "description": "Indicates whether to force the unmanaged access code update." } }, "required": ["access_code_id", "is_managed"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update an Unmanaged Access Code", "x-response-key": null, "summary": "/access_codes/unmanaged/update", "description": "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access code that you want to update." }, "is_managed": { "type": "boolean" }, "allow_external_modification": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed." }, "force": { "type": "boolean", "description": "Indicates whether to force the unmanaged access code update." } }, "required": ["access_code_id", "is_managed"] } } } }, "tags": ["/access_codes"], "x-fern-sdk-group-name": ["access_codes", "unmanaged"], "x-fern-sdk-method-name": "update" } }, "/devices/simulate/connect": { "post": { "x-title": "Simulate Device Connection", "x-response-key": null, "summary": "/devices/simulate/connect", "description": "Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).", "operationId": "devicesSimulateConnectPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to simulate connecting to Seam." } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "simulate"], "x-fern-sdk-method-name": "connect" } }, "/devices/simulate/connect_to_hub": { "post": { "x-title": "Simulate Hub Connection", "x-response-key": null, "summary": "/devices/simulate/connect_to_hub", "description": "Simulates bringing the Wi‑Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.", "operationId": "devicesSimulateConnectToHubPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device whose hub you want to reconnect." } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "simulate"], "x-fern-sdk-method-name": "connect_to_hub" } }, "/devices/simulate/disconnect": { "post": { "x-title": "Simulate Device Disconnection", "x-response-key": null, "summary": "/devices/simulate/disconnect", "description": "Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).", "operationId": "devicesSimulateDisconnectPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to simulate disconnecting from Seam." } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "simulate"], "x-fern-sdk-method-name": "disconnect" } }, "/devices/simulate/disconnect_from_hub": { "post": { "x-title": "Simulate Hub Disconnection", "x-response-key": null, "summary": "/devices/simulate/disconnect_from_hub", "description": "Simulates taking the Wi‑Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August, TTLock, and IglooHome devices.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device, or mark the\nIglooHome bridge offline in sandbox.", "operationId": "devicesSimulateDisconnectFromHubPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device whose hub you want to disconnect." } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "simulate"], "x-fern-sdk-method-name": "disconnect_from_hub" } }, "/devices/simulate/paid_subscription": { "post": { "x-title": "Simulate Paid Subscription", "x-response-key": null, "summary": "/devices/simulate/paid_subscription", "description": "Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only).\nSend `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription.\nThe actual device error is created/cleared by the poller after this state change.", "operationId": "devicesSimulatePaidSubscriptionPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid" }, "is_expired": { "type": "boolean" } }, "required": ["device_id", "is_expired"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "simulate"], "x-fern-sdk-method-name": "paid_subscription" } }, "/devices/simulate/remove": { "post": { "x-title": "Simulate Device Removal", "x-response-key": null, "summary": "/devices/simulate/remove", "description": "Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).", "operationId": "devicesSimulateRemovePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that you want to simulate removing from Seam." } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "simulate"], "x-fern-sdk-method-name": "remove" } }, "/devices/unmanaged/get": { "get": { "x-title": "Get an Unmanaged Device", "x-response-key": "device", "summary": "/devices/unmanaged/get", "description": "Returns a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/unmanaged_device" }, "ok": { "type": "boolean" } }, "required": ["device", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged device that you want to get." } }, { "name": "name", "in": "query", "schema": { "type": "string", "description": "Name of the unmanaged device that you want to get." } } ], "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device" }, "post": { "x-title": "Get an Unmanaged Device", "x-response-key": "device", "summary": "/devices/unmanaged/get", "description": "Returns a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/unmanaged_device" }, "ok": { "type": "boolean" } }, "required": ["device", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged device that you want to get." }, "name": { "type": "string", "description": "Name of the unmanaged device that you want to get." } } } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device" } }, "/devices/unmanaged/list": { "get": { "x-title": "List Unmanaged Devices", "x-response-key": "devices", "summary": "/devices/unmanaged/list", "description": "Returns a list of all [unmanaged devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_device" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["devices", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list devices." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." } }, { "name": "connected_account_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." } }, { "name": "connect_webview_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." } }, { "name": "device_type", "in": "query", "schema": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ], "description": "Device type for which you want to list devices." } }, { "name": "device_types", "in": "query", "schema": { "type": "array", "items": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ] }, "description": "Array of device types for which you want to list devices." } }, { "name": "manufacturer", "in": "query", "schema": { "type": "string", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "korelock", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring" ], "description": "Manufacturer for which you want to list devices." } }, { "name": "device_ids", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." } }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." } }, { "name": "custom_metadata_has", "in": "query", "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } }, { "name": "include_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "exclude_if", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." } }, { "name": "unstable_location_id", "in": "query", "schema": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." } }, { "name": "limit", "in": "query", "schema": { "default": 22900, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." } } ], "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" }, "post": { "x-title": "List Unmanaged Devices", "x-response-key": "devices", "summary": "/devices/unmanaged/list", "description": "Returns a list of all [unmanaged devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_device" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["devices", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list devices." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account for which you want to list devices." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of IDs of the connected accounts for which you want to list devices." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview for which you want to list devices." }, "device_type": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ], "description": "Device type for which you want to list devices." }, "device_types": { "type": "array", "items": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ] }, "description": "Array of device types for which you want to list devices." }, "manufacturer": { "type": "string", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "korelock", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring" ], "description": "Manufacturer for which you want to list devices." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device IDs for which you want to list devices." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp." }, "user_identifier_key": { "type": "string", "description": "Your own internal user ID for the user for which you want to list devices." }, "custom_metadata_has": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true }, "include_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "exclude_if": { "type": "array", "items": { "type": "string", "enum": [ "can_remotely_unlock", "can_remotely_lock", "can_program_offline_access_codes", "can_program_online_access_codes", "can_hvac_heat", "can_hvac_cool", "can_hvac_heat_cool", "can_turn_off_hvac", "can_simulate_removal", "can_simulate_connection", "can_simulate_disconnection", "can_unlock_with_code", "can_run_thermostat_programs", "can_program_thermostat_programs_as_weekday_weekend", "can_program_thermostat_programs_as_different_each_day", "can_program_thermostat_programs_as_same_each_day", "can_simulate_hub_connection", "can_simulate_hub_disconnection", "can_simulate_paid_subscription", "can_configure_auto_lock" ] }, "x-undocumented": "Only used internally." }, "unstable_location_id": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true, "x-deprecated": "Use `space_id`." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list devices." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`." }, "limit": { "default": 22900, "type": "number", "format": "float", "description": "Numerical limit on the number of devices to return." } } } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices" } }, "/devices/unmanaged/update": { "post": { "x-title": "Update an Unmanaged Device", "x-response-key": null, "summary": "/devices/unmanaged/update", "description": "Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged device that you want to update." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "unmanaged"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update an Unmanaged Device", "x-response-key": null, "summary": "/devices/unmanaged/update", "description": "Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged device that you want to update." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed." }, "custom_metadata": { "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 500 }, { "type": "boolean" } ], "nullable": true } } }, "required": ["device_id"] } } } }, "tags": ["/devices"], "x-fern-sdk-group-name": ["devices", "unmanaged"], "x-fern-sdk-method-name": "update" } }, "/customers/reservations/create_deep_link": { "post": { "x-title": "Create Reservation Deep Link", "x-response-key": "deep_link", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/customers/reservations/create_deep_link", "description": "Creates a deep link URL for a specific reservation that can be embedded in an iframe.\nThe deep link creates a restricted customer portal that navigates directly to the reservation page,\nhiding the navigation UI to prevent context switching.\n\nThis is intended for PMS integrations (like RMS Cloud) to embed reservation management\nin their own portal without exposing the full customer portal.\n\nThe deep link expires after 7 days.", "operationId": "customersReservationsCreateDeepLinkPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "deep_link": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "The deep link URL to embed in an iframe." }, "expires_at": { "type": "string", "format": "date-time", "description": "When the deep link expires." }, "customer_portal_id": { "type": "string", "format": "uuid", "description": "The ID of the created customer portal." } }, "required": ["url", "expires_at", "customer_portal_id"] }, "ok": { "type": "boolean" } }, "required": ["deep_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "The customer_key identifying the customer who owns the reservation." }, "reservation_key": { "type": "string", "description": "The key of the reservation to create a deep link for." } }, "required": ["customer_key", "reservation_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["customers", "reservations"], "x-fern-sdk-method-name": "create_deep_link", "x-fern-sdk-return-value": "deep_link" } }, "/noise_sensors/noise_thresholds/create": { "post": { "x-title": "Create a Noise Threshold", "x-response-key": "noise_threshold", "x-action-attempt-type": "CREATE_NOISE_THRESHOLD", "summary": "/noise_sensors/noise_thresholds/create", "description": "Creates a new [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.", "operationId": "noiseSensorsNoiseThresholdsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "noise_threshold": { "$ref": "#/components/schemas/noise_threshold" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "noise_threshold", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to create a noise threshold." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "name": { "type": "string", "description": "Name of the new noise threshold." }, "starts_daily_at": { "description": "Time at which the new noise threshold should become active daily.", "type": "string" }, "ends_daily_at": { "description": "Time at which the new noise threshold should become inactive daily.", "type": "string" }, "noise_threshold_decibels": { "type": "number", "format": "float", "description": "Noise level in decibels for the new noise threshold." }, "noise_threshold_nrs": { "type": "number", "format": "float", "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors)." } }, "required": ["device_id", "starts_daily_at", "ends_daily_at"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "noise_threshold" } }, "/noise_sensors/noise_thresholds/delete": { "delete": { "x-title": "Delete a Noise Threshold", "x-response-key": null, "x-action-attempt-type": "DELETE_NOISE_THRESHOLD", "summary": "/noise_sensors/noise_thresholds/delete", "description": "Deletes a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to delete." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that contains the noise threshold that you want to delete." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["noise_threshold_id", "device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Noise Threshold", "x-response-key": null, "x-action-attempt-type": "DELETE_NOISE_THRESHOLD", "summary": "/noise_sensors/noise_thresholds/delete", "description": "Deletes a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to delete." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that contains the noise threshold that you want to delete." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." } }, "required": ["noise_threshold_id", "device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "delete" } }, "/noise_sensors/noise_thresholds/get": { "get": { "x-title": "Get a Noise Threshold", "x-response-key": "noise_threshold", "summary": "/noise_sensors/noise_thresholds/get", "description": "Returns a specified [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold": { "$ref": "#/components/schemas/noise_threshold" }, "ok": { "type": "boolean" } }, "required": ["noise_threshold", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "noise_threshold_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to get." }, "required": true } ], "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "noise_threshold" }, "post": { "x-title": "Get a Noise Threshold", "x-response-key": "noise_threshold", "summary": "/noise_sensors/noise_thresholds/get", "description": "Returns a specified [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold": { "$ref": "#/components/schemas/noise_threshold" }, "ok": { "type": "boolean" } }, "required": ["noise_threshold", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to get." } }, "required": ["noise_threshold_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "noise_threshold" } }, "/noise_sensors/noise_thresholds/list": { "get": { "x-title": "List Noise Thresholds", "x-response-key": "noise_thresholds", "summary": "/noise_sensors/noise_thresholds/list", "description": "Returns a list of all [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/noise_threshold" } }, "ok": { "type": "boolean" } }, "required": ["noise_thresholds", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list noise thresholds." }, "required": true }, { "name": "is_programmed", "in": "query", "schema": { "type": "boolean", "description": "Enables you to limit the returned noise thresholds by whether they are programmed on the noise sensor. To list only noise thresholds that are programmed on the noise sensor, set this parameter to `true`. To list only noise thresholds that are not programmed on the noise sensor, se this parameter to `false`.", "x-undocumented": "Not sure if this parameter is supported or what it does." }, "required": false } ], "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "noise_thresholds" }, "post": { "x-title": "List Noise Thresholds", "x-response-key": "noise_thresholds", "summary": "/noise_sensors/noise_thresholds/list", "description": "Returns a list of all [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/noise_threshold" } }, "ok": { "type": "boolean" } }, "required": ["noise_thresholds", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to list noise thresholds." }, "is_programmed": { "type": "boolean", "description": "Enables you to limit the returned noise thresholds by whether they are programmed on the noise sensor. To list only noise thresholds that are programmed on the noise sensor, set this parameter to `true`. To list only noise thresholds that are not programmed on the noise sensor, se this parameter to `false`.", "x-undocumented": "Not sure if this parameter is supported or what it does." } }, "required": ["device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "noise_thresholds" } }, "/noise_sensors/noise_thresholds/update": { "patch": { "x-title": "Update a Noise Threshold", "x-response-key": null, "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD", "summary": "/noise_sensors/noise_thresholds/update", "description": "Updates a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to update." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that contains the noise threshold that you want to update." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "name": { "type": "string", "description": "Name of the noise threshold that you want to update." }, "starts_daily_at": { "type": "string", "description": "Time at which the noise threshold should become active daily." }, "ends_daily_at": { "type": "string", "description": "Time at which the noise threshold should become inactive daily." }, "noise_threshold_decibels": { "type": "number", "format": "float", "description": "Noise level in decibels for the noise threshold." }, "noise_threshold_nrs": { "type": "number", "format": "float", "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors)." } }, "required": ["noise_threshold_id", "device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update a Noise Threshold", "x-response-key": null, "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD", "summary": "/noise_sensors/noise_thresholds/update", "description": "Updates a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to update." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that contains the noise threshold that you want to update." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "name": { "type": "string", "description": "Name of the noise threshold that you want to update." }, "starts_daily_at": { "type": "string", "description": "Time at which the noise threshold should become active daily." }, "ends_daily_at": { "type": "string", "description": "Time at which the noise threshold should become inactive daily." }, "noise_threshold_decibels": { "type": "number", "format": "float", "description": "Noise level in decibels for the noise threshold." }, "noise_threshold_nrs": { "type": "number", "format": "float", "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors)." } }, "required": ["noise_threshold_id", "device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "update" }, "put": { "x-title": "Update a Noise Threshold", "x-response-key": null, "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD", "summary": "/noise_sensors/noise_thresholds/update", "description": "Updates a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsUpdatePut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that you want to update." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that contains the noise threshold that you want to update." }, "sync": { "default": false, "type": "boolean", "x-undocumented": "Only used internally." }, "name": { "type": "string", "description": "Name of the noise threshold that you want to update." }, "starts_daily_at": { "type": "string", "description": "Time at which the noise threshold should become active daily." }, "ends_daily_at": { "type": "string", "description": "Time at which the noise threshold should become inactive daily." }, "noise_threshold_decibels": { "type": "number", "format": "float", "description": "Noise level in decibels for the noise threshold." }, "noise_threshold_nrs": { "type": "number", "format": "float", "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors)." } }, "required": ["noise_threshold_id", "device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"], "x-fern-sdk-method-name": "update" } }, "/locks/simulate/keypad_code_entry": { "post": { "x-title": "Simulate a Keypad Code Entry", "x-response-key": "action_attempt", "x-action-attempt-type": "SIMULATE_KEYPAD_CODE_ENTRY", "summary": "/locks/simulate/keypad_code_entry", "description": "Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "locksSimulateKeypadCodeEntryPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to simulate a keypad code entry." }, "code": { "type": "string", "description": "Code that you want to simulate entering on a keypad." } }, "required": ["device_id", "code"] } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks", "simulate"], "x-fern-sdk-method-name": "keypad_code_entry", "x-fern-sdk-return-value": "action_attempt" } }, "/locks/simulate/manual_lock_via_keypad": { "post": { "x-title": "Simulate a Manual Lock Action Using a Keypad", "x-response-key": "action_attempt", "x-action-attempt-type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD", "summary": "/locks/simulate/manual_lock_via_keypad", "description": "Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "locksSimulateManualLockViaKeypadPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to simulate a manual lock action using a keypad." } }, "required": ["device_id"] } } } }, "tags": ["/locks"], "x-fern-sdk-group-name": ["locks", "simulate"], "x-fern-sdk-method-name": "manual_lock_via_keypad", "x-fern-sdk-return-value": "action_attempt" } }, "/noise_sensors/simulate/trigger_noise_threshold": { "post": { "x-title": "Simulate Triggering a Noise Threshold", "x-response-key": null, "summary": "/noise_sensors/simulate/trigger_noise_threshold", "description": "Simulates the triggering of a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "noiseSensorsSimulateTriggerNoiseThresholdPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device for which you want to simulate the triggering of a noise threshold." } }, "required": ["device_id"] } } } }, "tags": ["/noise_sensors"], "x-fern-sdk-group-name": ["noise_sensors", "simulate"], "x-fern-sdk-method-name": "trigger_noise_threshold" } }, "/phones/simulate/create_sandbox_phone": { "post": { "x-response-key": "phone", "x-title": "Create a Sandbox Phone", "summary": "/phones/simulate/create_sandbox_phone", "description": "Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).", "operationId": "phonesSimulateCreateSandboxPhonePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "$ref": "#/components/schemas/phone" }, "ok": { "type": "boolean" } }, "required": ["phone", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "custom_sdk_installation_id": { "type": "string", "description": "ID of the custom SDK installation that you want to use for the simulated phone." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity that you want to associate with the simulated phone." }, "phone_metadata": { "default": {}, "type": "object", "properties": { "operating_system": { "default": "android", "type": "string", "enum": ["android", "ios"], "description": "Mobile operating system that you want to use for the simulated phone." }, "os_version": { "default": "10", "type": "string", "description": "Mobile operating system version that you want to use for the simulated phone." }, "device_manufacturer": { "default": "Samsung", "type": "string", "description": "Manufacturer that you want to use for the simulated phone." }, "device_model": { "default": "Samsung Galaxy S10", "type": "string", "description": "Device model that you want to use for the simulated phone." } }, "description": "Metadata that you want to associate with the simulated phone." }, "assa_abloy_metadata": { "default": {}, "type": "object", "properties": { "ble_capability": { "default": true, "type": "boolean", "description": "Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability." }, "hce_capability": { "default": false, "type": "boolean", "description": "Indicates whether the simulated phone should have host card emulation (HCE) capability." }, "nfc_capability": { "default": false, "type": "boolean", "description": "Indicates whether the simulated phone should have near-field communication (NFC) capability." }, "application_version": { "default": "1.0.0", "type": "string", "description": "Application version that you want to use for the simulated phone." }, "seos_applet_version": { "default": "1.0.0", "type": "string", "description": "SEOS applet version that you want to use for the simulated phone." }, "seos_tsm_endpoint_id": { "default": 1, "type": "number", "format": "float", "description": "ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone." } }, "description": "ASSA ABLOY metadata that you want to associate with the simulated phone." } }, "required": ["user_identity_id"] } } } }, "tags": ["/phones"], "x-fern-sdk-group-name": ["phones", "simulate"], "x-fern-sdk-method-name": "create_sandbox_phone", "x-fern-sdk-return-value": "phone" } }, "/thermostats/daily_programs/create": { "post": { "x-title": "Create a Thermostat Daily Program", "x-response-key": "thermostat_daily_program", "summary": "/thermostats/daily_programs/create", "description": "Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.", "operationId": "thermostatsDailyProgramsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_daily_program": { "$ref": "#/components/schemas/thermostat_daily_program" }, "ok": { "type": "boolean" } }, "required": ["thermostat_daily_program", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to create a daily program." }, "name": { "type": "string", "description": "Name of the thermostat daily program." }, "periods": { "type": "array", "items": { "type": "object", "properties": { "starts_at_time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`." } }, "required": ["starts_at_time", "climate_preset_key"], "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time." }, "description": "Array of thermostat daily program periods." } }, "required": ["device_id", "name", "periods"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "daily_programs"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "thermostat_daily_program" } }, "/thermostats/daily_programs/delete": { "delete": { "x-title": "Delete a Thermostat Daily Program", "x-response-key": null, "summary": "/thermostats/daily_programs/delete", "description": "Deletes a thermostat daily program.", "operationId": "thermostatsDailyProgramsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "thermostat_daily_program_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the thermostat daily program that you want to delete." }, "required": true } ], "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "daily_programs"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Thermostat Daily Program", "x-response-key": null, "summary": "/thermostats/daily_programs/delete", "description": "Deletes a thermostat daily program.", "operationId": "thermostatsDailyProgramsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_daily_program_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat daily program that you want to delete." } }, "required": ["thermostat_daily_program_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "daily_programs"], "x-fern-sdk-method-name": "delete" } }, "/thermostats/daily_programs/update": { "patch": { "x-title": "Update a Thermostat Daily Program", "x-response-key": "action_attempt", "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS", "summary": "/thermostats/daily_programs/update", "description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.", "operationId": "thermostatsDailyProgramsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_daily_program_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat daily program that you want to update." }, "name": { "type": "string", "description": "Name of the thermostat daily program that you want to update." }, "periods": { "type": "array", "items": { "type": "object", "properties": { "starts_at_time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`." } }, "required": ["starts_at_time", "climate_preset_key"], "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time." }, "description": "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program." } }, "required": ["thermostat_daily_program_id", "name", "periods"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "daily_programs"], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "action_attempt" }, "post": { "x-title": "Update a Thermostat Daily Program", "x-response-key": "action_attempt", "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS", "summary": "/thermostats/daily_programs/update", "description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.", "operationId": "thermostatsDailyProgramsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_daily_program_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat daily program that you want to update." }, "name": { "type": "string", "description": "Name of the thermostat daily program that you want to update." }, "periods": { "type": "array", "items": { "type": "object", "properties": { "starts_at_time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`." } }, "required": ["starts_at_time", "climate_preset_key"], "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time." }, "description": "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program." } }, "required": ["thermostat_daily_program_id", "name", "periods"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "daily_programs"], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "action_attempt" } }, "/thermostats/schedules/create": { "post": { "x-title": "Create a Thermostat Schedule", "x-response-key": "thermostat_schedule", "summary": "/thermostats/schedules/create", "description": "Creates a new [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSchedulesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule": { "$ref": "#/components/schemas/thermostat_schedule" }, "ok": { "type": "boolean" } }, "required": ["thermostat_schedule", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "description": "ID of the thermostat device for which you want to create a schedule." }, "name": { "type": "string", "description": "Name of the thermostat schedule." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule." }, "max_override_period_minutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "nullable": true, "description": "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." }, "starts_at": { "description": "Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "is_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." } }, "required": [ "device_id", "climate_preset_key", "starts_at", "ends_at" ] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "thermostat_schedule" } }, "/thermostats/schedules/delete": { "delete": { "x-title": "Delete a Thermostat Schedule", "x-response-key": null, "summary": "/thermostats/schedules/delete", "description": "Deletes a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSchedulesDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "thermostat_schedule_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the thermostat schedule that you want to delete." }, "required": true } ], "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete a Thermostat Schedule", "x-response-key": null, "summary": "/thermostats/schedules/delete", "description": "Deletes a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSchedulesDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat schedule that you want to delete." } }, "required": ["thermostat_schedule_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "delete" } }, "/thermostats/schedules/get": { "get": { "x-title": "Get a Thermostat Schedule", "x-response-key": "thermostat_schedule", "summary": "/thermostats/schedules/get", "description": "Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule": { "$ref": "#/components/schemas/thermostat_schedule" }, "ok": { "type": "boolean" } }, "required": ["thermostat_schedule", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "thermostat_schedule_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the thermostat schedule that you want to get." }, "required": true } ], "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "thermostat_schedule" }, "post": { "x-title": "Get a Thermostat Schedule", "x-response-key": "thermostat_schedule", "summary": "/thermostats/schedules/get", "description": "Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule": { "$ref": "#/components/schemas/thermostat_schedule" }, "ok": { "type": "boolean" } }, "required": ["thermostat_schedule", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat schedule that you want to get." } }, "required": ["thermostat_schedule_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "thermostat_schedule" } }, "/thermostats/schedules/list": { "get": { "x-title": "List Thermostat Schedules", "x-response-key": "thermostat_schedules", "summary": "/thermostats/schedules/list", "description": "Returns a list of all [thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSchedulesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedules": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_schedule" } }, "ok": { "type": "boolean" } }, "required": ["thermostat_schedules", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "device_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to list schedules." }, "required": true }, { "name": "user_identifier_key", "in": "query", "schema": { "type": "string", "description": "User identifier key by which to filter the list of returned thermostat schedules." }, "required": false } ], "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "thermostat_schedules" }, "post": { "x-title": "List Thermostat Schedules", "x-response-key": "thermostat_schedules", "summary": "/thermostats/schedules/list", "description": "Returns a list of all [thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "operationId": "thermostatsSchedulesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedules": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_schedule" } }, "ok": { "type": "boolean" } }, "required": ["thermostat_schedules", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to list schedules." }, "user_identifier_key": { "type": "string", "description": "User identifier key by which to filter the list of returned thermostat schedules." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "thermostat_schedules" } }, "/thermostats/schedules/update": { "patch": { "x-title": "Update a Thermostat Schedule", "x-response-key": null, "summary": "/thermostats/schedules/update", "description": "Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat schedule that you want to update." }, "name": { "type": "string", "description": "Name of the thermostat schedule." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule." }, "max_override_period_minutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "nullable": true, "description": "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." }, "starts_at": { "description": "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "is_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." } }, "required": ["thermostat_schedule_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update a Thermostat Schedule", "x-response-key": null, "summary": "/thermostats/schedules/update", "description": "Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "thermostat_schedule_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat schedule that you want to update." }, "name": { "type": "string", "description": "Name of the thermostat schedule." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule." }, "max_override_period_minutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "nullable": true, "description": "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." }, "starts_at": { "description": "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "ends_at": { "description": "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "is_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." } }, "required": ["thermostat_schedule_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "schedules"], "x-fern-sdk-method-name": "update" } }, "/thermostats/simulate/hvac_mode_adjusted": { "post": { "x-response-key": null, "x-title": "HVAC Mode Adjusted", "summary": "/thermostats/simulate/hvac_mode_adjusted", "description": "Simulates having adjusted the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).", "operationId": "thermostatsSimulateHvacModeAdjustedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "propertyName": "hvac_mode" }, "oneOf": [ { "type": "object", "properties": { "hvac_mode": { "type": "string", "enum": ["off"], "description": "HVAC mode that you want to simulate." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode." } }, "required": ["hvac_mode", "device_id"] }, { "type": "object", "properties": { "hvac_mode": { "type": "string", "enum": ["cool"], "description": "HVAC mode that you want to simulate." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`." } }, "required": ["hvac_mode", "device_id"] }, { "type": "object", "properties": { "hvac_mode": { "type": "string", "enum": ["heat"], "description": "HVAC mode that you want to simulate." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`." } }, "required": ["hvac_mode", "device_id"] }, { "type": "object", "properties": { "hvac_mode": { "type": "string", "enum": ["heat_cool"], "description": "HVAC mode that you want to simulate." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`." } }, "required": ["hvac_mode", "device_id"] } ] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "simulate"], "x-fern-sdk-method-name": "hvac_mode_adjusted" } }, "/thermostats/simulate/temperature_reached": { "post": { "x-response-key": null, "x-title": "Temperature Reached", "summary": "/thermostats/simulate/temperature_reached", "description": "Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).", "operationId": "thermostatsSimulateTemperatureReachedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device that you want to simulate reaching a specified temperature." }, "temperature_celsius": { "type": "number", "format": "float", "description": "Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`." }, "temperature_fahrenheit": { "type": "number", "format": "float", "description": "Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`." } }, "required": ["device_id"] } } } }, "tags": ["/thermostats"], "x-fern-sdk-group-name": ["thermostats", "simulate"], "x-fern-sdk-method-name": "temperature_reached" } }, "/unstable_partner/building_blocks/connect_accounts": { "post": { "x-title": "Generate a Connect Accounts Building Block Magic Link", "x-response-key": "magic_link", "x-undocumented": "Experimental partner building blocks.", "summary": "/unstable_partner/building_blocks/connect_accounts", "description": "Creates a new building block magic link to connect accounts.", "operationId": "unstablePartnerBuildingBlocksConnectAccountsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "description": "Customer key for which you want to connect accounts.", "type": "string", "minLength": 1 } }, "required": ["customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["unstable_partner", "building_blocks"], "x-fern-sdk-method-name": "connect_accounts", "x-fern-sdk-return-value": "magic_link" } }, "/unstable_partner/building_blocks/generate_magic_link": { "post": { "x-title": "Generate a Building Block Magic Link", "x-response-key": "magic_link", "x-undocumented": "Experimental partner building blocks.", "summary": "/unstable_partner/building_blocks/generate_magic_link", "description": "Creates a new building block magic link.", "operationId": "unstablePartnerBuildingBlocksGenerateMagicLinkPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "building_block_type": { "type": "string", "enum": [ "connect_accounts", "organize_spaces", "console", "manage_devices" ], "description": "Type of building block for which you want to create a magic link." }, "customer_key": { "description": "Customer key for which you want to create a new building block magic link.", "type": "string", "minLength": 1 }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "space_key": { "description": "Your unique identifier for the space.", "type": "string", "minLength": 1 }, "parent_site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "space_key"] }, "description": "Optional list of spaces that you want to include in the new building block magic link." } }, "required": ["building_block_type", "customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["unstable_partner", "building_blocks"], "x-fern-sdk-method-name": "generate_magic_link", "x-fern-sdk-return-value": "magic_link" }, "get": { "x-title": "Generate a Building Block Magic Link", "x-response-key": "magic_link", "x-undocumented": "Experimental partner building blocks.", "summary": "/unstable_partner/building_blocks/generate_magic_link", "description": "Creates a new building block magic link.", "operationId": "unstablePartnerBuildingBlocksGenerateMagicLinkGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "building_block_type", "in": "query", "schema": { "type": "string", "enum": [ "connect_accounts", "organize_spaces", "console", "manage_devices" ], "description": "Type of building block for which you want to create a magic link." }, "required": true }, { "name": "customer_key", "in": "query", "schema": { "description": "Customer key for which you want to create a new building block magic link.", "type": "string", "minLength": 1 }, "required": true }, { "name": "spaces", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "space_key": { "description": "Your unique identifier for the space.", "type": "string", "minLength": 1 }, "parent_site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "space_key"] }, "description": "Optional list of spaces that you want to include in the new building block magic link." }, "required": false } ], "tags": [], "x-fern-sdk-group-name": ["unstable_partner", "building_blocks"], "x-fern-sdk-method-name": "generate_magic_link", "x-fern-sdk-return-value": "magic_link" } }, "/unstable_partner/building_blocks/manage_devices": { "post": { "x-title": "Generate a Manage Devices Building Block Magic Link", "x-response-key": "magic_link", "x-undocumented": "Experimental partner building blocks.", "summary": "/unstable_partner/building_blocks/manage_devices", "description": "Creates a new building block magic link to manage devices.", "operationId": "unstablePartnerBuildingBlocksManageDevicesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "description": "Customer key for which you want to manage devices.", "type": "string", "minLength": 1 } }, "required": ["customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["unstable_partner", "building_blocks"], "x-fern-sdk-method-name": "manage_devices", "x-fern-sdk-return-value": "magic_link" } }, "/unstable_partner/building_blocks/organize_spaces": { "post": { "x-title": "Generate an Organize Spaces Building Block Magic Link", "x-response-key": "magic_link", "x-undocumented": "Experimental partner building blocks.", "summary": "/unstable_partner/building_blocks/organize_spaces", "description": "Creates a new building block magic link to organize spaces.", "operationId": "unstablePartnerBuildingBlocksOrganizeSpacesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "description": "Customer key for which you want to organize spaces.", "type": "string", "minLength": 1 }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this location resource." }, "space_key": { "description": "Your unique identifier for the space.", "type": "string", "minLength": 1 }, "parent_site_key": { "description": "Your unique identifier for the site.", "type": "string", "minLength": 1 } }, "required": ["name", "space_key"] }, "description": "Optional list of spaces that you want to include in the new building block magic link." } }, "required": ["customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["unstable_partner", "building_blocks"], "x-fern-sdk-method-name": "organize_spaces", "x-fern-sdk-return-value": "magic_link" } }, "/user_identities/enrollment_automations/delete": { "delete": { "x-title": "Delete an Enrollment Automation", "x-response-key": null, "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/delete", "description": "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).", "operationId": "userIdentitiesEnrollmentAutomationsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "enrollment_automation_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the enrollment automation that you want to delete." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete an Enrollment Automation", "x-response-key": null, "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/delete", "description": "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).", "operationId": "userIdentitiesEnrollmentAutomationsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automation_id": { "type": "string", "format": "uuid", "description": "ID of the enrollment automation that you want to delete." } }, "required": ["enrollment_automation_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "delete" } }, "/user_identities/enrollment_automations/get": { "get": { "x-title": "Get an Enrollment Automation", "x-response-key": "enrollment_automation", "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/get", "description": "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).", "operationId": "userIdentitiesEnrollmentAutomationsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automation": { "$ref": "#/components/schemas/enrollment_automation" }, "ok": { "type": "boolean" } }, "required": ["enrollment_automation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "enrollment_automation_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the enrollment automation that you want to get." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "enrollment_automation" }, "post": { "x-title": "Get an Enrollment Automation", "x-response-key": "enrollment_automation", "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/get", "description": "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).", "operationId": "userIdentitiesEnrollmentAutomationsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automation": { "$ref": "#/components/schemas/enrollment_automation" }, "ok": { "type": "boolean" } }, "required": ["enrollment_automation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automation_id": { "type": "string", "format": "uuid", "description": "ID of the enrollment automation that you want to get." } }, "required": ["enrollment_automation_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "enrollment_automation" } }, "/user_identities/enrollment_automations/launch": { "post": { "x-title": "Launch an Enrollment Automation", "x-response-key": "enrollment_automation", "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/launch", "description": "Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system).", "operationId": "userIdentitiesEnrollmentAutomationsLaunchPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automation": { "$ref": "#/components/schemas/enrollment_automation" }, "ok": { "type": "boolean" } }, "required": ["enrollment_automation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to launch an enrollment automation." }, "credential_manager_acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the desired access system that serves as the credential manager for the enrollment automation." }, "acs_credential_pool_id": { "type": "string", "format": "uuid", "description": "ID of the credential pool from which to obtain credentials for the user identity." }, "create_credential_manager_user": { "type": "boolean", "description": "Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`." }, "credential_manager_acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`." } }, "required": [ "user_identity_id", "credential_manager_acs_system_id" ] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "launch", "x-fern-sdk-return-value": "enrollment_automation" } }, "/user_identities/enrollment_automations/list": { "get": { "x-title": "List Enrollment Automations", "x-response-key": "enrollment_automations", "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/list", "description": "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesEnrollmentAutomationsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automations": { "type": "array", "items": { "$ref": "#/components/schemas/enrollment_automation" } }, "ok": { "type": "boolean" } }, "required": ["enrollment_automations", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve enrollment automations." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "enrollment_automations" }, "post": { "x-title": "List Enrollment Automations", "x-response-key": "enrollment_automations", "x-undocumented": "Will be removed.", "summary": "/user_identities/enrollment_automations/list", "description": "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesEnrollmentAutomationsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollment_automations": { "type": "array", "items": { "$ref": "#/components/schemas/enrollment_automation" } }, "ok": { "type": "boolean" } }, "required": ["enrollment_automations", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve enrollment automations." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "enrollment_automations" } }, "/user_identities/unmanaged/get": { "get": { "x-title": "Get an Unmanaged User Identity", "x-response-key": "user_identity", "summary": "/user_identities/unmanaged/get", "description": "Returns a specified unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).", "operationId": "userIdentitiesUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "display_name": { "type": "string", "minLength": 1 }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user identity was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["issue_with_acs_user"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that has an issue." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that the user identity is associated with." } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "description": "Indicates that there is an issue with an access system user associated with this user identity." } ], "description": "Errors associated with the user identity." }, "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the user identity is currently being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the ACS user's profile does not match the user identity's profile" } ], "description": "Warnings associated with the user identity." }, "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it." }, "acs_user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access system user IDs associated with the user identity." } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "x-draft": "Early access.", "x-route-path": "/user_identities/unmanaged" }, "ok": { "type": "boolean" } }, "required": ["user_identity", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged user identity that you want to get." }, "required": true } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "user_identity" }, "post": { "x-title": "Get an Unmanaged User Identity", "x-response-key": "user_identity", "summary": "/user_identities/unmanaged/get", "description": "Returns a specified unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).", "operationId": "userIdentitiesUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "display_name": { "type": "string", "minLength": 1 }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user identity was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["issue_with_acs_user"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that has an issue." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that the user identity is associated with." } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "description": "Indicates that there is an issue with an access system user associated with this user identity." } ], "description": "Errors associated with the user identity." }, "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the user identity is currently being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the ACS user's profile does not match the user identity's profile" } ], "description": "Warnings associated with the user identity." }, "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it." }, "acs_user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access system user IDs associated with the user identity." } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "x-draft": "Early access.", "x-route-path": "/user_identities/unmanaged" }, "ok": { "type": "boolean" } }, "required": ["user_identity", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged user identity that you want to get." } }, "required": ["user_identity_id"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "user_identity" } }, "/user_identities/unmanaged/list": { "get": { "x-title": "List Unmanaged User Identities", "x-response-key": "user_identities", "summary": "/user_identities/unmanaged/list", "description": "Returns a list of all unmanaged [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).", "operationId": "userIdentitiesUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "display_name": { "type": "string", "minLength": 1 }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user identity was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["issue_with_acs_user"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that has an issue." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that the user identity is associated with." } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "description": "Indicates that there is an issue with an access system user associated with this user identity." } ], "description": "Errors associated with the user identity." }, "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the user identity is currently being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the ACS user's profile does not match the user identity's profile" } ], "description": "Warnings associated with the user identity." }, "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it." }, "acs_user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access system user IDs associated with the user identity." } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "x-draft": "Early access.", "x-route-path": "/user_identities/unmanaged" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["user_identities", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "description": "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `user_identity_id` or `acs_system_id`." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "user_identities" }, "post": { "x-title": "List Unmanaged User Identities", "x-response-key": "user_identities", "summary": "/user_identities/unmanaged/list", "description": "Returns a list of all unmanaged [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).", "operationId": "userIdentitiesUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "display_name": { "type": "string", "minLength": 1 }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user identity was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["issue_with_acs_user"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that has an issue." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that the user identity is associated with." } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "description": "Indicates that there is an issue with an access system user associated with this user identity." } ], "description": "Errors associated with the user identity." }, "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the user identity is currently being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the ACS user's profile does not match the user identity's profile" } ], "description": "Warnings associated with the user identity." }, "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it." }, "acs_user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access system user IDs associated with the user identity." } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "x-draft": "Early access.", "x-route-path": "/user_identities/unmanaged" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["user_identities", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": "string", "description": "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `user_identity_id` or `acs_system_id`." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "user_identities" } }, "/user_identities/unmanaged/update": { "patch": { "x-title": "Update an Unmanaged User Identity", "x-response-key": null, "summary": "/user_identities/unmanaged/update", "description": "Updates an unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.", "operationId": "userIdentitiesUnmanagedUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged user identity that you want to update." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Must be set to true to convert the unmanaged user identity to managed." }, "user_identity_key": { "type": "string", "description": "Unique key for the user identity. If not provided, the existing key will be preserved." } }, "required": ["user_identity_id", "is_managed"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "unmanaged"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update an Unmanaged User Identity", "x-response-key": null, "summary": "/user_identities/unmanaged/update", "description": "Updates an unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.", "operationId": "userIdentitiesUnmanagedUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged user identity that you want to update." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Must be set to true to convert the unmanaged user identity to managed." }, "user_identity_key": { "type": "string", "description": "Unique key for the user identity. If not provided, the existing key will be preserved." } }, "required": ["user_identity_id", "is_managed"] } } } }, "tags": ["/user_identities"], "x-fern-sdk-group-name": ["user_identities", "unmanaged"], "x-fern-sdk-method-name": "update" } }, "/workspaces/customization_profiles/create": { "post": { "x-title": "Update Customization Profile", "x-response-key": "customization_profile", "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/create", "description": "Updates the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile": { "$ref": "#/components/schemas/customization_profile" }, "ok": { "type": "boolean" } }, "required": ["customization_profile", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "default": null, "type": "string", "nullable": true }, "primary_color": { "type": "string" }, "secondary_color": { "type": "string" }, "customer_portal_theme": { "type": "object", "properties": { "primary_color": { "type": "string" }, "primary_foreground_color": { "type": "string" }, "secondary_color": { "type": "string" }, "secondary_foreground_color": { "type": "string" } } } } } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "customization_profile" } }, "/workspaces/customization_profiles/get": { "post": { "x-title": "Get Customization Profile", "x-response-key": "customization_profile", "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/get", "description": "Retrieves the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile": { "$ref": "#/components/schemas/customization_profile" }, "ok": { "type": "boolean" } }, "required": ["customization_profile", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile_id": { "type": "string", "format": "uuid" } }, "required": ["customization_profile_id"] } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "customization_profile" }, "get": { "x-title": "Get Customization Profile", "x-response-key": "customization_profile", "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/get", "description": "Retrieves the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile": { "$ref": "#/components/schemas/customization_profile" }, "ok": { "type": "boolean" } }, "required": ["customization_profile", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customization_profile_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "customization_profile" } }, "/workspaces/customization_profiles/list": { "post": { "x-title": "Get Customization Profile", "x-response-key": "customization_profiles", "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/list", "description": "Retrieves the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/customization_profile" } }, "ok": { "type": "boolean" } }, "required": ["customization_profiles", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which you want to list customization profiles." } } } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "customization_profiles" }, "get": { "x-title": "Get Customization Profile", "x-response-key": "customization_profiles", "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/list", "description": "Retrieves the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/customization_profile" } }, "ok": { "type": "boolean" } }, "required": ["customization_profiles", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which you want to list customization profiles." } } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "customization_profiles" } }, "/workspaces/customization_profiles/update": { "post": { "x-title": "Update Customization Profile", "x-response-key": null, "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/update", "description": "Updates the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "primary_color": { "type": "string" }, "secondary_color": { "type": "string" }, "customer_portal_theme": { "type": "object", "properties": { "primary_color": { "type": "string" }, "primary_foreground_color": { "type": "string" }, "secondary_color": { "type": "string" }, "secondary_foreground_color": { "type": "string" } }, "nullable": true } }, "required": ["customization_profile_id"] } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update Customization Profile", "x-response-key": null, "x-undocumented": "Unreleased.", "summary": "/workspaces/customization_profiles/update", "description": "Updates the customization profile for the workspace.", "operationId": "workspacesCustomizationProfilesUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customization_profile_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "primary_color": { "type": "string" }, "secondary_color": { "type": "string" }, "customer_portal_theme": { "type": "object", "properties": { "primary_color": { "type": "string" }, "primary_foreground_color": { "type": "string" }, "secondary_color": { "type": "string" }, "secondary_foreground_color": { "type": "string" } }, "nullable": true } }, "required": ["customization_profile_id"] } } } }, "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "update" } }, "/workspaces/customization_profiles/upload_images": { "post": { "x-title": "Upload Customization Profile Logo", "x-response-key": null, "x-undocumented": "Internal form-data endpoint for Console and Customer Portal.", "summary": "/workspaces/customization_profiles/upload_images", "description": "Uploads a logo for the customization profile.", "operationId": "workspacesCustomizationProfilesUploadImagesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "tags": ["/workspaces"], "x-fern-sdk-group-name": ["workspaces", "customization_profiles"], "x-fern-sdk-method-name": "upload_images" } }, "/acs/access_groups/unmanaged/get": { "get": { "x-title": "Get an Unmanaged Access Group", "x-response-key": "acs_access_group", "x-undocumented": "No unmanaged access groups are currently implemented.", "summary": "/acs/access_groups/unmanaged/get", "description": "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group": { "$ref": "#/components/schemas/unmanaged_acs_access_group" }, "ok": { "type": "boolean" } }, "required": ["acs_access_group", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_access_group_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access group that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_access_group" }, "post": { "x-title": "Get an Unmanaged Access Group", "x-response-key": "acs_access_group", "x-undocumented": "No unmanaged access groups are currently implemented.", "summary": "/acs/access_groups/unmanaged/get", "description": "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group": { "$ref": "#/components/schemas/unmanaged_acs_access_group" }, "ok": { "type": "boolean" } }, "required": ["acs_access_group", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access group that you want to get." } }, "required": ["acs_access_group_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_access_group" } }, "/acs/access_groups/unmanaged/list": { "get": { "x-title": "List Unmanaged Access Groups", "x-response-key": "acs_access_groups", "x-undocumented": "No unmanaged access groups are currently implemented.", "summary": "/acs/access_groups/unmanaged/list", "description": "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_access_group" } }, "ok": { "type": "boolean" } }, "required": ["acs_access_groups", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all unmanaged access groups." } }, { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all unmanaged access groups." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_access_groups" }, "post": { "x-title": "List Unmanaged Access Groups", "x-response-key": "acs_access_groups", "x-undocumented": "No unmanaged access groups are currently implemented.", "summary": "/acs/access_groups/unmanaged/list", "description": "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_access_group" } }, "ok": { "type": "boolean" } }, "required": ["acs_access_groups", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all unmanaged access groups." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all unmanaged access groups." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "access_groups", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_access_groups" } }, "/acs/credentials/unmanaged/get": { "get": { "x-title": "Get an Unmanaged Credential", "x-response-key": "acs_credential", "x-undocumented": "No unmanaged credentials are currently implemented.", "summary": "/acs/credentials/unmanaged/get", "description": "Returns a specified unmanaged [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/unmanaged_acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_credential_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged credential that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_credential" }, "post": { "x-title": "Get an Unmanaged Credential", "x-response-key": "acs_credential", "x-undocumented": "No unmanaged credentials are currently implemented.", "summary": "/acs/credentials/unmanaged/get", "description": "Returns a specified unmanaged [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential": { "$ref": "#/components/schemas/unmanaged_acs_credential" }, "ok": { "type": "boolean" } }, "required": ["acs_credential", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged credential that you want to get." } }, "required": ["acs_credential_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_credential" } }, "/acs/credentials/unmanaged/list": { "get": { "x-title": "List Unmanaged Credentials", "x-response-key": "acs_credentials", "x-undocumented": "No unmanaged credentials are currently implemented.", "summary": "/acs/credentials/unmanaged/list", "description": "Returns a list of all unmanaged [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_credential" } }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials" }, "post": { "x-title": "List Unmanaged Credentials", "x-response-key": "acs_credentials", "x-undocumented": "No unmanaged credentials are currently implemented.", "summary": "/acs/credentials/unmanaged/list", "description": "Returns a list of all unmanaged [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "acsCredentialsUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_credential" } }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all credentials." } }, "required": ["acs_user_id"], "description": "ID of the access system user for which you want to list unmanaged credentials." }, { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all credentials." } }, "required": ["acs_system_id"], "description": "ID of the access system for which you want to list unmanaged credentials." }, { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user for which you want to retrieve all credentials." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all credentials." } }, "required": ["acs_user_id", "acs_system_id"], "description": "ID of the access system and ID of the access system user for which you want to list unmanaged credentials." }, { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all credentials." } }, "required": ["user_identity_id"], "description": "ID of the user identity for which you want to list unmanaged credentials." } ] }, { "type": "object", "properties": { "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`." } } } ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "credentials", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials" } }, "/acs/encoders/simulate/next_credential_encode_will_fail": { "post": { "x-title": "Simulate that the Next Credential Encoding Will Fail", "x-response-key": null, "summary": "/acs/encoders/simulate/next_credential_encode_will_fail", "description": "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialEncodeWillFailPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`." }, "error_code": { "default": "no_credential_on_encoder", "type": "string", "enum": [ "no_credential_on_encoder", "encoding_interrupted" ], "description": "Code of the error to simulate." } }, "required": ["acs_encoder_id"], "additionalProperties": false }, { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`." }, "error_code": { "type": "string", "enum": [ "uncategorized_error", "action_attempt_expired" ], "description": "Code of the error to simulate." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_credential` that will fail to be encoded onto a card in the next request." } }, "required": ["acs_encoder_id", "error_code"], "additionalProperties": false } ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders", "simulate"], "x-fern-sdk-method-name": "next_credential_encode_will_fail" } }, "/acs/encoders/simulate/next_credential_encode_will_succeed": { "post": { "x-title": "Simulate that the Next Credential Encoding Will Succeed", "x-response-key": null, "summary": "/acs/encoders/simulate/next_credential_encode_will_succeed", "description": "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialEncodeWillSucceedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`." }, "scenario": { "default": "credential_is_issued", "type": "string", "enum": ["credential_is_issued"], "description": "Scenario to simulate." } }, "required": ["acs_encoder_id"], "additionalProperties": false } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders", "simulate"], "x-fern-sdk-method-name": "next_credential_encode_will_succeed" } }, "/acs/encoders/simulate/next_credential_scan_will_fail": { "post": { "x-title": "Simulate that the Next Credential Scan Will Fail", "x-response-key": null, "summary": "/acs/encoders/simulate/next_credential_scan_will_fail", "description": "Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialScanWillFailPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request." }, "error_code": { "default": "no_credential_on_encoder", "type": "string", "enum": ["no_credential_on_encoder"] } }, "required": ["acs_encoder_id"], "additionalProperties": false }, { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request." }, "error_code": { "type": "string", "enum": [ "uncategorized_error", "action_attempt_expired" ] }, "acs_credential_id_on_seam": { "type": "string", "format": "uuid" } }, "required": ["acs_encoder_id", "error_code"], "additionalProperties": false } ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders", "simulate"], "x-fern-sdk-method-name": "next_credential_scan_will_fail" } }, "/acs/encoders/simulate/next_credential_scan_will_succeed": { "post": { "x-title": "Simulate that the Next Credential Scan Will Succeed", "x-response-key": null, "summary": "/acs/encoders/simulate/next_credential_scan_will_succeed", "description": "Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialScanWillSucceedPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`." }, "scenario": { "default": "credential_exists_on_seam", "type": "string", "enum": [ "credential_exists_on_seam", "credential_on_encoder_needs_update" ], "description": "Scenario to simulate." }, "acs_credential_id_on_seam": { "type": "string", "format": "uuid", "description": "ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation." } }, "required": ["acs_encoder_id"], "additionalProperties": false }, { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`." }, "scenario": { "type": "string", "enum": ["credential_does_not_exist_on_seam"], "description": "Scenario to simulate." } }, "required": ["acs_encoder_id", "scenario"], "additionalProperties": false }, { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`." }, "scenario": { "type": "string", "enum": ["credential_on_encoder_is_empty"], "description": "Scenario to simulate." } }, "required": ["acs_encoder_id", "scenario"], "additionalProperties": false } ] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "encoders", "simulate"], "x-fern-sdk-method-name": "next_credential_scan_will_succeed" } }, "/acs/users/unmanaged/get": { "get": { "x-title": "Get an Unmanaged ACS User", "x-undocumented": "No unmanaged users are currently implemented.", "x-response-key": "acs_user", "summary": "/acs/users/unmanaged/get", "description": "Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersUnmanagedGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user": { "$ref": "#/components/schemas/unmanaged_acs_user" }, "ok": { "type": "boolean" } }, "required": ["acs_user", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "acs_user_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access system user that you want to get." }, "required": true } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_user" }, "post": { "x-title": "Get an Unmanaged ACS User", "x-undocumented": "No unmanaged users are currently implemented.", "x-response-key": "acs_user", "summary": "/acs/users/unmanaged/get", "description": "Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersUnmanagedGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user": { "$ref": "#/components/schemas/unmanaged_acs_user" }, "ok": { "type": "boolean" } }, "required": ["acs_user", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the unmanaged access system user that you want to get." } }, "required": ["acs_user_id"] } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users", "unmanaged"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_user" } }, "/acs/users/unmanaged/list": { "get": { "x-title": "List Unmanaged ACS Users", "x-undocumented": "No unmanaged users are currently implemented.", "x-response-key": "acs_users", "summary": "/acs/users/unmanaged/list", "description": "Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersUnmanagedListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_user" } }, "ok": { "type": "boolean" } }, "required": ["acs_users", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "user_identity_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all unmanaged access system users." } }, { "name": "user_identity_phone_number", "in": "query", "schema": { "type": "string", "description": "Phone number of the user identity for which you want to retrieve all unmanaged access system users." } }, { "name": "user_identity_email_address", "in": "query", "schema": { "type": "string", "description": "Email address of the user identity for which you want to retrieve all unmanaged access system users." } }, { "name": "acs_system_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all unmanaged access system users." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Number of unmanaged access system users to return." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`." } } ], "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_users" }, "post": { "x-title": "List Unmanaged ACS Users", "x-undocumented": "No unmanaged users are currently implemented.", "x-response-key": "acs_users", "summary": "/acs/users/unmanaged/list", "description": "Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "operationId": "acsUsersUnmanagedListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_user" } }, "ok": { "type": "boolean" } }, "required": ["acs_users", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity for which you want to retrieve all unmanaged access system users." }, "user_identity_phone_number": { "type": "string", "description": "Phone number of the user identity for which you want to retrieve all unmanaged access system users." }, "user_identity_email_address": { "type": "string", "description": "Email address of the user identity for which you want to retrieve all unmanaged access system users." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system for which you want to retrieve all unmanaged access system users." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Number of unmanaged access system users to return." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`." } } } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": ["acs", "users", "unmanaged"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_users" } }, "/seam/console/v1/get_resource_locator": { "get": { "x-title": "Get Resource Locator", "x-response-key": "resource_locator", "x-undocumented": "Internal endpoint for Console", "summary": "/seam/console/v1/get_resource_locator", "description": "Returns the type and system information of a resource given its UUID.", "operationId": "seamConsoleV1GetResourceLocatorGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource_locator": { "type": "object", "properties": { "resource_type": { "type": "string" }, "acs_system_id": { "type": "string", "format": "uuid" }, "device_id": { "type": "string", "format": "uuid" } }, "required": ["resource_type"] }, "ok": { "type": "boolean" } }, "required": ["resource_locator", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "uuid", "in": "query", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["seam", "console", "v1"], "x-fern-sdk-method-name": "get_resource_locator", "x-fern-sdk-return-value": "resource_locator" }, "post": { "x-title": "Get Resource Locator", "x-response-key": "resource_locator", "x-undocumented": "Internal endpoint for Console", "summary": "/seam/console/v1/get_resource_locator", "description": "Returns the type and system information of a resource given its UUID.", "operationId": "seamConsoleV1GetResourceLocatorPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource_locator": { "type": "object", "properties": { "resource_type": { "type": "string" }, "acs_system_id": { "type": "string", "format": "uuid" }, "device_id": { "type": "string", "format": "uuid" } }, "required": ["resource_type"] }, "ok": { "type": "boolean" } }, "required": ["resource_locator", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "uuid", "in": "query", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["seam", "console", "v1"], "x-fern-sdk-method-name": "get_resource_locator", "x-fern-sdk-return-value": "resource_locator" } }, "/seam/mobile_sdk/v1/report_salto_space_audit_trail": { "post": { "x-title": "Report Salto Space Audit Trail", "x-undocumented": "Mobile SDK only.", "x-response-key": null, "summary": "/seam/mobile_sdk/v1/report_salto_space_audit_trail", "description": "Reports audit trail data from Salto Space mobile SDK.", "operationId": "seamMobileSdkV1ReportSaltoSpaceAuditTrailPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid" }, "salto_space_metadata": { "type": "object", "properties": { "justin_mobile_sdk_audit_trail_data": { "type": "string", "minLength": 1 } }, "required": ["justin_mobile_sdk_audit_trail_data"] } }, "required": ["acs_system_id", "salto_space_metadata"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1"], "x-fern-sdk-method-name": "report_salto_space_audit_trail" } }, "/seam/bridge/v1/bridge_client_sessions/create": { "post": { "x-title": "Create a Bridge Client Session", "x-response-key": "bridge_client_session", "x-undocumented": "Seam Bridge client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/create", "description": "Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.", "operationId": "seamBridgeV1BridgeClientSessionsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_session": { "$ref": "#/components/schemas/bridge_client_session" }, "ok": { "type": "boolean" } }, "required": ["bridge_client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "certified_client": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_name": { "type": "string", "description": "Name of the Seam Bridge client that you want to create." }, "bridge_client_time_zone": { "type": "string", "description": "Time zone for the Seam Bridge client that you want to create." }, "bridge_client_machine_identifier_key": { "type": "string", "description": "Identifier key of the client machine for the Seam Bridge client that you want to create." } }, "required": [ "bridge_client_name", "bridge_client_time_zone", "bridge_client_machine_identifier_key" ] } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "bridge_client_session" } }, "/seam/bridge/v1/bridge_client_sessions/get": { "get": { "x-title": "Get a Seam Bridge Client Session", "x-response-key": "bridge_client_session", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/get", "description": "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.", "operationId": "seamBridgeV1BridgeClientSessionsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_session": { "$ref": "#/components/schemas/bridge_client_session" }, "ok": { "type": "boolean" } }, "required": ["bridge_client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "bridge_client_session" }, "post": { "x-title": "Get a Seam Bridge Client Session", "x-response-key": "bridge_client_session", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/get", "description": "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.", "operationId": "seamBridgeV1BridgeClientSessionsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_session": { "$ref": "#/components/schemas/bridge_client_session" }, "ok": { "type": "boolean" } }, "required": ["bridge_client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "bridge_client_session" } }, "/seam/bridge/v1/bridge_client_sessions/refresh_tailscale_auth_key": { "post": { "x-title": "Refresh the Tailscale Auth Key for a Seam Bridge Client Session", "x-response-key": "bridge_client_session", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/refresh_tailscale_auth_key", "description": "Refreshes the Tailscale auth key for the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.", "operationId": "seamBridgeV1BridgeClientSessionsRefreshTailscaleAuthKeyPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_session": { "$ref": "#/components/schemas/bridge_client_session" }, "ok": { "type": "boolean" } }, "required": ["bridge_client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "refresh_tailscale_auth_key", "x-fern-sdk-return-value": "bridge_client_session" } }, "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token": { "post": { "x-title": "Refresh the Telemetry Token for a Seam Bridge Client Session", "x-response-key": "bridge_client_session", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token", "description": "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication and refreshed telemetry token.", "operationId": "seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_session": { "$ref": "#/components/schemas/bridge_client_session" }, "ok": { "type": "boolean" } }, "required": ["bridge_client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "refresh_telemetry_token", "x-fern-sdk-return-value": "bridge_client_session" } }, "/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code": { "post": { "x-title": "Regenerate a Seam Bridge Client Session Pairing Code", "x-response-key": "bridge_client_session", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code", "description": "Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.", "operationId": "seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_client_session": { "$ref": "#/components/schemas/bridge_client_session" }, "ok": { "type": "boolean" } }, "required": ["bridge_client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "regenerate_pairing_code", "x-fern-sdk-return-value": "bridge_client_session" } }, "/seam/bridge/v1/bridge_client_sessions/report_status": { "post": { "x-title": "Report the Status of a Seam Bridge Client", "x-response-key": null, "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_client_sessions/report_status", "description": "Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.", "operationId": "seamBridgeV1BridgeClientSessionsReportStatusPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_tailscale_connected": { "type": "boolean", "nullable": true, "description": "Indicates whether Tailscale is connected." }, "tailscale_ip_v4": { "type": "string", "nullable": true, "description": "Tailscale IPv4 address." } }, "required": ["is_tailscale_connected", "tailscale_ip_v4"] } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_client_sessions" ], "x-fern-sdk-method-name": "report_status" } }, "/seam/console/v1/timelines/get": { "get": { "x-title": "Get Timeline Entries", "x-response-key": "timeline", "x-undocumented": "Internal endpoint for Console", "summary": "/seam/console/v1/timelines/get", "description": "Returns timeline entries for a resource and its child resources, grouped by entry groups.", "operationId": "seamConsoleV1TimelinesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeline": { "type": "object", "properties": { "resource_type": { "type": "string" }, "resource_id": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "context": { "oneOf": [ { "type": "object", "properties": { "context_type": { "type": "string", "enum": ["request"] }, "request_id": { "type": "string" }, "request_payload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "response_payload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } } }, "required": [ "context_type", "request_id", "request_payload", "response_payload" ] }, { "type": "object", "properties": { "context_type": { "type": "string", "enum": ["job"] }, "job_id": { "type": "string" } }, "required": ["context_type", "job_id"] } ] }, "entries": { "type": "array", "items": { "type": "object", "properties": { "resource_type": { "type": "string" }, "resource_id": { "type": "string" }, "entry_type": { "type": "string" }, "body": { "oneOf": [ { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["resource_created"] }, "description": { "type": "string" } }, "required": [ "entry_type", "description" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["resource_updated"] }, "description": { "type": "string" }, "properties_updated": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "properties_before": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "errors": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "entry_type", "description" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["resource_deleted"] }, "description": { "type": "string" } }, "required": [ "entry_type", "description" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["event"] }, "event_type": { "type": "string" }, "event_id": { "type": "string" } }, "required": [ "entry_type", "event_type", "event_id" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["provider_call"] }, "description": { "type": "string" }, "response_status_code": { "type": "number", "format": "float" }, "response_body": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } } }, "required": [ "entry_type", "description", "response_status_code" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["automation_run"] }, "rule_name": { "type": "string" }, "status": { "type": "string", "enum": [ "started", "completed", "failed", "skipped" ] }, "skip_reason": { "type": "string" }, "error_message": { "type": "string" }, "duration_ms": { "type": "number", "format": "float" } }, "required": [ "entry_type", "rule_name", "status" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["webhook_processed"] }, "connector_type": { "type": "string" }, "event_type": { "type": "string" }, "status": { "type": "string", "enum": [ "processed", "skipped", "failed" ] }, "skip_reason": { "type": "string" }, "error_message": { "type": "string" }, "raw_payload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "parsed_event": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } } }, "required": [ "entry_type", "connector_type", "event_type", "status" ] } ] }, "created_at": { "type": "string" } }, "required": [ "resource_type", "resource_id", "entry_type", "body", "created_at" ] } }, "created_at": { "type": "string" } }, "required": ["context", "entries", "created_at"] } } }, "required": ["resource_type", "resource_id", "groups"] }, "pagination": { "type": "object", "properties": { "next_page_cursor": { "type": "string", "nullable": true, "description": "Opaque value that can be used to select the next page of results via the `page_cursor` parameter." }, "has_next_page": { "type": "boolean", "description": "Indicates whether there is another page of results after this one." }, "next_page_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL to get the next page of results." }, "total_count": { "type": "integer", "description": "Total number of timeline entry groups" }, "page_size": { "type": "integer", "description": "Number of items per page" } }, "required": [ "next_page_cursor", "has_next_page", "next_page_url", "total_count", "page_size" ], "description": "Information about the current page of results." }, "ok": { "type": "boolean" } }, "required": ["timeline", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "resource_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the resource to get timelines for." }, "required": true }, { "name": "limit", "in": "query", "schema": { "default": 50, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 100, "description": "Maximum number of timeline entry groups to return per page. Maximum 100." }, "required": false }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp." }, "required": false }, { "name": "created_after", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned timeline entries. Returns entries created after this timestamp." }, "required": false }, { "name": "created_between", "in": "query", "schema": { "description": "Time range to filter timeline entries. Returns entries created between the two timestamps [start, end]." }, "required": false }, { "name": "entry_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "resource_created", "resource_updated", "resource_deleted", "event", "provider_call", "automation_run", "webhook_processed" ] }, "description": "Filter timeline entries by entry type. If not specified, all entry types are returned." }, "required": false }, { "name": "context_type", "in": "query", "schema": { "type": "string", "enum": ["request", "job"], "description": "Filter timeline entries by context type. 'request' for API requests, 'job' for background jobs." }, "required": false }, { "name": "page_cursor", "in": "query", "schema": { "type": "string", "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." }, "required": false } ], "tags": [], "x-fern-sdk-group-name": ["seam", "console", "v1", "timelines"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "timeline" }, "post": { "x-title": "Get Timeline Entries", "x-response-key": "timeline", "x-undocumented": "Internal endpoint for Console", "summary": "/seam/console/v1/timelines/get", "description": "Returns timeline entries for a resource and its child resources, grouped by entry groups.", "operationId": "seamConsoleV1TimelinesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeline": { "type": "object", "properties": { "resource_type": { "type": "string" }, "resource_id": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "context": { "oneOf": [ { "type": "object", "properties": { "context_type": { "type": "string", "enum": ["request"] }, "request_id": { "type": "string" }, "request_payload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "response_payload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } } }, "required": [ "context_type", "request_id", "request_payload", "response_payload" ] }, { "type": "object", "properties": { "context_type": { "type": "string", "enum": ["job"] }, "job_id": { "type": "string" } }, "required": ["context_type", "job_id"] } ] }, "entries": { "type": "array", "items": { "type": "object", "properties": { "resource_type": { "type": "string" }, "resource_id": { "type": "string" }, "entry_type": { "type": "string" }, "body": { "oneOf": [ { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["resource_created"] }, "description": { "type": "string" } }, "required": [ "entry_type", "description" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["resource_updated"] }, "description": { "type": "string" }, "properties_updated": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "properties_before": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "errors": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "entry_type", "description" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["resource_deleted"] }, "description": { "type": "string" } }, "required": [ "entry_type", "description" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["event"] }, "event_type": { "type": "string" }, "event_id": { "type": "string" } }, "required": [ "entry_type", "event_type", "event_id" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["provider_call"] }, "description": { "type": "string" }, "response_status_code": { "type": "number", "format": "float" }, "response_body": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } } }, "required": [ "entry_type", "description", "response_status_code" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["automation_run"] }, "rule_name": { "type": "string" }, "status": { "type": "string", "enum": [ "started", "completed", "failed", "skipped" ] }, "skip_reason": { "type": "string" }, "error_message": { "type": "string" }, "duration_ms": { "type": "number", "format": "float" } }, "required": [ "entry_type", "rule_name", "status" ] }, { "type": "object", "properties": { "entry_type": { "type": "string", "enum": ["webhook_processed"] }, "connector_type": { "type": "string" }, "event_type": { "type": "string" }, "status": { "type": "string", "enum": [ "processed", "skipped", "failed" ] }, "skip_reason": { "type": "string" }, "error_message": { "type": "string" }, "raw_payload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "parsed_event": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } } }, "required": [ "entry_type", "connector_type", "event_type", "status" ] } ] }, "created_at": { "type": "string" } }, "required": [ "resource_type", "resource_id", "entry_type", "body", "created_at" ] } }, "created_at": { "type": "string" } }, "required": ["context", "entries", "created_at"] } } }, "required": ["resource_type", "resource_id", "groups"] }, "pagination": { "type": "object", "properties": { "next_page_cursor": { "type": "string", "nullable": true, "description": "Opaque value that can be used to select the next page of results via the `page_cursor` parameter." }, "has_next_page": { "type": "boolean", "description": "Indicates whether there is another page of results after this one." }, "next_page_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL to get the next page of results." }, "total_count": { "type": "integer", "description": "Total number of timeline entry groups" }, "page_size": { "type": "integer", "description": "Number of items per page" } }, "required": [ "next_page_cursor", "has_next_page", "next_page_url", "total_count", "page_size" ], "description": "Information about the current page of results." }, "ok": { "type": "boolean" } }, "required": ["timeline", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resource_id": { "type": "string", "format": "uuid", "description": "ID of the resource to get timelines for." }, "limit": { "default": 50, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 100, "description": "Maximum number of timeline entry groups to return per page. Maximum 100." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp." }, "created_after": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned timeline entries. Returns entries created after this timestamp." }, "created_between": { "description": "Time range to filter timeline entries. Returns entries created between the two timestamps [start, end]." }, "entry_types": { "type": "array", "items": { "type": "string", "enum": [ "resource_created", "resource_updated", "resource_deleted", "event", "provider_call", "automation_run", "webhook_processed" ] }, "description": "Filter timeline entries by entry type. If not specified, all entry types are returned." }, "context_type": { "type": "string", "enum": ["request", "job"], "description": "Filter timeline entries by context type. 'request' for API requests, 'job' for background jobs." }, "page_cursor": { "type": "string", "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } }, "required": ["resource_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "console", "v1", "timelines"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "timeline" } }, "/seam/bridge/v1/bridge_connected_systems/list": { "get": { "x-title": "List Bridge-Connected Systems", "x-response-key": "bridge_connected_systems", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_connected_systems/list", "description": "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.", "operationId": "seamBridgeV1BridgeConnectedSystemsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_connected_systems": { "type": "array", "items": { "$ref": "#/components/schemas/bridge_connected_systems" } }, "ok": { "type": "boolean" } }, "required": ["bridge_connected_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_connected_systems" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "bridge_connected_systems" }, "post": { "x-title": "List Bridge-Connected Systems", "x-response-key": "bridge_connected_systems", "x-undocumented": "Seam Bridge Client only.", "summary": "/seam/bridge/v1/bridge_connected_systems/list", "description": "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.", "operationId": "seamBridgeV1BridgeConnectedSystemsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bridge_connected_systems": { "type": "array", "items": { "$ref": "#/components/schemas/bridge_connected_systems" } }, "ok": { "type": "boolean" } }, "required": ["bridge_connected_systems", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "bridge_client_session": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "bridge", "v1", "bridge_connected_systems" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "bridge_connected_systems" } }, "/seam/customer/v1/access_grants/list": { "get": { "x-title": "List Access Grants (Other Access)", "x-response-key": "access_grants", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/access_grants/list", "description": "Gets an Access Grant.", "operationId": "seamCustomerV1AccessGrantsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "ok": { "type": "boolean" } }, "required": ["access_grants", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_grants"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants" }, "post": { "x-title": "List Access Grants (Other Access)", "x-response-key": "access_grants", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/access_grants/list", "description": "Gets an Access Grant.", "operationId": "seamCustomerV1AccessGrantsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "ok": { "type": "boolean" } }, "required": ["access_grants", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_grants"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants" } }, "/seam/customer/v1/access_grants/update": { "post": { "x-title": "Update Access Grant Spaces", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/access_grants/update", "description": "Updates the spaces (locations) associated with an Access Grant.", "operationId": "seamCustomerV1AccessGrantsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant to update." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of location IDs to associate with the access grant." } }, "required": ["access_grant_id", "space_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_grants"], "x-fern-sdk-method-name": "update" }, "patch": { "x-title": "Update Access Grant Spaces", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/access_grants/update", "description": "Updates the spaces (locations) associated with an Access Grant.", "operationId": "seamCustomerV1AccessGrantsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant to update." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of location IDs to associate with the access grant." } }, "required": ["access_grant_id", "space_ids"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_grants"], "x-fern-sdk-method-name": "update" } }, "/seam/customer/v1/access_methods/encode": { "post": { "x-title": "Encode an Access Method", "x-response-key": "action_attempt", "x-action-attempt-type": "ENCODE_CREDENTIAL", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/access_methods/encode", "description": "Encodes an existing access method onto a plastic card placed on the specified encoder.\nThis endpoint is intended for use within embedded customer portals, such as deep links\nfor reservation management.", "operationId": "seamCustomerV1AccessMethodsEncodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": ["action_attempt", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the encoder to use for encoding the access method." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method to encode onto a card." } }, "required": ["acs_encoder_id", "access_method_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "access_methods"], "x-fern-sdk-method-name": "encode", "x-fern-sdk-return-value": "action_attempt" } }, "/seam/customer/v1/automations/delete": { "delete": { "x-title": "Delete Customer Portal Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automations/delete", "description": "Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.", "operationId": "seamCustomerV1AutomationsDeleteDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"], "x-fern-sdk-method-name": "delete" }, "post": { "x-title": "Delete Customer Portal Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automations/delete", "description": "Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.", "operationId": "seamCustomerV1AutomationsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"], "x-fern-sdk-method-name": "delete" } }, "/seam/customer/v1/automations/get": { "get": { "x-title": "Get Customer Portal Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automations/get", "description": "Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.", "operationId": "seamCustomerV1AutomationsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule", "config"] } } }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "$ref": "#/components/schemas/access_code" }, "reservation_deleted": { "$ref": "#/components/schemas/access_code" } } } }, "required": ["rules"] }, "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Key of the customer to get automation config for." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"], "x-fern-sdk-method-name": "get" }, "post": { "x-title": "Get Customer Portal Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automations/get", "description": "Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.", "operationId": "seamCustomerV1AutomationsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule", "config"] } } }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "$ref": "#/components/schemas/access_code" }, "reservation_deleted": { "$ref": "#/components/schemas/access_code" } } } }, "required": ["rules"] }, "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Key of the customer to get automation config for." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"], "x-fern-sdk-method-name": "get" } }, "/seam/customer/v1/automations/update": { "patch": { "x-title": "Update Customer Portal Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automations/update", "description": "Updates the automation configuration for a customer portal workspace.", "operationId": "seamCustomerV1AutomationsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Key of the customer to update automation config for." }, "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule", "config"] } }, "description": "Access automation rules configuration." }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "type": "object", "properties": {} }, "reservation_deleted": { "type": "object", "properties": {} } } } }, "description": "Climate automation rules configuration." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update Customer Portal Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automations/update", "description": "Updates the automation configuration for a customer portal workspace.", "operationId": "seamCustomerV1AutomationsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Key of the customer to update automation config for." }, "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule", "config"] } }, "description": "Access automation rules configuration." }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "type": "object", "properties": {} }, "reservation_deleted": { "type": "object", "properties": {} } } } }, "description": "Climate automation rules configuration." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"], "x-fern-sdk-method-name": "update" } }, "/seam/customer/v1/automation_runs/list": { "get": { "x-title": "List Automation Runs", "x-response-key": "automation_runs", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automation_runs/list", "description": "Returns a list of all automation runs for a workspace or customer.", "operationId": "seamCustomerV1AutomationRunsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "automation_runs": { "type": "array", "items": { "type": "object", "properties": { "automation_run_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": "string", "format": "uuid" }, "automation_id": { "type": "string", "format": "uuid", "nullable": true }, "partner_resource_id": { "type": "string", "format": "uuid", "nullable": true }, "partner_key": { "type": "string", "nullable": true }, "resource_type": { "type": "string", "nullable": true }, "resource_type_alias": { "type": "string", "nullable": true }, "automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string", "enum": [ "reservation_created", "reservation_time_updated", "reservation_deleted" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": ["create", "update", "delete"] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" } }, "required": [ "action_type", "resource_type", "access_grant_id" ] } }, "error": { "type": "string" }, "message": { "type": "string" } }, "required": ["success", "rule", "actions"] }, "created_at": { "type": "string" } }, "required": [ "automation_run_id", "workspace_id", "automation_id", "partner_resource_id", "partner_key", "resource_type", "resource_type_alias", "created_at" ] } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["automation_runs", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "parameters": [ { "name": "automation_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the automation for which you want to retrieve all automation runs." } }, { "name": "partner_resource_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the partner resource for which you want to retrieve all automation runs." } }, { "name": "rule", "in": "query", "schema": { "type": "string", "enum": [ "reservation_created", "reservation_time_updated", "reservation_deleted", "space_name_updated" ], "description": "Filter automation runs by the specific rule that was executed." } }, { "name": "success", "in": "query", "schema": { "type": "boolean", "description": "Filter automation runs by success status." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned automation runs. Returns runs created before this timestamp." } }, { "name": "page_cursor", "in": "query", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automation_runs"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "automation_runs" }, "post": { "x-title": "List Automation Runs", "x-response-key": "automation_runs", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/automation_runs/list", "description": "Returns a list of all automation runs for a workspace or customer.", "operationId": "seamCustomerV1AutomationRunsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "automation_runs": { "type": "array", "items": { "type": "object", "properties": { "automation_run_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": "string", "format": "uuid" }, "automation_id": { "type": "string", "format": "uuid", "nullable": true }, "partner_resource_id": { "type": "string", "format": "uuid", "nullable": true }, "partner_key": { "type": "string", "nullable": true }, "resource_type": { "type": "string", "nullable": true }, "resource_type_alias": { "type": "string", "nullable": true }, "automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string", "enum": [ "reservation_created", "reservation_time_updated", "reservation_deleted" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": ["create", "update", "delete"] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" } }, "required": [ "action_type", "resource_type", "access_grant_id" ] } }, "error": { "type": "string" }, "message": { "type": "string" } }, "required": ["success", "rule", "actions"] }, "created_at": { "type": "string" } }, "required": [ "automation_run_id", "workspace_id", "automation_id", "partner_resource_id", "partner_key", "resource_type", "resource_type_alias", "created_at" ] } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["automation_runs", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "automation_id": { "type": "string", "format": "uuid", "description": "ID of the automation for which you want to retrieve all automation runs." }, "partner_resource_id": { "type": "string", "format": "uuid", "description": "ID of the partner resource for which you want to retrieve all automation runs." }, "rule": { "type": "string", "enum": [ "reservation_created", "reservation_time_updated", "reservation_deleted", "space_name_updated" ], "description": "Filter automation runs by the specific rule that was executed." }, "success": { "type": "boolean", "description": "Filter automation runs by success status." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned automation runs. Returns runs created before this timestamp." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "type": "string", "nullable": true } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "automation_runs"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "automation_runs" } }, "/seam/customer/v1/customers/list": { "get": { "x-title": "List Customers", "x-response-key": "customers", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/customers/list", "description": "Returns a list of all customers within the workspace.", "operationId": "seamCustomerV1CustomersListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/customer" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["customers", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned customers to include all records that satisfy a partial match using `customer_key`." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "page_cursor", "in": "query", "schema": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "customers" }, "post": { "x-title": "List Customers", "x-response-key": "customers", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/customers/list", "description": "Returns a list of all customers within the workspace.", "operationId": "seamCustomerV1CustomersListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/customer" } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["customers", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned customers to include all records that satisfy a partial match using `customer_key`." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "page_cursor": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "customers" } }, "/seam/customer/v1/customers/me": { "get": { "x-title": "Me", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/customers/me", "description": "Returns the customer associated with the authenticated client session.", "operationId": "seamCustomerV1CustomersMeGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/customer" }, "connector": { "type": "object", "properties": { "connector_type": { "type": "string" } }, "required": ["connector_type"] }, "ok": { "type": "boolean" } }, "required": ["customer", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"], "x-fern-sdk-method-name": "me" }, "post": { "x-title": "Me", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/customers/me", "description": "Returns the customer associated with the authenticated client session.", "operationId": "seamCustomerV1CustomersMePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/customer" }, "connector": { "type": "object", "properties": { "connector_type": { "type": "string" } }, "required": ["connector_type"] }, "ok": { "type": "boolean" } }, "required": ["customer", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"], "x-fern-sdk-method-name": "me" } }, "/seam/customer/v1/customers/open_portal": { "post": { "x-title": "Open Customer Portal", "x-response-key": "magic_link", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/customers/open_portal", "description": "Opens an existing customer portal or creates a new one if the previous portal has expired.\nReturns an error if no portal was ever created for this customer.", "operationId": "seamCustomerV1CustomersOpenPortalPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "magic_link": { "$ref": "#/components/schemas/magic_link" }, "ok": { "type": "boolean" } }, "required": ["magic_link", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "The customer key to open a portal for." } }, "required": ["customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"], "x-fern-sdk-method-name": "open_portal", "x-fern-sdk-return-value": "magic_link" } }, "/seam/customer/v1/connector_customers/list": { "get": { "x-title": "List Connector Customers", "x-response-key": "connector_customers", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connector_customers/list", "description": "Lists connector customers for a given connector.", "operationId": "seamCustomerV1ConnectorCustomersListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_customers": { "type": "array", "items": { "type": "object", "properties": { "connector_customer_id": { "type": "string" }, "connector_id": { "type": "string" }, "customer_key": { "type": "string" }, "instance_config": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" }, "nullable": true }, "initial_sync_completed": { "type": "boolean" }, "initial_sync_status": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "connector_customer_id", "connector_id", "customer_key", "instance_config", "initial_sync_completed", "initial_sync_status", "status", "created_at", "updated_at" ] } }, "ok": { "type": "boolean" } }, "required": ["connector_customers", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "connector_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the connector." } } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "connector_customers" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connector_customers" }, "post": { "x-title": "List Connector Customers", "x-response-key": "connector_customers", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connector_customers/list", "description": "Lists connector customers for a given connector.", "operationId": "seamCustomerV1ConnectorCustomersListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_customers": { "type": "array", "items": { "type": "object", "properties": { "connector_customer_id": { "type": "string" }, "connector_id": { "type": "string" }, "customer_key": { "type": "string" }, "instance_config": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" }, "nullable": true }, "initial_sync_completed": { "type": "boolean" }, "initial_sync_status": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "connector_customer_id", "connector_id", "customer_key", "instance_config", "initial_sync_completed", "initial_sync_status", "status", "created_at", "updated_at" ] } }, "ok": { "type": "boolean" } }, "required": ["connector_customers", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_id": { "type": "string", "format": "uuid", "description": "ID of the connector." } } } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "connector_customers" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connector_customers" } }, "/seam/customer/v1/connectors/authorize": { "get": { "x-title": "Get OAuth Authorization URL for Global Connector", "x-response-key": "connector_authorize", "x-undocumented": "Internal endpoint for OAuth authorization.", "summary": "/seam/customer/v1/connectors/authorize", "description": "Returns the OAuth authorization URL for a global connector.\nThis endpoint only works for global connectors (connectors that support multiple customers).", "operationId": "seamCustomerV1ConnectorsAuthorizeGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_authorize": { "type": "object", "properties": { "authorize_url": { "type": "string", "format": "uri" }, "connector_type": { "type": "string" } }, "required": ["authorize_url", "connector_type"] }, "ok": { "type": "boolean" } }, "required": ["connector_authorize", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "parameters": [ { "name": "slug", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "Workspace slug" }, "required": true }, { "name": "connector_name", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "Connector name/type. If not provided, workspace_slug will be used as connector_name" }, "required": false } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "authorize", "x-fern-sdk-return-value": "connector_authorize" }, "post": { "x-title": "Get OAuth Authorization URL for Global Connector", "x-response-key": "connector_authorize", "x-undocumented": "Internal endpoint for OAuth authorization.", "summary": "/seam/customer/v1/connectors/authorize", "description": "Returns the OAuth authorization URL for a global connector.\nThis endpoint only works for global connectors (connectors that support multiple customers).", "operationId": "seamCustomerV1ConnectorsAuthorizePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_authorize": { "type": "object", "properties": { "authorize_url": { "type": "string", "format": "uri" }, "connector_type": { "type": "string" } }, "required": ["authorize_url", "connector_type"] }, "ok": { "type": "boolean" } }, "required": ["connector_authorize", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "description": "Workspace slug" }, "connector_name": { "type": "string", "minLength": 1, "description": "Connector name/type. If not provided, workspace_slug will be used as connector_name" } }, "required": ["slug"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "authorize", "x-fern-sdk-return-value": "connector_authorize" } }, "/seam/customer/v1/connectors/connector_types": { "get": { "x-title": "List Connector Types", "x-response-key": "connector_types", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/connector_types", "description": "Lists all available connector types and their editable fields for UI input.", "operationId": "seamCustomerV1ConnectorsConnectorTypesGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_types": { "type": "array", "items": { "type": "object", "properties": { "connector_type": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "editable_fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "string[]", "number", "boolean" ] }, "required": { "type": "boolean" } }, "required": [ "name", "display_name", "description", "type", "required" ] } } }, "required": [ "connector_type", "display_name", "editable_fields" ] } }, "ok": { "type": "boolean" } }, "required": ["connector_types", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "console_session_with_workspace": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "connector_types", "x-fern-sdk-return-value": "connector_types" }, "post": { "x-title": "List Connector Types", "x-response-key": "connector_types", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/connector_types", "description": "Lists all available connector types and their editable fields for UI input.", "operationId": "seamCustomerV1ConnectorsConnectorTypesPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_types": { "type": "array", "items": { "type": "object", "properties": { "connector_type": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "editable_fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "string[]", "number", "boolean" ] }, "required": { "type": "boolean" } }, "required": [ "name", "display_name", "description", "type", "required" ] } } }, "required": [ "connector_type", "display_name", "editable_fields" ] } }, "ok": { "type": "boolean" } }, "required": ["connector_types", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "console_session_with_workspace": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "connector_types", "x-fern-sdk-return-value": "connector_types" } }, "/seam/customer/v1/connectors/create": { "post": { "x-title": "Create Connector", "x-response-key": "connector", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/create", "description": "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.", "operationId": "seamCustomerV1ConnectorsCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector": { "type": "object", "properties": { "connector_id": { "type": "string" }, "connector_type": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive", "error"] }, "webhook_subscription": { "type": "object", "properties": { "subscription_id": { "type": "string" }, "webhook_url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["active", "inactive", "error"] } }, "required": [ "subscription_id", "webhook_url", "events", "status" ] }, "error": { "type": "string" } }, "required": ["connector_id", "connector_type", "status"] }, "ok": { "type": "boolean" } }, "required": ["connector", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_type": { "type": "string", "enum": [ "mock", "mews", "rms", "cloudbeds", "smoobu", "zonal", "ical" ], "description": "Type of connector to create" }, "customer_key": { "description": "Key identifying the customer", "type": "string", "minLength": 1 }, "config": { "type": "object", "additionalProperties": {}, "description": "Instance-specific configuration for the connector" } }, "required": ["connector_type", "config"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "connector" } }, "/seam/customer/v1/connectors/delete": { "post": { "x-title": "Delete Connector", "x-response-key": "connector", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/delete", "description": "Deletes a connector from a workspace. The connector must already be assigned to a workspace.\nThis will remove the connector row from the database and deactivate any active connections.", "operationId": "seamCustomerV1ConnectorsDeletePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector": { "type": "object", "properties": { "connector_id": { "type": "string" }, "connector_type": { "type": "string" }, "status": { "type": "string", "enum": ["deleted"] } }, "required": ["connector_id", "connector_type", "status"] }, "ok": { "type": "boolean" } }, "required": ["connector", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_id": { "type": "string", "minLength": 1, "description": "ID of the connector to delete" }, "customer_key": { "type": "string" }, "customer_id": { "type": "string" }, "connector_customer_id": { "type": "string" }, "unique_provider_resource_key": { "type": "string" } }, "required": ["connector_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "delete", "x-fern-sdk-return-value": "connector" } }, "/seam/customer/v1/connectors/list": { "get": { "x-title": "List Connectors", "x-response-key": "connectors", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/list", "description": "Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).", "operationId": "seamCustomerV1ConnectorsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "type": "object", "properties": { "connector_id": { "type": "string" }, "connector_type": { "type": "string" }, "customer_key": { "type": "string", "nullable": true }, "unique_provider_resource_key": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": ["active", "inactive", "error"] }, "config": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "connector_id", "connector_type", "customer_key", "unique_provider_resource_key", "status", "config", "created_at", "updated_at" ] } }, "ok": { "type": "boolean" } }, "required": ["connectors", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connectors" }, "post": { "x-title": "List Connectors", "x-response-key": "connectors", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/list", "description": "Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).", "operationId": "seamCustomerV1ConnectorsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "type": "object", "properties": { "connector_id": { "type": "string" }, "connector_type": { "type": "string" }, "customer_key": { "type": "string", "nullable": true }, "unique_provider_resource_key": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": ["active", "inactive", "error"] }, "config": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/access_code" } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "connector_id", "connector_type", "customer_key", "unique_provider_resource_key", "status", "config", "created_at", "updated_at" ] } }, "ok": { "type": "boolean" } }, "required": ["connectors", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connectors" } }, "/seam/customer/v1/connectors/sync": { "post": { "x-title": "Sync Connector Data", "x-response-key": "connector_sync", "x-undocumented": "Only used internally.", "summary": "/seam/customer/v1/connectors/sync", "description": "Triggers an immediate data sync for a connector by scheduling a polling task.", "operationId": "seamCustomerV1ConnectorsSyncPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_sync": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "required": ["status", "message"] }, "ok": { "type": "boolean" } }, "required": ["connector_sync", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_id": { "type": "string", "format": "uuid", "description": "ID of the connector to sync" }, "connector_type": { "type": "string", "description": "Type of the connector to sync" }, "customer_key": { "type": "string", "description": "Key of the customer to sync" }, "connector_customer_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the connector customer to sync" }, "unique_provider_resource_key": { "type": "string", "nullable": true, "description": "Unique provider resource key of the connector to sync" } }, "required": ["connector_id", "connector_type", "customer_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "sync", "x-fern-sdk-return-value": "connector_sync" } }, "/seam/customer/v1/connectors/update": { "post": { "x-title": "Update Connector", "x-response-key": "connector", "x-undocumented": "Internal endpoint for Console.", "summary": "/seam/customer/v1/connectors/update", "description": "Updates an existing connector in a workspace. The connector must already be assigned to a workspace.\nThe connector will be reactivated with the new configuration.", "operationId": "seamCustomerV1ConnectorsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "connector": { "type": "object", "properties": { "connector_id": { "type": "string" }, "connector_type": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive", "error"] }, "webhook_subscription": { "type": "object", "properties": { "subscription_id": { "type": "string" }, "webhook_url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["active", "inactive", "error"] } }, "required": [ "subscription_id", "webhook_url", "events", "status" ] }, "error": { "type": "string" } }, "required": ["connector_id", "connector_type", "status"] }, "ok": { "type": "boolean" } }, "required": ["connector", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connector_id": { "type": "string", "minLength": 1, "description": "ID of the connector to update" }, "connector_customer_id": { "type": "string", "format": "uuid", "description": "ID of the connector customer to update (for global connectors like Cloudbeds)" }, "customer_key": { "description": "Key identifying the customer", "type": "string", "minLength": 1 }, "config": { "type": "object", "additionalProperties": {}, "description": "Instance-specific configuration for the connector" } }, "required": ["connector_id", "config"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "connector" } }, "/seam/customer/v1/encoders/list": { "get": { "x-title": "List Encoders", "x-response-key": "encoders", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/encoders/list", "description": "Returns a list of card encoders available to the customer.\nThis endpoint is intended for use within embedded customer portals, such as deep links\nfor reservation management, to allow staff to select an encoder for card encoding.", "operationId": "seamCustomerV1EncodersListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "ok": { "type": "boolean" } }, "required": ["encoders", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "space_key", "in": "query", "schema": { "type": "string", "description": "Optional filter to list encoders for a specific space." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "encoders"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "encoders" }, "post": { "x-title": "List Encoders", "x-response-key": "encoders", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/encoders/list", "description": "Returns a list of card encoders available to the customer.\nThis endpoint is intended for use within embedded customer portals, such as deep links\nfor reservation management, to allow staff to select an encoder for card encoding.", "operationId": "seamCustomerV1EncodersListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "ok": { "type": "boolean" } }, "required": ["encoders", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_key": { "type": "string", "description": "Optional filter to list encoders for a specific space." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "encoders"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "encoders" } }, "/seam/customer/v1/events/list": { "get": { "x-title": "List Events for Customer Space", "x-response-key": "events", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/events/list", "description": "Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.", "operationId": "seamCustomerV1EventsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "ok": { "type": "boolean" } }, "required": ["events", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list events." }, "required": true }, { "name": "since", "in": "query", "schema": { "type": "string", "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`." }, "required": false }, { "name": "between", "in": "query", "schema": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "minItems": 2, "maxItems": 2, "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`." }, "required": false }, { "name": "event_type", "in": "query", "schema": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "description": "Type of the events that you want to list." }, "required": false }, { "name": "event_types", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ] }, "description": "Types of the events that you want to list." }, "required": false }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of events to return." }, "required": false } ], "tags": ["/events"], "x-fern-sdk-group-name": ["seam", "customer", "v1", "events"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "events" }, "post": { "x-title": "List Events for Customer Space", "x-response-key": "events", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/events/list", "description": "Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.", "operationId": "seamCustomerV1EventsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "ok": { "type": "boolean" } }, "required": ["events", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space for which you want to list events." }, "since": { "type": "string", "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`." }, "between": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "minItems": 2, "maxItems": 2, "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`." }, "event_type": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "description": "Type of the events that you want to list." }, "event_types": { "type": "array", "items": { "type": "string", "enum": [ "access_code.created", "access_code.changed", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ] }, "description": "Types of the events that you want to list." }, "limit": { "default": 500, "type": "number", "format": "float", "description": "Numerical limit on the number of events to return." } }, "required": ["space_id"] } } } }, "tags": ["/events"], "x-fern-sdk-group-name": ["seam", "customer", "v1", "events"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "events" } }, "/seam/customer/v1/portals/get": { "get": { "x-title": "Get Customer Portal Configuration", "x-response-key": "customer_portal", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/portals/get", "description": "Retrieves the configuration for a customer portal identified by customer_portal_id.", "operationId": "seamCustomerV1PortalsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_portal": { "type": "object", "properties": { "features": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "connect": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "accepted_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account." }, "excluded_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account." } }, "description": "Configuration for the connect accounts feature." }, "manage": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "exclude_reservation_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage reservations for their properties." }, "exclude_reservation_technical_details": { "default": false, "type": "boolean", "description": "Indicates whether to exclude technical details from reservation views." }, "exclude_staff_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage staff for their properties." }, "events": { "type": "object", "properties": { "allowed_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events." }, "default_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types that are pre-selected in the events filter when the user first loads the events tab." } }, "description": "Configuration for event type filtering in the manage feature." } }, "description": "Configuration for the manage feature." }, "manage_devices": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---" }, "organize": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the organize feature." }, "configure": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "allow_access_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the access automation rules for their properties." }, "allow_climate_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the climate automation rules for their properties." }, "allow_instant_key_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the Instant Key profile for their properties." } }, "description": "Configuration for the configure feature." } } }, "is_embedded": { "default": false, "type": "boolean", "description": "Whether the portal is embedded in another application." }, "landing_page": { "type": "object", "properties": { "manage": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "space_key": { "type": "string" } }, "required": ["space_key"] }, { "type": "object", "properties": { "property_key": { "type": "string" } }, "required": ["property_key"] }, { "type": "object", "properties": { "room_key": { "type": "string" } }, "required": ["room_key"] }, { "type": "object", "properties": { "common_area_key": { "type": "string" } }, "required": ["common_area_key"] }, { "type": "object", "properties": { "unit_key": { "type": "string" } }, "required": ["unit_key"] }, { "type": "object", "properties": { "facility_key": { "type": "string" } }, "required": ["facility_key"] }, { "type": "object", "properties": { "building_key": { "type": "string" } }, "required": ["building_key"] }, { "type": "object", "properties": { "listing_key": { "type": "string" } }, "required": ["listing_key"] }, { "type": "object", "properties": { "property_listing_key": { "type": "string" } }, "required": ["property_listing_key"] }, { "type": "object", "properties": { "site_key": { "type": "string" } }, "required": ["site_key"] } ] }, { "oneOf": [ { "type": "object", "properties": { "reservation_key": { "type": "string" } }, "required": ["reservation_key"] }, { "type": "object", "properties": { "booking_key": { "type": "string" } }, "required": ["booking_key"] }, { "type": "object", "properties": { "access_grant_key": { "type": "string" } }, "required": ["access_grant_key"] } ] } ] } }, "description": "Configuration for the landing page when the portal loads." }, "locale": { "type": "string", "enum": ["en-US", "pt-PT", "fr-FR", "it-IT", "es-ES"], "description": "The locale to use for the portal." }, "exclude_locale_picker": { "default": false, "type": "boolean", "description": "Whether to exclude the option to select a locale within the portal UI." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "The ID of the customization profile to use for the portal." }, "customer_resources_filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[a-zA-Z_]\\w*$", "description": "The custom_metadata field name to filter on." }, "operation": { "type": "string", "enum": ["="], "description": "The comparison operation. Currently only '=' is supported." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "The value to compare against." } }, "required": ["field", "operation", "value"] }, "description": "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata." }, "navigation_mode": { "default": "full", "type": "string", "enum": ["full", "restricted"], "description": "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links." }, "deep_link": { "type": "object", "properties": { "resource_type": { "type": "string", "enum": ["reservation", "space"] }, "resource_key": { "type": "string" } }, "required": ["resource_type", "resource_key"], "description": "Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.", "x-undocumented": "Internal endpoint for customer portals." }, "business_vertical": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical of the customer portal." }, "feature_flags": { "type": "object", "properties": { "RESERVATION_UI_V2": { "type": "boolean" } } } } }, "ok": { "type": "boolean" } }, "required": ["customer_portal", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "customer_portal_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Customer portal ID." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "portals"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "customer_portal" }, "post": { "x-title": "Get Customer Portal Configuration", "x-response-key": "customer_portal", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/portals/get", "description": "Retrieves the configuration for a customer portal identified by customer_portal_id.", "operationId": "seamCustomerV1PortalsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_portal": { "type": "object", "properties": { "features": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "connect": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "accepted_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account." }, "excluded_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account." } }, "description": "Configuration for the connect accounts feature." }, "manage": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "exclude_reservation_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage reservations for their properties." }, "exclude_reservation_technical_details": { "default": false, "type": "boolean", "description": "Indicates whether to exclude technical details from reservation views." }, "exclude_staff_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage staff for their properties." }, "events": { "type": "object", "properties": { "allowed_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events." }, "default_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types that are pre-selected in the events filter when the user first loads the events tab." } }, "description": "Configuration for event type filtering in the manage feature." } }, "description": "Configuration for the manage feature." }, "manage_devices": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---" }, "organize": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the organize feature." }, "configure": { "default": { "$ref": "#/components/schemas/access_code" }, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "allow_access_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the access automation rules for their properties." }, "allow_climate_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the climate automation rules for their properties." }, "allow_instant_key_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the Instant Key profile for their properties." } }, "description": "Configuration for the configure feature." } } }, "is_embedded": { "default": false, "type": "boolean", "description": "Whether the portal is embedded in another application." }, "landing_page": { "type": "object", "properties": { "manage": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "space_key": { "type": "string" } }, "required": ["space_key"] }, { "type": "object", "properties": { "property_key": { "type": "string" } }, "required": ["property_key"] }, { "type": "object", "properties": { "room_key": { "type": "string" } }, "required": ["room_key"] }, { "type": "object", "properties": { "common_area_key": { "type": "string" } }, "required": ["common_area_key"] }, { "type": "object", "properties": { "unit_key": { "type": "string" } }, "required": ["unit_key"] }, { "type": "object", "properties": { "facility_key": { "type": "string" } }, "required": ["facility_key"] }, { "type": "object", "properties": { "building_key": { "type": "string" } }, "required": ["building_key"] }, { "type": "object", "properties": { "listing_key": { "type": "string" } }, "required": ["listing_key"] }, { "type": "object", "properties": { "property_listing_key": { "type": "string" } }, "required": ["property_listing_key"] }, { "type": "object", "properties": { "site_key": { "type": "string" } }, "required": ["site_key"] } ] }, { "oneOf": [ { "type": "object", "properties": { "reservation_key": { "type": "string" } }, "required": ["reservation_key"] }, { "type": "object", "properties": { "booking_key": { "type": "string" } }, "required": ["booking_key"] }, { "type": "object", "properties": { "access_grant_key": { "type": "string" } }, "required": ["access_grant_key"] } ] } ] } }, "description": "Configuration for the landing page when the portal loads." }, "locale": { "type": "string", "enum": ["en-US", "pt-PT", "fr-FR", "it-IT", "es-ES"], "description": "The locale to use for the portal." }, "exclude_locale_picker": { "default": false, "type": "boolean", "description": "Whether to exclude the option to select a locale within the portal UI." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "The ID of the customization profile to use for the portal." }, "customer_resources_filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[a-zA-Z_]\\w*$", "description": "The custom_metadata field name to filter on." }, "operation": { "type": "string", "enum": ["="], "description": "The comparison operation. Currently only '=' is supported." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "The value to compare against." } }, "required": ["field", "operation", "value"] }, "description": "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata." }, "navigation_mode": { "default": "full", "type": "string", "enum": ["full", "restricted"], "description": "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links." }, "deep_link": { "type": "object", "properties": { "resource_type": { "type": "string", "enum": ["reservation", "space"] }, "resource_key": { "type": "string" } }, "required": ["resource_type", "resource_key"], "description": "Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.", "x-undocumented": "Internal endpoint for customer portals." }, "business_vertical": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical of the customer portal." }, "feature_flags": { "type": "object", "properties": { "RESERVATION_UI_V2": { "type": "boolean" } } } } }, "ok": { "type": "boolean" } }, "required": ["customer_portal", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_portal_id": { "type": "string", "format": "uuid", "description": "Customer portal ID." } }, "required": ["customer_portal_id"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "portals"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "customer_portal" } }, "/seam/customer/v1/portals/update": { "patch": { "x-title": "Update Customer Portal Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/portals/update", "description": "Updates the configuration for a customer portal.", "operationId": "seamCustomerV1PortalsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_portal_id": { "type": "string", "format": "uuid", "description": "ID of the customer portal to update." }, "portal_configuration": { "type": "object", "properties": { "features": { "default": {}, "type": "object", "properties": { "connect": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "accepted_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account." }, "excluded_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account." } }, "description": "Configuration for the connect accounts feature." }, "manage": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "exclude_reservation_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage reservations for their properties." }, "exclude_reservation_technical_details": { "default": false, "type": "boolean", "description": "Indicates whether to exclude technical details from reservation views." }, "exclude_staff_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage staff for their properties." }, "events": { "type": "object", "properties": { "allowed_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events." }, "default_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types that are pre-selected in the events filter when the user first loads the events tab." } }, "description": "Configuration for event type filtering in the manage feature." } }, "description": "Configuration for the manage feature." }, "manage_devices": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---" }, "organize": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the organize feature." }, "configure": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "allow_access_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the access automation rules for their properties." }, "allow_climate_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the climate automation rules for their properties." }, "allow_instant_key_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the Instant Key profile for their properties." } }, "description": "Configuration for the configure feature." } } }, "is_embedded": { "default": false, "type": "boolean", "description": "Whether the portal is embedded in another application." }, "landing_page": { "type": "object", "properties": { "manage": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "space_key": { "type": "string" } }, "required": ["space_key"] }, { "type": "object", "properties": { "property_key": { "type": "string" } }, "required": ["property_key"] }, { "type": "object", "properties": { "room_key": { "type": "string" } }, "required": ["room_key"] }, { "type": "object", "properties": { "common_area_key": { "type": "string" } }, "required": ["common_area_key"] }, { "type": "object", "properties": { "unit_key": { "type": "string" } }, "required": ["unit_key"] }, { "type": "object", "properties": { "facility_key": { "type": "string" } }, "required": ["facility_key"] }, { "type": "object", "properties": { "building_key": { "type": "string" } }, "required": ["building_key"] }, { "type": "object", "properties": { "listing_key": { "type": "string" } }, "required": ["listing_key"] }, { "type": "object", "properties": { "property_listing_key": { "type": "string" } }, "required": ["property_listing_key"] }, { "type": "object", "properties": { "site_key": { "type": "string" } }, "required": ["site_key"] } ] }, { "oneOf": [ { "type": "object", "properties": { "reservation_key": { "type": "string" } }, "required": ["reservation_key"] }, { "type": "object", "properties": { "booking_key": { "type": "string" } }, "required": ["booking_key"] }, { "type": "object", "properties": { "access_grant_key": { "type": "string" } }, "required": ["access_grant_key"] } ] } ] } }, "description": "Configuration for the landing page when the portal loads." }, "locale": { "type": "string", "enum": ["en-US", "pt-PT", "fr-FR", "it-IT", "es-ES"], "description": "The locale to use for the portal." }, "exclude_locale_picker": { "default": false, "type": "boolean", "description": "Whether to exclude the option to select a locale within the portal UI." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "The ID of the customization profile to use for the portal." }, "customer_resources_filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[a-zA-Z_]\\w*$", "description": "The custom_metadata field name to filter on." }, "operation": { "type": "string", "enum": ["="], "description": "The comparison operation. Currently only '=' is supported." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "The value to compare against." } }, "required": ["field", "operation", "value"] }, "description": "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata." }, "navigation_mode": { "default": "full", "type": "string", "enum": ["full", "restricted"], "description": "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links." }, "deep_link": { "type": "object", "properties": { "resource_type": { "type": "string", "enum": ["reservation", "space"] }, "resource_key": { "type": "string" } }, "required": ["resource_type", "resource_key"], "description": "Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.", "x-undocumented": "Internal endpoint for customer portals." } }, "description": "Partial portal configuration to merge with the existing configuration." } }, "required": ["customer_portal_id", "portal_configuration"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "portals"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update Customer Portal Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/portals/update", "description": "Updates the configuration for a customer portal.", "operationId": "seamCustomerV1PortalsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_portal_id": { "type": "string", "format": "uuid", "description": "ID of the customer portal to update." }, "portal_configuration": { "type": "object", "properties": { "features": { "default": {}, "type": "object", "properties": { "connect": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "accepted_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account." }, "excluded_providers": { "type": "array", "items": { "type": "string" }, "description": "List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account." } }, "description": "Configuration for the connect accounts feature." }, "manage": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "exclude_reservation_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage reservations for their properties." }, "exclude_reservation_technical_details": { "default": false, "type": "boolean", "description": "Indicates whether to exclude technical details from reservation views." }, "exclude_staff_management": { "default": false, "type": "boolean", "description": "Indicates whether the customer can manage staff for their properties." }, "events": { "type": "object", "properties": { "allowed_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events." }, "default_events": { "type": "array", "items": { "type": "string" }, "description": "List of event types that are pre-selected in the events filter when the user first loads the events tab." } }, "description": "Configuration for event type filtering in the manage feature." } }, "description": "Configuration for the manage feature." }, "manage_devices": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---" }, "organize": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." } }, "description": "Configuration for the organize feature." }, "configure": { "default": {}, "type": "object", "properties": { "exclude": { "default": false, "type": "boolean", "description": "Whether to exclude this feature from the portal." }, "allow_access_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the access automation rules for their properties." }, "allow_climate_automation_rule_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the climate automation rules for their properties." }, "allow_instant_key_customization": { "default": false, "type": "boolean", "description": "Indicates whether the customer can customize the Instant Key profile for their properties." } }, "description": "Configuration for the configure feature." } } }, "is_embedded": { "default": false, "type": "boolean", "description": "Whether the portal is embedded in another application." }, "landing_page": { "type": "object", "properties": { "manage": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "space_key": { "type": "string" } }, "required": ["space_key"] }, { "type": "object", "properties": { "property_key": { "type": "string" } }, "required": ["property_key"] }, { "type": "object", "properties": { "room_key": { "type": "string" } }, "required": ["room_key"] }, { "type": "object", "properties": { "common_area_key": { "type": "string" } }, "required": ["common_area_key"] }, { "type": "object", "properties": { "unit_key": { "type": "string" } }, "required": ["unit_key"] }, { "type": "object", "properties": { "facility_key": { "type": "string" } }, "required": ["facility_key"] }, { "type": "object", "properties": { "building_key": { "type": "string" } }, "required": ["building_key"] }, { "type": "object", "properties": { "listing_key": { "type": "string" } }, "required": ["listing_key"] }, { "type": "object", "properties": { "property_listing_key": { "type": "string" } }, "required": ["property_listing_key"] }, { "type": "object", "properties": { "site_key": { "type": "string" } }, "required": ["site_key"] } ] }, { "oneOf": [ { "type": "object", "properties": { "reservation_key": { "type": "string" } }, "required": ["reservation_key"] }, { "type": "object", "properties": { "booking_key": { "type": "string" } }, "required": ["booking_key"] }, { "type": "object", "properties": { "access_grant_key": { "type": "string" } }, "required": ["access_grant_key"] } ] } ] } }, "description": "Configuration for the landing page when the portal loads." }, "locale": { "type": "string", "enum": ["en-US", "pt-PT", "fr-FR", "it-IT", "es-ES"], "description": "The locale to use for the portal." }, "exclude_locale_picker": { "default": false, "type": "boolean", "description": "Whether to exclude the option to select a locale within the portal UI." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "The ID of the customization profile to use for the portal." }, "customer_resources_filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[a-zA-Z_]\\w*$", "description": "The custom_metadata field name to filter on." }, "operation": { "type": "string", "enum": ["="], "description": "The comparison operation. Currently only '=' is supported." }, "value": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "The value to compare against." } }, "required": ["field", "operation", "value"] }, "description": "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata." }, "navigation_mode": { "default": "full", "type": "string", "enum": ["full", "restricted"], "description": "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links." }, "deep_link": { "type": "object", "properties": { "resource_type": { "type": "string", "enum": ["reservation", "space"] }, "resource_key": { "type": "string" } }, "required": ["resource_type", "resource_key"], "description": "Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.", "x-undocumented": "Internal endpoint for customer portals." } }, "description": "Partial portal configuration to merge with the existing configuration." } }, "required": ["customer_portal_id", "portal_configuration"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "portals"], "x-fern-sdk-method-name": "update" } }, "/seam/customer/v1/reservations/get": { "get": { "x-title": "Get Reservation for Customer", "x-response-key": "reservation", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/reservations/get", "description": "Returns a single reservation for a specific customer by reservation ID.", "operationId": "seamCustomerV1ReservationsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reservation": { "type": "object", "properties": { "reservation_id": { "type": "string", "format": "uuid" }, "reservation_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "is_resource_syncing": { "type": "boolean" }, "guest_name": { "type": "string", "nullable": true }, "guest": { "type": "object", "properties": { "guest_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email_address": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "user_identity_id": { "type": "string", "format": "uuid", "nullable": true }, "is_resource_syncing": { "type": "boolean" } }, "required": [ "guest_key", "name", "email_address", "phone_number", "user_identity_id", "is_resource_syncing" ], "nullable": true }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "nullable": true }, "space_key": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "required": ["space_id", "space_key", "name"] } }, "access_grant_id": { "type": "string", "format": "uuid", "nullable": true }, "access_methods": { "type": "array", "items": { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid" }, "access_grant_id": { "type": "string", "format": "uuid" }, "mode": { "type": "string" }, "is_issued": { "type": "boolean" }, "is_card_encoding_required": { "type": "boolean" }, "code": { "type": "string", "nullable": true }, "instant_key_url": { "type": "string", "format": "uri" } }, "required": [ "access_method_id", "access_grant_id", "mode", "is_issued" ] } }, "last_automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": [ "create", "update", "delete", "skip" ] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" }, "skip_reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["action_type", "resource_type"] } }, "error": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "success", "rule", "actions", "created_at" ], "nullable": true } }, "required": [ "reservation_id", "reservation_key", "name", "starts_at", "ends_at", "created_at", "is_resource_syncing", "guest_name", "guest", "spaces", "access_grant_id", "access_methods", "last_automation_result" ] }, "ok": { "type": "boolean" } }, "required": ["reservation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "The customer_key identifying the customer. Required when not using client_session_with_customer auth." } }, { "name": "reservation_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "ID of the reservation to retrieve." } }, { "name": "reservation_key", "in": "query", "schema": { "type": "string", "description": "Key of the reservation to retrieve." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "reservation" }, "post": { "x-title": "Get Reservation for Customer", "x-response-key": "reservation", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/reservations/get", "description": "Returns a single reservation for a specific customer by reservation ID.", "operationId": "seamCustomerV1ReservationsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reservation": { "type": "object", "properties": { "reservation_id": { "type": "string", "format": "uuid" }, "reservation_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "is_resource_syncing": { "type": "boolean" }, "guest_name": { "type": "string", "nullable": true }, "guest": { "type": "object", "properties": { "guest_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email_address": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "user_identity_id": { "type": "string", "format": "uuid", "nullable": true }, "is_resource_syncing": { "type": "boolean" } }, "required": [ "guest_key", "name", "email_address", "phone_number", "user_identity_id", "is_resource_syncing" ], "nullable": true }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "nullable": true }, "space_key": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "required": ["space_id", "space_key", "name"] } }, "access_grant_id": { "type": "string", "format": "uuid", "nullable": true }, "access_methods": { "type": "array", "items": { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid" }, "access_grant_id": { "type": "string", "format": "uuid" }, "mode": { "type": "string" }, "is_issued": { "type": "boolean" }, "is_card_encoding_required": { "type": "boolean" }, "code": { "type": "string", "nullable": true }, "instant_key_url": { "type": "string", "format": "uri" } }, "required": [ "access_method_id", "access_grant_id", "mode", "is_issued" ] } }, "last_automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": [ "create", "update", "delete", "skip" ] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" }, "skip_reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["action_type", "resource_type"] } }, "error": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "success", "rule", "actions", "created_at" ], "nullable": true } }, "required": [ "reservation_id", "reservation_key", "name", "starts_at", "ends_at", "created_at", "is_resource_syncing", "guest_name", "guest", "spaces", "access_grant_id", "access_methods", "last_automation_result" ] }, "ok": { "type": "boolean" } }, "required": ["reservation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "The customer_key identifying the customer. Required when not using client_session_with_customer auth." }, "reservation_id": { "type": "string", "format": "uuid", "description": "ID of the reservation to retrieve." }, "reservation_key": { "type": "string", "description": "Key of the reservation to retrieve." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "reservation" } }, "/seam/customer/v1/reservations/list": { "get": { "x-title": "List Reservations for Customer Space", "x-response-key": "reservations", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/reservations/list", "description": "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.", "operationId": "seamCustomerV1ReservationsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reservations": { "type": "array", "items": { "type": "object", "properties": { "reservation_id": { "type": "string", "format": "uuid" }, "reservation_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "is_resource_syncing": { "type": "boolean" }, "guest_name": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "warning_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "warning_code", "message", "created_at" ] } }, "pending_mutations": { "type": "array", "items": { "type": "object", "properties": { "mutation_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "mutation_code", "message", "created_at" ] } }, "access_methods": { "type": "array", "items": { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid" }, "mode": { "type": "string" }, "is_issued": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "warning_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "warning_code", "message", "created_at" ] } }, "pending_mutations": { "type": "array", "items": { "type": "object", "properties": { "mutation_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "mutation_code", "message", "created_at" ] } } }, "required": [ "access_method_id", "mode", "is_issued", "warnings", "pending_mutations" ] } }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "space_id": { "type": "string", "nullable": true }, "space_key": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "required": ["space_id", "space_key", "name"] } }, "last_automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": [ "create", "update", "delete", "skip" ] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" }, "skip_reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["action_type", "resource_type"] } }, "error": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "success", "rule", "actions", "created_at" ], "nullable": true } }, "required": [ "reservation_id", "reservation_key", "name", "starts_at", "ends_at", "created_at", "is_resource_syncing", "guest_name", "warnings", "pending_mutations", "access_methods", "spaces", "last_automation_result" ] } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["reservations", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "The customer_key identifying the customer. Required when not using client_session_with_customer auth." } }, { "name": "space_key", "in": "query", "schema": { "type": "string", "description": "Filter reservations by space key." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Filter reservations by space ID (UUID)." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned reservations. Returns reservations created before this timestamp." } }, { "name": "created_after", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned reservations. Returns reservations created after this timestamp." } }, { "name": "between", "in": "query", "schema": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "minItems": 2, "maxItems": 2, "description": "Lower and upper timestamps to filter reservations whose time range overlaps with the given interval." } }, { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned reservations to include all records that satisfy a partial match using `reservation_id`, `reservation_key`, `name`, `guest_name`, or space names." } }, { "name": "page_cursor", "in": "query", "schema": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "reservations" }, "post": { "x-title": "List Reservations for Customer Space", "x-response-key": "reservations", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/reservations/list", "description": "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.", "operationId": "seamCustomerV1ReservationsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reservations": { "type": "array", "items": { "type": "object", "properties": { "reservation_id": { "type": "string", "format": "uuid" }, "reservation_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "is_resource_syncing": { "type": "boolean" }, "guest_name": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "warning_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "warning_code", "message", "created_at" ] } }, "pending_mutations": { "type": "array", "items": { "type": "object", "properties": { "mutation_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "mutation_code", "message", "created_at" ] } }, "access_methods": { "type": "array", "items": { "type": "object", "properties": { "access_method_id": { "type": "string", "format": "uuid" }, "mode": { "type": "string" }, "is_issued": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "warning_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "warning_code", "message", "created_at" ] } }, "pending_mutations": { "type": "array", "items": { "type": "object", "properties": { "mutation_code": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "mutation_code", "message", "created_at" ] } } }, "required": [ "access_method_id", "mode", "is_issued", "warnings", "pending_mutations" ] } }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "space_id": { "type": "string", "nullable": true }, "space_key": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "required": ["space_id", "space_key", "name"] } }, "last_automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": [ "create", "update", "delete", "skip" ] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" }, "skip_reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["action_type", "resource_type"] } }, "error": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "success", "rule", "actions", "created_at" ], "nullable": true } }, "required": [ "reservation_id", "reservation_key", "name", "starts_at", "ends_at", "created_at", "is_resource_syncing", "guest_name", "warnings", "pending_mutations", "access_methods", "spaces", "last_automation_result" ] } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["reservations", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "The customer_key identifying the customer. Required when not using client_session_with_customer auth." }, "space_key": { "type": "string", "description": "Filter reservations by space key." }, "space_id": { "type": "string", "format": "uuid", "description": "Filter reservations by space ID (UUID)." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned reservations. Returns reservations created before this timestamp." }, "created_after": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned reservations. Returns reservations created after this timestamp." }, "between": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "minItems": 2, "maxItems": 2, "description": "Lower and upper timestamps to filter reservations whose time range overlaps with the given interval." }, "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned reservations to include all records that satisfy a partial match using `reservation_id`, `reservation_key`, `name`, `guest_name`, or space names." }, "page_cursor": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "reservations" } }, "/seam/customer/v1/reservations/list_access_grants": { "get": { "x-title": "List Access Grants for Reservation", "x-response-key": "access_grants", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/reservations/list_access_grants", "description": "Lists access grants linked to a reservation by reservation_key.", "operationId": "seamCustomerV1ReservationsListAccessGrantsGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "ok": { "type": "boolean" } }, "required": ["access_grants", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "The customer_key identifying the customer. Required when not using client_session_with_customer auth." }, "required": false }, { "name": "reservation_key", "in": "query", "schema": { "type": "string", "description": "The reservation_key to filter access grants by." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"], "x-fern-sdk-method-name": "list_access_grants", "x-fern-sdk-return-value": "access_grants" }, "post": { "x-title": "List Access Grants for Reservation", "x-response-key": "access_grants", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/reservations/list_access_grants", "description": "Lists access grants linked to a reservation by reservation_key.", "operationId": "seamCustomerV1ReservationsListAccessGrantsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "ok": { "type": "boolean" } }, "required": ["access_grants", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "The customer_key identifying the customer. Required when not using client_session_with_customer auth." }, "reservation_key": { "type": "string", "description": "The reservation_key to filter access grants by." } }, "required": ["reservation_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"], "x-fern-sdk-method-name": "list_access_grants", "x-fern-sdk-return-value": "access_grants" } }, "/seam/customer/v1/settings/get": { "get": { "x-title": "Get Customer Portal Settings", "x-response-key": "business_vertical", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/get", "description": "Retrieves the settings for a customer portal workspace.", "operationId": "seamCustomerV1SettingsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_vertical": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical of the customer portal." }, "slug": { "type": "string", "nullable": true }, "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "settings"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "business_vertical" }, "post": { "x-title": "Get Customer Portal Settings", "x-response-key": "business_vertical", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/get", "description": "Retrieves the settings for a customer portal workspace.", "operationId": "seamCustomerV1SettingsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_vertical": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical of the customer portal." }, "slug": { "type": "string", "nullable": true }, "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "settings"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "business_vertical" } }, "/seam/customer/v1/settings/update": { "patch": { "x-title": "Update Customer Portal Settings", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/update", "description": "Updates the settings for a customer portal workspace.", "operationId": "seamCustomerV1SettingsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_vertical": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical to set on the workspace." }, "slug": { "type": "string", "nullable": true, "description": "Slug to set on the workspace." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "settings"], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update Customer Portal Settings", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/update", "description": "Updates the settings for a customer portal workspace.", "operationId": "seamCustomerV1SettingsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business_vertical": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical to set on the workspace." }, "slug": { "type": "string", "nullable": true, "description": "Slug to set on the workspace." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "settings"], "x-fern-sdk-method-name": "update" } }, "/seam/customer/v1/spaces/create": { "post": { "x-title": "Create a Space", "x-response-key": "space", "x-draft": "Early access.", "x-undocumented": "Only used internally.", "summary": "/seam/customer/v1/spaces/create", "description": "Creates a new space with optional parent space support.", "operationId": "seamCustomerV1SpacesCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "space": { "$ref": "#/components/schemas/space" }, "ok": { "type": "boolean" } }, "required": ["space", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the space that you want to create." }, "space_key": { "type": "string", "description": "Unique key for the space within the workspace." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the devices that you want to add to the new space." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the entrances that you want to add to the new space." }, "parent_space_key": { "type": "string", "description": "Space key of the parent space for this space." }, "parent_space_name": { "type": "string", "description": "Name of the parent space for this space." } }, "required": ["name"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "space" } }, "/seam/customer/v1/spaces/list": { "get": { "x-title": "List Spaces", "x-response-key": "spaces", "x-draft": "Early access.", "x-undocumented": "Only used internally.", "summary": "/seam/customer/v1/spaces/list", "description": "Returns a list of all spaces.", "operationId": "seamCustomerV1SpacesListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "ok": { "type": "boolean" } }, "required": ["spaces", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`." } }, { "name": "connected_account_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.", "x-undocumented": "Only used internally.", "x-draft": "Needs review." } }, { "name": "space_key", "in": "query", "schema": { "type": "string", "description": "Filter spaces by space_key." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "spaces" }, "post": { "x-title": "List Spaces", "x-response-key": "spaces", "x-draft": "Early access.", "x-undocumented": "Only used internally.", "summary": "/seam/customer/v1/spaces/list", "description": "Returns a list of all spaces.", "operationId": "seamCustomerV1SpacesListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "ok": { "type": "boolean" } }, "required": ["spaces", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": "string", "minLength": 1, "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.", "x-undocumented": "Only used internally.", "x-draft": "Needs review." }, "space_key": { "type": "string", "description": "Filter spaces by space_key." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "spaces" } }, "/seam/customer/v1/spaces/list_reservations": { "get": { "x-title": "List Reservations for Space", "x-response-key": "reservations", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/spaces/list_reservations", "description": "Returns a list of existing reservations for a specific space.\nIf issued_status is \"issued\", only reservations that have access methods issued will be returned.\nIf issued_status is \"pending\", only reservations that do not have access methods issued will be returned.\nIf issued_status is not provided, only reservations that do not have access methods issued will be returned.", "operationId": "seamCustomerV1SpacesListReservationsGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reservations": { "type": "array", "items": { "type": "object", "properties": { "reservation_id": { "type": "string", "format": "uuid" }, "reservation_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "guest_name": { "type": "string", "nullable": true }, "has_issued_access": { "type": "boolean" }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "last_automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": [ "create", "update", "delete", "skip" ] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" }, "skip_reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["action_type", "resource_type"] } }, "error": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "success", "rule", "actions", "created_at" ], "nullable": true } }, "required": [ "reservation_id", "reservation_key", "name", "starts_at", "ends_at", "created_at", "guest_name", "has_issued_access", "access_methods", "last_automation_result" ] } }, "ok": { "type": "boolean" } }, "required": ["reservations", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "issued_status", "in": "query", "schema": { "default": "pending", "type": "string", "enum": ["issued", "pending"], "description": "Filter reservations by issued status." }, "required": false }, { "name": "space_key", "in": "query", "schema": { "type": "string", "description": "Filter reservations by space key." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"], "x-fern-sdk-method-name": "list_reservations", "x-fern-sdk-return-value": "reservations" }, "post": { "x-title": "List Reservations for Space", "x-response-key": "reservations", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/spaces/list_reservations", "description": "Returns a list of existing reservations for a specific space.\nIf issued_status is \"issued\", only reservations that have access methods issued will be returned.\nIf issued_status is \"pending\", only reservations that do not have access methods issued will be returned.\nIf issued_status is not provided, only reservations that do not have access methods issued will be returned.", "operationId": "seamCustomerV1SpacesListReservationsPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "reservations": { "type": "array", "items": { "type": "object", "properties": { "reservation_id": { "type": "string", "format": "uuid" }, "reservation_key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true }, "ends_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "guest_name": { "type": "string", "nullable": true }, "has_issued_access": { "type": "boolean" }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "last_automation_result": { "type": "object", "properties": { "success": { "type": "boolean" }, "rule": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_type": { "type": "string", "enum": [ "create", "update", "delete", "skip" ] }, "resource_type": { "type": "string" }, "access_grant_id": { "type": "string", "format": "uuid" }, "skip_reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["action_type", "resource_type"] } }, "error": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "success", "rule", "actions", "created_at" ], "nullable": true } }, "required": [ "reservation_id", "reservation_key", "name", "starts_at", "ends_at", "created_at", "guest_name", "has_issued_access", "access_methods", "last_automation_result" ] } }, "ok": { "type": "boolean" } }, "required": ["reservations", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "issued_status": { "default": "pending", "type": "string", "enum": ["issued", "pending"], "description": "Filter reservations by issued status." }, "space_key": { "type": "string", "description": "Filter reservations by space key." } }, "required": ["space_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"], "x-fern-sdk-method-name": "list_reservations", "x-fern-sdk-return-value": "reservations" } }, "/seam/customer/v1/spaces/push_common_areas": { "post": { "x-title": "Push Common Areas", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/spaces/push_common_areas", "description": "Pushes common areas for a customer, optionally nested under spaces.\nThe customer_key is taken from the authenticated client session.", "operationId": "seamCustomerV1SpacesPushCommonAreasPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "common_areas": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"] } }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "common_areas": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"] } } }, "required": ["name", "common_areas"] } } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"], "x-fern-sdk-method-name": "push_common_areas" } }, "/seam/customer/v1/staff_members/get": { "get": { "x-title": "Get Staff Member", "x-response-key": "staff_member", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/staff_members/get", "description": "Returns a staff member for a specific customer.", "operationId": "seamCustomerV1StaffMembersGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "space_key": { "type": "string" }, "child_space_keys": { "type": "array", "items": { "type": "string" } } }, "required": ["space_key"] } }, "staff_member": { "type": "object", "properties": { "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "name": { "type": "string", "description": "Your display name for this user identity resource." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "user_identity_id": { "type": "string", "format": "uuid" } }, "required": ["staff_member_key", "name"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." }, "ok": { "type": "boolean" } }, "required": ["access_grant", "spaces", "staff_member", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "staff_member_key", "in": "query", "schema": { "type": "string", "description": "Key of staff member to get." }, "required": true } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "staff_member" }, "post": { "x-title": "Get Staff Member", "x-response-key": "staff_member", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/staff_members/get", "description": "Returns a staff member for a specific customer.", "operationId": "seamCustomerV1StaffMembersGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "spaces": { "type": "array", "items": { "type": "object", "properties": { "space_key": { "type": "string" }, "child_space_keys": { "type": "array", "items": { "type": "string" } } }, "required": ["space_key"] } }, "staff_member": { "type": "object", "properties": { "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "name": { "type": "string", "description": "Your display name for this user identity resource." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "user_identity_id": { "type": "string", "format": "uuid" } }, "required": ["staff_member_key", "name"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." }, "ok": { "type": "boolean" } }, "required": ["access_grant", "spaces", "staff_member", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "staff_member_key": { "type": "string", "description": "Key of staff member to get." } }, "required": ["staff_member_key"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "staff_member" } }, "/seam/customer/v1/staff_members/list": { "get": { "x-title": "List Staff Members for Customer Space", "x-response-key": "staff_members", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/staff_members/list", "description": "Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.", "operationId": "seamCustomerV1StaffMembersListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "staff_members": { "type": "array", "items": { "type": "object", "properties": { "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "name": { "type": "string", "description": "Your display name for this user identity resource." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "user_identity_id": { "type": "string", "format": "uuid" } }, "required": ["staff_member_key", "name"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["staff_members", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "parameters": [ { "name": "space_key", "in": "query", "schema": { "type": "string", "description": "Filter staff members by space key." } }, { "name": "space_id", "in": "query", "schema": { "type": "string", "format": "uuid", "description": "Filter staff members by space ID (UUID)." } }, { "name": "limit", "in": "query", "schema": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." } }, { "name": "created_before", "in": "query", "schema": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned staff members. Returns staff members created before this timestamp." } }, { "name": "page_cursor", "in": "query", "schema": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } ], "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "staff_members" }, "post": { "x-title": "List Staff Members for Customer Space", "x-response-key": "staff_members", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/staff_members/list", "description": "Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.", "operationId": "seamCustomerV1StaffMembersListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "staff_members": { "type": "array", "items": { "type": "object", "properties": { "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "name": { "type": "string", "description": "Your display name for this user identity resource." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "user_identity_id": { "type": "string", "format": "uuid" } }, "required": ["staff_member_key", "name"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." } }, "pagination": { "$ref": "#/components/schemas/pagination" }, "ok": { "type": "boolean" } }, "required": ["staff_members", "pagination", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "space_key": { "type": "string", "description": "Filter staff members by space key." }, "space_id": { "type": "string", "format": "uuid", "description": "Filter staff members by space ID (UUID)." }, "limit": { "default": 500, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "Maximum number of records to return per page." }, "created_before": { "type": "string", "format": "date-time", "description": "Timestamp by which to limit returned staff members. Returns staff members created before this timestamp." }, "page_cursor": { "type": "string", "nullable": true, "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`." } } } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "staff_members" } }, "/seam/instant_key/v1/client_sessions/exchange_short_code": { "post": { "x-title": "Exchange Instant Key Short Code", "x-response-key": "client_session", "x-undocumented": "Seam Instant Key only.", "summary": "/seam/instant_key/v1/client_sessions/exchange_short_code", "description": "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.", "operationId": "seamInstantKeyV1ClientSessionsExchangeShortCodePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": ["client_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "certified_client": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "short_code": { "type": "string", "description": "Short code that you want to exchange for a client session token." } }, "required": ["short_code"] } } } }, "tags": ["/client_sessions"], "x-fern-sdk-group-name": [ "seam", "instant_key", "v1", "client_sessions" ], "x-fern-sdk-method-name": "exchange_short_code", "x-fern-sdk-return-value": "client_session" } }, "/seam/instant_key/v1/preview/get": { "get": { "x-title": "Preview Instant Key", "x-response-key": "instant_key_preview", "x-undocumented": "Seam Instant Key only.", "summary": "/seam/instant_key/v1/preview/get", "operationId": "seamInstantKeyV1PreviewGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key_preview": { "type": "object", "properties": { "shortcode": { "type": "string" }, "hotel": { "type": "object", "properties": { "hotel_name": { "type": "string" }, "primary_color": { "type": "string" }, "accent_color": { "type": "string" }, "secondary_color": { "type": "string" }, "logo_url": { "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "hotel_name", "primary_color", "accent_color", "secondary_color", "verified" ] }, "guest": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "check_in_date": { "type": "string" }, "check_out_date": { "type": "string" } }, "required": [ "first_name", "last_name", "full_name", "email", "check_in_date", "check_out_date" ] }, "room": { "type": "object", "properties": { "room_number": { "type": "string" }, "room_type": { "type": "string" }, "floor": { "type": "number", "format": "float" } }, "required": ["room_number", "room_type", "floor"] }, "access": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "hours": { "type": "string" }, "location": { "type": "string" }, "available": { "type": "boolean" } }, "required": ["name", "icon", "available"] } }, "key_status": { "type": "string", "enum": ["ready", "expired", "used"] }, "support_phone": { "type": "string" }, "support_email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "shortcode", "hotel", "guest", "room", "access", "key_status", "support_phone", "support_email", "created_at", "updated_at", "expires_at" ], "description": "Represents a preview of an Instant Key with hotel, guest, and access information.", "x-route-path": "/instant_keys/preview" }, "ok": { "type": "boolean" } }, "required": ["instant_key_preview", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "certified_client": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key_url": { "type": "string", "description": "The short code of the instant key to preview." } }, "required": ["instant_key_url"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "instant_key", "v1", "preview"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "instant_key_preview" }, "post": { "x-title": "Preview Instant Key", "x-response-key": "instant_key_preview", "x-undocumented": "Seam Instant Key only.", "summary": "/seam/instant_key/v1/preview/get", "operationId": "seamInstantKeyV1PreviewGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key_preview": { "type": "object", "properties": { "shortcode": { "type": "string" }, "hotel": { "type": "object", "properties": { "hotel_name": { "type": "string" }, "primary_color": { "type": "string" }, "accent_color": { "type": "string" }, "secondary_color": { "type": "string" }, "logo_url": { "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "hotel_name", "primary_color", "accent_color", "secondary_color", "verified" ] }, "guest": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "check_in_date": { "type": "string" }, "check_out_date": { "type": "string" } }, "required": [ "first_name", "last_name", "full_name", "email", "check_in_date", "check_out_date" ] }, "room": { "type": "object", "properties": { "room_number": { "type": "string" }, "room_type": { "type": "string" }, "floor": { "type": "number", "format": "float" } }, "required": ["room_number", "room_type", "floor"] }, "access": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "hours": { "type": "string" }, "location": { "type": "string" }, "available": { "type": "boolean" } }, "required": ["name", "icon", "available"] } }, "key_status": { "type": "string", "enum": ["ready", "expired", "used"] }, "support_phone": { "type": "string" }, "support_email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "shortcode", "hotel", "guest", "room", "access", "key_status", "support_phone", "support_email", "created_at", "updated_at", "expires_at" ], "description": "Represents a preview of an Instant Key with hotel, guest, and access information.", "x-route-path": "/instant_keys/preview" }, "ok": { "type": "boolean" } }, "required": ["instant_key_preview", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "certified_client": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instant_key_url": { "type": "string", "description": "The short code of the instant key to preview." } }, "required": ["instant_key_url"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "instant_key", "v1", "preview"], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "instant_key_preview" } }, "/seam/mobile_sdk/v1/phone_sessions/get_or_create": { "post": { "x-title": "Get or Create a Phone Session", "x-response-key": "phone_session", "x-undocumented": "Mobile SDK only.", "summary": "/seam/mobile_sdk/v1/phone_sessions/get_or_create", "description": "Gets or creates a session for a mobile SDK phone.", "operationId": "seamMobileSdkV1PhoneSessionsGetOrCreatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_session": { "$ref": "#/components/schemas/phone_session" }, "ok": { "type": "boolean" } }, "required": ["phone_session", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "custom_sdk_installation_id": { "type": "string", "description": "ID of the custom SDK installation that you want to use for the new session." }, "phone_os": { "type": "string", "enum": ["ios", "android"], "description": "Phone operating system that you want to use for the new session." }, "phone_device_metadata": { "type": "object", "properties": { "os_version": { "type": "string" }, "manufacturer": { "type": "string" }, "model": { "type": "string" } }, "description": "Phone device metadata that you want to use for the new session." } }, "required": ["custom_sdk_installation_id", "phone_os"] } } } }, "tags": [], "x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1", "phone_sessions"], "x-fern-sdk-method-name": "get_or_create", "x-fern-sdk-return-value": "phone_session" } }, "/seam/console/v1/workspace/feature_flags/list": { "get": { "x-response-key": "feature_flags", "x-undocumented": "Internal endpoint for Console", "summary": "/seam/console/v1/workspace/feature_flags/list", "description": "Lists workspace feature flags.", "operationId": "seamConsoleV1WorkspaceFeatureFlagsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "feature_flags": { "type": "object", "additionalProperties": { "type": "boolean" } }, "ok": { "type": "boolean" } }, "required": ["feature_flags", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "console", "v1", "workspace", "feature_flags" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "feature_flags" }, "post": { "x-response-key": "feature_flags", "x-undocumented": "Internal endpoint for Console", "summary": "/seam/console/v1/workspace/feature_flags/list", "description": "Lists workspace feature flags.", "operationId": "seamConsoleV1WorkspaceFeatureFlagsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "feature_flags": { "type": "object", "additionalProperties": { "type": "boolean" } }, "ok": { "type": "boolean" } }, "required": ["feature_flags", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "console", "v1", "workspace", "feature_flags" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "feature_flags" } }, "/seam/customer/v1/customers/automations/get": { "get": { "x-title": "Get Customer Automation Configuration", "x-response-key": "automation", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/customers/automations/get", "description": "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).", "operationId": "seamCustomerV1CustomersAutomationsGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "automation": { "type": "object", "properties": { "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule", "config"] } } }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "$ref": "#/components/schemas/access_code" }, "reservation_deleted": { "$ref": "#/components/schemas/access_code" } } } }, "required": ["rules"] } } }, "ok": { "type": "boolean" } }, "required": ["automation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "customers", "automations" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "automation" }, "post": { "x-title": "Get Customer Automation Configuration", "x-response-key": "automation", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/customers/automations/get", "description": "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).", "operationId": "seamCustomerV1CustomersAutomationsGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "automation": { "type": "object", "properties": { "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "$ref": "#/components/schemas/access_code" } }, "required": ["rule", "config"] } } }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "$ref": "#/components/schemas/access_code" }, "reservation_deleted": { "$ref": "#/components/schemas/access_code" } } } }, "required": ["rules"] } } }, "ok": { "type": "boolean" } }, "required": ["automation", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "customers", "automations" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "automation" } }, "/seam/customer/v1/customers/automations/update": { "patch": { "x-title": "Update Customer Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/customers/automations/update", "description": "Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.", "operationId": "seamCustomerV1CustomersAutomationsUpdatePatch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule", "config"] } }, "description": "Access automation rules configuration." }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "type": "object", "properties": {} }, "reservation_deleted": { "type": "object", "properties": {} } } } }, "description": "Climate automation rules configuration." } } } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "customers", "automations" ], "x-fern-sdk-method-name": "update" }, "post": { "x-title": "Update Customer Automation Configuration", "x-response-key": null, "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/customers/automations/update", "description": "Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.", "operationId": "seamCustomerV1CustomersAutomationsUpdatePost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_created"] }, "config": { "type": "object", "properties": { "access_methods": { "type": "array", "items": { "type": "string", "enum": ["card", "mobile_key", "code"] }, "minItems": 1 }, "method_issuance_strategy": { "type": "string", "enum": [ "first_available", "first_two_available", "all_available" ] }, "card_count_on_reservation_create": { "type": "integer", "minimum": 0 }, "instant_key_max_use_count": { "type": "integer", "minimum": 1 }, "prefer_guest_phone_last4_as_code": { "type": "boolean" }, "allow_shared_email_and_phone_across_user_identities": { "type": "boolean" } }, "required": [ "access_methods", "method_issuance_strategy" ] } }, "required": ["rule", "config"] }, "reservation_time_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_time_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_spaces_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_spaces_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "reservation_deleted": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["reservation_deleted"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "space_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["space_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "user_identity_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["user_identity_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_name_updated": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_name_updated"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule"] }, "staff_member_created": { "type": "object", "properties": { "rule": { "type": "string", "enum": ["staff_member_created"] }, "config": { "type": "object", "properties": {} } }, "required": ["rule", "config"] } }, "description": "Access automation rules configuration." }, "climate_rules": { "type": "object", "properties": { "rules": { "type": "object", "properties": { "reservation_created": { "type": "object", "properties": { "occupied_preset_key": { "type": "string" }, "automated_occupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "unoccupied_preset_key": { "type": "string" }, "automated_unoccupied_preset": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["heat", "cool", "auto"] }, "heating_set_point_celsius": { "type": "number", "format": "float" }, "heating_set_point_fahrenheit": { "type": "number", "format": "float" }, "cooling_set_point_celsius": { "type": "number", "format": "float" }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float" }, "fan_mode": { "type": "string", "enum": ["on", "auto", "circulate"] }, "is_override_allowed": { "type": "boolean" }, "max_override_period_minutes": { "type": "number", "format": "float" } }, "required": [ "mode", "fan_mode", "is_override_allowed", "max_override_period_minutes" ] }, "precondition_minutes_before_reservation": { "type": "number", "format": "float" } } }, "reservation_time_updated": { "type": "object", "properties": {} }, "reservation_deleted": { "type": "object", "properties": {} } } } }, "description": "Climate automation rules configuration." } } } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "customers", "automations" ], "x-fern-sdk-method-name": "update" } }, "/seam/customer/v1/connectors/ical/generate-config": { "post": { "x-title": "Generate iCal Config", "x-response-key": "generated_config", "x-undocumented": "Only used internally.", "summary": "/seam/customer/v1/connectors/ical/generate-config", "description": "Fetches an iCal feed URL and uses AI to generate a parsing config\nbased on the feed's structure and content.", "operationId": "seamCustomerV1ConnectorsIcalGenerateConfigPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_config": { "type": "object", "properties": { "ical_config": { "type": "object", "properties": { "filter": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to match against" }, "pattern": { "type": "string", "description": "Regex pattern — events not matching are skipped" } }, "required": ["source", "pattern"], "description": "Optional filter to skip non-matching events" }, "fields": { "type": "object", "properties": { "reservation_key": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract the reservation key (falls back to UID)" }, "guest_name": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract guest name" }, "guest_email": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract guest email" }, "guest_phone": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract guest phone" }, "starts_at": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract check-in date" }, "ends_at": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract check-out date" } }, "required": ["starts_at", "ends_at"] }, "time_zone": { "type": "string", "description": "IANA time zone (e.g. America/New_York) applied when dates have no time/timezone" }, "default_check_in_time": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "description": "Default check-in time (HH:MM) used when iCal gives date-only values" }, "default_check_out_time": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "description": "Default check-out time (HH:MM) used when iCal gives date-only values" } }, "required": ["fields"] } }, "required": ["ical_config"] }, "ok": { "type": "boolean" } }, "required": ["generated_config", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ical_url": { "type": "string", "format": "uri", "description": "iCal feed URL to analyze" } }, "required": ["ical_url"] } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "connectors", "ical" ], "x-fern-sdk-method-name": "generate-config", "x-fern-sdk-return-value": "generated_config" } }, "/seam/customer/v1/connectors/ical/validate-config": { "post": { "x-title": "Validate iCal Config", "x-response-key": "validation_result", "x-undocumented": "Only used internally.", "summary": "/seam/customer/v1/connectors/ical/validate-config", "description": "Fetches a sample iCal feed and validates the config against it,\nreturning the parsed reservations so the caller can verify\nextraction is correct.", "operationId": "seamCustomerV1ConnectorsIcalValidateConfigPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "validation_result": { "type": "object", "properties": { "is_valid": { "type": "boolean" }, "total_events": { "type": "number", "format": "float" }, "matched_events": { "type": "number", "format": "float" }, "filtered_events": { "type": "number", "format": "float" }, "reservations": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "reservation_key": { "type": "string", "nullable": true }, "guest_name": { "type": "string", "nullable": true }, "guest_email": { "type": "string", "nullable": true }, "guest_phone": { "type": "string", "nullable": true }, "starts_at": { "type": "string", "nullable": true }, "ends_at": { "type": "string", "nullable": true } }, "required": [ "uid", "reservation_key", "guest_name", "guest_email", "guest_phone", "starts_at", "ends_at" ] } }, "errors": { "type": "array", "items": { "type": "string" } } }, "required": [ "is_valid", "total_events", "matched_events", "filtered_events", "reservations", "errors" ] }, "ok": { "type": "boolean" } }, "required": ["validation_result", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ical_url": { "type": "string", "format": "uri", "description": "iCal feed URL to validate against" }, "ical_config": { "type": "object", "properties": { "filter": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to match against" }, "pattern": { "type": "string", "description": "Regex pattern — events not matching are skipped" } }, "required": ["source", "pattern"], "description": "Optional filter to skip non-matching events" }, "fields": { "type": "object", "properties": { "reservation_key": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract the reservation key (falls back to UID)" }, "guest_name": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract guest name" }, "guest_email": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract guest email" }, "guest_phone": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract guest phone" }, "starts_at": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract check-in date" }, "ends_at": { "type": "object", "properties": { "source": { "type": "string", "description": "iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc." }, "pattern": { "type": "string", "description": "Regex with capture group to extract value from the property" }, "type": { "type": "string", "enum": ["date"], "description": "Special type handling — 'date' parses iCal date formats" } }, "required": ["source"], "description": "How to extract check-out date" } }, "required": ["starts_at", "ends_at"] }, "time_zone": { "type": "string", "description": "IANA time zone (e.g. America/New_York) applied when dates have no time/timezone" }, "default_check_in_time": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "description": "Default check-in time (HH:MM) used when iCal gives date-only values" }, "default_check_out_time": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "description": "Default check-out time (HH:MM) used when iCal gives date-only values" } }, "required": ["fields"], "description": "Config to validate" } }, "required": ["ical_url", "ical_config"] } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "connectors", "ical" ], "x-fern-sdk-method-name": "validate-config", "x-fern-sdk-return-value": "validation_result" } }, "/seam/customer/v1/settings/vertical_resource_aliases/get": { "get": { "x-title": "Get Vertical Resource Aliases", "x-response-key": "vertical_resource_aliases", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/vertical_resource_aliases/get", "description": "Returns the resource aliases for the workspace's business vertical, mapping\ngeneric resource types (space, user_identity, access_grant) to their\nvertical-specific terminology. Defaults to neutral if no vertical is set.", "operationId": "seamCustomerV1SettingsVerticalResourceAliasesGetGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "vertical_resource_aliases": { "type": "object", "properties": { "space": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ], "description": "Primary space alias for this vertical." }, "additional_spaces": { "type": "array", "items": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ] }, "description": "Additional space aliases relevant to this vertical." }, "user_identity": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ], "description": "Primary user identity alias for this vertical." }, "access_grant": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ], "description": "Primary access grant alias for this vertical." } }, "required": [ "space", "additional_spaces", "user_identity", "access_grant" ] }, "ok": { "type": "boolean" } }, "required": ["vertical_resource_aliases", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "parameters": [], "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "settings", "vertical_resource_aliases" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "vertical_resource_aliases" }, "post": { "x-title": "Get Vertical Resource Aliases", "x-response-key": "vertical_resource_aliases", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/vertical_resource_aliases/get", "description": "Returns the resource aliases for the workspace's business vertical, mapping\ngeneric resource types (space, user_identity, access_grant) to their\nvertical-specific terminology. Defaults to neutral if no vertical is set.", "operationId": "seamCustomerV1SettingsVerticalResourceAliasesGetPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "vertical_resource_aliases": { "type": "object", "properties": { "space": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ], "description": "Primary space alias for this vertical." }, "additional_spaces": { "type": "array", "items": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ] }, "description": "Additional space aliases relevant to this vertical." }, "user_identity": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ], "description": "Primary user identity alias for this vertical." }, "access_grant": { "type": "object", "properties": { "resource_key": { "type": "string", "description": "The key alias for a single resource." }, "resource_label": { "type": "string", "description": "Human-readable label for a single resource." }, "collection_key": { "type": "string", "description": "The key alias for a collection of resources." }, "collection_label": { "type": "string", "description": "Human-readable label for a collection of resources." } }, "required": [ "resource_key", "resource_label", "collection_key", "collection_label" ], "description": "Primary access grant alias for this vertical." } }, "required": [ "space", "additional_spaces", "user_identity", "access_grant" ] }, "ok": { "type": "boolean" } }, "required": ["vertical_resource_aliases", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "settings", "vertical_resource_aliases" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "vertical_resource_aliases" } }, "/seam/customer/v1/settings/business_verticals/list": { "get": { "x-title": "List Business Verticals", "x-response-key": "business_verticals", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/business_verticals/list", "description": "Returns all available business verticals.", "operationId": "seamCustomerV1SettingsBusinessVerticalsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_verticals": { "type": "array", "items": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical of the customer portal." } }, "ok": { "type": "boolean" } }, "required": ["business_verticals", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] } ], "parameters": [], "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "settings", "business_verticals" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "business_verticals" }, "post": { "x-title": "List Business Verticals", "x-response-key": "business_verticals", "x-undocumented": "Internal endpoint for customer portals.", "summary": "/seam/customer/v1/settings/business_verticals/list", "description": "Returns all available business verticals.", "operationId": "seamCustomerV1SettingsBusinessVerticalsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_verticals": { "type": "array", "items": { "type": "string", "enum": [ "neutral", "short_term_rental", "hospitality", "multi_family", "gym_management", "property_tours" ], "description": "Business vertical of the customer portal." } }, "ok": { "type": "boolean" } }, "required": ["business_verticals", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "console_session_with_workspace": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "customer", "v1", "settings", "business_verticals" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "business_verticals" } }, "/seam/mobile_sdk/v1/acs/credentials/list": { "get": { "x-title": "List Credentials", "x-response-key": "acs_credentials", "x-undocumented": "Mobile SDK only.", "summary": "/seam/mobile_sdk/v1/acs/credentials/list", "description": "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "seamMobileSdkV1AcsCredentialsListGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] } ], "parameters": [], "tags": ["/acs"], "x-fern-sdk-group-name": [ "seam", "mobile_sdk", "v1", "acs", "credentials" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials" }, "post": { "x-title": "List Credentials", "x-response-key": "acs_credentials", "x-undocumented": "Mobile SDK only.", "summary": "/seam/mobile_sdk/v1/acs/credentials/list", "description": "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).", "operationId": "seamMobileSdkV1AcsCredentialsListPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "ok": { "type": "boolean" } }, "required": ["acs_credentials", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": ["/acs"], "x-fern-sdk-group-name": [ "seam", "mobile_sdk", "v1", "acs", "credentials" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials" } }, "/seam/partner/v1/building_blocks/spaces/auto_map": { "get": { "x-title": "Do Auto-Mapping for Partner Resources that Map to Spaces", "x-response-key": "spaces", "x-undocumented": "Partner building blocks/UI only.", "summary": "/seam/partner/v1/building_blocks/spaces/auto_map", "description": "Auto-maps partner resources that have been pushed to Seam.", "operationId": "seamPartnerV1BuildingBlocksSpacesAutoMapGet", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "partner_resource_key": { "type": "string" }, "parent_partner_resource_key": { "type": "string" }, "devices": { "type": "array", "items": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid" }, "device_type": { "type": "string" }, "name": { "type": "string" }, "connected_account_id": { "type": "string", "format": "uuid" } }, "required": [ "device_id", "device_type", "name", "connected_account_id" ] } }, "acs_entrances": { "type": "array", "items": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "connected_account_id": { "type": "string", "format": "uuid" } }, "required": [ "acs_entrance_id", "name", "connected_account_id" ] } }, "needs_review": { "type": "boolean" }, "is_draft": { "type": "boolean" }, "is_common_area": { "type": "boolean" } }, "required": [ "name", "partner_resource_key", "devices", "acs_entrances" ] } }, "ok": { "type": "boolean" } }, "required": ["spaces", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "parameters": [ { "name": "customer_key", "in": "query", "schema": { "type": "string", "description": "Customer key for which to auto-map spaces." } }, { "name": "collection_key", "in": "query", "schema": { "type": "string", "description": "Collection key." } } ], "tags": [], "x-fern-sdk-group-name": [ "seam", "partner", "v1", "building_blocks", "spaces" ], "x-fern-sdk-method-name": "auto_map", "x-fern-sdk-return-value": "spaces" }, "post": { "x-title": "Do Auto-Mapping for Partner Resources that Map to Spaces", "x-response-key": "spaces", "x-undocumented": "Partner building blocks/UI only.", "summary": "/seam/partner/v1/building_blocks/spaces/auto_map", "description": "Auto-maps partner resources that have been pushed to Seam.", "operationId": "seamPartnerV1BuildingBlocksSpacesAutoMapPost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "partner_resource_key": { "type": "string" }, "parent_partner_resource_key": { "type": "string" }, "devices": { "type": "array", "items": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid" }, "device_type": { "type": "string" }, "name": { "type": "string" }, "connected_account_id": { "type": "string", "format": "uuid" } }, "required": [ "device_id", "device_type", "name", "connected_account_id" ] } }, "acs_entrances": { "type": "array", "items": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "connected_account_id": { "type": "string", "format": "uuid" } }, "required": [ "acs_entrance_id", "name", "connected_account_id" ] } }, "needs_review": { "type": "boolean" }, "is_draft": { "type": "boolean" }, "is_common_area": { "type": "boolean" } }, "required": [ "name", "partner_resource_key", "devices", "acs_entrances" ] } }, "ok": { "type": "boolean" } }, "required": ["spaces", "ok"] } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Customer key for which to auto-map spaces." }, "collection_key": { "type": "string", "description": "Collection key." } } } } } }, "tags": [], "x-fern-sdk-group-name": [ "seam", "partner", "v1", "building_blocks", "spaces" ], "x-fern-sdk-method-name": "auto_map", "x-fern-sdk-return-value": "spaces" } } }, "components": { "securitySchemes": { "seam_workspace": { "type": "apiKey", "in": "header", "name": "seam-workspace" }, "seam_client_session_token": { "type": "apiKey", "in": "header", "name": "seam-client-session-token" }, "client_session_token": { "type": "apiKey", "in": "header", "name": "client-session-token" }, "access_token": { "type": "http", "scheme": "bearer", "bearerFormat": "API Token" }, "pat_with_workspace": { "type": "http", "scheme": "bearer", "bearerFormat": "API Token" }, "pat_without_workspace": { "type": "http", "scheme": "bearer", "bearerFormat": "API Token" }, "client_session": { "type": "http", "scheme": "bearer", "bearerFormat": "Client Session Token" }, "client_session_with_customer": { "type": "http", "scheme": "bearer", "bearerFormat": "Customer Client Session Token" }, "bridge_client_session": { "type": "http", "scheme": "bearer", "bearerFormat": "Bridge Client Session Token" }, "certified_client": { "type": "http", "scheme": "bearer", "bearerFormat": "Certified Client" }, "console_session_with_workspace": { "type": "http", "scheme": "bearer", "bearerFormat": "Console Session Token" }, "console_session_without_workspace": { "type": "http", "scheme": "bearer", "bearerFormat": "Console Session Token" }, "api_key": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key" }, "publishable_key": { "type": "apiKey", "in": "header", "name": "seam-publishable-key" } }, "schemas": { "access_code": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the Seam workspace associated with the access code." }, "common_code_key": { "type": "string", "nullable": true, "description": "Unique identifier for a group of access codes that share the same code." }, "is_scheduled_on_device": { "type": "boolean", "description": "Indicates whether the code is set on the device according to a preconfigured schedule." }, "type": { "type": "string", "enum": ["time_bound", "ongoing"], "description": "Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration." }, "is_waiting_for_code_assignment": { "type": "boolean", "description": "Indicates whether the access code is waiting for a code assignment." }, "access_code_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the access code." }, "device_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the device associated with the access code." }, "name": { "type": "string", "nullable": true, "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "code": { "type": "string", "nullable": true, "description": "Code used for access. Typically, a numeric or alphanumeric string." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access code was created." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["smartthings_failed_to_set_access_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to set code on SmartThings device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": [ "smartthings_failed_to_set_after_multiple_retries" ], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to set code after multiple retries." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["smartthings_no_free_slots_available"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "No free slots available on the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["failed_to_set_on_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to set code on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["failed_to_remove_from_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to remove code from device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["duplicate_code_on_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Duplicate access code detected on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["duplicate_code_attempt_prevented"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "An attempt to modify this access code was prevented." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["no_space_for_access_code_on_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "No space for access code on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["kwikset_unable_to_confirm_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Unable to confirm that the access code is set on Kwikset device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["kwikset_unable_to_confirm_deletion"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Unable to confirm the deletion of the access code on Kwikset device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["code_modified_external_to_seam"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Code was modified or removed externally after Seam successfully set it on the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_invalid_code_length"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Invalid code length for August lock." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_device_programming_delay"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Access code has not yet been fully moved to the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_missing_keypad"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "August lock is missing a keypad." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_temporarily_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "August lock is temporarily offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["salto_ks_user_not_subscribed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Salto site user is not subscribed." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["wyze_duplicate_code_name"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Duplicate access code name detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["wyze_potential_duplicate_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Potential duplicate access code detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["dormakaba_oracode_invalid_time_range"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "No Dormakaba Oracode user levels configured for the requested time range." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["kwikset_insufficient_permissions"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["keynest_unsupported_third_party_locker"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "KeyNest locker is not supported." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["replaced_by_newer_access_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "This access code was overridden on the device by a newer access code programmed to the same slot." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["account_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the account is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the Salto site user limit has been reached.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_removed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device has been removed." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["hub_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the hub is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["empty_backup_access_code_pool"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_not_authorized"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the user is not authorized to use the August lock.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_missing_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the lock is not connected to a bridge.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["ttlock_lock_not_paired_to_gateway"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the lock is not paired with a gateway.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["missing_device_credentials"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that device credentials are missing." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["auxiliary_heat_running"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the auxiliary heat is running.", "x-variant-group-key": "thermostats" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["subscription_required"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that a subscription is required to connect." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["lockly_missing_wifi_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n " }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, "description": "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["smartthings_failed_to_set_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Failed to set code on SmartThings device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["schlage_detected_duplicate"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Duplicate access code detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["schlage_creation_outage"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Received an error when attempting to create this code." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["code_modified_external_to_seam"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Code was modified or removed externally after Seam successfully set it on the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["delay_in_setting_on_device"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Delay in setting code on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["delay_in_removing_from_device"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Delay in removing code from device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["third_party_integration_detected"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Third-party integration detected that may cause access codes to fail." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["august_device_programming_delay"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Access code has not yet been fully moved to the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["august_lock_temporarily_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "August lock is temporarily offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["igloo_algopin_must_be_used_within_24_hours"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Algopins must be used within 24 hours." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["management_transferred"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Management was transferred to another workspace." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["kwikset_unable_to_confirm_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Unable to confirm that the access code is set on Kwikset device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ultraloq_access_code_disabled"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["using_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "A backup access code has been pulled and is being used in place of this access code." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Access code is being deleted." } ], "description": "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)." }, "description": "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "is_managed": { "type": "boolean", "enum": [true], "description": "Indicates whether Seam manages the access code." }, "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the time-bound access code becomes active." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time after which the time-bound access code becomes inactive." }, "status": { "type": "string", "enum": ["setting", "set", "unset", "removing", "unknown"], "description": "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes)." }, "is_backup_access_code_available": { "type": "boolean", "description": "Indicates whether a backup access code is available for use if the primary access code is lost or compromised." }, "is_backup": { "type": "boolean", "description": "Indicates whether the access code is a backup code." }, "pulled_backup_access_code_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code." }, "is_external_modification_allowed": { "type": "boolean", "description": "Indicates whether changes to the access code from external sources are permitted." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use." }, "is_offline_access_code": { "type": "boolean", "description": "Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection." }, "dormakaba_oracode_metadata": { "type": "object", "properties": { "stay_id": { "type": "number", "format": "float", "description": "Dormakaba Oracode stay ID associated with this access code." }, "user_level_id": { "type": "string", "description": "Dormakaba Oracode user level ID associated with this access code." }, "user_level_name": { "type": "string", "nullable": true, "description": "Dormakaba Oracode user level name associated with this access code." }, "site_name": { "type": "string", "description": "Dormakaba Oracode site name associated with this access code." }, "is_cancellable": { "type": "boolean", "description": "Indicates whether the stay can be cancelled via the Dormakaba Oracode API." }, "is_extendable": { "type": "boolean", "description": "Indicates whether the stay can be extended via the Dormakaba Oracode API." }, "is_early_checkin_able": { "type": "boolean", "description": "Indicates whether early check-in is available for this stay." }, "is_overridable": { "type": "boolean", "description": "Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached." } }, "required": ["stay_id", "user_level_name"], "description": "Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.", "nullable": true } }, "required": [ "workspace_id", "common_code_key", "type", "access_code_id", "device_id", "name", "code", "created_at", "errors", "warnings", "is_managed", "status", "is_backup_access_code_available", "is_external_modification_allowed", "is_one_time_use", "is_offline_access_code" ], "description": "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.", "x-route-path": "/access_codes" }, "unmanaged_access_code": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the Seam workspace associated with the access code." }, "type": { "type": "string", "enum": ["time_bound", "ongoing"], "description": "Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration." }, "access_code_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the access code." }, "device_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the device associated with the access code." }, "name": { "type": "string", "nullable": true, "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)." }, "code": { "type": "string", "nullable": true, "description": "Code used for access. Typically, a numeric or alphanumeric string." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access code was created." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["smartthings_failed_to_set_access_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to set code on SmartThings device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": [ "smartthings_failed_to_set_after_multiple_retries" ], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to set code after multiple retries." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["smartthings_no_free_slots_available"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "No free slots available on the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["failed_to_set_on_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to set code on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["failed_to_remove_from_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Failed to remove code from device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["duplicate_code_on_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Duplicate access code detected on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["duplicate_code_attempt_prevented"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "An attempt to modify this access code was prevented." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["no_space_for_access_code_on_device"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "No space for access code on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["kwikset_unable_to_confirm_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Unable to confirm that the access code is set on Kwikset device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["kwikset_unable_to_confirm_deletion"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Unable to confirm the deletion of the access code on Kwikset device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["code_modified_external_to_seam"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Code was modified or removed externally after Seam successfully set it on the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_invalid_code_length"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Invalid code length for August lock." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_device_programming_delay"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Access code has not yet been fully moved to the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_missing_keypad"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "August lock is missing a keypad." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_temporarily_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "August lock is temporarily offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["salto_ks_user_not_subscribed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Salto site user is not subscribed." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["wyze_duplicate_code_name"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Duplicate access code name detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["wyze_potential_duplicate_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Potential duplicate access code detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["dormakaba_oracode_invalid_time_range"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "No Dormakaba Oracode user levels configured for the requested time range." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["kwikset_insufficient_permissions"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["keynest_unsupported_third_party_locker"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "KeyNest locker is not supported." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_access_code_error": { "type": "boolean", "enum": [true], "description": "Indicates that this is an access code error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["replaced_by_newer_access_code"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "is_access_code_error", "error_code"], "description": "This access code was overridden on the device by a newer access code programmed to the same slot." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["account_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the account is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the Salto site user limit has been reached.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_removed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device has been removed." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["hub_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the hub is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["empty_backup_access_code_pool"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_not_authorized"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the user is not authorized to use the August lock.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_missing_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the lock is not connected to a bridge.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["ttlock_lock_not_paired_to_gateway"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the lock is not paired with a gateway.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["missing_device_credentials"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that device credentials are missing." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["auxiliary_heat_running"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the auxiliary heat is running.", "x-variant-group-key": "thermostats" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["subscription_required"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that a subscription is required to connect." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["lockly_missing_wifi_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n " }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, "description": "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["smartthings_failed_to_set_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Failed to set code on SmartThings device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["schlage_detected_duplicate"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Duplicate access code detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["schlage_creation_outage"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Received an error when attempting to create this code." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["code_modified_external_to_seam"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Code was modified or removed externally after Seam successfully set it on the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["delay_in_setting_on_device"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Delay in setting code on device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["delay_in_removing_from_device"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Delay in removing code from device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["third_party_integration_detected"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Third-party integration detected that may cause access codes to fail." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["august_device_programming_delay"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Access code has not yet been fully moved to the device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["august_lock_temporarily_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "August lock is temporarily offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["igloo_algopin_must_be_used_within_24_hours"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Algopins must be used within 24 hours." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["management_transferred"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Management was transferred to another workspace." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["kwikset_unable_to_confirm_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Unable to confirm that the access code is set on Kwikset device." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ultraloq_access_code_disabled"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["using_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "A backup access code has been pulled and is being used in place of this access code." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "warning_code"], "description": "Access code is being deleted." } ], "description": "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)." }, "description": "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "is_managed": { "type": "boolean", "enum": [false], "description": "Indicates that Seam does not manage the access code." }, "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the time-bound access code becomes active." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time after which the time-bound access code becomes inactive." }, "status": { "type": "string", "enum": ["set"], "description": "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational." }, "dormakaba_oracode_metadata": { "type": "object", "properties": { "stay_id": { "type": "number", "format": "float", "description": "Dormakaba Oracode stay ID associated with this access code." }, "user_level_id": { "type": "string", "description": "Dormakaba Oracode user level ID associated with this access code." }, "user_level_name": { "type": "string", "nullable": true, "description": "Dormakaba Oracode user level name associated with this access code." }, "site_name": { "type": "string", "description": "Dormakaba Oracode site name associated with this access code." }, "is_cancellable": { "type": "boolean", "description": "Indicates whether the stay can be cancelled via the Dormakaba Oracode API." }, "is_extendable": { "type": "boolean", "description": "Indicates whether the stay can be extended via the Dormakaba Oracode API." }, "is_early_checkin_able": { "type": "boolean", "description": "Indicates whether early check-in is available for this stay." }, "is_overridable": { "type": "boolean", "description": "Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached." } }, "required": ["stay_id", "user_level_name"], "description": "Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.", "nullable": true } }, "required": [ "workspace_id", "type", "access_code_id", "device_id", "name", "code", "created_at", "errors", "warnings", "is_managed", "status" ], "description": "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.\n\nNot all providers support unmanaged access codes. The following providers do not support unmanaged access codes:\n\n- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)", "x-route-path": "/access_codes/unmanaged" }, "action_attempt": { "oneOf": [ { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["LOCK_DOOR"], "description": "Action attempt to track the status of locking a door." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Locking a door is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["LOCK_DOOR"], "description": "Action attempt to track the status of locking a door." }, "result": { "type": "object", "properties": { "was_confirmed_by_device": { "type": "boolean", "description": "Indicates whether the device confirmed that the lock action occurred." } }, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Locking a door succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["LOCK_DOOR"], "description": "Action attempt to track the status of locking a door." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Locking a door failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["UNLOCK_DOOR"], "description": "Action attempt to track the status of unlocking a door." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Unlocking a door is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["UNLOCK_DOOR"], "description": "Action attempt to track the status of unlocking a door." }, "result": { "type": "object", "properties": { "was_confirmed_by_device": { "type": "boolean", "description": "Indicates whether the device confirmed that the unlock action occurred." } }, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Unlocking a door succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["UNLOCK_DOOR"], "description": "Action attempt to track the status of unlocking a door." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Unlocking a door failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["SCAN_CREDENTIAL"], "description": "Action attempt to track the status of scanning a credential." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Reading credential data from the physical encoder is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["SCAN_CREDENTIAL"], "description": "Action attempt to track the status of scanning a credential." }, "result": { "type": "object", "properties": { "acs_credential_on_encoder": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "is_issued": { "type": "boolean", "nullable": true }, "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable." }, "card_number": { "type": "string", "nullable": true, "description": "A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "visionline_metadata": { "type": "object", "properties": { "card_id": { "type": "string", "description": "Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "cancelled": { "type": "boolean", "description": "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled." }, "discarded": { "type": "boolean", "description": "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded." }, "expired": { "type": "boolean", "description": "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired." }, "overwritten": { "type": "boolean", "description": "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten." }, "overridden": { "type": "boolean", "description": "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden." }, "pending_auto_update": { "type": "boolean", "description": "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update." }, "card_format": { "type": "string", "enum": ["TLCode", "rfid48"], "description": "Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "card_holder": { "type": "string", "description": "Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "number_of_issued_cards": { "type": "number", "format": "float", "description": "Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." } }, "required": [ "card_id", "cancelled", "discarded", "expired", "overwritten", "pending_auto_update", "card_format", "number_of_issued_cards" ], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." } }, "required": [ "created_at", "is_issued", "starts_at", "ends_at", "card_number" ], "nullable": true, "description": "Snapshot of credential data read from the physical encoder." }, "acs_credential_on_seam": { "oneOf": [ { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "unknown_issue_with_acs_credential" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [true] } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "description": "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.", "x-route-path": "/acs/credentials" }, { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "unknown_issue_with_acs_credential" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [false] } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "description": "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.", "x-route-path": "/acs/credentials/unmanaged", "x-undocumented": "Unreleased." } ], "description": "Corresponding credential data as stored on Seam and the access system.", "x-route-path": "/acs/credentials", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "warning_code": { "type": "string", "enum": [ "acs_credential_on_encoder_out_of_sync", "acs_credential_on_seam_not_found" ], "description": "Indicates a warning related to scanning a credential." }, "warning_message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." } }, "required": ["warning_code", "warning_message"], "description": "Warning related to scanning a credential." }, "description": "Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system." } }, "required": [ "acs_credential_on_encoder", "acs_credential_on_seam", "warnings" ], "description": "Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Reading credential data from physical encoder succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["SCAN_CREDENTIAL"], "description": "Action attempt to track the status of scanning a credential." }, "error": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["uncategorized_error"], "description": "Type of the error associated with the action attempt." }, "message": { "type": "string", "description": "Message for the error associated with the action attempt." } }, "required": ["type", "message"], "description": "Error that doesn't fit into other specific error categories." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["action_attempt_expired"], "description": "Type of the error associated with the action attempt." }, "message": { "type": "string", "description": "Message for the error associated with the action attempt." } }, "required": ["type", "message"], "description": "Error to indicate an expired action attempt." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["no_credential_on_encoder"], "description": "Error type to indicate that there is no credential on the encoder." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that there is no credential on the encoder." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["encoder_not_online"], "description": "Error type to indicate that the encoder is not online." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that the encoder is not online." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["encoder_communication_timeout"], "description": "Error type to indicate that communication with the encoder timed out." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that communication with the encoder timed out." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["bridge_disconnected"], "description": "Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system." } ] } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Reading credential data from physical encoder failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["ENCODE_CREDENTIAL"], "description": "Action attempt to track the status of encoding credential data from the physical encoder onto a card." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Encoding credential data from the physical encoder onto a card is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["ENCODE_CREDENTIAL"], "description": "Action attempt to track the status of encoding credential data from the physical encoder onto a card." }, "result": { "oneOf": [ { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_credential"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [true] } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "description": "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.", "x-route-path": "/acs/credentials" }, { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_credential"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [false] } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "description": "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.", "x-route-path": "/acs/credentials/unmanaged", "x-undocumented": "Unreleased." } ], "description": "Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Encoding credential data from the physical encoder onto a card succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["ENCODE_CREDENTIAL"], "description": "Action attempt to track the status of encoding credential data from the physical encoder onto a card." }, "error": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["uncategorized_error"], "description": "Type of the error associated with the action attempt." }, "message": { "type": "string", "description": "Message for the error associated with the action attempt." } }, "required": ["type", "message"], "description": "Error that doesn't fit into other specific error categories." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["action_attempt_expired"], "description": "Type of the error associated with the action attempt." }, "message": { "type": "string", "description": "Message for the error associated with the action attempt." } }, "required": ["type", "message"], "description": "Error to indicate an expired action attempt." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["no_credential_on_encoder"], "description": "Error type to indicate that there is no credential on the encoder." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that there is no credential on the encoder." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["incompatible_card_format"], "description": "Error type to indicate an incompatible card format." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate an incompatible card format." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["credential_cannot_be_reissued"], "description": "Error type to indicate that the affected credential cannot be reissued." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that the affected credential cannot be reissued." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["encoder_not_online"], "description": "Error type to indicate that the encoder is not online." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that the encoder is not online." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["encoder_communication_timeout"], "description": "Error type to indicate that communication with the encoder timed out." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that communication with the encoder timed out." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["bridge_disconnected"], "description": "Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["encoding_interrupted"], "description": "Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["credential_deleted"], "description": "Error type to indicate that the credential was deleted and can no longer be encoded." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error to indicate that the credential was deleted and can no longer be encoded." } ] } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Encoding credential data from the physical encoder onto a card failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["RESET_SANDBOX_WORKSPACE"], "description": "Action attempt to track the status of resetting a sandbox workspace." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Resetting a sandbox workspace is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["RESET_SANDBOX_WORKSPACE"], "description": "Action attempt to track the status of resetting a sandbox workspace." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Resetting a sandbox workspace succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["RESET_SANDBOX_WORKSPACE"], "description": "Action attempt to track the status of resetting a sandbox workspace." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Resetting a sandbox workspace failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["SET_FAN_MODE"], "description": "Action attempt to track the status of setting the fan mode on a thermostat." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Setting the fan mode is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["SET_FAN_MODE"], "description": "Action attempt to track the status of setting the fan mode on a thermostat." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Setting the fan mode succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["SET_FAN_MODE"], "description": "Action attempt to track the status of setting the fan mode on a thermostat." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Setting the fan mode failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["SET_HVAC_MODE"], "description": "Action attempt to track the status of setting the HVAC mode on a thermostat." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Setting the HVAC mode is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["SET_HVAC_MODE"], "description": "Action attempt to track the status of setting the HVAC mode on a thermostat." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Setting the HVAC mode succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["SET_HVAC_MODE"], "description": "Action attempt to track the status of setting the HVAC mode on a thermostat." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Setting the HVAC mode failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["ACTIVATE_CLIMATE_PRESET"], "description": "Action attempt to track the status of a climate preset activation." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Activating a climate preset is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["ACTIVATE_CLIMATE_PRESET"], "description": "Action attempt to track the status of a climate preset activation." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Activating a climate preset succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["ACTIVATE_CLIMATE_PRESET"], "description": "Action attempt to track the status of a climate preset activation." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Activating a climate preset failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["SIMULATE_KEYPAD_CODE_ENTRY"], "description": "Action attempt to track the status of simulating a keypad code entry." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Simulating a keypad code entry is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["SIMULATE_KEYPAD_CODE_ENTRY"], "description": "Action attempt to track the status of simulating a keypad code entry." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Simulating a keypad code entry succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["SIMULATE_KEYPAD_CODE_ENTRY"], "description": "Action attempt to track the status of simulating a keypad code entry." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Simulating a keypad code entry failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"], "description": "Action attempt to track the status of simulating a manual lock action using a keypad." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Simulating a manual lock action using a keypad is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"], "description": "Action attempt to track the status of simulating a manual lock action using a keypad." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Simulating a manual lock action using a keypad succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"], "description": "Action attempt to track the status of simulating a manual lock action using a keypad." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Simulating a manual lock action using a keypad failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["PUSH_THERMOSTAT_PROGRAMS"], "description": "Action attempt to track the status of pushing thermostat programs." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Pushing thermostat weekly programs is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["PUSH_THERMOSTAT_PROGRAMS"], "description": "Action attempt to track the status of pushing thermostat programs." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Pushing thermostat weekly programs succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["PUSH_THERMOSTAT_PROGRAMS"], "description": "Action attempt to track the status of pushing thermostat programs." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Pushing thermostat weekly programs failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["CONFIGURE_AUTO_LOCK"], "description": "Action attempt to track the status of configuring the auto-lock on a lock." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ], "description": "Configuring the auto-lock is pending." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["CONFIGURE_AUTO_LOCK"], "description": "Action attempt to track the status of configuring the auto-lock on a lock." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ], "description": "Configuring the auto-lock succeeded." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["CONFIGURE_AUTO_LOCK"], "description": "Action attempt to track the status of configuring the auto-lock on a lock." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ], "description": "Configuring the auto-lock failed." }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["SYNC_ACCESS_CODES"], "description": "Syncing access codes is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["SYNC_ACCESS_CODES"], "description": "Syncing access codes succeeded." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["SYNC_ACCESS_CODES"], "description": "Syncing access codes failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["CREATE_ACCESS_CODE"], "description": "Creating an access code is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["CREATE_ACCESS_CODE"], "description": "Creating an access code succeeded." }, "result": { "type": "object", "properties": { "access_code": { "description": "Created access code." } }, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["CREATE_ACCESS_CODE"], "description": "Creating an access code failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["DELETE_ACCESS_CODE"], "description": "Deleting an access code is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["DELETE_ACCESS_CODE"], "description": "Deleting an access code succeeded." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["DELETE_ACCESS_CODE"], "description": "Deleting an access code failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["UPDATE_ACCESS_CODE"], "description": "Updating an access code is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["UPDATE_ACCESS_CODE"], "description": "Updating an access code succeeded." }, "result": { "type": "object", "properties": { "access_code": { "description": "Updated access code." } }, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["UPDATE_ACCESS_CODE"], "description": "Updating an access code failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["CREATE_NOISE_THRESHOLD"], "description": "Creating a noise threshold is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["CREATE_NOISE_THRESHOLD"], "description": "Creating a noise threshold succeeded." }, "result": { "type": "object", "properties": { "noise_threshold": { "description": "Created noise threshold." } }, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["CREATE_NOISE_THRESHOLD"], "description": "Creating a noise threshold failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["DELETE_NOISE_THRESHOLD"], "description": "Deleting a noise threshold is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["DELETE_NOISE_THRESHOLD"], "description": "Deleting a noise threshold succeeded." }, "result": { "type": "object", "properties": {}, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["DELETE_NOISE_THRESHOLD"], "description": "Deleting a noise threshold failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["pending"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for pending action attempts." }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for pending action attempts." }, "action_type": { "type": "string", "enum": ["UPDATE_NOISE_THRESHOLD"], "description": "Updating a noise threshold is pending." } }, "required": [ "action_attempt_id", "status", "result", "error", "action_type" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["success"] }, "error": { "nullable": true, "description": "Errors associated with the action attempt. Null for successful action attempts." }, "action_type": { "type": "string", "enum": ["UPDATE_NOISE_THRESHOLD"], "description": "Updating a noise threshold succeeded." }, "result": { "type": "object", "properties": { "noise_threshold": { "description": "Updated noise threshold." } }, "description": "Result of the action." } }, "required": [ "action_attempt_id", "status", "error", "action_type", "result" ] }, { "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "status": { "type": "string", "enum": ["error"] }, "result": { "nullable": true, "description": "Result of the action attempt. Null for failed action attempts." }, "action_type": { "type": "string", "enum": ["UPDATE_NOISE_THRESHOLD"], "description": "Updating a noise threshold failed." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["type", "message"], "description": "Error associated with the action." } }, "required": [ "action_attempt_id", "status", "result", "action_type", "error" ] } ], "description": "Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.\n\nWhen you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.\n\nSee also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).", "x-route-path": "/action_attempts" }, "client_session": { "type": "object", "properties": { "client_session_id": { "type": "string", "format": "uuid", "description": "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created." }, "expires_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires." }, "token": { "type": "string", "description": "Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "user_identifier_key": { "type": "string", "nullable": true, "description": "Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "device_count": { "type": "number", "format": "float", "description": "Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "customer_key": { "type": "string", "description": "Customer key associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "connect_webview_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)." }, "user_identity_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.", "deprecated": true, "x-deprecated": "Use `user_identity_id` instead." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session." } }, "required": [ "client_session_id", "workspace_id", "created_at", "expires_at", "token", "user_identifier_key", "device_count", "connected_account_ids", "connect_webview_ids", "user_identity_ids" ], "description": "Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).", "x-route-path": "/client_sessions" }, "thermostat_schedule": { "type": "object", "properties": { "thermostat_schedule_id": { "type": "string", "format": "uuid", "description": "ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device." }, "name": { "type": "string", "nullable": true, "description": "User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." }, "max_override_period_minutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "nullable": true, "description": "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "is_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." } }, "required": [ "thermostat_schedule_id", "device_id", "name", "climate_preset_key", "starts_at", "ends_at", "workspace_id", "created_at", "errors" ], "description": "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.", "x-route-path": "/thermostats/schedules" }, "connect_webview": { "type": "object", "properties": { "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the Connect Webview." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Connect Webview was created." }, "connected_account_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview." }, "url": { "type": "string", "format": "uri", "description": "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user." }, "device_selection_mode": { "type": "string", "enum": ["none", "single", "multiple"] }, "accepted_providers": { "type": "array", "items": { "type": "string" }, "description": "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)." }, "accepted_capabilities": { "type": "array", "items": { "type": "string", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n" }, "description": "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`." }, "accepted_devices": { "type": "array", "items": { "type": "string" }, "deprecated": true, "x-undocumented": "Unused. Will be removed.", "x-deprecated": "Unused. Will be removed." }, "any_device_allowed": { "type": "boolean", "deprecated": true, "x-undocumented": "Unused. Will be removed.", "x-deprecated": "Unused. Will be removed." }, "any_provider_allowed": { "type": "boolean", "description": "Indicates whether any provider is allowed." }, "login_successful": { "type": "boolean", "description": "Indicates whether the user logged in successfully using the Connect Webview." }, "status": { "type": "string", "enum": ["pending", "failed", "authorized"], "description": "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview." }, "custom_redirect_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs." }, "custom_redirect_failure_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL to which the Connect Webview should redirect when an unexpected error occurs." }, "custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application." }, "automatically_manage_new_devices": { "type": "boolean", "description": "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API." }, "wait_for_device_creation": { "type": "boolean", "description": "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview." }, "authorized_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the user authorized (through the Connect Webview) the management of their devices." }, "selected_provider": { "type": "string", "nullable": true, "description": "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)." }, "customer_key": { "type": "string", "description": "The customer key associated with this webview, if any." } }, "required": [ "connect_webview_id", "workspace_id", "created_at", "connected_account_id", "url", "device_selection_mode", "accepted_providers", "accepted_capabilities", "accepted_devices", "any_device_allowed", "any_provider_allowed", "login_successful", "status", "custom_redirect_url", "custom_redirect_failure_url", "custom_metadata", "automatically_manage_new_devices", "wait_for_device_creation", "authorized_at", "selected_provider" ], "description": "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", "x-route-path": "/connect_webviews" }, "connected_account": { "type": "object", "properties": { "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the connected account was created." }, "user_identifier": { "type": "object", "properties": { "username": { "type": "string", "description": "Username of the user identifier associated with the connected account." }, "api_url": { "type": "string", "description": "API URL for the user identifier associated with the connected account." }, "email": { "type": "string", "description": "Email address of the user identifier associated with the connected account." }, "phone": { "type": "string", "description": "Phone number of the user identifier associated with the connected account." }, "exclusive": { "type": "boolean", "description": "Indicates whether the user identifier associated with the connected account is exclusive." } }, "description": "User identifier associated with the connected account.", "deprecated": true, "x-deprecated": "Use `display_name` instead." }, "account_type": { "type": "string", "description": "Type of connected account." }, "account_type_display_name": { "type": "string", "description": "Display name for the connected account type." }, "image_url": { "type": "string", "format": "uri", "description": "Logo URL for the connected account provider." }, "display_name": { "type": "string", "description": "Display name for the connected account." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["account_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the account is disconnected." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "salto_ks_metadata": { "type": "object", "properties": { "sites": { "type": "array", "items": { "type": "object", "properties": { "site_id": { "type": "string", "description": "ID of a Salto site associated with the connected account that has an error." }, "site_name": { "type": "string", "description": "Name of a Salto site associated with the connected account that has an error." }, "subscribed_site_user_count": { "type": "integer", "minimum": 0, "description": "Count of subscribed site users for a Salto site associated with the connected account that has an error." }, "site_user_subscription_limit": { "type": "integer", "minimum": 0, "description": "Subscription limit of site users for a Salto site associated with the connected account that has an error." } }, "required": [ "site_id", "site_name", "subscribed_site_user_count", "site_user_subscription_limit" ], "description": "Salto site associated with the connected account that has an error." }, "description": "Salto sites associated with the connected account that has an error." } }, "required": ["sites"], "description": "Salto KS metadata associated with the connected account that has an error." } }, "required": [ "created_at", "message", "error_code", "salto_ks_metadata" ], "description": "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit." } ] }, "description": "Errors associated with the connected account." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["scheduled_maintenance_window"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that scheduled downtime is planned for the connected account." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_connected_account"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["salto_ks_subscription_limit_almost_reached"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "salto_ks_metadata": { "type": "object", "properties": { "sites": { "type": "array", "items": { "type": "object", "properties": { "site_id": { "type": "string", "description": "ID of a Salto site associated with the connected account that has a warning." }, "site_name": { "type": "string", "description": "Name of a Salto site associated with the connected account that has a warning." }, "site_user_subscription_limit": { "type": "integer", "minimum": 0, "description": "Subscription limit of site users for a Salto site associated with the connected account that has a warning." }, "subscribed_site_user_count": { "type": "integer", "minimum": 0, "description": "Count of subscribed site users for a Salto site associated with the connected account that has a warning." } }, "required": [ "site_id", "site_name", "site_user_subscription_limit", "subscribed_site_user_count" ], "description": "Salto site associated with the connected account that has a warning." }, "description": "Salto sites associated with the connected account that has a warning." } }, "required": ["sites"], "description": "Salto KS metadata associated with the connected account that has a warning." } }, "required": [ "created_at", "message", "warning_code", "salto_ks_metadata" ], "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["account_reauthorization_requested"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam." } ], "description": "Warning associated with the connected account." }, "description": "Warnings associated with the connected account." }, "custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application." }, "automatically_manage_new_devices": { "type": "boolean", "description": "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API." }, "customer_key": { "type": "string", "description": "Your unique key for the customer associated with this connected account." }, "accepted_capabilities": { "type": "array", "items": { "type": "string", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n" }, "description": "List of capabilities that were accepted during the account connection process." } }, "required": [ "connected_account_id", "account_type_display_name", "display_name", "errors", "warnings", "custom_metadata", "automatically_manage_new_devices", "accepted_capabilities" ], "description": "Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.", "x-route-path": "/connected_accounts" }, "customer": { "type": "object", "properties": { "customer_key": { "type": "string", "description": "Unique key for the customer within the workspace." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the customer was created." } }, "required": ["customer_key", "workspace_id", "created_at"], "description": "Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more.", "x-route-path": "/customers", "x-undocumented": "Internal resource." }, "device": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device." }, "device_type": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ], "description": "Type of the device." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces the device is in." }, "nickname": { "type": "string", "description": "Optional nickname to describe the device, settable through Seam." }, "display_name": { "type": "string", "description": "Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices." }, "capabilities_supported": { "type": "array", "items": { "type": "string", "enum": [ "access_code", "lock", "noise_detection", "thermostat", "battery", "phone" ], "description": "\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n " }, "description": "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n " }, "properties": { "allOf": [ { "allOf": [ { "allOf": [ { "type": "object", "properties": { "online": { "type": "boolean", "description": "Indicates whether the device is online." }, "name": { "type": "string", "description": "Name of the device.", "deprecated": true, "x-deprecated": "use device.display_name instead" }, "accessory_keypad": { "type": "object", "properties": { "is_connected": { "type": "boolean", "description": "Indicates if an accessory keypad is connected to the device.\n " }, "battery": { "type": "object", "properties": { "level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1 } }, "required": ["level"], "description": "Keypad battery properties.\n " } }, "required": ["is_connected"], "description": "Accessory keypad properties and state.", "x-property-group-key": "hardware" }, "appearance": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the device as seen from the provider API and application, not settable through Seam." } }, "required": ["name"], "description": "Appearance-related properties, as reported by the device.", "x-property-group-key": "hardware" }, "model": { "type": "object", "properties": { "can_connect_accessory_keypad": { "type": "boolean", "description": "\n Indicates whether the device can connect a accessory keypad.\n " }, "display_name": { "type": "string", "description": "\n Display name of the device model.\n " }, "manufacturer_display_name": { "type": "string", "description": "\n Display name that corresponds to the manufacturer-specific terminology for the device.\n " }, "has_built_in_keypad": { "type": "boolean", "description": "\n Indicates whether the device has a built in accessory keypad.\n " }, "offline_access_codes_supported": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.can_program_offline_access_codes." }, "online_access_codes_supported": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.can_program_online_access_codes." }, "accessory_keypad_supported": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.properties.model.can_connect_accessory_keypad" } }, "required": [ "display_name", "manufacturer_display_name" ], "description": "Device model-related properties." }, "has_direct_power": { "type": "boolean", "description": "Indicates whether the device has direct power.", "x-property-group-key": "hardware" }, "battery_level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.", "x-property-group-key": "hardware" }, "battery": { "type": "object", "properties": { "level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Battery charge level as a value between 0 and 1, inclusive.\n " }, "status": { "type": "string", "enum": ["critical", "low", "good", "full"], "description": "Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n " } }, "required": ["level", "status"], "description": "Represents the current status of the battery charge level.", "x-property-group-key": "hardware" }, "manufacturer": { "type": "string", "description": "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.", "x-property-group-key": "hardware" }, "image_url": { "type": "string", "format": "uri", "description": "Image URL for the device.", "x-property-group-key": "hardware" }, "image_alt_text": { "type": "string", "description": "Alt text for the device image.", "x-property-group-key": "hardware" }, "serial_number": { "type": "string", "description": "Serial number of the device.", "x-property-group-key": "hardware" }, "online_access_codes_enabled": { "type": "boolean", "description": "Indicates whether it is currently possible to use online access codes for the device.", "deprecated": true, "x-property-group-key": "access_codes", "x-deprecated": "use device.can_program_online_access_codes" }, "offline_access_codes_enabled": { "type": "boolean", "description": "Indicates whether it is currently possible to use offline access codes for the device.", "deprecated": true, "x-property-group-key": "access_codes", "x-deprecated": "use device.can_program_offline_access_codes" }, "supports_accessory_keypad": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.properties.model.can_connect_accessory_keypad", "x-property-group-key": "access_codes" }, "supports_offline_access_codes": { "type": "boolean", "deprecated": true, "x-deprecated": "use offline_access_codes_enabled", "x-property-group-key": "access_codes" }, "noise_level_decibels": { "type": "number", "format": "float", "description": "Indicates current noise level in decibels, if the device supports noise detection.", "x-property-group-key": "noise_sensors" }, "currently_triggering_noise_threshold_ids": { "type": "array", "items": { "type": "string" }, "description": "Array of noise threshold IDs that are currently triggering.", "x-property-group-key": "noise_sensors" } }, "required": ["online", "name", "appearance", "model"] }, { "type": "object", "properties": { "assa_abloy_credential_service_metadata": { "type": "object", "properties": { "has_active_endpoint": { "type": "boolean", "description": "Indicates whether the credential service has active endpoints associated with the phone." }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "endpoint_id": { "type": "string", "description": "ID of the associated endpoint." }, "is_active": { "type": "boolean", "description": "Indicated whether the endpoint is active." } }, "required": ["endpoint_id", "is_active"] }, "description": "Endpoints associated with the phone." } }, "required": ["has_active_endpoint", "endpoints"], "description": "ASSA ABLOY Credential Service metadata for the phone." }, "salto_space_credential_service_metadata": { "type": "object", "properties": { "has_active_phone": { "type": "boolean", "description": "Indicates whether the credential service has an active associated phone." } }, "required": ["has_active_phone"], "description": "Salto Space credential service metadata for the phone." } }, "description": "\n Properties of the phone.\n " } ] }, { "type": "object", "properties": { "august_metadata": { "type": "object", "properties": { "lock_id": { "type": "string", "description": "Lock ID for an August device." }, "lock_name": { "type": "string", "description": "Lock name for an August device." }, "house_name": { "type": "string", "description": "House name for an August device." }, "has_keypad": { "type": "boolean", "description": "Indicates whether an August device has a keypad." }, "keypad_battery_level": { "type": "string", "description": "Keypad battery level for an August device." }, "model": { "type": "string", "description": "Model for an August device." }, "house_id": { "type": "string", "description": "House ID for an August device." } }, "required": [ "lock_id", "lock_name", "house_name", "has_keypad" ], "description": "Metadata for an August device." }, "avigilon_alta_metadata": { "type": "object", "properties": { "entry_name": { "type": "string", "description": "Entry name for an Avigilon Alta system." }, "org_name": { "type": "string", "description": "Organization name for an Avigilon Alta system." }, "zone_id": { "type": "number", "format": "float", "description": "Zone ID for an Avigilon Alta system." }, "zone_name": { "type": "string", "description": "Zone name for an Avigilon Alta system." }, "site_id": { "type": "number", "format": "float", "description": "Site ID for an Avigilon Alta system." }, "site_name": { "type": "string", "description": "Site name for an Avigilon Alta system." }, "entry_relays_total_count": { "type": "number", "format": "float", "description": "Total count of entry relays for an Avigilon Alta system." } }, "required": [ "entry_name", "org_name", "zone_id", "zone_name", "site_id", "site_name", "entry_relays_total_count" ], "description": "Metadata for an Avigilon Alta system." }, "schlage_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Schlage device." }, "device_name": { "type": "string", "description": "Device name for a Schlage device." }, "model": { "type": "string", "description": "Model for a Schlage device." } }, "required": ["device_id", "device_name"], "description": "Metadata for a Schlage device." }, "smartthings_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a SmartThings device." }, "device_name": { "type": "string", "description": "Device name for a SmartThings device." }, "model": { "type": "string", "description": "Model for a SmartThings device." }, "location_id": { "type": "string", "description": "Location ID for a SmartThings device." } }, "required": ["device_id", "device_name"], "description": "Metadata for a SmartThings device." }, "lockly_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Lockly device." }, "device_name": { "type": "string", "description": "Device name for a Lockly device." }, "model": { "type": "string", "description": "Model for a Lockly device." } }, "required": ["device_id", "device_name"], "description": "Metadata for a Lockly device." }, "nuki_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Nuki device." }, "device_name": { "type": "string", "description": "Device name for a Nuki device." }, "keypad_battery_critical": { "type": "boolean", "description": "Indicates whether the keypad battery is in a critical state for a Nuki device." }, "keypad_paired": { "type": "boolean", "description": "Indicates whether the keypad is paired for a Nuki device." }, "keypad_2_paired": { "type": "boolean", "description": "Indicates whether keypad 2 is paired for a Nuki device." } }, "required": ["device_id", "device_name"], "description": "Metadata for a Nuki device." }, "kwikset_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Kwikset device." }, "device_name": { "type": "string", "description": "Device name for a Kwikset device." }, "model_number": { "type": "string", "description": "Model number for a Kwikset device." } }, "required": [ "device_id", "device_name", "model_number" ], "description": "Metadata for a Kwikset device." }, "salto_metadata": { "type": "object", "properties": { "lock_id": { "type": "string", "description": "Lock ID for a Salto device." }, "customer_reference": { "type": "string", "description": "Customer reference for a Salto device." }, "lock_type": { "type": "string", "description": "Lock type for a Salto device." }, "battery_level": { "type": "string", "description": "Battery level for a Salto device." }, "locked_state": { "type": "string", "description": "Locked state for a Salto device." }, "model": { "type": "string", "description": "Model for a Salto device." }, "site_id": { "type": "string", "description": "Site ID for the Salto KS site to which the device belongs." }, "site_name": { "type": "string", "description": "Site name for the Salto KS site to which the device belongs." } }, "required": [ "lock_id", "customer_reference", "lock_type", "battery_level", "locked_state" ], "description": "Metada for a Salto device.", "deprecated": true, "x-deprecated": "Use `salto_ks_metadata ` instead." }, "salto_ks_metadata": { "type": "object", "properties": { "lock_id": { "type": "string", "description": "Lock ID for a Salto KS device." }, "customer_reference": { "type": "string", "description": "Customer reference for a Salto KS device." }, "lock_type": { "type": "string", "description": "Lock type for a Salto KS device." }, "battery_level": { "type": "string", "description": "Battery level for a Salto KS device." }, "locked_state": { "type": "string", "description": "Locked state for a Salto KS device." }, "model": { "type": "string", "description": "Model for a Salto KS device." }, "has_custom_pin_subscription": { "type": "boolean", "description": "Indicates whether the site has a Salto KS subscription that supports custom PINs." }, "site_id": { "type": "string", "description": "Site ID for the Salto KS site to which the device belongs." }, "site_name": { "type": "string", "description": "Site name for the Salto KS site to which the device belongs." } }, "required": [ "lock_id", "customer_reference", "lock_type", "battery_level", "locked_state" ], "description": "Metadata for a Salto KS device." }, "genie_metadata": { "type": "object", "properties": { "device_name": { "type": "string", "description": "Lock name for a Genie device." }, "door_name": { "type": "string", "description": "Door name for a Genie device." } }, "required": ["device_name", "door_name"], "description": "Metadata for a Genie device." }, "brivo_metadata": { "type": "object", "properties": { "device_name": { "type": "string", "description": "Device name for a Brivo device." }, "activation_enabled": { "type": "boolean", "description": "Indicates whether the Brivo access point has activation (remote unlock) enabled." } }, "description": "Metadata for a Brivo device." }, "igloo_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for an igloo device." }, "bridge_id": { "type": "string", "description": "Bridge ID for an igloo device." }, "model": { "type": "string", "description": "Model for an igloo device." } }, "required": ["device_id", "bridge_id"], "description": "Metadata for an igloo device." }, "noiseaware_metadata": { "type": "object", "properties": { "device_model": { "type": "string", "enum": ["indoor", "outdoor"], "description": "Device model for a NoiseAware device." }, "noise_level_nrs": { "type": "number", "format": "float", "description": "Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device." }, "noise_level_decibel": { "type": "number", "format": "float", "description": "Noise level, in decibels, for a NoiseAware device." }, "device_name": { "type": "string", "description": "Device name for a NoiseAware device." }, "device_id": { "type": "string", "description": "Device ID for a NoiseAware device." } }, "required": [ "device_model", "noise_level_nrs", "noise_level_decibel", "device_name", "device_id" ], "description": "Metadata for a NoiseAware device." }, "minut_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Minut device." }, "device_name": { "type": "string", "description": "Device name for a Minut device." }, "latest_sensor_values": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "time": { "type": "string", "description": "Time of latest temperature reading for a Minut device." }, "value": { "type": "number", "format": "float", "description": "Value of latest temperature reading for a Minut device." } }, "required": ["time", "value"], "description": "Latest temperature reading for a Minut device." }, "sound": { "type": "object", "properties": { "time": { "type": "string", "description": "Time of latest sound reading for a Minut device." }, "value": { "type": "number", "format": "float", "description": "Value of latest sound reading for a Minut device." } }, "required": ["time", "value"], "description": "Latest sound reading for a Minut device." }, "humidity": { "type": "object", "properties": { "time": { "type": "string", "description": "Time of latest humidity reading for a Minut device." }, "value": { "type": "number", "format": "float", "description": "Value of latest humidity reading for a Minut device." } }, "required": ["time", "value"], "description": "Latest humidity reading for a Minut device." }, "pressure": { "type": "object", "properties": { "time": { "type": "string", "description": "Time of latest pressure reading for a Minut device." }, "value": { "type": "number", "format": "float", "description": "Value of latest pressure reading for a Minut device." } }, "required": ["time", "value"], "description": "Latest pressure reading for a Minut device." }, "accelerometer_z": { "type": "object", "properties": { "time": { "type": "string", "description": "Time of latest accelerometer Z-axis reading for a Minut device." }, "value": { "type": "number", "format": "float", "description": "Value of latest accelerometer Z-axis reading for a Minut device." } }, "required": ["time", "value"], "description": "Latest accelerometer Z-axis reading for a Minut device." } }, "required": [ "temperature", "sound", "humidity", "pressure", "accelerometer_z" ], "description": "Latest sensor values for a Minut device." } }, "required": [ "device_id", "device_name", "latest_sensor_values" ], "description": "Metadata for a Minut device." }, "four_suites_metadata": { "type": "object", "properties": { "device_id": { "type": "number", "format": "float", "description": "Device ID for a 4SUITES device." }, "device_name": { "type": "string", "description": "Device name for a 4SUITES device." }, "reclose_delay_in_seconds": { "type": "number", "format": "float", "description": "Reclose delay, in seconds, for a 4SUITES device." } }, "required": [ "device_id", "device_name", "reclose_delay_in_seconds" ], "description": "Metadata for a 4SUITES device." }, "two_n_metadata": { "type": "object", "properties": { "device_id": { "type": "number", "format": "float", "description": "Device ID for a 2N device." }, "device_name": { "type": "string", "description": "Device name for a 2N device." } }, "required": ["device_id", "device_name"], "description": "Metadata for a 2N device." }, "controlbyweb_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a ControlByWeb device." }, "device_name": { "type": "string", "description": "Device name for a ControlByWeb device." }, "relay_name": { "type": "string", "nullable": true, "description": "Relay name for a ControlByWeb device." } }, "required": ["device_id", "device_name", "relay_name"], "description": "Metadata for a ControlByWeb device." }, "ttlock_metadata": { "type": "object", "properties": { "lock_id": { "type": "number", "format": "float", "description": "Lock ID for a TTLock device." }, "lock_alias": { "type": "string", "description": "Lock alias for a TTLock device." }, "feature_value": { "type": "string", "description": "Feature value for a TTLock device." }, "features": { "type": "object", "properties": { "passcode": { "type": "boolean", "description": "Indicates whether a TTLock device supports a passcode." }, "passcode_management": { "type": "boolean", "description": "Indicates whether a TTLock device supports passcode management." }, "unlock_via_gateway": { "type": "boolean", "description": "Indicates whether a TTLock device supports unlock via gateway." }, "lock_command": { "type": "boolean", "description": "Indicates whether a TTLock device supports the lock command." }, "incomplete_keyboard_passcode": { "type": "boolean", "description": "Indicates whether a TTLock device supports an incomplete keyboard passcode." }, "wifi": { "type": "boolean", "description": "Indicates whether a TTLock device supports Wi-Fi." }, "auto_lock_time_config": { "type": "boolean", "description": "Indicates whether a TTLock device supports auto-lock time configuration." } }, "required": [ "passcode", "passcode_management", "unlock_via_gateway", "lock_command", "incomplete_keyboard_passcode", "wifi", "auto_lock_time_config" ], "description": "Features for a TTLock device." }, "has_gateway": { "type": "boolean", "description": "Indicates whether a TTLock device has a gateway." }, "wireless_keypads": { "type": "array", "items": { "type": "object", "properties": { "wireless_keypad_id": { "type": "number", "format": "float", "description": "ID for a wireless keypad for a TTLock device." }, "wireless_keypad_name": { "type": "string", "description": "Name for a wireless keypad for a TTLock device." } }, "required": [ "wireless_keypad_id", "wireless_keypad_name" ] }, "description": "Wireless keypads for a TTLock device." } }, "required": [ "lock_id", "lock_alias", "feature_value", "features" ], "description": "Metadata for a TTLock device." }, "seam_bridge_metadata": { "type": "object", "properties": { "unlock_method": { "type": "string", "enum": ["bridge", "doorking"], "description": "Unlock method for Seam Bridge." }, "device_num": { "type": "number", "format": "float", "description": "Device number for Seam Bridge." }, "name": { "type": "string", "description": "Name for Seam Bridge." } }, "required": ["device_num", "name"], "description": "Metadata for Seam Bridge." }, "igloohome_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for an igloohome device." }, "device_name": { "type": "string", "description": "Device name for an igloohome device." }, "bridge_id": { "type": "string", "description": "Bridge ID for an igloohome device." }, "bridge_name": { "type": "string", "description": "Bridge name for an igloohome device." }, "keypad_id": { "type": "string", "description": "Keypad ID for an igloohome device." }, "is_accessory_keypad_linked_to_bridge": { "type": "boolean", "description": "Indicates whether a keypad is linked to a bridge for an igloohome device." } }, "required": ["device_id", "device_name"], "description": "Metadata for an igloohome device." }, "nest_metadata": { "type": "object", "properties": { "nest_device_id": { "type": "string", "description": "Device ID for a Google Nest device." }, "device_name": { "type": "string", "description": "Device name for a Google Nest device. Google sets this value." }, "device_custom_name": { "type": "string", "description": "Custom device name for a Google Nest device. The device owner sets this value." }, "display_name": { "type": "string", "description": "Display name for a Google Nest device." } }, "required": [ "nest_device_id", "device_name", "device_custom_name" ], "description": "Metadata for a Google Nest device." }, "ecobee_metadata": { "type": "object", "properties": { "ecobee_device_id": { "type": "string", "description": "Device ID for an ecobee device." }, "device_name": { "type": "string", "description": "Device name for an ecobee device." } }, "required": ["ecobee_device_id", "device_name"], "description": "Metadata for an ecobee device." }, "honeywell_resideo_metadata": { "type": "object", "properties": { "honeywell_resideo_device_id": { "type": "string", "description": "Device ID for a Honeywell Resideo device." }, "device_name": { "type": "string", "description": "Device name for a Honeywell Resideo device." } }, "required": [ "honeywell_resideo_device_id", "device_name" ], "description": "Metadata for a Honeywell Resideo device." }, "dormakaba_oracode_metadata": { "type": "object", "properties": { "door_id": { "type": "number", "format": "float", "description": "Door ID for a dormakaba Oracode device." }, "door_name": { "type": "string", "description": "Door name for a dormakaba Oracode device." }, "device_id": { "oneOf": [ { "type": "number", "format": "float" }, { "type": "string" } ], "description": "Device ID for a dormakaba Oracode device." }, "door_is_wireless": { "type": "boolean", "description": "Indicates whether a door is wireless for a dormakaba Oracode device." }, "site_id": { "type": "number", "format": "float", "nullable": true, "description": "Site ID for a dormakaba Oracode device.", "deprecated": true, "x-deprecated": "Previously marked as \"@DEPRECATED.\"" }, "site_name": { "type": "string", "description": "Site name for a dormakaba Oracode device." }, "iana_timezone": { "type": "string", "description": "IANA time zone for a dormakaba Oracode device." }, "predefined_time_slots": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of a time slot for a dormakaba Oracode device." }, "prefix": { "type": "number", "format": "float", "description": "Prefix for a time slot for a dormakaba Oracode device." }, "check_in_time": { "type": "string", "description": "Check in time for a time slot for a dormakaba Oracode device." }, "check_out_time": { "type": "string", "description": "Checkout time for a time slot for a dormakaba Oracode device." }, "is_24_hour": { "type": "boolean", "description": "Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot." }, "is_biweekly_mode": { "type": "boolean", "description": "Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode." }, "is_one_shot": { "type": "boolean", "description": "Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot." }, "is_master": { "type": "boolean", "description": "Indicates whether a time slot for a dormakaba Oracode device is a master time slot." }, "dormakaba_oracode_user_level_prefix": { "type": "number", "format": "float", "description": "Prefix for a user level for a dormakaba Oracode device." }, "dormakaba_oracode_user_level_id": { "type": "string", "format": "uuid", "description": "ID of a user level for a dormakaba Oracode device." } }, "required": [ "name", "prefix", "check_in_time", "check_out_time", "is_24_hour", "is_biweekly_mode", "is_one_shot", "is_master", "dormakaba_oracode_user_level_prefix", "dormakaba_oracode_user_level_id" ], "description": "Time slot for a dormakaba Oracode device." }, "description": "Predefined time slots for a dormakaba Oracode device." } }, "required": [ "door_name", "door_is_wireless", "site_id", "site_name" ], "description": "Metadata for a dormakaba Oracode device." }, "wyze_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Wyze device." }, "device_name": { "type": "string", "description": "Device name for a Wyze device." }, "product_name": { "type": "string", "description": "Product name for a Wyze device." }, "product_type": { "type": "string", "description": "Product type for a Wyze device." }, "product_model": { "type": "string", "description": "Product model for a Wyze device." }, "device_info_model": { "type": "string", "description": "Device information model for a Wyze device." }, "keypad_uuid": { "type": "string", "description": "Keypad UUID for a Wyze device." }, "locker_status_hardlock": { "type": "number", "format": "float", "description": "Locker status (hardlock) for a Wyze device." } }, "required": [ "device_id", "device_name", "product_name", "product_type", "product_model", "device_info_model" ], "description": "Metadata for a Wyze device." }, "tedee_metadata": { "type": "object", "properties": { "device_id": { "type": "number", "format": "float", "description": "Device ID for a Tedee device." }, "serial_number": { "type": "string", "description": "Serial number for a Tedee device." }, "device_name": { "type": "string", "description": "Device name for a Tedee device." }, "device_model": { "type": "string", "description": "Device model for a Tedee device." }, "bridge_id": { "type": "number", "format": "float", "description": "Bridge ID for a Tedee device." }, "bridge_name": { "type": "string", "description": "Bridge name for a Tedee device." }, "keypad_id": { "type": "number", "format": "float", "description": "Keypad ID for a Tedee device." } }, "required": [ "device_id", "serial_number", "device_name", "device_model", "bridge_id", "bridge_name" ], "description": "Metadata for a Tedee device." }, "visionline_metadata": { "type": "object", "properties": { "encoder_id": { "type": "string", "description": "Encoder ID for an ASSA ABLOY Visionline system." } }, "required": ["encoder_id"], "description": "Metadata for an ASSA ABLOY Visionline system." }, "akiles_metadata": { "type": "object", "properties": { "gadget_name": { "type": "string", "description": "Gadget name for an Akiles device." }, "gadget_id": { "type": "string", "description": "Gadget ID for an Akiles device." }, "product_name": { "type": "string", "description": "Product name for an Akiles device." }, "_member_group_id": { "type": "string", "description": "Group ID to which to add users for an Akiles device." } }, "required": [ "gadget_name", "gadget_id", "product_name" ], "description": "Metadata for an Akiles device." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "encoder_name": { "type": "string", "description": "Encoder name for an ASSA ABLOY Vostio system." } }, "required": ["encoder_name"], "description": "Metadata for an ASSA ABLOY Vostio system." }, "tado_metadata": { "type": "object", "properties": { "serial_no": { "type": "string", "description": "Serial number for a tado° device." }, "device_type": { "type": "string", "description": "Device type for a tado° device." } }, "required": ["serial_no", "device_type"], "description": "Metadata for a tado° device." }, "sensi_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Sensi device." }, "device_name": { "type": "string", "description": "Device name for a Sensi device." }, "product_type": { "type": "string", "description": "Product type for a Sensi device." }, "dual_setpoints_not_supported": { "type": "boolean", "description": "Set to true when the device does not support the /dual-setpoints API endpoint." }, "enforced_setpoint_range_celsius": { "description": "Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error." } }, "required": [ "device_id", "device_name", "product_type" ], "description": "Metadata for a Sensi device." }, "keynest_metadata": { "type": "object", "properties": { "key_id": { "type": "string", "description": "Key ID for a KeyNest device." }, "device_name": { "type": "string", "description": "Device name for a KeyNest device." }, "property_id": { "type": "string", "nullable": true, "description": "Property ID for a KeyNest device." }, "property_postcode": { "type": "string", "nullable": true, "description": "Property postcode for a KeyNest device." }, "key_notes": { "type": "string", "nullable": true, "description": "Key notes for a KeyNest device." }, "subscription_plan": { "type": "string", "description": "Subscription plan for a KeyNest device." }, "status_type": { "type": "string", "description": "Status type for a KeyNest device." }, "current_or_last_store_id": { "type": "number", "format": "float", "description": "Current or last store ID for a KeyNest device." }, "last_movement": { "type": "string", "description": "Last movement timestamp for a KeyNest device." }, "address": { "type": "string", "nullable": true, "description": "Address for a KeyNest device." }, "current_status": { "type": "string", "nullable": true, "description": "Current status for a KeyNest device." }, "current_user_name": { "type": "string", "nullable": true, "description": "Current user name for a KeyNest device." }, "current_user_email": { "type": "string", "nullable": true, "description": "Current user email for a KeyNest device." }, "current_user_phone_number": { "type": "string", "nullable": true, "description": "Current user phone number for a KeyNest device." }, "current_user_company": { "type": "string", "nullable": true, "description": "Current user company for a KeyNest device." }, "handover_method": { "type": "string", "nullable": true, "description": "Handover method for a KeyNest device." }, "keynest_app_user": { "type": "string", "nullable": true, "description": "KeyNest app user for a KeyNest device." }, "default_office_id": { "type": "number", "format": "float", "description": "Default office ID for a KeyNest device." }, "fob_id": { "type": "number", "format": "float", "description": "Fob ID for a KeyNest device." }, "has_photo": { "type": "boolean", "description": "Whether the KeyNest device has a photo." }, "is_quadient_locker": { "type": "boolean", "description": "Whether the key is in a locker that does not support the access codes API." } }, "description": "Metadata for a KeyNest device." }, "ultraloq_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for an Ultraloq device." }, "device_name": { "type": "string", "description": "Device name for an Ultraloq device." }, "device_type": { "type": "string", "description": "Device type for an Ultraloq device." }, "time_zone": { "type": "string", "nullable": true, "description": "IANA timezone for the Ultraloq device." } }, "required": [ "device_id", "device_name", "device_type", "time_zone" ], "description": "Metadata for an Ultraloq device." }, "ring_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Ring device." }, "device_name": { "type": "string", "description": "Device name for a Ring device." } }, "required": ["device_id", "device_name"], "description": "Metadata for a Ring device." }, "korelock_metadata": { "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID for a Korelock device." }, "device_name": { "type": "string", "description": "Device name for a Korelock device." }, "model_code": { "type": "string", "description": "Model code for a Korelock device." }, "serial_number": { "type": "string", "description": "Serial number for a Korelock device." }, "firmware_version": { "type": "string", "description": "Firmware version for a Korelock device." }, "wifi_signal_strength": { "type": "number", "format": "float", "description": "WiFi signal strength (0-1) for a Korelock device." }, "location_id": { "type": "string", "nullable": true, "description": "Location ID for a Korelock device. Required for timebound access codes." } }, "description": "Metadata for a Korelock device." } }, "description": "Provider-specific metadata.", "x-property-group-key": "provider_metadata" } ] }, { "allOf": [ { "type": "object", "properties": { "_experimental_supported_code_from_access_codes_lengths": { "type": "array", "items": { "type": "number", "format": "float" }, "x-undocumented": "Marked as experimental." }, "code_constraints": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "constraint_type": { "type": "string", "enum": [ "no_zeros", "cannot_start_with_12", "no_triple_consecutive_ints", "cannot_specify_pin_code", "pin_code_matches_existing_set", "start_date_in_future", "no_ascending_or_descending_sequence", "at_least_three_unique_digits", "cannot_contain_089", "cannot_contain_0789", "unique_first_four_digits", "no_all_same_digits" ], "description": "Code constraint type for access codes." } }, "required": ["constraint_type"], "description": "Code constraint for access codes." }, { "type": "object", "properties": { "constraint_type": { "type": "string", "enum": ["name_length", "name_must_be_unique"] }, "min_length": { "type": "number", "format": "float", "description": "Minimum name length constraint for access codes." }, "max_length": { "type": "number", "format": "float", "description": "Maximum name length constraint for access codes." } }, "required": ["constraint_type"], "description": "Name constraint for access codes." } ], "description": "Access code constraint." }, "description": "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.", "x-property-group-key": "access_codes" }, "supported_code_lengths": { "type": "array", "items": { "type": "number", "format": "float" }, "description": "Supported code lengths for access codes.", "x-property-group-key": "access_codes" }, "max_active_codes_supported": { "type": "number", "format": "float", "description": "Maximum number of active access codes that the device supports.", "x-property-group-key": "access_codes" }, "supports_backup_access_code_pool": { "type": "boolean", "description": "Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).", "x-property-group-key": "access_codes" }, "has_native_entry_events": { "type": "boolean", "description": "Indicates whether the device supports native entry events.", "x-property-group-key": "access_codes" }, "locked": { "type": "boolean", "description": "Indicates whether the lock is locked.", "x-property-group-key": "locks" }, "keypad_battery": { "type": "object", "properties": { "level": { "type": "number", "format": "float", "description": "\n Keypad battery charge level.\n " } }, "required": ["level"], "description": "Keypad battery status.", "x-property-group-key": "access_codes" }, "door_open": { "type": "boolean", "description": "Indicates whether the door is open.", "x-property-group-key": "locks" }, "auto_lock_enabled": { "type": "boolean", "description": "Indicates whether automatic locking is enabled.", "x-property-group-key": "locks" }, "auto_lock_delay_seconds": { "type": "number", "format": "float", "description": "The delay in seconds before the lock automatically locks after being unlocked.", "x-property-group-key": "locks" } } }, { "type": "object", "properties": { "temperature_fahrenheit": { "type": "number", "format": "float", "description": "Reported temperature in °F.", "x-property-group-key": "thermostats" }, "temperature_celsius": { "type": "number", "format": "float", "description": "Reported temperature in °C.", "x-property-group-key": "thermostats" }, "relative_humidity": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Reported relative humidity, as a value between 0 and 1, inclusive.", "x-property-group-key": "thermostats" }, "available_hvac_mode_settings": { "type": "array", "items": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"] }, "description": "HVAC mode settings that the thermostat supports.", "x-property-group-key": "thermostats" }, "available_fan_mode_settings": { "type": "array", "items": { "type": "string", "enum": ["auto", "on", "circulate"] }, "description": "Fan mode settings that the thermostat supports.", "x-property-group-key": "thermostats" }, "available_climate_preset_modes": { "type": "array", "items": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ] }, "description": "Climate preset modes that the thermostat supports, such as \"home\", \"away\", \"wake\", \"sleep\", \"occupied\", and \"unoccupied\".", "x-property-group-key": "thermostats", "x-draft": "Needs review." }, "is_heating": { "type": "boolean", "description": "Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.", "x-property-group-key": "thermostats" }, "is_cooling": { "type": "boolean", "description": "Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.", "x-property-group-key": "thermostats" }, "is_fan_running": { "type": "boolean", "description": "Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.", "x-property-group-key": "thermostats" }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "deprecated": true, "x-deprecated": "Use `current_climate_setting.fan_mode_setting` instead.", "x-property-group-key": "thermostats" }, "is_temporary_manual_override_active": { "type": "boolean", "description": "Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.", "x-property-group-key": "thermostats" }, "current_climate_setting": { "type": "object", "properties": { "climate_preset_key": { "type": "string", "description": "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "can_edit": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited." }, "can_delete": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted." }, "can_use_with_thermostat_daily_programs": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program." }, "name": { "default": null, "type": "string", "nullable": true, "description": "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "display_name": { "type": "string", "description": "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "climate_preset_mode": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n " }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "manual_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "deprecated": true, "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" }, "ecobee_metadata": { "type": "object", "properties": { "climate_ref": { "type": "string", "description": "Reference to the Ecobee climate, if applicable." }, "is_optimized": { "type": "boolean", "description": "Indicates if the climate preset is optimized by Ecobee." }, "owner": { "type": "string", "enum": ["user", "system"], "description": "Indicates whether the climate preset is owned by the user or the system." } }, "required": [ "climate_ref", "is_optimized", "owner" ], "description": "\n Metadata specific to the Ecobee climate, if applicable.\n " } }, "description": "Current climate setting.", "x-property-group-key": "thermostats" }, "default_climate_setting": { "type": "object", "properties": { "climate_preset_key": { "type": "string", "description": "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "can_edit": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited." }, "can_delete": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted." }, "can_use_with_thermostat_daily_programs": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program." }, "name": { "default": null, "type": "string", "nullable": true, "description": "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "display_name": { "type": "string", "description": "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "climate_preset_mode": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n " }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "manual_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "deprecated": true, "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" }, "ecobee_metadata": { "type": "object", "properties": { "climate_ref": { "type": "string", "description": "Reference to the Ecobee climate, if applicable." }, "is_optimized": { "type": "boolean", "description": "Indicates if the climate preset is optimized by Ecobee." }, "owner": { "type": "string", "enum": ["user", "system"], "description": "Indicates whether the climate preset is owned by the user or the system." } }, "required": [ "climate_ref", "is_optimized", "owner" ], "description": "\n Metadata specific to the Ecobee climate, if applicable.\n " } }, "deprecated": true, "x-deprecated": "use fallback_climate_preset_key to specify a fallback climate preset instead.", "x-property-group-key": "thermostats" }, "available_climate_presets": { "type": "array", "items": { "type": "object", "properties": { "climate_preset_key": { "type": "string", "description": "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "can_edit": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited." }, "can_delete": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted." }, "can_use_with_thermostat_daily_programs": { "type": "boolean", "description": "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program." }, "name": { "default": null, "type": "string", "nullable": true, "description": "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "display_name": { "type": "string", "description": "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)." }, "climate_preset_mode": { "type": "string", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n " }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "manual_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "deprecated": true, "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" }, "ecobee_metadata": { "type": "object", "properties": { "climate_ref": { "type": "string", "description": "Reference to the Ecobee climate, if applicable." }, "is_optimized": { "type": "boolean", "description": "Indicates if the climate preset is optimized by Ecobee." }, "owner": { "type": "string", "enum": ["user", "system"], "description": "Indicates whether the climate preset is owned by the user or the system." } }, "required": [ "climate_ref", "is_optimized", "owner" ], "description": "\n Metadata specific to the Ecobee climate, if applicable.\n " } }, "required": [ "climate_preset_key", "can_edit", "can_delete", "can_use_with_thermostat_daily_programs", "display_name", "manual_override_allowed" ] }, "description": "Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.", "x-property-group-key": "thermostats" }, "fallback_climate_preset_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.", "x-property-group-key": "thermostats" }, "active_thermostat_schedule": { "type": "object", "properties": { "thermostat_schedule_id": { "type": "string", "format": "uuid", "description": "ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device." }, "name": { "type": "string", "nullable": true, "description": "User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." }, "max_override_period_minutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "nullable": true, "description": "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "is_override_allowed": { "type": "boolean", "description": "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)." } }, "required": [ "thermostat_schedule_id", "device_id", "name", "climate_preset_key", "starts_at", "ends_at", "workspace_id", "created_at", "errors" ], "description": "Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "x-route-path": "/thermostats/schedules", "nullable": true, "deprecated": true, "x-property-group-key": "thermostats", "x-deprecated": "Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead." }, "active_thermostat_schedule_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "x-property-group-key": "thermostats" }, "thermostat_daily_programs": { "type": "array", "items": { "type": "object", "properties": { "thermostat_daily_program_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat daily program." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device on which the thermostat daily program is configured." }, "name": { "type": "string", "nullable": true, "description": "User-friendly name to identify the thermostat daily program." }, "periods": { "type": "array", "items": { "type": "object", "properties": { "starts_at_time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`." } }, "required": [ "starts_at_time", "climate_preset_key" ], "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time." }, "description": "Array of thermostat daily program periods." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the thermostat daily program was created." } }, "required": [ "thermostat_daily_program_id", "device_id", "name", "periods", "workspace_id", "created_at" ], "description": "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.", "x-route-path": "/thermostats/daily_programs" }, "description": "Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.", "x-property-group-key": "thermostats" }, "thermostat_weekly_program": { "type": "object", "properties": { "monday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Mondays." }, "tuesday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Tuesdays." }, "wednesday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Wednesdays." }, "thursday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Thursdays." }, "friday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Fridays." }, "saturday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Saturdays." }, "sunday_program_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat daily program to run on Sundays." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the thermostat weekly program was created." } }, "required": [ "monday_program_id", "tuesday_program_id", "wednesday_program_id", "thursday_program_id", "friday_program_id", "saturday_program_id", "sunday_program_id", "created_at" ], "nullable": true, "description": "Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.", "x-property-group-key": "thermostats" }, "min_cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.", "x-property-group-key": "thermostats" }, "min_cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.", "x-property-group-key": "thermostats" }, "max_cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.", "x-property-group-key": "thermostats" }, "max_cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.", "x-property-group-key": "thermostats" }, "min_heating_set_point_celsius": { "type": "number", "format": "float", "description": "Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.", "x-property-group-key": "thermostats" }, "min_heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.", "x-property-group-key": "thermostats" }, "max_heating_set_point_celsius": { "type": "number", "format": "float", "description": "Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.", "x-property-group-key": "thermostats" }, "max_heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.", "x-property-group-key": "thermostats" }, "min_heating_cooling_delta_celsius": { "type": "number", "format": "float", "description": "Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.", "x-property-group-key": "thermostats" }, "min_heating_cooling_delta_fahrenheit": { "type": "number", "format": "float", "description": "Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.", "x-property-group-key": "thermostats" }, "temperature_threshold": { "type": "object", "properties": { "lower_limit_celsius": { "type": "number", "format": "float", "nullable": true, "description": "Lower limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n " }, "lower_limit_fahrenheit": { "type": "number", "format": "float", "nullable": true, "description": "Lower limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n " }, "upper_limit_celsius": { "type": "number", "format": "float", "nullable": true, "description": "Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n " }, "upper_limit_fahrenheit": { "type": "number", "format": "float", "nullable": true, "description": "Upper limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n " } }, "required": [ "lower_limit_celsius", "lower_limit_fahrenheit", "upper_limit_celsius", "upper_limit_fahrenheit" ], "description": "Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.", "x-property-group-key": "thermostats" }, "thermostat_daily_program_period_precision_minutes": { "type": "number", "format": "float", "description": "Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.", "x-property-group-key": "thermostats" }, "max_unique_climate_presets_per_thermostat_weekly_program": { "type": "number", "format": "float", "description": "Maximum number of climate presets that the thermostat can support for weekly programming.", "x-property-group-key": "thermostats" }, "max_thermostat_daily_program_periods_per_day": { "type": "number", "format": "float", "description": "Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.", "x-property-group-key": "thermostats" } } } ] } ], "description": "Properties of the device.", "x-property-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "location": { "type": "object", "properties": { "location_name": { "type": "string", "description": "Name of the device location.\n " }, "time_zone": { "type": "string", "description": "Time zone of the device location.\n " }, "timezone": { "type": "string", "description": "Time zone of the device location.", "deprecated": true, "x-deprecated": "Use `time_zone` instead." } }, "description": "Location information for the device.", "x-property-group-key": "hardware" }, "connected_account_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the account associated with the device." }, "workspace_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the Seam workspace associated with the device." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["account_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the account is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the Salto site user limit has been reached.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_removed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device has been removed." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["hub_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the hub is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["empty_backup_access_code_pool"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_not_authorized"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the user is not authorized to use the August lock.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_missing_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the lock is not connected to a bridge.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["ttlock_lock_not_paired_to_gateway"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the lock is not paired with a gateway.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["missing_device_credentials"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that device credentials are missing." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["auxiliary_heat_running"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the auxiliary heat is running.", "x-variant-group-key": "thermostats" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["subscription_required"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that a subscription is required to connect." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["lockly_missing_wifi_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n " }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, "description": "Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["partial_backup_access_code_pool"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the backup access code is unhealthy.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["many_active_backup_codes"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that there are too many backup codes.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["wyze_device_missing_gateway"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "\n Indicates that the Wyze Lock is not connected to a gateway.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["third_party_integration_detected"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that a third-party integration has been detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ttlock_lock_gateway_unlocking_not_enabled"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Remote Unlock feature is not enabled in the settings.\"", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ttlock_weak_gateway_signal"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "\n Indicates that the gateway signal is weak.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["power_saving_mode"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device is in power saving mode and may have limited functionality.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["temperature_threshold_exceeded"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the temperature threshold has been exceeded.", "x-variant-group-key": "thermostats" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["device_communication_degraded"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device appears to be unresponsive." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["scheduled_maintenance_window"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that a scheduled maintenance window has been detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["device_has_flaky_connection"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device has a flaky connection." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["salto_ks_office_mode"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["salto_ks_privacy_mode"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["salto_ks_subscription_limit_almost_reached"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_phone"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.", "x-variant-group-key": "phones" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["lockly_time_zone_not_configured"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ultraloq_time_zone_unknown"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["two_n_device_missing_timezone"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["hub_required_for_additional_capabilities"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["keynest_unsupported_locker"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the key is in a locker that does not support the access codes API.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["accessory_keypad_setup_required"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["unreliable_online_status"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["max_access_codes_reached"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "active_access_code_count": { "type": "integer", "description": "Number of active access codes on the device when the warning was set." }, "max_active_access_code_count": { "type": "integer", "description": "Maximum number of active access codes supported by the device." } }, "required": [ "message", "created_at", "warning_code", "active_access_code_count", "max_active_access_code_count" ], "description": "Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.", "x-variant-group-key": "access_codes" } ] }, "description": "Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the device object was created." }, "is_managed": { "type": "boolean", "enum": [true], "description": "Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices)." }, "custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application." }, "device_provider": { "type": "object", "properties": { "provider_category": { "type": "string", "description": "Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations." }, "device_provider_name": { "type": "string", "description": "Device provider name. Corresponds to the integration type, such as `august`, `schlage`, `yale_access`, and so on." }, "display_name": { "type": "string", "description": "Display name for the device provider type." }, "image_url": { "type": "string", "format": "uri", "description": "Image URL for the device provider." } }, "required": [ "provider_category", "device_provider_name", "display_name" ], "description": "Provider of the device. Represents the third-party service through which the device is controlled.", "x-property-group-key": "hardware" }, "device_manufacturer": { "type": "object", "properties": { "manufacturer": { "type": "string", "description": "Manufacturer identifier, such as `august`, `yale`, `salto`, and so on." }, "display_name": { "type": "string", "description": "Display name for the manufacturer, such as `August`, `Yale`, `Salto`, and so on." }, "image_url": { "type": "string", "format": "uri", "description": "Image URL for the manufacturer logo." } }, "required": ["manufacturer", "display_name"], "description": "Manufacturer of the device. Represents the hardware brand, which may differ from the provider.", "x-property-group-key": "hardware" }, "can_remotely_unlock": { "type": "boolean" }, "can_remotely_lock": { "type": "boolean" }, "can_program_offline_access_codes": { "type": "boolean" }, "can_program_online_access_codes": { "type": "boolean" }, "can_hvac_heat": { "type": "boolean" }, "can_hvac_cool": { "type": "boolean" }, "can_hvac_heat_cool": { "type": "boolean" }, "can_turn_off_hvac": { "type": "boolean" }, "can_simulate_removal": { "type": "boolean" }, "can_simulate_connection": { "type": "boolean" }, "can_simulate_disconnection": { "type": "boolean" }, "can_unlock_with_code": { "type": "boolean" }, "can_run_thermostat_programs": { "type": "boolean" }, "can_program_thermostat_programs_as_weekday_weekend": { "type": "boolean" }, "can_program_thermostat_programs_as_different_each_day": { "type": "boolean" }, "can_program_thermostat_programs_as_same_each_day": { "type": "boolean" }, "can_simulate_hub_connection": { "type": "boolean" }, "can_simulate_hub_disconnection": { "type": "boolean" }, "can_simulate_paid_subscription": { "type": "boolean" }, "can_configure_auto_lock": { "type": "boolean" } }, "required": [ "device_id", "device_type", "space_ids", "display_name", "capabilities_supported", "properties", "connected_account_id", "workspace_id", "errors", "warnings", "created_at", "is_managed", "custom_metadata" ], "description": "Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.", "x-route-path": "/devices", "x-property-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "unmanaged_device": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the device." }, "device_type": { "oneOf": [ { "type": "string", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "korelock_lock" ], "description": "Device type for smartlocks.\n " }, { "type": "string", "enum": ["keynest_key"], "description": "Device type for keys.\n " }, { "type": "string", "enum": ["noiseaware_activity_zone", "minut_sensor"], "description": "Device type for noise sensors.\n " }, { "type": "string", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "description": "Device type for thermostats.\n " }, { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, { "type": "string", "enum": ["ring_camera"], "description": "Device type for cameras." } ], "description": "Type of the device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the account associated with the device." }, "location": { "type": "object", "properties": { "location_name": { "type": "string", "description": "Name of the device location.\n " }, "time_zone": { "type": "string", "description": "Time zone of the device location.\n " }, "timezone": { "type": "string", "description": "Time zone of the device location.", "deprecated": true, "x-deprecated": "Use `time_zone` instead." } }, "description": "Location information for the device.", "x-property-group-key": "hardware" }, "capabilities_supported": { "type": "array", "items": { "type": "string", "enum": [ "access_code", "lock", "noise_detection", "thermostat", "battery", "phone" ], "description": "\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n " }, "description": "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n " }, "workspace_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the Seam workspace associated with the device." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["account_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the account is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [false], "description": "Indicates that the error is not a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_connected_account_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error." } }, "required": [ "message", "is_device_error", "created_at", "error_code", "is_connected_account_error" ], "description": "Indicates that the Salto site user limit has been reached.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_offline"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is offline." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_removed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device has been removed." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["hub_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the hub is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["device_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the device is disconnected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["empty_backup_access_code_pool"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_not_authorized"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the user is not authorized to use the August lock.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["august_lock_missing_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the lock is not connected to a bridge.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["ttlock_lock_not_paired_to_gateway"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the lock is not paired with a gateway.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["missing_device_credentials"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that device credentials are missing." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["auxiliary_heat_running"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that the auxiliary heat is running.", "x-variant-group-key": "thermostats" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["subscription_required"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "Indicates that a subscription is required to connect." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_device_error": { "type": "boolean", "enum": [true], "description": "Indicates that the error is a device error." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["lockly_missing_wifi_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": [ "message", "is_device_error", "created_at", "error_code" ], "description": "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n " }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "is_connected_account_error": { "type": "boolean", "description": "Indicates whether the error is related specifically to the connected account." }, "is_bridge_error": { "type": "boolean", "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)." }, "error_code": { "type": "string", "enum": ["bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, "description": "Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["partial_backup_access_code_pool"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the backup access code is unhealthy.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["many_active_backup_codes"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that there are too many backup codes.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["wyze_device_missing_gateway"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "\n Indicates that the Wyze Lock is not connected to a gateway.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["third_party_integration_detected"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that a third-party integration has been detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ttlock_lock_gateway_unlocking_not_enabled"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Remote Unlock feature is not enabled in the settings.\"", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ttlock_weak_gateway_signal"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "\n Indicates that the gateway signal is weak.\n " }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["power_saving_mode"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device is in power saving mode and may have limited functionality.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["temperature_threshold_exceeded"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the temperature threshold has been exceeded.", "x-variant-group-key": "thermostats" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["device_communication_degraded"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device appears to be unresponsive." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["scheduled_maintenance_window"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that a scheduled maintenance window has been detected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["device_has_flaky_connection"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device has a flaky connection." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["salto_ks_office_mode"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["salto_ks_privacy_mode"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.", "x-variant-group-key": "access_codes" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["salto_ks_subscription_limit_almost_reached"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_phone"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.", "x-variant-group-key": "phones" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["lockly_time_zone_not_configured"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["ultraloq_time_zone_unknown"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["two_n_device_missing_timezone"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["hub_required_for_additional_capabilities"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["keynest_unsupported_locker"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the key is in a locker that does not support the access codes API.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["accessory_keypad_setup_required"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["unreliable_online_status"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "warning_code"], "description": "Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.", "x-variant-group-key": "locks" }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "warning_code": { "type": "string", "enum": ["max_access_codes_reached"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "active_access_code_count": { "type": "integer", "description": "Number of active access codes on the device when the warning was set." }, "max_active_access_code_count": { "type": "integer", "description": "Maximum number of active access codes supported by the device." } }, "required": [ "message", "created_at", "warning_code", "active_access_code_count", "max_active_access_code_count" ], "description": "Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.", "x-variant-group-key": "access_codes" } ] }, "description": "Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "x-variant-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the device object was created." }, "custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application." }, "is_managed": { "type": "boolean", "enum": [false] }, "properties": { "type": "object", "properties": { "accessory_keypad": { "type": "object", "properties": { "is_connected": { "type": "boolean", "description": "Indicates if an accessory keypad is connected to the device.\n " }, "battery": { "type": "object", "properties": { "level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1 } }, "required": ["level"], "description": "Keypad battery properties.\n " } }, "required": ["is_connected"], "description": "Accessory keypad properties and state.", "x-property-group-key": "hardware" }, "name": { "type": "string", "description": "Name of the device.", "deprecated": true, "x-deprecated": "use device.display_name instead" }, "online": { "type": "boolean", "description": "Indicates whether the device is online." }, "manufacturer": { "type": "string", "description": "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.", "x-property-group-key": "hardware" }, "image_url": { "type": "string", "format": "uri", "description": "Image URL for the device.", "x-property-group-key": "hardware" }, "image_alt_text": { "type": "string", "description": "Alt text for the device image.", "x-property-group-key": "hardware" }, "battery_level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.", "x-property-group-key": "hardware" }, "battery": { "type": "object", "properties": { "level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Battery charge level as a value between 0 and 1, inclusive.\n " }, "status": { "type": "string", "enum": ["critical", "low", "good", "full"], "description": "Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n " } }, "required": ["level", "status"], "description": "Represents the current status of the battery charge level.", "x-property-group-key": "hardware" }, "online_access_codes_enabled": { "type": "boolean", "description": "Indicates whether it is currently possible to use online access codes for the device.", "deprecated": true, "x-property-group-key": "access_codes", "x-deprecated": "use device.can_program_online_access_codes" }, "offline_access_codes_enabled": { "type": "boolean", "description": "Indicates whether it is currently possible to use offline access codes for the device.", "deprecated": true, "x-property-group-key": "access_codes", "x-deprecated": "use device.can_program_offline_access_codes" }, "model": { "type": "object", "properties": { "can_connect_accessory_keypad": { "type": "boolean", "description": "\n Indicates whether the device can connect a accessory keypad.\n " }, "display_name": { "type": "string", "description": "\n Display name of the device model.\n " }, "manufacturer_display_name": { "type": "string", "description": "\n Display name that corresponds to the manufacturer-specific terminology for the device.\n " }, "has_built_in_keypad": { "type": "boolean", "description": "\n Indicates whether the device has a built in accessory keypad.\n " }, "offline_access_codes_supported": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.can_program_offline_access_codes." }, "online_access_codes_supported": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.can_program_online_access_codes." }, "accessory_keypad_supported": { "type": "boolean", "deprecated": true, "x-deprecated": "use device.properties.model.can_connect_accessory_keypad" } }, "required": ["display_name", "manufacturer_display_name"], "description": "Device model-related properties." } }, "required": ["name", "online", "model"], "description": "properties of the device.", "x-property-groups": { "locks": { "name": "locks" }, "access_codes": { "name": "access codes" }, "thermostats": { "name": "thermostats" }, "hardware": { "name": "hardware" }, "noise_sensors": { "name": "noise sensors" }, "phones": { "name": "phones" }, "provider_metadata": { "name": "provider metadata" } } }, "can_remotely_unlock": { "type": "boolean" }, "can_remotely_lock": { "type": "boolean" }, "can_program_offline_access_codes": { "type": "boolean" }, "can_program_online_access_codes": { "type": "boolean" }, "can_hvac_heat": { "type": "boolean" }, "can_hvac_cool": { "type": "boolean" }, "can_hvac_heat_cool": { "type": "boolean" }, "can_turn_off_hvac": { "type": "boolean" }, "can_simulate_removal": { "type": "boolean" }, "can_simulate_connection": { "type": "boolean" }, "can_simulate_disconnection": { "type": "boolean" }, "can_unlock_with_code": { "type": "boolean" }, "can_run_thermostat_programs": { "type": "boolean" }, "can_program_thermostat_programs_as_weekday_weekend": { "type": "boolean" }, "can_program_thermostat_programs_as_different_each_day": { "type": "boolean" }, "can_program_thermostat_programs_as_same_each_day": { "type": "boolean" }, "can_simulate_hub_connection": { "type": "boolean" }, "can_simulate_hub_disconnection": { "type": "boolean" }, "can_simulate_paid_subscription": { "type": "boolean" }, "can_configure_auto_lock": { "type": "boolean" } }, "required": [ "device_id", "device_type", "connected_account_id", "capabilities_supported", "workspace_id", "errors", "warnings", "created_at", "custom_metadata", "is_managed", "properties" ], "description": "Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "x-route-path": "/devices/unmanaged", "x-property-groups": { "locks": { "name": "Locks" }, "access_codes": { "name": "Access Codes" }, "thermostats": { "name": "Thermostats" }, "hardware": { "name": "Hardware" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" } } }, "device_provider": { "type": "object", "properties": { "device_provider_name": { "type": "string", "enum": [ "hotek", "dormakaba_community", "legic_connect", "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "schlage", "smartthings", "yale", "genie", "doorking", "salto", "salto_ks", "lockly", "ttlock", "linear", "noiseaware", "nuki", "igloo", "kwikset", "minut", "my_2n", "controlbyweb", "nest", "igloohome", "ecobee", "four_suites", "dormakaba_oracode", "pti", "wyze", "seam_passport", "visionline", "assa_abloy_credential_service", "tedee", "honeywell_resideo", "latch", "akiles", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "tado", "salto_space", "sensi", "keynest", "korelock", "dormakaba_ambiance", "ultraloq", "ring" ] }, "display_name": { "type": "string" }, "image_url": { "type": "string" }, "provider_categories": { "type": "array", "items": { "type": "string", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras" ] } }, "can_remotely_unlock": { "type": "boolean" }, "can_remotely_lock": { "type": "boolean" }, "can_program_offline_access_codes": { "type": "boolean" }, "can_program_online_access_codes": { "type": "boolean" }, "can_hvac_heat": { "type": "boolean" }, "can_hvac_cool": { "type": "boolean" }, "can_hvac_heat_cool": { "type": "boolean" }, "can_turn_off_hvac": { "type": "boolean" }, "can_simulate_removal": { "type": "boolean" }, "can_simulate_connection": { "type": "boolean" }, "can_simulate_disconnection": { "type": "boolean" }, "can_unlock_with_code": { "type": "boolean" }, "can_run_thermostat_programs": { "type": "boolean" }, "can_program_thermostat_programs_as_weekday_weekend": { "type": "boolean" }, "can_program_thermostat_programs_as_different_each_day": { "type": "boolean" }, "can_program_thermostat_programs_as_same_each_day": { "type": "boolean" }, "can_simulate_hub_connection": { "type": "boolean" }, "can_simulate_hub_disconnection": { "type": "boolean" }, "can_simulate_paid_subscription": { "type": "boolean" }, "can_configure_auto_lock": { "type": "boolean" } }, "required": [ "device_provider_name", "display_name", "image_url", "provider_categories" ], "x-route-path": "/devices" }, "event": { "discriminator": { "propertyName": "event_type" }, "oneOf": [ { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.created"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.changed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.scheduled_on_device"] }, "code": { "type": "string", "description": "Code for the affected access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "code" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.set_on_device"] }, "code": { "type": "string", "description": "Code for the affected access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "code" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.removed_from_device"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.delay_in_setting_on_device"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." }, "access_code_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the access code." }, "access_code_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "description": "There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.failed_to_set_on_device"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." }, "access_code_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the access code." }, "access_code_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.deleted"] }, "code": { "type": "string", "description": "Code for the affected access code.", "nullable": true } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "code" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.delay_in_removing_from_device"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." }, "access_code_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the access code." }, "access_code_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "description": "There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.failed_to_remove_from_device"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." }, "access_code_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the access code." }, "access_code_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.modified_external_to_seam"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.deleted_external_to_seam"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.backup_access_code_pulled"] }, "backup_access_code_id": { "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "backup_access_code_id" ], "description": "A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.", "x-route-path": "/access_codes" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.unmanaged.converted_to_managed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.", "x-route-path": "/access_codes/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.unmanaged.failed_to_convert_to_managed"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." }, "access_code_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the access code." }, "access_code_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the access code." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "description": "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.", "x-route-path": "/access_codes/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.unmanaged.created"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.", "x-route-path": "/access_codes/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the affected access code." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the affected access code." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["access_code.unmanaged.removed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "description": "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.", "x-route-path": "/access_codes/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": ["access_grant.created"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "description": "An Access Grant was created.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": ["access_grant.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "description": "An Access Grant was deleted.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": ["access_grant.access_granted_to_all_doors"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "description": "All access requested for an Access Grant was successfully granted.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": ["access_grant.access_granted_to_door"] }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details)." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type", "acs_entrance_id" ], "description": "Access requested as part of an Access Grant to a particular door was successfully granted.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": ["access_grant.access_to_door_lost"] }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details)." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type", "acs_entrance_id" ], "description": "Access to a particular door that was requested as part of an Access Grant was lost.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": ["access_grant.access_times_changed"] }, "access_grant_key": { "type": "string", "description": "Key of the affected Access Grant (if present)." }, "starts_at": { "type": "string", "description": "The new start time for the access grant." }, "ends_at": { "type": "string", "description": "The new end time for the access grant." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "description": "An Access Grant's start or end time was changed.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the affected Access Grant." }, "event_type": { "type": "string", "enum": [ "access_grant.could_not_create_requested_access_methods" ] }, "error_message": { "type": "string", "description": "Description of why the access methods could not be created." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type", "error_message" ], "description": "One or more requested access methods could not be created for an Access Grant.", "x-route-path": "/access_grants" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the affected access method." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants associated with this access method." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants associated with this access method (if present)." }, "event_type": { "type": "string", "enum": ["access_method.issued"] }, "code": { "type": "string", "description": "The actual PIN code for code access methods (only present when mode is 'code')." }, "is_backup_code": { "type": "boolean", "description": "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used)." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "description": "An access method was issued.", "x-route-path": "/access_methods" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the affected access method." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants associated with this access method." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants associated with this access method (if present)." }, "event_type": { "type": "string", "enum": ["access_method.revoked"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "description": "An access method was revoked.", "x-route-path": "/access_methods" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the affected access method." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants associated with this access method." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants associated with this access method (if present)." }, "event_type": { "type": "string", "enum": ["access_method.card_encoding_required"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "description": "An access method representing a physical card requires encoding.", "x-route-path": "/access_methods" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the affected access method." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants associated with this access method." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants associated with this access method (if present)." }, "event_type": { "type": "string", "enum": ["access_method.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "description": "An access method was deleted.", "x-route-path": "/access_methods" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the affected access method." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants associated with this access method." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants associated with this access method (if present)." }, "event_type": { "type": "string", "enum": ["access_method.reissued"] }, "code": { "type": "string", "description": "The actual PIN code for code access methods (only present when mode is 'code')." }, "is_backup_code": { "type": "boolean", "description": "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used)." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "description": "An access method was reissued.", "x-route-path": "/access_methods" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the affected access method." }, "access_grant_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access grants associated with this access method." }, "access_grant_keys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the access grants associated with this access method (if present)." }, "event_type": { "type": "string", "enum": ["access_method.created"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "description": "An access method was created.", "x-route-path": "/access_methods" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "event_type": { "type": "string", "enum": ["acs_system.connected"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "event_type" ], "description": "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.", "x-route-path": "/acs/systems" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "event_type": { "type": "string", "enum": ["acs_system.added"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "event_type" ], "description": "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was added.", "x-route-path": "/acs/systems" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "event_type": { "type": "string", "enum": ["acs_system.disconnected"] }, "acs_system_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the access control system." }, "acs_system_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the access control system." }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "event_type", "acs_system_errors", "acs_system_warnings", "connected_account_errors", "connected_account_warnings" ], "description": "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.", "x-route-path": "/acs/systems" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the affected credential." }, "event_type": { "type": "string", "enum": ["acs_credential.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "description": "An [access system credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.", "x-route-path": "/acs/credentials" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the affected credential." }, "event_type": { "type": "string", "enum": ["acs_credential.issued"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "description": "An [access system credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.", "x-route-path": "/acs/credentials" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the affected credential." }, "event_type": { "type": "string", "enum": ["acs_credential.reissued"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "description": "An [access system credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was reissued.", "x-route-path": "/acs/credentials" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the affected credential." }, "event_type": { "type": "string", "enum": ["acs_credential.invalidated"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "description": "An [access system credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore.", "x-route-path": "/acs/credentials" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_user_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": ["acs_user.created"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_user_id", "event_type" ], "description": "An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", "x-route-path": "/acs/users" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_user_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": ["acs_user.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_user_id", "event_type" ], "description": "An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.", "x-route-path": "/acs/users" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the affected encoder." }, "event_type": { "type": "string", "enum": ["acs_encoder.added"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_encoder_id", "event_type" ], "description": "An [access system encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.", "x-route-path": "/acs/encoders" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the affected encoder." }, "event_type": { "type": "string", "enum": ["acs_encoder.removed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_encoder_id", "event_type" ], "description": "An [access system encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.", "x-route-path": "/acs/encoders" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the affected access group." }, "event_type": { "type": "string", "enum": ["acs_access_group.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_access_group_id", "event_type" ], "description": "An ACS access group was deleted.", "x-route-path": "/acs/access_groups" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_entrance_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": ["acs_entrance.added"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_entrance_id", "event_type" ], "description": "An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.", "x-route-path": "/acs/entrances" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system." }, "acs_entrance_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": ["acs_entrance.removed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_entrance_id", "event_type" ], "description": "An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.", "x-route-path": "/acs/entrances" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "client_session_id": { "type": "string", "format": "uuid", "description": "ID of the affected client session." }, "event_type": { "type": "string", "enum": ["client_session.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "client_session_id", "event_type" ], "description": "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.", "x-route-path": "/client_sessions" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.connected"] }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with this connected account, if any." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.created"] }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connect_webview_id" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.successful_login"] }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connect_webview_id" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", "deprecated": true, "x-deprecated": "Use `connect_webview.login_succeeded`.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.disconnected"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.completed_first_sync"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.deleted"] }, "connected_account_type": { "type": "string", "description": "undocumented: Unreleased." }, "customer_key": { "type": "string", "description": "The customer key associated with this connected account, if any." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": [ "connected_account.completed_first_sync_after_reconnection" ] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["connected_account.reauthorization_requested"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings" ], "description": "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.", "x-route-path": "/connected_accounts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": ["action_attempt.lock_door.succeeded"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": ["action_attempt.lock_door.failed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": ["action_attempt.unlock_door.succeeded"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": ["action_attempt.unlock_door.failed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": ["action_attempt.simulate_keypad_code_entry.succeeded"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "A simulate keypad code entry [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": ["action_attempt.simulate_keypad_code_entry.failed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "A simulate keypad code entry [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": [ "action_attempt.simulate_manual_lock_via_keypad.succeeded" ] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "A simulate manual lock via keypad [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the affected action attempt." }, "action_type": { "type": "string", "description": "Type of the action." }, "status": { "type": "string", "description": "Status of the action." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device associated with the action attempt, if applicable." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with the action attempt, if applicable." }, "event_type": { "type": "string", "enum": [ "action_attempt.simulate_manual_lock_via_keypad.failed" ] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "description": "A simulate manual lock via keypad [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.", "x-route-path": "/action_attempts" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)." }, "event_type": { "type": "string", "enum": ["connect_webview.login_succeeded"] }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account; present when connected_account_id is provided." }, "customer_key": { "type": "string", "description": "The customer key associated with this connect webview, if any." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connect_webview_id", "event_type", "connected_account_id" ], "description": "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.", "x-route-path": "/connect_webviews" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "connect_webview_id": { "type": "string", "format": "uuid", "description": "ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)." }, "event_type": { "type": "string", "enum": ["connect_webview.login_failed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connect_webview_id", "event_type" ], "description": "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.", "x-route-path": "/connect_webviews" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.connected"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.added"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.converted_to_unmanaged"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.unmanaged.converted_to_managed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.", "x-route-path": "/devices/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.unmanaged.connected"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`.", "x-route-path": "/devices/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.disconnected"] }, "error_code": { "type": "string", "enum": [ "account_disconnected", "hub_disconnected", "device_disconnected" ], "description": "Error code associated with the disconnection event, if any." }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "error_code", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "description": "The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.unmanaged.disconnected"] }, "error_code": { "type": "string", "enum": [ "account_disconnected", "hub_disconnected", "device_disconnected" ], "description": "Error code associated with the disconnection event, if any." }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "error_code", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "description": "The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", "x-route-path": "/devices/unmanaged" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.tampered"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.low_battery"] }, "battery_level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "battery_level" ], "description": "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.battery_status_changed"] }, "battery_status": { "type": "string", "enum": ["critical", "low", "good", "full"], "description": "Battery status of the affected device, calculated from the numeric `battery_level` value." }, "battery_level": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "battery_status", "battery_level" ], "description": "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.removed"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A [device](https://docs.seam.co/latest/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.third_party_integration_detected"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is using a third-party integration that will interfere with Seam device management.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.third_party_integration_no_longer_detected"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.salto.privacy_mode_activated"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.salto.privacy_mode_deactivated"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.connection_became_flaky"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "description": "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.connection_stabilized"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.error.subscription_required"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "description": "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.error.subscription_required.resolved"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.accessory_keypad_connected"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.accessory_keypad_disconnected"] }, "connected_account_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the connected account." }, "connected_account_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the connected account." }, "device_errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] }, "description": "Errors associated with the device." }, "device_warnings": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"] }, "description": "Warnings associated with the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "description": "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["noise_sensor.noise_threshold_triggered"] }, "noise_level_decibels": { "type": "number", "format": "float", "description": "Detected noise level in decibels." }, "noise_level_nrs": { "type": "number", "format": "float", "description": "Detected noise level in Noiseaware Noise Risk Score (NRS)." }, "noise_threshold_id": { "type": "string", "format": "uuid", "description": "ID of the noise threshold that was triggered." }, "noise_threshold_name": { "type": "string", "description": "Name of the noise threshold that was triggered." }, "noiseaware_metadata": { "type": "object", "additionalProperties": {}, "description": "Metadata from Noiseaware." }, "minut_metadata": { "type": "object", "additionalProperties": {}, "description": "Metadata from Minut." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.", "x-route-path": "/noise_sensors/noise_thresholds" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["lock.locked"] }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that was used to lock the device." }, "access_code_is_managed": { "type": "boolean", "description": "Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt associated with the lock action." }, "method": { "type": "string", "enum": [ "keycode", "manual", "automatic", "unknown", "seamapi" ], "description": "Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "method" ], "description": "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.", "x-route-path": "/locks" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["lock.unlocked"] }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that was used to unlock the affected device." }, "access_code_is_managed": { "type": "boolean", "description": "Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set." }, "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt associated with the unlock action." }, "method": { "type": "string", "enum": [ "keycode", "manual", "automatic", "unknown", "seamapi" ], "description": "Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the unlock event.\n " }, "acs_system_id": { "type": "string", "format": "uuid", "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the unlock event.\n " }, "acs_user_id": { "type": "string", "format": "uuid", "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the unlock event.\n " }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the unlock event.\n " } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "method" ], "description": "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.", "x-route-path": "/locks" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["lock.access_denied"] }, "access_code_id": { "type": "string", "format": "uuid", "description": "ID of the access code that was used in the unlock attempts." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "The [lock](https://docs.seam.co/latest/capability-guides/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device.", "x-route-path": "/locks" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["thermostat.climate_preset_activated"] }, "thermostat_schedule_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the thermostat schedule that prompted the affected climate preset to be activated." }, "climate_preset_key": { "type": "string", "description": "Key of the climate preset that was activated." }, "is_fallback_climate_preset": { "type": "boolean", "description": "Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "thermostat_schedule_id", "climate_preset_key", "is_fallback_climate_preset" ], "description": "A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.", "x-route-path": "/thermostats" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["thermostat.manually_adjusted"] }, "method": { "type": "string", "enum": ["seam", "external"], "description": "Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat." }, "fan_mode_setting": { "type": "string", "enum": ["auto", "on", "circulate"], "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`." }, "hvac_mode_setting": { "type": "string", "enum": ["off", "heat", "cool", "heat_cool", "eco"], "description": "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`." }, "cooling_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_celsius": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "cooling_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." }, "heating_set_point_fahrenheit": { "type": "number", "format": "float", "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "method" ], "description": "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.", "x-route-path": "/thermostats" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["thermostat.temperature_threshold_exceeded"] }, "temperature_celsius": { "type": "number", "format": "float", "description": "Temperature, in °C, reported by the affected thermostat." }, "temperature_fahrenheit": { "type": "number", "format": "float", "description": "Temperature, in °F, reported by the affected thermostat." }, "upper_limit_celsius": { "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit, in °C, defined by the set threshold." }, "upper_limit_fahrenheit": { "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit, in °F, defined by the set threshold." }, "lower_limit_celsius": { "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit, in °C, defined by the set threshold." }, "lower_limit_fahrenheit": { "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit, in °F, defined by the set threshold." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit", "upper_limit_celsius", "upper_limit_fahrenheit", "lower_limit_celsius", "lower_limit_fahrenheit" ], "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", "x-route-path": "/thermostats" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["thermostat.temperature_threshold_no_longer_exceeded"] }, "temperature_celsius": { "type": "number", "format": "float", "description": "Temperature, in °C, reported by the affected thermostat." }, "temperature_fahrenheit": { "type": "number", "format": "float", "description": "Temperature, in °F, reported by the affected thermostat." }, "upper_limit_celsius": { "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit, in °C, defined by the set threshold." }, "upper_limit_fahrenheit": { "type": "number", "format": "float", "nullable": true, "description": "Upper temperature limit, in °F, defined by the set threshold." }, "lower_limit_celsius": { "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit, in °C, defined by the set threshold." }, "lower_limit_fahrenheit": { "type": "number", "format": "float", "nullable": true, "description": "Lower temperature limit, in °F, defined by the set threshold." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit", "upper_limit_celsius", "upper_limit_fahrenheit", "lower_limit_celsius", "lower_limit_fahrenheit" ], "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", "x-route-path": "/thermostats" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["thermostat.temperature_reached_set_point"] }, "temperature_celsius": { "type": "number", "format": "float", "description": "Temperature, in °C, reported by the affected thermostat." }, "temperature_fahrenheit": { "type": "number", "format": "float", "description": "Temperature, in °F, reported by the affected thermostat." }, "desired_temperature_celsius": { "type": "number", "format": "float", "description": "Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point." }, "desired_temperature_fahrenheit": { "type": "number", "format": "float", "description": "Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit" ], "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "x-route-path": "/thermostats" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["thermostat.temperature_changed"] }, "temperature_celsius": { "type": "number", "format": "float", "description": "Temperature, in °C, reported by the affected thermostat." }, "temperature_fahrenheit": { "type": "number", "format": "float", "description": "Temperature, in °F, reported by the affected thermostat." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit" ], "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 °C.", "x-route-path": "/thermostats" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.name_changed"] }, "device_name": { "type": "string", "description": "The new name of the affected device." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "device_name" ], "description": "The name of a [device](https://docs.seam.co/latest/core-concepts/devices) was changed.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["camera.activated"] }, "activation_reason": { "type": "string", "enum": ["motion_detected"], "description": "The reason the camera was activated." }, "motion_sub_type": { "type": "string", "enum": ["human", "vehicle", "package", "other"], "description": "Sub-type of motion detected, if available." }, "image_url": { "type": "string", "format": "uri", "description": "URL to a thumbnail image captured at the time of activation." }, "video_url": { "type": "string", "format": "uri", "description": "URL to a short video clip captured at the time of activation." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "activation_reason" ], "description": "A [camera](https://docs.seam.co/latest/core-concepts/devices) was activated, for example, by motion detection.", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected device." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event." }, "customer_key": { "type": "string", "description": "The customer key associated with the device, if any." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided." }, "connected_account_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided." }, "event_type": { "type": "string", "enum": ["device.doorbell_rang"] }, "image_url": { "type": "string", "format": "uri", "description": "URL to a thumbnail image captured at the time the doorbell was pressed." }, "video_url": { "type": "string", "format": "uri", "description": "URL to a short video clip captured at the time the doorbell was pressed." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "description": "A doorbell button was pressed on a [device](https://docs.seam.co/latest/core-concepts/devices).", "x-route-path": "/devices" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "enrollment_automation_id": { "type": "string", "format": "uuid", "description": "ID of the affected enrollment automation." }, "event_type": { "type": "string", "enum": ["enrollment_automation.deleted"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "enrollment_automation_id", "event_type" ], "description": "An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.", "x-route-path": "/user_identities/enrollment_automations" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the affected phone device." }, "device_custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device; present when device_id is provided." }, "event_type": { "type": "string", "enum": ["phone.deactivated"] } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "event_type" ], "description": "A phone device was deactivated.", "x-route-path": "/phones" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the affected space." }, "event_type": { "type": "string", "enum": ["space.device_membership_changed"], "description": "Type of the event." }, "space_key": { "type": "string", "description": "Unique key for the space within the workspace." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of all devices currently attached to the space." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of all ACS entrances currently attached to the space." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "space_id", "event_type", "device_ids", "acs_entrance_ids" ], "description": "A device was added or removed from a space.", "x-route-path": "/spaces" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the affected space." }, "event_type": { "type": "string", "enum": ["space.created"], "description": "Type of the event." }, "space_key": { "type": "string", "description": "Unique key for the space within the workspace." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of all devices attached to the space when it was created." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of all ACS entrances attached to the space when it was created." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "space_id", "event_type", "device_ids", "acs_entrance_ids" ], "description": "A space was created.", "x-route-path": "/spaces" }, { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid", "description": "ID of the event." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event was created." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Date and time at which the event occurred." }, "space_id": { "type": "string", "format": "uuid", "description": "ID of the affected space." }, "event_type": { "type": "string", "enum": ["space.deleted"], "description": "Type of the event." }, "space_key": { "type": "string", "description": "Unique key for the space within the workspace." }, "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of all devices attached to the space when it was deleted." }, "acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of all ACS entrances currently attached to the space when it was deleted." } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "space_id", "event_type", "device_ids", "acs_entrance_ids" ], "description": "A space was deleted.", "x-route-path": "/spaces" } ], "description": "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.", "x-route-path": "/events" }, "noise_threshold": { "type": "object", "properties": { "noise_threshold_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the noise threshold." }, "device_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the device that contains the noise threshold." }, "name": { "type": "string", "description": "Name of the noise threshold." }, "noise_threshold_nrs": { "type": "number", "format": "float", "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors)." }, "starts_daily_at": { "type": "string", "description": "Time at which the noise threshold should become active daily." }, "ends_daily_at": { "type": "string", "description": "Time at which the noise threshold should become inactive daily." }, "noise_threshold_decibels": { "type": "number", "format": "float", "description": "Noise level in decibels for the noise threshold." } }, "required": [ "noise_threshold_id", "device_id", "name", "starts_daily_at", "ends_daily_at", "noise_threshold_decibels" ], "description": "Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.", "x-route-path": "/noise_sensors/noise_thresholds" }, "webhook": { "type": "object", "properties": { "webhook_id": { "type": "string", "description": "ID of the [webhook](https://docs.seam.co/latest/developer-tools/webhooks)." }, "url": { "type": "string", "description": "URL for the [webhook](https://docs.seam.co/latest/developer-tools/webhooks)." }, "event_types": { "type": "array", "items": { "type": "string" }, "description": "Types of events that the [webhook](https://docs.seam.co/latest/developer-tools/webhooks) should receive." }, "secret": { "type": "string", "description": "Secret associated with the [webhook](https://docs.seam.co/latest/developer-tools/webhooks)." } }, "required": ["webhook_id", "url"], "description": "Represents a [webhook](https://docs.seam.co/latest/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.", "x-route-path": "/webhooks" }, "workspace": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces)." }, "name": { "type": "string", "description": "Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces)." }, "company_name": { "type": "string", "description": "Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces)." }, "is_sandbox": { "type": "boolean", "description": "Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces)." }, "connect_webview_customization": { "type": "object", "properties": { "primary_button_color": { "type": "string", "description": "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "primary_button_text_color": { "type": "string", "description": "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "success_message": { "type": "string", "description": "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "logo_shape": { "type": "string", "enum": ["circle", "square"], "description": "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." }, "inviter_logo_url": { "type": "string", "description": "URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews)." } } }, "is_suspended": { "type": "boolean", "description": "Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days." }, "connect_partner_name": { "type": "string", "nullable": true, "deprecated": true, "x-deprecated": "Use `company_name` instead." }, "publishable_key": { "type": "string", "description": "Publishable key for the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). This key is used to identify the workspace in client-side applications." }, "is_publishable_key_auth_enabled": { "type": "boolean", "description": "Indicates whether publishable key authentication is enabled for this workspace." } }, "required": [ "workspace_id", "name", "company_name", "is_sandbox", "connect_webview_customization", "is_suspended", "connect_partner_name", "is_publishable_key_auth_enabled" ], "description": "Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).", "x-route-path": "/workspaces" }, "acs_system": { "type": "object", "properties": { "default_credential_manager_acs_system_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "acs_user_count": { "type": "number", "format": "float" }, "acs_access_group_count": { "type": "number", "format": "float" }, "external_type": { "type": "string", "enum": [ "pti_site", "alta_org", "salto_ks_site", "salto_space_system", "brivo_account", "hid_credential_manager_organization", "visionline_system", "assa_abloy_credential_service", "latch_building", "dormakaba_community_site", "dormakaba_ambiance_site", "legic_connect_credential_service", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "hotek_site" ], "description": "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type." }, "is_credential_manager": { "type": "boolean", "description": "Indicates whether the `acs_system` is a credential manager." }, "visionline_metadata": { "type": "object", "properties": { "mobile_access_uuid": { "type": "string", "description": "Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset." }, "system_id": { "type": "string", "description": "Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager." }, "lan_address": { "type": "string", "description": "IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network." } }, "required": ["mobile_access_uuid", "system_id", "lan_address"] }, "system_type": { "type": "string", "enum": [ "pti_site", "alta_org", "salto_ks_site", "salto_space_system", "brivo_account", "hid_credential_manager_organization", "visionline_system", "assa_abloy_credential_service", "latch_building", "dormakaba_community_site", "dormakaba_ambiance_site", "legic_connect_credential_service", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "hotek_site" ], "deprecated": true, "x-deprecated": "Use `external_type`." }, "system_type_display_name": { "type": "string", "deprecated": true, "x-deprecated": "Use `external_type_display_name`." }, "location": { "type": "object", "properties": { "time_zone": { "type": "string", "nullable": true, "description": "Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located." } }, "required": ["time_zone"] }, "name": { "type": "string", "description": "Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "connected_account_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", "deprecated": true, "x-deprecated": "Use `connected_account_id`." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "image_url": { "type": "string", "description": "URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "image_alt_text": { "type": "string", "description": "Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["seam_bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["bridge_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_bridge_error": { "type": "boolean" } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["visionline_instance_unreachable"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["acs_system_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["account_disconnected"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["salto_ks_certification_expired"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access." } ], "description": "Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "description": "Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["salto_ks_subscription_limit_almost_reached"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["time_zone_does_not_match_location"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "misconfigured_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "this field is deprecated." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." } ], "description": "Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." }, "description": "Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)." } }, "required": [ "acs_system_id", "is_credential_manager", "location", "name", "created_at", "workspace_id", "connected_account_ids", "connected_account_id", "image_url", "image_alt_text", "errors", "warnings" ], "description": "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).", "x-route-path": "/acs/systems" }, "acs_access_group": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access control system that contains the access group." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group." }, "name": { "type": "string", "description": "Name of the access group." }, "access_group_type": { "type": "string", "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group" ], "deprecated": true, "x-deprecated": "Use `external_type`." }, "access_group_type_display_name": { "type": "string", "deprecated": true, "x-deprecated": "Use `external_type_display_name`." }, "display_name": { "type": "string" }, "external_type": { "type": "string", "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group" ], "description": "Brand-specific terminology for the access group type." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the access group type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access group was created." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_create_on_acs_system"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." } ], "description": "Error associated with the `acs_access_group`." }, "description": "Errors associated with the `acs_access_group`." }, "warnings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_access_group"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly." } ], "description": "Warning associated with the `acs_access_group`." }, "description": "Warnings associated with the `acs_access_group`." }, "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "nullable": true } }, "required": ["starts_at", "ends_at"], "description": "`starts_at` and `ends_at` timestamps for the access group's access." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["creating"], "description": "Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing an access group creation to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deleting"], "description": "Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing an access group deletion to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_deletion"], "description": "Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires." } }, "required": ["created_at", "message", "mutation_code"], "description": "This access group is scheduled for automatic deletion when its access window expires." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_group_information"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system." }, "from": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the access group." } }, "description": "Old access group information." }, "to": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the access group." } }, "description": "New access group information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access group information update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_schedule"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Ending time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "Old access schedule information." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Ending time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "New access schedule information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access schedule update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_user_membership"], "description": "Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system." }, "from": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Old user ID." } }, "required": ["acs_user_id"], "description": "Old user membership." }, "to": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "New user ID." } }, "required": ["acs_user_id"], "description": "New user membership." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing a user membership update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_entrance_membership"], "description": "Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system." }, "from": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Old entrance ID." } }, "required": ["acs_entrance_id"], "description": "Old entrance membership." }, "to": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "nullable": true, "description": "New entrance ID." } }, "required": ["acs_entrance_id"], "description": "New entrance membership." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an entrance membership update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_user_membership_update"], "description": "Mutation code to indicate that a scheduled user membership change is pending for this access group." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the user involved in the scheduled change." }, "variant": { "type": "string", "enum": ["adding", "removing"], "description": "Whether the user is scheduled to be added to or removed from this access group." } }, "required": [ "created_at", "message", "mutation_code", "acs_user_id", "variant" ], "description": "A scheduled user membership change is pending for this access group." } ] }, "description": "Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system." }, "is_managed": { "type": "boolean", "enum": [true] } }, "required": [ "acs_access_group_id", "acs_system_id", "workspace_id", "connected_account_id", "name", "access_group_type", "access_group_type_display_name", "display_name", "external_type", "external_type_display_name", "created_at", "errors", "warnings", "pending_mutations", "is_managed" ], "description": "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", "x-route-path": "/acs/access_groups" }, "unmanaged_acs_access_group": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access control system that contains the access group." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group." }, "name": { "type": "string", "description": "Name of the access group." }, "access_group_type": { "type": "string", "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group" ], "deprecated": true, "x-deprecated": "Use `external_type`." }, "access_group_type_display_name": { "type": "string", "deprecated": true, "x-deprecated": "Use `external_type_display_name`." }, "display_name": { "type": "string" }, "external_type": { "type": "string", "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group" ], "description": "Brand-specific terminology for the access group type." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the access group type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access group was created." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_create_on_acs_system"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." } ], "description": "Error associated with the `acs_access_group`." }, "description": "Errors associated with the `acs_access_group`." }, "warnings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_access_group"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly." } ], "description": "Warning associated with the `acs_access_group`." }, "description": "Warnings associated with the `acs_access_group`." }, "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "nullable": true } }, "required": ["starts_at", "ends_at"], "description": "`starts_at` and `ends_at` timestamps for the access group's access." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["creating"], "description": "Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing an access group creation to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deleting"], "description": "Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing an access group deletion to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_deletion"], "description": "Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires." } }, "required": ["created_at", "message", "mutation_code"], "description": "This access group is scheduled for automatic deletion when its access window expires." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_group_information"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system." }, "from": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the access group." } }, "description": "Old access group information." }, "to": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the access group." } }, "description": "New access group information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access group information update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_schedule"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Ending time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "Old access schedule information." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Ending time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "New access schedule information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access schedule update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_user_membership"], "description": "Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system." }, "from": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Old user ID." } }, "required": ["acs_user_id"], "description": "Old user membership." }, "to": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "New user ID." } }, "required": ["acs_user_id"], "description": "New user membership." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing a user membership update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_entrance_membership"], "description": "Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system." }, "from": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Old entrance ID." } }, "required": ["acs_entrance_id"], "description": "Old entrance membership." }, "to": { "type": "object", "properties": { "acs_entrance_id": { "type": "string", "format": "uuid", "nullable": true, "description": "New entrance ID." } }, "required": ["acs_entrance_id"], "description": "New entrance membership." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an entrance membership update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_user_membership_update"], "description": "Mutation code to indicate that a scheduled user membership change is pending for this access group." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the user involved in the scheduled change." }, "variant": { "type": "string", "enum": ["adding", "removing"], "description": "Whether the user is scheduled to be added to or removed from this access group." } }, "required": [ "created_at", "message", "mutation_code", "acs_user_id", "variant" ], "description": "A scheduled user membership change is pending for this access group." } ] }, "description": "Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system." }, "is_managed": { "type": "boolean", "enum": [false] } }, "required": [ "acs_access_group_id", "acs_system_id", "workspace_id", "connected_account_id", "name", "access_group_type", "access_group_type_display_name", "display_name", "external_type", "external_type_display_name", "created_at", "errors", "warnings", "pending_mutations", "is_managed" ], "x-route-path": "/acs/access_groups/unmanaged", "x-undocumented": "Unreleased." }, "acs_user": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "hid_acs_system_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created." }, "display_name": { "type": "string", "description": "Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "external_type": { "type": "string", "enum": [ "pti_user", "brivo_user", "hid_credential_manager_user", "salto_site_user", "latch_user", "dormakaba_community_user", "salto_space_user" ], "description": "Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type." }, "is_suspended": { "type": "boolean", "description": "Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users)." }, "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "nullable": true } }, "required": ["starts_at", "ends_at"], "description": "`starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access." }, "user_identity_id": { "type": "string", "description": "ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "user_identity_full_name": { "type": "string", "nullable": true, "description": "Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "user_identity_email_address": { "type": "string", "nullable": true, "description": "Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "user_identity_phone_number": { "type": "string", "nullable": true, "description": "Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"] } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the access system user will be deleted shortly." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["salto_ks_user_not_subscribed"] } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_user"] } }, "required": ["created_at", "message", "warning_code"], "description": "An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["latch_resident_user"] } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user." } ], "description": "Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "description": "Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["deleted_externally"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_create_on_acs_system"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_update_on_acs_system"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_delete_on_acs_system"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["latch_conflict_with_resident_user"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co)." } ], "description": "Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "description": "Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["creating"], "description": "Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing a user creation to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deleting"], "description": "Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing a user deletion to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_creation"], "description": "Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time." }, "scheduled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Optional: When the user creation is scheduled to occur." } }, "required": ["created_at", "message", "mutation_code"], "description": "User exists in Seam but has not been pushed to the provider yet. Will be created when a credential is issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_user_information"], "description": "Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system." }, "from": { "type": "object", "properties": { "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Email address of the access system user." }, "full_name": { "type": "string", "nullable": true, "description": "Full name of the access system user." }, "phone_number": { "type": "string", "nullable": true, "description": "Phone number of the access system user." } }, "description": "Old access system user information." }, "to": { "type": "object", "properties": { "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Email address of the access system user." }, "full_name": { "type": "string", "nullable": true, "description": "Full name of the access system user." }, "phone_number": { "type": "string", "nullable": true, "description": "Phone number of the access system user." } }, "description": "New access system user information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ] }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_schedule"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "Old access schedule information." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "New access schedule information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access schedule update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_suspension_state"], "description": "Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system." }, "from": { "type": "object", "properties": { "is_suspended": { "type": "boolean" } }, "required": ["is_suspended"], "description": "Old user suspension state information." }, "to": { "type": "object", "properties": { "is_suspended": { "type": "boolean" } }, "required": ["is_suspended"], "description": "New user suspension state information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing a suspension state update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_group_membership"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system." }, "from": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Old access group ID." } }, "required": ["acs_access_group_id"], "description": "Old access group membership." }, "to": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "nullable": true, "description": "New access group ID." } }, "required": ["acs_access_group_id"], "description": "New access group membership." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access group membership update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_group_membership_update"], "description": "Mutation code to indicate that a scheduled access group membership change is pending for this user." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group involved in the scheduled change." }, "variant": { "type": "string", "enum": ["adding", "removing"], "description": "Whether the user is scheduled to be added to or removed from the access group." } }, "required": [ "created_at", "message", "mutation_code", "acs_access_group_id", "variant" ], "description": "A scheduled access group membership change is pending for this user." } ] }, "description": "Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system." }, "last_successful_sync_at": { "type": "string", "format": "date-time", "nullable": true, "description": "The last time an internal sync job completed for this access system user.", "x-undocumented": "Only used internally." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "\n The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).\n " }, "salto_space_metadata": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User ID in the Salto Space access system." }, "audit_openings": { "type": "boolean", "description": "Indicates whether AuditOpenings is enabled for the user in the Salto Space access system." } }, "description": "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "full_name": { "type": "string", "minLength": 1, "description": "Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "email": { "type": "string", "format": "email", "deprecated": true, "x-deprecated": "use email_address." }, "email_address": { "type": "string", "format": "email", "description": "Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "phone_number": { "type": "string", "description": "Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "is_managed": { "type": "boolean", "enum": [true] } }, "required": [ "acs_user_id", "acs_system_id", "workspace_id", "created_at", "display_name", "warnings", "errors", "last_successful_sync_at", "connected_account_id", "is_managed" ], "description": "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", "x-route-path": "/acs/users" }, "unmanaged_acs_user": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "hid_acs_system_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created." }, "display_name": { "type": "string", "description": "Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "external_type": { "type": "string", "enum": [ "pti_user", "brivo_user", "hid_credential_manager_user", "salto_site_user", "latch_user", "dormakaba_community_user", "salto_space_user" ], "description": "Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type." }, "is_suspended": { "type": "boolean", "description": "Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users)." }, "access_schedule": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "nullable": true } }, "required": ["starts_at", "ends_at"], "description": "`starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access." }, "user_identity_id": { "type": "string", "description": "ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "user_identity_full_name": { "type": "string", "nullable": true, "description": "Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "user_identity_email_address": { "type": "string", "nullable": true, "description": "Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "user_identity_phone_number": { "type": "string", "nullable": true, "description": "Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"] } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the access system user will be deleted shortly." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["salto_ks_user_not_subscribed"] } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_user"] } }, "required": ["created_at", "message", "warning_code"], "description": "An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["latch_resident_user"] } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user." } ], "description": "Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "description": "Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["deleted_externally"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["salto_ks_subscription_limit_exceeded"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_create_on_acs_system"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_update_on_acs_system"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["failed_to_delete_on_acs_system"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co)." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["latch_conflict_with_resident_user"] } }, "required": ["created_at", "message", "error_code"], "description": "Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co)." } ], "description": "Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "description": "Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["creating"], "description": "Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing a user creation to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deleting"], "description": "Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system." } }, "required": ["created_at", "message", "mutation_code"], "description": "Seam is in the process of pushing a user deletion to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_creation"], "description": "Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time." }, "scheduled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Optional: When the user creation is scheduled to occur." } }, "required": ["created_at", "message", "mutation_code"], "description": "User exists in Seam but has not been pushed to the provider yet. Will be created when a credential is issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_user_information"], "description": "Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system." }, "from": { "type": "object", "properties": { "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Email address of the access system user." }, "full_name": { "type": "string", "nullable": true, "description": "Full name of the access system user." }, "phone_number": { "type": "string", "nullable": true, "description": "Phone number of the access system user." } }, "description": "Old access system user information." }, "to": { "type": "object", "properties": { "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Email address of the access system user." }, "full_name": { "type": "string", "nullable": true, "description": "Full name of the access system user." }, "phone_number": { "type": "string", "nullable": true, "description": "Phone number of the access system user." } }, "description": "New access system user information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ] }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_schedule"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "Old access schedule information." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Starting time for the access schedule." } }, "required": ["starts_at", "ends_at"], "description": "New access schedule information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access schedule update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_suspension_state"], "description": "Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system." }, "from": { "type": "object", "properties": { "is_suspended": { "type": "boolean" } }, "required": ["is_suspended"], "description": "Old user suspension state information." }, "to": { "type": "object", "properties": { "is_suspended": { "type": "boolean" } }, "required": ["is_suspended"], "description": "New user suspension state information." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing a suspension state update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_group_membership"], "description": "Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system." }, "from": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Old access group ID." } }, "required": ["acs_access_group_id"], "description": "Old access group membership." }, "to": { "type": "object", "properties": { "acs_access_group_id": { "type": "string", "format": "uuid", "nullable": true, "description": "New access group ID." } }, "required": ["acs_access_group_id"], "description": "New access group membership." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of pushing an access group membership update to the integrated access system." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["deferring_group_membership_update"], "description": "Mutation code to indicate that a scheduled access group membership change is pending for this user." }, "acs_access_group_id": { "type": "string", "format": "uuid", "description": "ID of the access group involved in the scheduled change." }, "variant": { "type": "string", "enum": ["adding", "removing"], "description": "Whether the user is scheduled to be added to or removed from the access group." } }, "required": [ "created_at", "message", "mutation_code", "acs_access_group_id", "variant" ], "description": "A scheduled access group membership change is pending for this user." } ] }, "description": "Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system." }, "last_successful_sync_at": { "type": "string", "format": "date-time", "nullable": true, "description": "The last time an internal sync job completed for this access system user.", "x-undocumented": "Only used internally." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "\n The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).\n " }, "salto_space_metadata": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User ID in the Salto Space access system." }, "audit_openings": { "type": "boolean", "description": "Indicates whether AuditOpenings is enabled for the user in the Salto Space access system." } }, "description": "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "full_name": { "type": "string", "minLength": 1, "description": "Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "email": { "type": "string", "format": "email", "deprecated": true, "x-deprecated": "use email_address." }, "email_address": { "type": "string", "format": "email", "description": "Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)." }, "phone_number": { "type": "string", "description": "Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)." }, "is_managed": { "type": "boolean", "enum": [false] } }, "required": [ "acs_user_id", "acs_system_id", "workspace_id", "created_at", "display_name", "warnings", "errors", "last_successful_sync_at", "connected_account_id", "is_managed" ], "description": "Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).", "x-route-path": "/acs/users/unmanaged", "x-undocumented": "Unreleased." }, "acs_entrance": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces that the entrance is in." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created." }, "display_name": { "type": "string", "description": "Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "latch_metadata": { "type": "object", "properties": { "accessibility_type": { "type": "string", "description": "Accessibility type in the Latch access system." }, "door_name": { "type": "string", "description": "Name of the door in the Latch access system." }, "door_type": { "type": "string", "description": "Type of the door in the Latch access system." }, "is_connected": { "type": "boolean", "description": "Indicates whether the entrance is connected." } }, "required": [ "accessibility_type", "door_name", "door_type", "is_connected" ], "description": "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "hotek_metadata": { "type": "object", "properties": { "room_number": { "type": "string", "description": "Room number of the entrance." }, "common_area_number": { "type": "string", "description": "Display name of the entrance." }, "common_area_name": { "type": "string", "description": "Display name of the entrance." } }, "description": "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "visionline_metadata": { "type": "object", "properties": { "door_name": { "type": "string", "description": "Name of the door in the Visionline access system." }, "door_category": { "type": "string", "enum": [ "entrance", "guest", "elevator reader", "common", "common (PMS)" ], "description": "Category of the door in the Visionline access system." }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "visionline_door_profile_id": { "type": "string", "description": "Door profile ID in the Visionline access system." }, "visionline_door_profile_type": { "type": "string", "enum": ["BLE", "commonDoor", "touch"], "description": "Door profile type in the Visionline access system." } }, "required": [ "visionline_door_profile_id", "visionline_door_profile_type" ] }, "description": "Profile for the door in the Visionline access system." } }, "required": ["door_name", "door_category"], "description": "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "salto_ks_metadata": { "type": "object", "properties": { "door_name": { "type": "string", "description": "Name of the door in the Salto KS access system." }, "locked_state": { "type": "string", "description": "Locked state of the door in the Salto KS access system." }, "lock_type": { "type": "string", "description": "Type of the lock in the Salto KS access system." }, "online": { "type": "boolean", "description": "Indicates whether the door access device is online." }, "battery_level": { "type": "string", "description": "Battery level of the door access device." }, "left_open_alarm": { "type": "boolean", "description": "Indicates whether the door is left open." }, "intrusion_alarm": { "type": "boolean", "description": "Indicates whether an intrusion alarm is active on the door." }, "privacy_mode": { "type": "boolean", "description": "Indicates whether privacy mode is enabled for the lock." } }, "required": [ "door_name", "locked_state", "lock_type", "battery_level" ], "description": "Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "dormakaba_community_metadata": { "type": "object", "properties": { "access_point_profile": { "type": "string", "description": "Type of access point profile in the dormakaba Community access system." } }, "required": ["access_point_profile"], "description": "dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "door_type": { "type": "string", "enum": ["CommonDoor", "EntranceDoor", "GuestDoor", "Elevator"], "description": "Type of the door in the Vostio access system." }, "door_name": { "type": "string", "description": "Name of the door in the Vostio access system." }, "door_number": { "type": "number", "format": "float", "description": "Number of the door in the Vostio access system." }, "stand_open": { "type": "boolean", "description": "Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system." }, "pms_id": { "type": "string", "description": "PMS ID of the door in the Vostio access system." } }, "required": ["door_type", "door_name"], "description": "ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "salto_space_metadata": { "type": "object", "properties": { "door_id": { "type": "string", "description": "Door ID in the Salto Space access system." }, "door_name": { "type": "string", "description": "Name of the door in the Salto Space access system." }, "door_description": { "type": "string", "description": "Description of the door in the Salto Space access system." }, "audit_on_keys": { "type": "boolean", "description": "Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system." }, "room_name": { "type": "string", "description": "Name of the room in the Salto Space access system." }, "room_description": { "type": "string", "description": "Description of the room in the Salto Space access system." } }, "description": "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "dormakaba_ambiance_metadata": { "type": "object", "properties": { "access_point_name": { "type": "string", "description": "Name of the access point in the dormakaba Ambiance access system." } }, "required": ["access_point_name"], "description": "dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "brivo_metadata": { "type": "object", "properties": { "access_point_id": { "type": "string", "description": "ID of the access point in the Brivo access system." }, "site_id": { "type": "number", "format": "float", "description": "ID of the site that the access point belongs to." }, "site_name": { "type": "string", "description": "Name of the site that the access point belongs to." } }, "required": ["access_point_id", "site_id", "site_name"], "description": "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "can_unlock_with_mobile_key": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with mobile key credentials." }, "can_unlock_with_card": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with card credentials." }, "can_unlock_with_code": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with pin codes." }, "can_unlock_with_cloud_key": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with cloud key credentials." }, "can_belong_to_reservation": { "type": "boolean", "description": "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key." } }, "required": [ "acs_system_id", "acs_entrance_id", "space_ids", "created_at", "display_name", "connected_account_id", "errors" ], "description": "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.", "x-route-path": "/acs/entrances" }, "acs_credential_provisioning_automation": { "type": "object", "properties": { "acs_credential_provisioning_automation_id": { "type": "string", "format": "uuid" }, "credential_manager_acs_system_id": { "type": "string", "format": "uuid" }, "user_identity_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "workspace_id": { "type": "string", "format": "uuid" } }, "required": [ "acs_credential_provisioning_automation_id", "credential_manager_acs_system_id", "user_identity_id", "created_at", "workspace_id" ], "deprecated": true, "x-route-path": "/acs/credential_provisioning_automations", "x-deprecated": "Not used.", "x-undocumented": "Deprecated. Will be removed." }, "acs_credential_pool": { "type": "object", "properties": { "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid" }, "display_name": { "type": "string", "minLength": 1 }, "external_type": { "type": "string", "enum": ["hid_part_number"] }, "external_type_display_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "workspace_id": { "type": "string", "format": "uuid" } }, "required": [ "acs_credential_pool_id", "acs_system_id", "display_name", "external_type", "external_type_display_name", "created_at", "workspace_id" ], "deprecated": true, "x-route-path": "/acs/credential_pools", "x-deprecated": "Not used.", "x-undocumented": "Deprecated. Will be removed." }, "acs_credential": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_credential"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [true] } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "description": "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.", "x-route-path": "/acs/credentials" }, "unmanaged_acs_credential": { "type": "object", "properties": { "acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_credential"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [false] } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "description": "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.", "x-route-path": "/acs/credentials/unmanaged", "x-undocumented": "Unreleased." }, "acs_encoder": { "type": "object", "properties": { "acs_encoder_id": { "type": "string", "format": "uuid", "description": "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["acs_encoder_removed"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"], "description": "Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)." }, "description": "Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created." }, "display_name": { "type": "string", "description": "Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)." } }, "required": [ "acs_encoder_id", "acs_system_id", "connected_account_id", "workspace_id", "errors", "created_at", "display_name" ], "description": "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", "x-route-path": "/acs/encoders" }, "enrollment_automation": { "type": "object", "properties": { "enrollment_automation_id": { "type": "string", "format": "uuid", "description": "ID of the enrollment automation." }, "credential_manager_acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity)." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the enrollment automation was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation." } }, "required": [ "enrollment_automation_id", "credential_manager_acs_system_id", "user_identity_id", "created_at", "workspace_id" ], "description": "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).", "x-route-path": "/user_identities/enrollment_automations", "x-undocumented": "Will be removed." }, "phone": { "type": "object", "properties": { "device_id": { "type": "string", "format": "uuid", "description": "ID of the phone.\n " }, "nickname": { "type": "string", "description": "Optional nickname to describe the phone, settable through Seam.\n " }, "display_name": { "type": "string", "description": "Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.\n " }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the phone.\n " }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the phone was created.\n " }, "custom_metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.\n " }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the phone." }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "warning_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["warning_code", "message"] }, "description": "Warnings associated with the phone." }, "device_type": { "type": "string", "enum": ["ios_phone", "android_phone"], "description": "Device type for phones.\n " }, "properties": { "type": "object", "properties": { "assa_abloy_credential_service_metadata": { "type": "object", "properties": { "has_active_endpoint": { "type": "boolean", "description": "Indicates whether the credential service has active endpoints associated with the phone." }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "endpoint_id": { "type": "string", "description": "ID of the associated endpoint." }, "is_active": { "type": "boolean", "description": "Indicated whether the endpoint is active." } }, "required": ["endpoint_id", "is_active"] }, "description": "Endpoints associated with the phone." } }, "required": ["has_active_endpoint", "endpoints"], "description": "ASSA ABLOY Credential Service metadata for the phone." }, "salto_space_credential_service_metadata": { "type": "object", "properties": { "has_active_phone": { "type": "boolean", "description": "Indicates whether the credential service has an active associated phone." } }, "required": ["has_active_phone"], "description": "Salto Space credential service metadata for the phone." } }, "description": "\n Properties of the phone.\n " } }, "required": [ "device_id", "display_name", "workspace_id", "created_at", "custom_metadata", "errors", "warnings", "device_type", "properties" ], "description": "Represents an app user's mobile phone.", "x-route-path": "/phones", "x-property-groups": { "phones": { "name": "Phones" } } }, "user_identity": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity." }, "user_identity_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Unique key for the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "display_name": { "type": "string", "minLength": 1 }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user identity was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["issue_with_acs_user"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that has an issue." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that the user identity is associated with." } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "description": "Indicates that there is an issue with an access system user associated with this user identity." } ], "description": "Errors associated with the user identity." }, "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the user identity is currently being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["acs_user_profile_does_not_match_user_identity"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the ACS user's profile does not match the user identity's profile" } ], "description": "Warnings associated with the user identity." }, "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it." }, "acs_user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access system user IDs associated with the user identity." } }, "required": [ "user_identity_id", "user_identity_key", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "description": "Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.", "x-route-path": "/user_identities" }, "pagination": { "type": "object", "properties": { "next_page_cursor": { "type": "string", "nullable": true, "description": "Opaque value that can be used to select the next page of results via the `page_cursor` parameter." }, "has_next_page": { "type": "boolean", "description": "Indicates whether there is another page of results after this one." }, "next_page_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL to get the next page of results." } }, "required": ["next_page_cursor", "has_next_page", "next_page_url"], "description": "Information about the current page of results." }, "instant_key": { "type": "object", "properties": { "instant_key_id": { "type": "string", "format": "uuid", "description": "ID of the Instant Key." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Instant Key was created." }, "instant_key_url": { "type": "string", "format": "uri", "description": "Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app." }, "client_session_id": { "type": "string", "format": "uuid", "description": "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity associated with the Instant Key." }, "expires_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Instant Key expires." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "ID of the customization profile associated with the Instant Key." }, "customization": { "type": "object", "properties": { "primary_color": { "type": "string", "description": "Primary color used in the Instant Key UI." }, "secondary_color": { "type": "string", "description": "Secondary color used in the Instant Key UI." }, "logo_url": { "type": "string", "format": "uri", "description": "URL of the logo displayed on the Instant Key." } }, "description": "Customization applied to the Instant Key UI." } }, "required": [ "instant_key_id", "workspace_id", "created_at", "instant_key_url", "client_session_id", "user_identity_id", "expires_at" ], "description": "Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.\n\nThere’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.", "x-route-path": "/instant_keys" }, "phone_registration": { "type": "object", "properties": { "phone_registration_id": { "type": "string", "description": "Registration ID for the phone." }, "provider_state": { "description": "Provider state for the phone." }, "provider_name": { "type": "string", "nullable": true, "description": "Provider name for the phone." }, "is_being_activated": { "type": "boolean", "description": "Indicates whether the phone is being activated." } }, "required": [ "phone_registration_id", "provider_name", "is_being_activated" ], "description": "Represents a mobile phone registration.", "x-route-path": "/seam/mobile_sdk/v1/phone_sessions", "x-undocumented": "Seam Mobile SDK only." }, "phone_session": { "type": "object", "properties": { "provider_sessions": { "type": "array", "items": { "type": "object", "properties": { "phone_registration": { "type": "object", "properties": { "phone_registration_id": { "type": "string", "description": "Registration ID for the phone." }, "provider_state": { "description": "Provider state for the phone." }, "provider_name": { "type": "string", "nullable": true, "description": "Provider name for the phone." }, "is_being_activated": { "type": "boolean", "description": "Indicates whether the phone is being activated." } }, "required": [ "phone_registration_id", "provider_name", "is_being_activated" ], "description": "Represents a mobile phone registration.", "x-route-path": "/seam/mobile_sdk/v1/phone_sessions", "x-undocumented": "Seam Mobile SDK only." }, "acs_credentials": { "type": "array", "items": { "type": "object", "properties": { "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs." }, "acs_credential_pool_id": { "type": "string", "format": "uuid" }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "parent_acs_credential_id": { "type": "string", "format": "uuid", "description": "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "display_name": { "type": "string", "minLength": 1, "description": "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "code": { "type": "string", "nullable": true, "description": "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_one_time_use": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use." }, "card_number": { "type": "string", "nullable": true, "description": "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_issued": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card." }, "access_method": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "external_type": { "type": "string", "enum": [ "pti_card", "brivo_credential", "brivo_digital_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card" ], "description": "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`." }, "external_type_display_name": { "type": "string", "description": "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "starts_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "ends_at": { "type": "string", "description": "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["waiting_to_be_issued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_externally_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["schedule_modified"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["unknown_issue_with_acs_credential"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["needs_to_be_reissued"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": [ "created_at", "message", "warning_code" ], "description": "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential." } ], "description": "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "description": "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_multi_phone_sync_credential": { "type": "boolean", "description": "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)." }, "is_latest_desired_state_synced_with_provider": { "type": "boolean", "nullable": true, "description": "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider." }, "latest_desired_state_synced_with_provider_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider." }, "visionline_metadata": { "type": "object", "properties": { "card_function_type": { "type": "string", "enum": ["guest", "staff"], "description": "Card function type in the Visionline access system." }, "joiner_acs_credential_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the credentials to which you want to join." }, "guest_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Guest entrance IDs in the Visionline access system." }, "common_acs_entrance_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Common entrance IDs in the Visionline access system." }, "is_valid": { "type": "boolean", "description": "Indicates whether the credential is valid." }, "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "card_id": { "type": "string", "description": "ID of the card in the Visionline access system." }, "credential_id": { "type": "string", "description": "ID of the credential in the Visionline access system." } }, "required": ["card_function_type"], "description": "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "auto_join": { "type": "boolean", "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors." }, "override_guest_acs_entrance_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs of the guest entrances to override in the Vostio access system." }, "key_id": { "type": "string", "description": "Key ID in the Vostio access system." }, "key_issuing_request_id": { "type": "string", "description": "Key issuing request ID in the Vostio access system." }, "door_names": { "type": "array", "items": { "type": "string" }, "description": "Names of the doors to which to grant access in the Vostio access system." }, "endpoint_id": { "type": "string", "description": "Endpoint ID in the Vostio access system." } }, "description": "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)." }, "is_managed": { "type": "boolean", "enum": [true] }, "acs_credential_id": { "type": "string", "nullable": true }, "acs_entrances": { "type": "array", "items": { "type": "object", "properties": { "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "acs_entrance_id": { "type": "string", "format": "uuid", "description": "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces that the entrance is in." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created." }, "display_name": { "type": "string", "description": "Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." } }, "required": ["error_code", "message"] }, "description": "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "latch_metadata": { "type": "object", "properties": { "accessibility_type": { "type": "string", "description": "Accessibility type in the Latch access system." }, "door_name": { "type": "string", "description": "Name of the door in the Latch access system." }, "door_type": { "type": "string", "description": "Type of the door in the Latch access system." }, "is_connected": { "type": "boolean", "description": "Indicates whether the entrance is connected." } }, "required": [ "accessibility_type", "door_name", "door_type", "is_connected" ], "description": "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "hotek_metadata": { "type": "object", "properties": { "room_number": { "type": "string", "description": "Room number of the entrance." }, "common_area_number": { "type": "string", "description": "Display name of the entrance." }, "common_area_name": { "type": "string", "description": "Display name of the entrance." } }, "description": "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "visionline_metadata": { "type": "object", "properties": { "door_name": { "type": "string", "description": "Name of the door in the Visionline access system." }, "door_category": { "type": "string", "enum": [ "entrance", "guest", "elevator reader", "common", "common (PMS)" ], "description": "Category of the door in the Visionline access system." }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "visionline_door_profile_id": { "type": "string", "description": "Door profile ID in the Visionline access system." }, "visionline_door_profile_type": { "type": "string", "enum": ["BLE", "commonDoor", "touch"], "description": "Door profile type in the Visionline access system." } }, "required": [ "visionline_door_profile_id", "visionline_door_profile_type" ] }, "description": "Profile for the door in the Visionline access system." } }, "required": ["door_name", "door_category"], "description": "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "salto_ks_metadata": { "type": "object", "properties": { "door_name": { "type": "string", "description": "Name of the door in the Salto KS access system." }, "locked_state": { "type": "string", "description": "Locked state of the door in the Salto KS access system." }, "lock_type": { "type": "string", "description": "Type of the lock in the Salto KS access system." }, "online": { "type": "boolean", "description": "Indicates whether the door access device is online." }, "battery_level": { "type": "string", "description": "Battery level of the door access device." }, "left_open_alarm": { "type": "boolean", "description": "Indicates whether the door is left open." }, "intrusion_alarm": { "type": "boolean", "description": "Indicates whether an intrusion alarm is active on the door." }, "privacy_mode": { "type": "boolean", "description": "Indicates whether privacy mode is enabled for the lock." } }, "required": [ "door_name", "locked_state", "lock_type", "battery_level" ], "description": "Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "dormakaba_community_metadata": { "type": "object", "properties": { "access_point_profile": { "type": "string", "description": "Type of access point profile in the dormakaba Community access system." } }, "required": ["access_point_profile"], "description": "dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "assa_abloy_vostio_metadata": { "type": "object", "properties": { "door_type": { "type": "string", "enum": [ "CommonDoor", "EntranceDoor", "GuestDoor", "Elevator" ], "description": "Type of the door in the Vostio access system." }, "door_name": { "type": "string", "description": "Name of the door in the Vostio access system." }, "door_number": { "type": "number", "format": "float", "description": "Number of the door in the Vostio access system." }, "stand_open": { "type": "boolean", "description": "Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system." }, "pms_id": { "type": "string", "description": "PMS ID of the door in the Vostio access system." } }, "required": ["door_type", "door_name"], "description": "ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "salto_space_metadata": { "type": "object", "properties": { "door_id": { "type": "string", "description": "Door ID in the Salto Space access system." }, "door_name": { "type": "string", "description": "Name of the door in the Salto Space access system." }, "door_description": { "type": "string", "description": "Description of the door in the Salto Space access system." }, "audit_on_keys": { "type": "boolean", "description": "Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system." }, "room_name": { "type": "string", "description": "Name of the room in the Salto Space access system." }, "room_description": { "type": "string", "description": "Description of the room in the Salto Space access system." } }, "description": "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "dormakaba_ambiance_metadata": { "type": "object", "properties": { "access_point_name": { "type": "string", "description": "Name of the access point in the dormakaba Ambiance access system." } }, "required": ["access_point_name"], "description": "dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "brivo_metadata": { "type": "object", "properties": { "access_point_id": { "type": "string", "description": "ID of the access point in the Brivo access system." }, "site_id": { "type": "number", "format": "float", "description": "ID of the site that the access point belongs to." }, "site_name": { "type": "string", "description": "Name of the site that the access point belongs to." } }, "required": [ "access_point_id", "site_id", "site_name" ], "description": "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)." }, "can_unlock_with_mobile_key": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with mobile key credentials." }, "can_unlock_with_card": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with card credentials." }, "can_unlock_with_code": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with pin codes." }, "can_unlock_with_cloud_key": { "type": "boolean", "description": "Indicates whether the ACS entrance can be unlocked with cloud key credentials." }, "can_belong_to_reservation": { "type": "boolean", "description": "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key." } }, "required": [ "acs_system_id", "acs_entrance_id", "space_ids", "created_at", "display_name", "connected_account_id", "errors" ], "description": "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.", "x-route-path": "/acs/entrances" } } }, "required": [ "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed", "acs_credential_id", "acs_entrances" ], "description": "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.", "x-route-path": "/acs/credentials" }, "description": "Access system credentials associated with the phone provider session." } }, "required": ["phone_registration", "acs_credentials"], "description": "Phone provider session." }, "description": "Phone provider sessions." }, "user_identity": { "type": "object", "properties": { "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of the user identity." }, "user_identity_key": { "type": "string", "minLength": 1, "nullable": true, "description": "Unique key for the user identity." }, "email_address": { "type": "string", "format": "email", "nullable": true, "description": "Unique email address for the user identity." }, "phone_number": { "type": "string", "nullable": true, "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)." }, "display_name": { "type": "string", "minLength": 1 }, "full_name": { "type": "string", "minLength": 1, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the user identity was created." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["issue_with_acs_user"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "acs_user_id": { "type": "string", "format": "uuid", "description": "ID of the access system user that has an issue." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the access system that the user identity is associated with." } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "description": "Indicates that there is an issue with an access system user associated with this user identity." } ], "description": "Errors associated with the user identity." }, "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the user identity is currently being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the ACS user's profile does not match the user identity's profile" } ], "description": "Warnings associated with the user identity." }, "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it." }, "acs_user_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of access system user IDs associated with the user identity." } }, "required": [ "user_identity_id", "user_identity_key", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "description": "User identity." }, "workspace_id": { "type": "string", "description": "Workspace ID." }, "is_sandbox_workspace": { "type": "boolean", "description": "Whether the workspace is in sandbox mode." } }, "required": [ "provider_sessions", "user_identity", "workspace_id", "is_sandbox_workspace" ], "description": "Represents a mobile phone session.", "x-route-path": "/seam/mobile_sdk/v1/phone_sessions", "x-undocumented": "Seam Mobile SDK only." }, "magic_link": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "URL for the magic link." }, "customer_key": { "type": "string", "description": "Customer key for the magic link." }, "expires_at": { "type": "string", "format": "date-time", "description": "Date and time at which the magic link expires." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the magic link was created." } }, "required": [ "url", "customer_key", "expires_at", "workspace_id", "created_at" ], "description": "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.", "x-undocumented": "Unreleased.", "x-route-path": "/unstable_partner/building_blocks" }, "space": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid", "description": "ID of the space." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space." }, "space_key": { "type": "string", "description": "Unique key for the space within the workspace." }, "name": { "type": "string", "description": "Name of the space." }, "display_name": { "type": "string", "description": "Display name for the space." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the space was created." }, "device_count": { "type": "number", "format": "float", "description": "Number of devices in the space." }, "acs_entrance_count": { "type": "number", "format": "float", "description": "Number of entrances in the space." }, "customer_key": { "type": "string", "description": "Customer key associated with the space." }, "parent_space_id": { "type": "string", "format": "uuid", "x-undocumented": "Only used internally." }, "parent_space_key": { "type": "string", "x-undocumented": "Only used internally." } }, "required": [ "space_id", "workspace_id", "name", "display_name", "created_at", "device_count", "acs_entrance_count" ], "description": "Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.", "x-draft": "Early access.", "x-route-path": "/spaces" }, "staff_member": { "type": "object", "properties": { "name": { "type": "string", "description": "Your display name for this user identity resource." }, "email_address": { "type": "string", "description": "Email address associated with the user identity." }, "phone_number": { "type": "string", "description": "Phone number associated with the user identity." }, "staff_member_key": { "type": "string", "description": "Your unique identifier for the staff." }, "space_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the spaces the staff member is associated with." }, "property_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the properties the staff member is associated with." }, "room_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the rooms the staff member is associated with." }, "common_area_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the common areas the staff member is associated with." }, "unit_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the units the staff member is associated with." }, "facility_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the facilities the staff member is associated with." }, "building_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the buildings the staff member is associated with." }, "listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the listings the staff member is associated with." }, "property_listing_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the property listings the staff member is associated with." }, "site_keys": { "type": "array", "items": { "type": "string" }, "description": "List of unique identifiers for the sites the staff member is associated with." } }, "required": ["name", "staff_member_key"], "description": "Represents a staff member for a specific customer.", "x-route-path": "/seam/customer/v1/staff_members", "x-undocumented": "Internal resource for customer portals." }, "access_grant": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the Access Grant." }, "access_grant_id": { "type": "string", "format": "uuid", "description": "ID of the Access Grant." }, "access_grant_key": { "type": "string", "description": "Unique key for the access grant within the workspace." }, "reservation_key": { "type": "string", "description": "Reservation key for the access grant." }, "user_identity_id": { "type": "string", "format": "uuid", "description": "ID of user identity to which the Access Grant gives access." }, "location_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "deprecated": true, "x-deprecated": "Use `space_ids`." }, "space_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the spaces to which the Access Grant gives access." }, "requested_access_methods": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "code": { "type": "string", "minLength": 4, "maxLength": 9, "pattern": "^\\d+$", "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'." }, "instant_key_max_use_count": { "type": "integer", "minimum": 1, "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the requested access method was added to the Access Grant." }, "created_access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the requested access method." } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ] }, "description": "Access methods that the user requested for the Access Grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods created for the Access Grant." }, "client_session_token": { "type": "string", "description": "Client Session Token. Only returned if the Access Grant has a mobile_key access method." }, "name": { "type": "string", "nullable": true, "description": "Name of the Access Grant. If not provided, the display name will be computed." }, "display_name": { "type": "string", "description": "Display name of the Access Grant." }, "instant_key_url": { "type": "string", "format": "uri", "description": "Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. " }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant was created." }, "starts_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Access Grant starts." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the Access Grant ends." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["underprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["overprovisioned_access"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "description": "Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["requested_code_unavailable"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device where the requested code was unavailable." }, "original_code": { "type": "string", "description": "The originally requested PIN code that was unavailable." }, "new_code": { "type": "string", "description": "The new PIN code that was assigned instead." } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["device_does_not_support_access_codes"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the device that does not support access codes." } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization." } ], "description": "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "description": "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "error_code": { "type": "string", "enum": ["cannot_create_requested_access_methods"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "error_code"] } ] }, "description": "Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "ID of the customization profile associated with the Access Grant." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_spaces"], "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access codes existed." } }, "required": ["device_ids"], "description": "Previous location configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access codes should be created." }, "common_code_key": { "type": "string", "nullable": true, "description": "Common code key to ensure PIN code reuse across devices." } }, "required": ["device_ids"], "description": "New location configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the devices/spaces associated with this access grant." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant." }, "access_method_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the access methods being updated." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "description": "Seam is in the process of updating the access times for this access grant." } ] }, "description": "List of pending mutations for the access grant. This shows updates that are in progress." } }, "required": [ "workspace_id", "access_grant_id", "user_identity_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "description": "Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.", "x-draft": "Early access.", "x-route-path": "/access_grants" }, "access_method": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the Seam workspace associated with the access method." }, "access_method_id": { "type": "string", "format": "uuid", "description": "ID of the access method." }, "display_name": { "type": "string", "description": "Display name of the access method." }, "mode": { "type": "string", "enum": ["code", "card", "mobile_key", "cloud_key"], "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the access method was created." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the access method was issued." }, "is_issued": { "type": "boolean", "description": "Indicates whether the access method has been issued." }, "instant_key_url": { "type": "string", "format": "uri", "description": "URL of the Instant Key for mobile key access methods." }, "client_session_token": { "type": "string", "description": "Token of the client session associated with the access method." }, "is_encoding_required": { "type": "boolean", "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method." }, "is_ready_for_encoding": { "type": "boolean", "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued." }, "code": { "type": "string", "nullable": true, "description": "The actual PIN code for code access methods." }, "warnings": { "type": "array", "items": { "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["being_deleted"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["updating_access_times"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the warning." }, "message": { "type": "string", "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it." }, "warning_code": { "type": "string", "enum": ["pulled_backup_access_code"], "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue." }, "original_access_method_id": { "type": "string", "format": "uuid", "description": "ID of the original access method from which this backup access method was split, if applicable." } }, "required": ["created_at", "message", "warning_code"], "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time." } ], "description": "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "description": "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)." }, "pending_mutations": { "type": "array", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["provisioning_access"], "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access was provisioned." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access is being provisioned." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of provisioning access for this access method on new devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["revoking_access"], "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices." }, "from": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Previous device IDs where access existed." } }, "required": ["device_ids"], "description": "Previous device configuration." }, "to": { "type": "object", "properties": { "device_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "New device IDs where access should remain." } }, "required": ["device_ids"], "description": "New device configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of revoking access for this access method from devices." }, { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the mutation was created." }, "message": { "type": "string", "description": "Detailed description of the mutation." }, "mutation_code": { "type": "string", "enum": ["updating_access_times"], "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method." }, "from": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Previous end time for access." } }, "required": ["starts_at", "ends_at"], "description": "Previous access time configuration." }, "to": { "type": "object", "properties": { "starts_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New start time for access." }, "ends_at": { "type": "string", "format": "date-time", "nullable": true, "description": "New end time for access." } }, "required": ["starts_at", "ends_at"], "description": "New access time configuration." } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "description": "Seam is in the process of updating the access times for this access method." } ] }, "description": "Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress." }, "customization_profile_id": { "type": "string", "format": "uuid", "description": "ID of the customization profile associated with the access method." } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "description": "Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.", "x-draft": "Early access.", "x-route-path": "/access_methods" }, "bridge_client_session": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the Seam Bridge client session was created." }, "bridge_client_session_id": { "type": "string", "format": "uuid", "description": "ID of the Seam Bridge client session." }, "bridge_client_session_token": { "type": "string", "description": "Client session token associated with the Seam Bridge client session." }, "pairing_code": { "type": "string", "minLength": 6, "maxLength": 6, "description": "Pairing code for Seam Bridge. Use this code to pair Seam Bridge with your workspace." }, "pairing_code_expires_at": { "type": "string", "format": "date-time", "description": "Date and time at which the pairing code expires." }, "tailscale_hostname": { "type": "string", "description": "Tailscale hostname for Seam Bridge." }, "tailscale_auth_key": { "type": "string", "nullable": true, "description": "Tailscale authorization key for Seam Bridge." }, "bridge_client_name": { "type": "string", "description": "Name of the Seam Bridge client." }, "bridge_client_time_zone": { "type": "string", "description": "Time zone for the Seam Bridge client." }, "bridge_client_machine_identifier_key": { "type": "string", "description": "Identifier key of the client machine for the Seam Bridge client." }, "errors": { "type": "array", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["bridge_lan_unreachable"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." }, "is_tailscale_proxy_reachable": { "type": "boolean", "nullable": true, "description": "Indicates whether Seam can reach the Tailscale proxy." }, "is_tailscale_proxy_socks_server_healthy": { "type": "boolean", "nullable": true, "description": "Indicates whether the Tailscale proxy's SOCKS server is healthy." }, "can_tailscale_proxy_reach_tailscale_network": { "type": "boolean", "nullable": true, "description": "Indicates whether the Tailscale proxy can reach the Tailscale network." }, "can_tailscale_proxy_reach_bridge": { "type": "boolean", "nullable": true, "description": "Indicates whether the Tailscale proxy can reach Seam Bridge." }, "is_bridge_socks_server_healthy": { "type": "boolean", "nullable": true, "description": "Indicates whether Seam Bridge's SOCKS server is healthy." } }, "required": [ "message", "created_at", "error_code", "is_tailscale_proxy_reachable", "is_tailscale_proxy_socks_server_healthy", "can_tailscale_proxy_reach_tailscale_network", "can_tailscale_proxy_reach_bridge", "is_bridge_socks_server_healthy" ], "description": "Indicates that Seam cannot reach Seam Bridge's LAN." }, { "type": "object", "properties": { "message": { "type": "string", "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam created the error." }, "error_code": { "type": "string", "enum": ["no_communication_from_bridge"], "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue." } }, "required": ["message", "created_at", "error_code"], "description": "Indicates that Seam Bridge has stopped communicating with Seam." } ], "description": "Indicates an error associated with the Seam Bridge client session." }, "description": "Errors associated with the Seam Bridge client session." }, "telemetry_token": { "type": "string", "nullable": true, "description": "Telemetry token for the Seam Bridge client session." }, "telemetry_token_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time at which the telemetry token for the Seam Bridge client session expires." }, "telemetry_url": { "type": "string", "nullable": true, "description": "Telemetry URL for the Seam Bridge client session." } }, "required": [ "created_at", "bridge_client_session_id", "bridge_client_session_token", "pairing_code", "pairing_code_expires_at", "tailscale_hostname", "tailscale_auth_key", "bridge_client_name", "bridge_client_time_zone", "bridge_client_machine_identifier_key", "errors", "telemetry_token", "telemetry_token_expires_at", "telemetry_url" ], "description": "Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.", "x-route-path": "/seam/bridge/v1/bridge_client_sessions", "x-undocumented": "Seam Bridge client only." }, "bridge_connected_systems": { "type": "object", "properties": { "bridge_id": { "type": "string", "format": "uuid", "description": "ID of Seam Bridge connected to the access system." }, "bridge_created_at": { "type": "string", "format": "date-time", "description": "Date and time at which Seam Bridge was created." }, "connected_account_id": { "type": "string", "format": "uuid", "description": "ID of the connected account associated with Seam Bridge." }, "connected_account_created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the connected account associated with Seam Bridge was created." }, "acs_system_id": { "type": "string", "format": "uuid", "description": "ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge." }, "acs_system_display_name": { "type": "string", "description": "Display name for the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired." }, "workspace_display_name": { "type": "string", "description": "Display name for the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired." } }, "required": [ "bridge_id", "bridge_created_at", "connected_account_id", "connected_account_created_at", "acs_system_id", "acs_system_display_name", "workspace_id", "workspace_display_name" ], "description": "Represents an access system connected to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).", "x-route-path": "/seam/bridge/v1/bridge_connected_systems", "x-undocumented": "Seam Bridge client only." }, "thermostat_daily_program": { "type": "object", "properties": { "thermostat_daily_program_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat daily program." }, "device_id": { "type": "string", "format": "uuid", "description": "ID of the thermostat device on which the thermostat daily program is configured." }, "name": { "type": "string", "nullable": true, "description": "User-friendly name to identify the thermostat daily program." }, "periods": { "type": "array", "items": { "type": "object", "properties": { "starts_at_time": { "type": "string", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, "climate_preset_key": { "type": "string", "description": "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`." } }, "required": ["starts_at_time", "climate_preset_key"], "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time." }, "description": "Array of thermostat daily program periods." }, "workspace_id": { "type": "string", "format": "uuid", "description": "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time at which the thermostat daily program was created." } }, "required": [ "thermostat_daily_program_id", "device_id", "name", "periods", "workspace_id", "created_at" ], "description": "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.", "x-route-path": "/thermostats/daily_programs" }, "customization_profile": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "customization_profile_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "logo_url": { "type": "string", "format": "uri" }, "primary_color": { "type": "string" }, "secondary_color": { "type": "string" }, "customer_portal_theme": { "type": "object", "properties": { "primary_color": { "type": "string" }, "primary_foreground_color": { "type": "string" }, "secondary_color": { "type": "string" }, "secondary_foreground_color": { "type": "string" } } } }, "required": [ "workspace_id", "name", "customization_profile_id", "created_at" ], "description": "A customization profile.", "x-title": "Customization Profile", "x-undocumented": "Unreleased.", "x-route-path": "/workspaces/customization_profiles" }, "batch": { "type": "object", "properties": { "user_identities": { "type": "array", "items": { "$ref": "#/components/schemas/user_identity" } }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/workspace" } }, "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/space" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/device" } }, "connected_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/connected_account" } }, "acs_entrances": { "type": "array", "items": { "$ref": "#/components/schemas/acs_entrance" } }, "acs_systems": { "type": "array", "items": { "$ref": "#/components/schemas/acs_system" } }, "acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/acs_user" } }, "acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/acs_access_group" } }, "acs_encoders": { "type": "array", "items": { "$ref": "#/components/schemas/acs_encoder" } }, "acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/acs_credential" } }, "unmanaged_acs_credentials": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_credential" } }, "action_attempts": { "type": "array", "items": { "$ref": "#/components/schemas/action_attempt" } }, "client_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/client_session" } }, "unmanaged_acs_users": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_user" } }, "unmanaged_acs_access_groups": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_acs_access_group" } }, "unmanaged_devices": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_device" } }, "connect_webviews": { "type": "array", "items": { "$ref": "#/components/schemas/connect_webview" } }, "access_methods": { "type": "array", "items": { "$ref": "#/components/schemas/access_method" } }, "access_grants": { "type": "array", "items": { "$ref": "#/components/schemas/access_grant" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "instant_keys": { "type": "array", "items": { "$ref": "#/components/schemas/instant_key" } }, "access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/access_code" } }, "unmanaged_access_codes": { "type": "array", "items": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "thermostat_daily_programs": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_daily_program" } }, "thermostat_schedules": { "type": "array", "items": { "$ref": "#/components/schemas/thermostat_schedule" } }, "noise_thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/noise_threshold" } }, "customization_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/customization_profile" } } }, "description": "A batch of workspace resources.", "x-route-path": "/workspaces" } } } }